Site icon Filestack Blog

How to Upload a File in PHP (With Easy Examples)

{ "@context": "http://schema.org", "@type": "Article", "headline": "How to Upload a File in PHP (With Easy Examples)", "description": "Learn how to upload files in PHP with easy examples, covering both basic PHP file upload techniques and advanced methods using Filestack's API. This guide will help you implement file upload functionality in your web application securely and efficiently.", "author": { "@type": "Person", "name": "Filestack" }, "publisher": { "@type": "Organization", "name": "Filestack", "logo": { "@type": "ImageObject", "url": "https://www.filestack.com/img/fs-logo.svg" } }, "datePublished": "2024-08-22", "dateModified": "2024-08-22", "mainEntityOfPage": { "@type": "WebPage", "@id": "https://blog.filestack.com/php-file-upload/" }, "image": "https://blog.filestack.com/wp-content/uploads/2019/05/php-file-upload-banner.png", "articleSection": [ "PHP", "Web Development", "File Upload" ], "keywords": "PHP file upload, Filestack PHP API, file upload tutorial, web development, PHP example", "wordCount": "2200", "articleBody": "With today's developing technology, the use and importance of file upload services in software applications is increasing..." }

With today’s developing technology, the use and importance of file upload (File Upload as a Service – FUaaS) services in software applications is increasing. To improve user experience and facilitate data management, the file upload function has become an indispensable part of almost every modern web application. In this context, uploading files using a popular programming language like PHP is an extremely critical process for developers. The PHP file upload process is gaining importance every day.

While the flexible and user-friendly structure of PHP makes this process easier, tools like Filestack make the process even simpler by eliminating the hassle of managing more complex upload infrastructures. Uploading files, images, and videos using PHP is as easy as adding a few simple scripts. In this article, we will examine two different approaches to adding PHP file upload functionality to your site. First, we will discuss the simple PHP way, which provides full control over files. Then, we will discuss Filestack’s PHP file upload service, which makes the upload process even easier and takes over the infrastructure management for you. So let’s get started.

Key Takeaways

Uploading files, images, and videos using PHP is as easy as adding a couple of scripts. This guide will show you two different ways on how to add php file upload functionality to your site:

Let’s get started with some easy examples:

PHP File Upload – The Simple Way

To start, we’ll create the following:

1. The HTML Form

First, we’ll create an HTML form that the user will see when they want to upload the file. Create a new folder for this example project, and within it, create an index.html file with the following code:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>PHP File Upload</title>
</head>
<body>
    <form action="fileUploadScript.php" method="post" enctype="multipart/form-data">
        Upload a File:
        <input type="file" name="the_file" id="fileToUpload">
        <input type="submit" name="submit" value="Start Upload">
    </form>
</body>
</html>

A couple important things to notice in the example above:

Next, open your terminal and from the directory where you created the file, start the PHP server:

Then, open your web browser and go to localhost:1234. You should see something like this:

2. The PHP File Upload Script

Next, we’ll handle the backend of the file upload. First, in the same directory, create a new directory called uploads. This will be where our script will save the files.

Then, in the same directory as index.html, create a file called fileUploadScript.php. Notice that this is the same name as the action attribute in the form. Then add this code:

<?php
    $currentDirectory = getcwd();
    $uploadDirectory = "/uploads/";

    $errors = []; // Store errors here

    $fileExtensionsAllowed = ['jpeg','jpg','png']; // These will be the only file extensions allowed 

    $fileName = $_FILES['the_file']['name'];
    $fileSize = $_FILES['the_file']['size'];
    $fileTmpName  = $_FILES['the_file']['tmp_name'];
    $fileType = $_FILES['the_file']['type'];
    $fileExtension = strtolower(end(explode('.',$fileName)));

    $uploadPath = $currentDirectory . $uploadDirectory . basename($fileName); 

    if (isset($_POST['submit'])) {

      if (! in_array($fileExtension,$fileExtensionsAllowed)) {
        $errors[] = "This file extension is not allowed. Please upload a JPEG or PNG file";
      }

      if ($fileSize > 4000000) {
        $errors[] = "File exceeds maximum size (4MB)";
      }

      if (empty($errors)) {
        $didUpload = move_uploaded_file($fileTmpName, $uploadPath);

        if ($didUpload) {
          echo "The file " . basename($fileName) . " has been uploaded";
        } else {
          echo "An error occurred. Please contact the administrator.";
        }
      } else {
        foreach ($errors as $error) {
          echo $error . "These are the errors" . "\n";
        }
      }

    }
