Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. File.php

class File

Same name in this branch
  1. 11.1.x vendor/phpunit/php-code-coverage/src/Node/File.php \SebastianBergmann\CodeCoverage\Node\File
  2. 11.1.x vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/File.php \SebastianBergmann\CodeCoverage\Report\Html\File
  3. 11.1.x vendor/phpunit/php-code-coverage/src/Report/Xml/File.php \SebastianBergmann\CodeCoverage\Report\Xml\File
  4. 11.1.x vendor/phpunit/phpunit/src/TextUI/Configuration/Value/File.php \PHPUnit\TextUI\Configuration\File
  5. 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Scalar/MagicConst/File.php \PhpParser\Node\Scalar\MagicConst\File
  6. 11.1.x vendor/symfony/mime/Part/File.php \Symfony\Component\Mime\Part\File
  7. 11.1.x vendor/symfony/validator/Constraints/File.php \Symfony\Component\Validator\Constraints\File
  8. 11.1.x vendor/symfony/http-foundation/File/File.php \Symfony\Component\HttpFoundation\File\File
  9. 11.1.x vendor/squizlabs/php_codesniffer/src/Files/File.php \PHP_CodeSniffer\Files\File
  10. 11.1.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  11. 11.1.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  12. 11.1.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  13. 11.1.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  14. 11.1.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  15. 11.1.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File

Provides a form element for uploading a file.

If you add this element to a form the enctype="multipart/form-data" attribute will automatically be added to the form element.

Properties:

  • #multiple: A Boolean indicating whether multiple files may be uploaded.
  • #size: The size of the file input element in characters.

The value of this form element will always be an array of \Symfony\Component\HttpFoundation\File\UploadedFile objects, regardless of whether #multiple is TRUE or FALSE

Hierarchy

  • class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
    • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
      • class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
        • class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
          • class \Drupal\Core\Render\Element\File extends \Drupal\Core\Render\Element\FormElementBase

Expanded class hierarchy of File

171 string references to 'File'
AbstractUriElement::__construct in vendor/symfony/dom-crawler/AbstractUriElement.php
ArchiveCommand::execute in vendor/composer/composer/src/Composer/Command/ArchiveCommand.php
Executes the current command.
AssetResolver::getCssAssets in core/lib/Drupal/Core/Asset/AssetResolver.php
Returns the CSS assets for the current response's libraries.
AssetResolver::getJsAssets in core/lib/Drupal/Core/Asset/AssetResolver.php
Returns the JavaScript assets for the current response's libraries.
BaseFieldFileFormatterBase::isApplicable in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php
Returns if the formatter can be used for the provided field.

... See full list

File

core/lib/Drupal/Core/Render/Element/File.php, line 23

Namespace

Drupal\Core\Render\Element
View source
class File extends FormElementBase {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#input' => TRUE,
            '#multiple' => FALSE,
            '#process' => [
                [
                    $class,
                    'processFile',
                ],
            ],
            '#size' => 60,
            '#pre_render' => [
                [
                    $class,
                    'preRenderFile',
                ],
            ],
            '#theme' => 'input__file',
            '#theme_wrappers' => [
                'form_element',
            ],
            '#value_callback' => [
                [
                    $class,
                    'valueCallback',
                ],
            ],
        ];
    }
    
    /**
     * Processes a file upload element, make use of #multiple if present.
     */
    public static function processFile(&$element, FormStateInterface $form_state, &$complete_form) {
        if ($element['#multiple']) {
            $element['#attributes']['multiple'] = 'multiple';
            $element['#name'] .= '[]';
        }
        return $element;
    }
    
    /**
     * Prepares a #type 'file' render element for input.html.twig.
     *
     * For assistance with handling the uploaded file correctly, see the API
     * provided by file.api.php.
     *
     * @param array $element
     *   An associative array containing the properties of the element.
     *   Properties used: #title, #name, #size, #description, #required,
     *   #attributes.
     *
     * @return array
     *   The $element with prepared variables ready for input.html.twig.
     */
    public static function preRenderFile($element) {
        $element['#attributes']['type'] = 'file';
        Element::setAttributes($element, [
            'id',
            'name',
            'size',
        ]);
        static::setAttributes($element, [
            'js-form-file',
            'form-file',
        ]);
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
        if ($input === FALSE) {
            return NULL;
        }
        $parents = $element['#parents'];
        $element_name = array_shift($parents);
        $uploaded_files = \Drupal::request()->files
            ->get('files', []);
        $uploaded_file = $uploaded_files[$element_name] ?? NULL;
        if ($uploaded_file) {
            // Cast this to an array so that the structure is consistent regardless of
            // whether #value is set or not.
            return (array) $uploaded_file;
        }
        return NULL;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
File::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
File::preRenderFile public static function Prepares a #type 'file' render element for input.html.twig.
File::processFile public static function Processes a file upload element, make use of #multiple if present.
File::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementBase::valueCallback
FormElementBase::processAutocomplete public static function Adds autocomplete functionality to elements. 1
FormElementBase::processPattern public static function #process callback for #pattern form element property. 1
FormElementBase::validatePattern public static function #element_validate callback for #pattern form element property. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes 2
RSS feed
Powered by Drupal