File.php

Same filename in this branch
  1. 8.9.x core/modules/media/src/Plugin/media/Source/File.php
  2. 8.9.x core/modules/file/src/Entity/File.php
  3. 8.9.x core/modules/file/src/Plugin/views/field/File.php
  4. 8.9.x core/modules/file/src/Plugin/views/wizard/File.php
  5. 8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php
  6. 8.9.x core/modules/file/src/Plugin/migrate/source/d7/File.php
Same filename and directory in other branches
  1. 10 core/modules/media/src/Plugin/media/Source/File.php
  2. 10 core/modules/file/src/Entity/File.php
  3. 10 core/modules/file/src/Plugin/views/field/File.php
  4. 10 core/modules/file/src/Plugin/views/wizard/File.php
  5. 10 core/modules/file/src/Plugin/migrate/source/d6/File.php
  6. 10 core/modules/file/src/Plugin/migrate/source/d7/File.php
  7. 11.x core/modules/media/src/Plugin/media/Source/File.php
  8. 11.x core/modules/file/src/Entity/File.php
  9. 11.x core/modules/file/src/Plugin/views/field/File.php
  10. 11.x core/modules/file/src/Plugin/views/wizard/File.php
  11. 11.x core/modules/file/src/Plugin/migrate/source/d6/File.php
  12. 11.x core/modules/file/src/Plugin/migrate/source/d7/File.php
  13. 11.x core/lib/Drupal/Core/Render/Element/File.php
  14. 10 core/lib/Drupal/Core/Render/Element/File.php
  15. 9 core/modules/media/src/Plugin/media/Source/File.php
  16. 9 core/modules/file/src/Entity/File.php
  17. 9 core/modules/file/src/Plugin/views/field/File.php
  18. 9 core/modules/file/src/Plugin/views/wizard/File.php
  19. 9 core/modules/file/src/Plugin/migrate/source/d6/File.php
  20. 9 core/modules/file/src/Plugin/migrate/source/d7/File.php
  21. 9 core/lib/Drupal/Core/Render/Element/File.php

Namespace

Drupal\Core\Render\Element

File

core/lib/Drupal/Core/Render/Element/File.php

View source
<?php

namespace Drupal\Core\Render\Element;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Element;

/**
 * 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.
 *
 * @FormElement("file")
 */
class File extends FormElement {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#multiple' => FALSE,
      '#process' => [
        [
          $class,
          'processFile',
        ],
      ],
      '#size' => 60,
      '#pre_render' => [
        [
          $class,
          'preRenderFile',
        ],
      ],
      '#theme' => 'input__file',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }
  
  /**
   * 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.inc.
   *
   * @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;
  }

}

Classes

Title Deprecated Summary
File Provides a form element for uploading a file.

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