?>

A couple things to note:

Now there are a couple final steps before we can start uploading files:

max_file_uploads = 20
upload_max_filesize = 2M
post_max_size = 8M

Handling Errors – Best Practices

Errors that may occur during the file upload process can negatively impact the user experience. Therefore, it is extremely important to handle errors properly and inform the user. We have prevented errors that may occur in the application in the following ways:

Checking File Extensions

Allowing users to upload only certain file format types is a critical step in increasing security. In the example above, only jpeg, jpg, and png file extensions are allowed. If the file extension does not meet these rules, it is important to provide a clear message to the user and catch the error:

if (! in_array($fileExtension,$fileExtensionsAllowed)) {
  $errors[] = "This file extension is not allowed. Please upload a JPEG or PNG file";
}

This way, the user can clearly understand what is wrong and choose the appropriate file type.

Checking File Max Size

It is important for server performance and data storage that the file size does not exceed a certain limit. In the example above, the user is presented with an error message when the file size exceeds 4MB. For such errors, it is important to provide user-friendly and descriptive messages:

if ($fileSize > 4000000) {
  $errors[] = "File exceeds maximum size (4MB)";
}

Managing Error Messages

Error messages presented to the user help them understand what went wrong and make the necessary corrections. Displaying error messages in bulk and clearly explaining each error improves the user experience:

if (empty($errors)) {
  $didUpload = move_uploaded_file($fileTmpName, $uploadPath);

  if ($didUpload) {
    echo "The file " . basename($fileName) . " has been uploaded";
  } else {
    echo "An error occurred. Please contact the administrator.";
  }
} else {
  foreach ($errors as $error) {
  echo $error . "These are the errors" . "\n";
  }
}

With these best practices, you can properly manage errors that may occur during the file upload process, notify the user, and improve the overall user experience.

Run

Finally, if you now start the PHP server and go to localhost:1234, then upload a file with the Start Upload button, you should see it save in the uploads folder!

Keep in mind that the all of the code above requires additional security precautions before being released in production. For example, there are currently no checks to see if the user has uploaded a virus disguised as an image. To learn more, check out this article which describes various ways to handle secure file uploads.

File Upload with Filestack

In this second example, we’ll use Filestack to upload a file. Filestack is an advanced file upload API and service that securely stores files in the cloud.

Why use a third party like Filestack over building it yourself? By using a third party you no longer need to deal with the scaling, security, and maintenance that comes with building your own file upload system. This can free you up to focus on building other important parts of your application.

So let’s get started:

1. Sign Up to Filestack Plans: Start Free, Continue Professionally

Filestack offers a powerful platform that simplifies file uploading and management processes. It provides flexible solutions by offering free and paid plans tailored to the different needs of its users. The free plan stands out as an ideal option, especially for small-scale projects or developers in the early stages. In this plan, users have the opportunity to meet their basic needs such as 1.0 GB bandwidth and 500 file uploads. In addition, they can test their projects and experience basic functions with 1.0 GB storage and 1,000 conversion operations.

For more capacity and professional use, Filestack’s paid plans come into play. The starter package called “Start” is offered for $69 per month and provides a sufficient solution for medium-sized projects. In this package, users can access a larger capacity with 75 GB bandwidth, 20,000 file upload rights, and 50 GB storage space. Moreover, file optimization and conversion operations can be easily performed with 50,000 conversion operations. These features make it a suitable solution for projects that serve more users or process higher volumes of data.

