function file_requirements

Same name and namespace in other branches
  1. 7.x modules/file/file.install \file_requirements()
  2. 9 core/modules/file/file.install \file_requirements()
  3. 8.9.x core/modules/file/file.install \file_requirements()

Implements hook_requirements().

Display information about getting upload progress bars working.

1 call to file_requirements()
RequirementsTest::testUploadRequirements in core/modules/file/tests/src/Kernel/RequirementsTest.php
Tests the file upload requirements.

File

core/modules/file/file.install, line 65

Code

function file_requirements($phase) {
  $requirements = [];
  if ($phase != 'runtime') {
    return $requirements;
  }
  $server_software = \Drupal::request()->server
    ->get('SERVER_SOFTWARE', '');
  // Get the web server identity.
  $is_nginx = preg_match("/Nginx/i", $server_software);
  $is_apache = preg_match("/Apache/i", $server_software);
  $fastcgi = $is_apache && (str_contains($server_software, 'mod_fastcgi') || str_contains($server_software, 'mod_fcgi'));
  // Check the uploadprogress extension is loaded.
  if (extension_loaded('uploadprogress')) {
    $value = t('Enabled (<a href="http://pecl.php.net/package/uploadprogress">PECL uploadprogress</a>)');
    $description = NULL;
  }
  else {
    $value = t('Not enabled');
    $description = t('Your server is capable of displaying file upload progress, but does not have the required libraries. It is recommended to install the <a href="http://pecl.php.net/package/uploadprogress">PECL uploadprogress library</a>.');
  }
  // Adjust the requirement depending on what the server supports.
  if (!$is_apache && !$is_nginx) {
    $value = t('Not enabled');
    $description = t('Your server is not capable of displaying file upload progress. File upload progress requires an Apache server running PHP with mod_php or Nginx with PHP-FPM.');
  }
  elseif ($fastcgi) {
    $value = t('Not enabled');
    $description = t('Your server is not capable of displaying file upload progress. File upload progress requires PHP be run with mod_php or PHP-FPM and not as FastCGI.');
  }
  $requirements['file_progress'] = [
    'title' => t('Upload progress'),
    'value' => $value,
    'description' => $description,
  ];
  return $requirements;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.