class Url

Same name in this branch
  1. 10 core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
  2. 10 core/lib/Drupal/Core/Url.php \Drupal\Core\Url
Same name and namespace in other branches
  1. 9 core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
  2. 9 core/lib/Drupal/Core/Render/Element/Url.php \Drupal\Core\Render\Element\Url
  3. 9 core/lib/Drupal/Core/Url.php \Drupal\Core\Url
  4. 8.9.x core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
  5. 8.9.x core/lib/Drupal/Core/Render/Element/Url.php \Drupal\Core\Render\Element\Url
  6. 8.9.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url
  7. 11.x core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
  8. 11.x core/lib/Drupal/Core/Render/Element/Url.php \Drupal\Core\Render\Element\Url
  9. 11.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url

Provides a form element for input of a URL.

Properties:

  • #default_value: A valid URL string.
  • #size: The size of the input element in characters.
  • #pattern: A string for the native HTML5 pattern attribute.

Usage example:


$form['homepage'] = [
  '#type' => 'url',
  '#title' => $this->t('Home Page'),
  '#size' => 30,
  '#pattern' => '*.example.com',
  ...
];

Hierarchy

Expanded class hierarchy of Url

See also

\Drupal\Core\Render\Element\Textfield

149 string references to 'Url'
AliasPathProcessorTest::providerTestProcessOutbound in core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php
AliasPathProcessorTest::testProcessInbound in core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php
Tests the processInbound method.
AliasPathProcessorTest::testProcessOutbound in core/modules/path_alias/tests/src/Unit/PathProcessor/AliasPathProcessorTest.php
@covers ::processOutbound[[api-linebreak]]
ArgumentPluginBase::getCacheContexts in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
The cache contexts associated with this object.
BlockCacheTest::testCachePerPage in core/modules/block/tests/src/Functional/BlockCacheTest.php
Tests "url" cache context.

... See full list

File

core/lib/Drupal/Core/Render/Element/Url.php, line 31

Namespace

Drupal\Core\Render\Element
View source
class Url extends FormElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => 255,
      '#autocomplete_route_name' => FALSE,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateUrl',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderUrl',
        ],
      ],
      '#theme' => 'input__url',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }
  
  /**
   * Form element validation handler for #type 'url'.
   *
   * Note that #maxlength and #required is validated by _form_validate() already.
   */
  public static function validateUrl(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $form_state->setValueForElement($element, $value);
    if ($value !== '' && !UrlHelper::isValid($value, TRUE)) {
      $form_state->setError($element, t('The URL %url is not valid.', [
        '%url' => $value,
      ]));
    }
  }
  
  /**
   * Prepares a #type 'url' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderUrl($element) {
    $element['#attributes']['type'] = 'url';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-url',
    ]);
    return $element;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
FormElementBase::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 17
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
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
Url::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Url::preRenderUrl public static function Prepares a #type 'url' render element for input.html.twig.
Url::validateUrl public static function Form element validation handler for #type 'url'.

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