For larger projects, the “Grow” and “Scale” plans come into play. The “Grow” plan is ideal for expanding projects, offering 200GB of bandwidth, 50,000 file uploads, and 150,000 conversions for $199 per month. For higher demands, the “Scale” plan offers comprehensive features like 400GB of bandwidth, 125,000 file uploads, and 300,000 conversions for $379 per month. Both plans offer the option to remove the Filestack logo, and Platinum Support can be added as an option.

In this context, first sign up for a Filestack account with a subscription plan of your choice. Go to their registration page and after you log in, get the API Key, which you will use in the later steps.

2. Start Uploading

Now that we have the Filestack library, let’s integrate their JavaScript file uploader widget, which allows your users to connect to a variety of other sources from which to upload from. For example, if they wanted to upload from a URL or from social media. Simply replace the contents of index.html with the following:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>PHP File Upload</title>
</head>
<body>
    <style>
      .picker-content{
        height:300px;
        width:200px;
      }
    </style>
    <script src="//static.filestackapi.com/filestack-js/2.x.x/filestack.min.js"></script>
    <script type="text/javascript">
      document.addEventListener("DOMContentLoaded", function(event) { 
        const client = filestack.init(YOUR_API_KEY); 

        let options = {
          "displayMode": "inline",
          "container": ".picker-content",
          "accept": [
            "image/jpeg",
            "image/jpg",
            "image/png"
          ],
          "fromSources": [
            "local_file_system"
          ],
          "uploadInBackground": false,
          "onUploadDone": (res) => console.log(res),
        };

        picker = client.picker(options);
        picker.open();
      });
    </script>
    <div class="picker-content"></div>
</body>
</html>

Then, open your page and then upload a file using the upload widget. After uploading, you should be able to log into your Filestack dashboard and see your newly uploaded file:

And that’s it! You don’t even need the server to handle the file, which is better for scalability, security, and maintenance.

Filestack PHP Library (optional)

The above example covers the simplest example of uploading a file with Filestack. But, what if you wanted to access the file on your server to run some kind of post-processing, like checking if an image file is safe for work? To do that, you can use the Filestack PHP library. We’ll use Composer to install the Filestack PHP library. If you don’t have Composer already, you can install it by going to the folder you created originally and running (see this for official documentation):

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php -r "if (hash_file('sha384', 'composer-setup.php') === '48e3236262b34d30969dca3c37281b3b4bbe3221bda826ac6a9a62d6444cdb0dcd0615698a5cbe587c3f0fe57a54d8f5') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
php composer-setup.php
php -r "unlink('composer-setup.php');"

After you do the above, you should be able to see Composer’s output by running php composer.phar.

Then run require --prefer-dist filestack/filestack-php to install the Filestack SDK.

Now that we have the Filestack library, let’s make a new PHP script to check if a specific uploaded file is safe for work. Create a new file called fileUploadFilestack.php and add the following (making sure to change the YOUR_API_KEY, YOUR_SECURITY_SECRET, and YOUR_FILE_HANDLE variables):

<?php
  require __DIR__ . '/vendor/autoload.php';
  use Filestack\FilestackClient;
  $client = new FilestackClient(YOUR_API_KEY);
  $security = new FilestackSecurity(YOUR_SECURITY_SECRET);

  $file_handle = YOUR_FILE_HANDLE;

  # get tags with client
  $result_json = $client->getTags($file_handle);

  # get tags with filelink
  $filelink = new Filelink($file_handle, YOUR_API_KEY, $security);

  $json_result = $filelink->getTags();

  # get safe for work flag with filelink
  $json_result = $filelink->getSafeForWork();
?>

When this script is run, the result of the safe-for-work check will be saved in the $json_result variable. And that’s just one example. Using the Filestack PHP SDK allows you to perform a variety of tasks on your uploaded files. Check out these other examples:

In addition, if you want to see more examples of how the file upload picker can be integrated into a form check out these links:

Summary

Now that you know how implement PHP file uploads two ways, you can easily add this feature to your website or application. If dealing with the scalability, security, and maintenance challenges of hosting your own file upload infrastructure seems too daunting, let Filestack handle it. Also be sure to check out our article on AJAX File Uploads as well!


Exit mobile version