class Url
Same name in this branch
- 11.x core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
- 11.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url
Same name and namespace in other branches
- 9 core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
- 9 core/lib/Drupal/Core/Render/Element/Url.php \Drupal\Core\Render\Element\Url
- 9 core/lib/Drupal/Core/Url.php \Drupal\Core\Url
- 8.9.x core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
- 8.9.x core/lib/Drupal/Core/Render/Element/Url.php \Drupal\Core\Render\Element\Url
- 8.9.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url
- 10 core/modules/views/src/Plugin/views/field/Url.php \Drupal\views\Plugin\views\field\Url
- 10 core/lib/Drupal/Core/Render/Element/Url.php \Drupal\Core\Render\Element\Url
- 10 core/lib/Drupal/Core/Url.php \Drupal\Core\Url
Provides a form element for input of a URL.
Properties:
@property $default_value A valid URL string. @property $size The size of the input element in characters. @property $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',
...
];
Attributes
#[FormElement('url')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Url implements \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Url
See also
\Drupal\Core\Render\Element\Textfield
170 string references to 'Url'
- AliasPathProcessorTest::providerTestProcessOutbound in core/
modules/ path_alias/ tests/ src/ Unit/ PathProcessor/ AliasPathProcessorTest.php - Provides data for testing outbound processing.
- 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.
10 #type uses of Url
- CommentForm::form in core/
modules/ comment/ src/ CommentForm.php - Gets the actual form array to be built.
- FormTest::testRequiredFields in core/
modules/ system/ tests/ src/ Functional/ Form/ FormTest.php - Check several empty values for required forms elements.
- FormTestDisabledElementsForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestDisabledElementsForm.php - Form constructor.
- FormTestPatternForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestPatternForm.php - Form constructor.
- FormTestUrlForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestUrlForm.php - Form constructor.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Url.php, line 35
Namespace
Drupal\Core\Render\ElementView source
class Url extends FormElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#input' => TRUE,
'#size' => 60,
'#maxlength' => 255,
'#autocomplete_route_name' => FALSE,
'#process' => [
[
static::class,
'processAutocomplete',
],
[
static::class,
'processAjaxForm',
],
[
static::class,
'processPattern',
],
],
'#element_validate' => [
[
static::class,
'validateUrl',
],
],
'#pre_render' => [
[
static::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 | Render API callback: Handles the #pattern form element property. | 1 | |
FormElementBase::validatePattern | public static | function | Render API callback: Handles the #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. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
RenderElementBase::$renderParent | protected | property | The parent element. | ||
RenderElementBase::$renderParentName | protected | property | The parent key. | ||
RenderElementBase::$storage | protected | property | The storage. | ||
RenderElementBase::addChild | public | function | Adds a child render element. | Overrides ElementInterface::addChild | |
RenderElementBase::changeType | public | function | Change the type of the element. | Overrides ElementInterface::changeType | |
RenderElementBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 2 |
RenderElementBase::createChild | public | function | Creates a render object and attaches it to the current render object. | Overrides ElementInterface::createChild | |
RenderElementBase::elementInfoManager | protected | function | Returns the element info manager. | ||
RenderElementBase::getChild | public | function | Gets a child. | Overrides ElementInterface::getChild | |
RenderElementBase::getChildren | public | function | Returns child elements. | Overrides ElementInterface::getChildren | |
RenderElementBase::initializeInternalStorage | public | function | Initialize storage. | Overrides ElementInterface::initializeInternalStorage | |
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::removeChild | public | function | Removes a child. | Overrides ElementInterface::removeChild | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
RenderElementBase::setType | protected | function | Set type on initialize. | 1 | |
RenderElementBase::toRenderable | public | function | Returns a render array. | Overrides ElementInterface::toRenderable | |
RenderElementBase::__construct | public | function | Constructs a new render element object. | 6 | |
RenderElementBase::__get | public | function | Magic method: gets a property value. | ||
RenderElementBase::__isset | public | function | Magic method: checks if a property value is set. | ||
RenderElementBase::__set | public | function | Magic method: Sets a property value. | ||
RenderElementBase::__sleep | public | function | |||
RenderElementBase::__unset | public | function | Magic method: unsets a property value. | ||
RenderElementBase::__wakeup | public | function | |||
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.