Folder Upload in Laravel: Complete Guide and Examples

In Laravel, uploading files is a common requirement for many web applications. Whether you need to allow users to upload profile pictures, documents, or any other type of file, Laravel provides a convenient way to handle file uploads.

This article will guide you through the process of implementing folder upload functionality in Laravel. We will cover everything from configuring your application to handling the uploaded files.

Configuring Your Application

Before you can start uploading files, you need to make sure your Laravel application is properly configured. Laravel uses the config/filesystems.php file to define the disk that will be used for file storage. By default, Laravel uses the local disk, which stores files in the storage/app directory.

If you want to store the uploaded files in a different directory, you can create a new disk configuration in the config/filesystems.php file. For example, if you want to store the files in a uploads directory, you can add the following code to the disks array:

'uploads' => [
    'driver' => 'local',
    'root' => storage_path('app/uploads'),
],

Once you have configured the disk, you can start implementing the folder upload functionality.

Creating the Upload Form

To allow users to upload files, you need to create an HTML form with an input field of type file. In Laravel, you can use the Form facade to generate the form elements. Here's an example of a simple upload form:

<form action="/upload" method="POST" enctype="multipart/form-data">
    {{ csrf_field() }}
    <input type="file" name="file">
    <button type="submit">Upload</button>
</form>

Make sure to include the enctype="multipart/form-data" attribute in the form tag. This is necessary to enable file uploads.

Handling the Upload

Once the user submits the upload form, you need to handle the uploaded file in your Laravel application. Laravel provides a convenient way to handle file uploads using the store method of the UploadedFile class.

In your controller, you can access the uploaded file using the file method of the Request object. Here's an example of how you can handle the upload:

public function upload(Request $request)
{
    $file = $request->file('file');
    $file->store('uploads');
    
    return 'File uploaded successfully!';
}

In this example, we retrieve the uploaded file using the file method and then use the store method to store the file in the specified directory (in this case, uploads). The store method automatically generates a unique filename to avoid conflicts.

Displaying Uploaded Files

After the file has been uploaded, you may want to display it to the user. Laravel makes it easy to generate URLs for uploaded files using the Storage facade.

Here's an example of how you can display a link to the uploaded file:

<a href="{{ Storage::url('uploads/' . $file->hashName()) }}">Download File</a>

In this example, we use the url method of the Storage facade to generate the URL for the uploaded file. We concatenate the uploads/ directory with the hashName method of the UploadedFile instance to get the file's unique filename.

Implementing folder upload functionality in Laravel is straightforward. By following the steps outlined in this guide, you can easily allow users to upload files to your web application. Remember to configure your application, create the upload form, handle the upload, and display the uploaded files to the user.

References