Url

Type
Class
Namespace
craft\fields
Inherits
craft\fields\Url » craft\base\Field » craft\base\SavableComponent » craft\base\ConfigurableComponent » craft\base\Component » craft\base\Model » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface, craft\base\ConfigurableComponentInterface, craft\base\FieldInterface, craft\base\PreviewableFieldInterface, craft\base\SavableComponentInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, craft\base\FieldTrait, craft\base\SavableComponentTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since
3.0.0

Url represents a URL field.

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window) array (opens new window) – Attribute values (name => value).
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
columnPrefix string (opens new window), null (opens new window) – The field’s content column prefix
contentColumnType string (opens new window) – The column type.
contentGqlMutationArgumentType \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlQueryArgumentType \GraphQL\Type\Definition\Type, array (opens new window)
contentGqlType \GraphQL\Type\Definition\Type, array (opens new window)
context string (opens new window), null (opens new window) – The field’s context
dateCreated DateTime (opens new window), null (opens new window) – The date that the component was created
dateUpdated DateTime (opens new window), null (opens new window) – The date that the component was last updated
eagerLoadingGqlConditions array (opens new window), false (opens new window)
elementValidationRules array (opens new window)
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window) array (opens new window) – The first errors.
group craft\records\FieldGroup, null (opens new window)
groupId integer (opens new window), null (opens new window) – The field’s group’s ID
handle string (opens new window), null (opens new window) – The field’s handle
id integer (opens new window), string (opens new window), null (opens new window) – The component’s ID (could be a temporary one: "new:X")
instructions string (opens new window), null (opens new window) – The field’s instructions
isNew boolean (opens new window) – Whether the component is new
isTranslatable boolean (opens new window)
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
layoutId integer (opens new window), null (opens new window) – The ID of the field layout that the field was fetched from
maxLength integer (opens new window) – The maximum length (in bytes) the field can hold
name string (opens new window), null (opens new window) – The field’s name
oldHandle string (opens new window), null (opens new window) – The field’s previous handle
oldSettings array (opens new window), null (opens new window) – The field’s previous settings
placeholder string (opens new window), null (opens new window) – The input’s placeholder text
required boolean (opens new window), null (opens new window) – Whether the field is required in the field layout it was fetched from
scenario (opens new window) string (opens new window) – The scenario that this model is in.
searchable boolean (opens new window) – Whether the field's values should be registered as search keywords on the elements.
settings array (opens new window) – The component’s settings.
settingsHtml string (opens new window), null (opens new window)
sortOption array (opens new window)
sortOrder integer (opens new window), null (opens new window) – The field’s sort position in the field layout it was fetched from
tabId integer (opens new window), null (opens new window) – The tab ID of the field layout that the field was fetched from
translationDescription string (opens new window), null (opens new window)
translationKeyFormat string (opens new window), null (opens new window) – The field’s translation key format, if translationMethod is "custom"
translationMethod string (opens new window) – The field’s translation method
uid string (opens new window), null (opens new window) – The field's UID
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# contentColumnType

Type
string (opens new window)
Default value
null
Access
Read-only

The column type. yii\db\QueryBuilder::getColumnType() (opens new window) will be called to convert the give column type to the physical one. For example, string will be converted as varchar(255) and string(100) becomes varchar(100). not null will automatically be appended as well.

View source (opens new window)

# elementValidationRules

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# maxLength

Type
integer (opens new window)
Default value
255

The maximum length (in bytes) the field can hold

View source (opens new window)

# placeholder

Type
string (opens new window), null (opens new window)
Default value
null

The input’s placeholder text

View source (opens new window)

# settingsHtml

Type
string (opens new window), null (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__toString() Use the translated field name as the string representation.
__unset() (opens new window) Sets an object property to null.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterDelete() Performs actions after a component is deleted.
afterElementDelete() Performs actions after the element has been deleted.
afterElementPropagate() Performs actions after the element has been fully saved and propagated to other sites.
afterElementRestore() Performs actions after the element has been restored.
afterElementSave() Performs actions after the element has been saved.
afterSave() Performs actions after a component is saved.
afterValidate() (opens new window) This method is invoked after validation ends.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attributeHints() (opens new window) Returns the attribute hints.
attributeLabels() (opens new window) Returns the attribute labels.
attributes() (opens new window) Returns the list of attribute names.
beforeApplyDelete() Performs actions before a component delete is applied to the database.
beforeDelete() Performs actions before a component is deleted.
beforeElementDelete() Performs actions before an element is deleted.
beforeElementRestore() Performs actions before an element is restored.
beforeElementSave() Performs actions before an element is saved.
beforeSave() Performs actions before a component is saved.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearErrors() (opens new window) Removes errors for all attributes or a single attribute.
createValidators() (opens new window) Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
displayName() Returns the display name of this class.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
formName() (opens new window) Returns the form name that this model class should use.
generateAttributeLabel() (opens new window) Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
getAttributeHint() (opens new window) Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window) Returns the text label for the specified attribute.
getAttributes() (opens new window) Returns attribute values.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getContentColumnType() Returns the column type that this field should get within the content table.
getContentGqlMutationArgumentType() Returns the GraphQL type to be used as an argument in mutations for this field type.
getContentGqlQueryArgumentType() Returns the GraphQL type to be used as an argument in queries for this field type.
getContentGqlType() Returns the GraphQL type to be used for this field type.
getEagerLoadingGqlConditions() Returns an array that lists the scopes this custom field allows when eager-loading or false if eager-loading should not be allowed in the GraphQL context.
getElementValidationRules() Returns the validation rules for an element with this field.
getError() Returns the first error of the specified attribute.
getErrorSummary() (opens new window) Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window) Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window) Returns the first error of the specified attribute.
getFirstErrors() (opens new window) Returns the first error of every attribute in the model.
getGroup() Returns the field’s group.
getInputHtml() Returns the field’s input HTML.
getIsNew() Returns whether the component is new (unsaved).
getIsTranslatable() Returns whether the field should be shown as translatable in the UI.
getIterator() (opens new window) Returns an iterator for traversing the attributes in the model.
getScenario() (opens new window) Returns the scenario that this model is used in.
getSearchKeywords() Returns the search keywords that should be associated with this field.
getSettings() Returns an array of the component’s settings.
getSettingsHtml() Returns the component’s settings HTML.
getSortOption() Returns the sort option array that should be included in the element’s sortOptions() response.
getStaticHtml() Returns a static (non-editable) version of the field’s input HTML.
getTableAttributeHtml() Returns the HTML that should be shown for this field in Table View.
getTranslationDescription() Returns the description of this field’s translation support.
getTranslationKey() Returns the field’s translation key, based on a given element.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasContentColumn() Returns whether this field has a column in the content table.
hasErrors() Returns a value indicating whether there is any validation error.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
init() Initializes the object.
instance() (opens new window) Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window) Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window) Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window) Returns a value indicating whether the attribute is safe for massive assignments.
isEmpty()
isSelectable() Returns whether the component should be selectable in component Type selects.
isValueEmpty() Returns whether the given value should be considered “empty” to a validator.
load() (opens new window) Populates the model with input data.
loadMultiple() (opens new window) Populates a set of models with the data from end user.
modifyElementIndexQuery() Modifies an element index query.
modifyElementsQuery() Modifies an element query.
normalizeValue() Normalizes the field’s value for use.
off() (opens new window) Detaches an existing event handler from this component.
offsetExists() (opens new window) Returns whether there is an element at the specified offset.
offsetGet() (opens new window) Returns the element at the specified offset.
offsetSet() (opens new window) Sets the element at the specified offset.
offsetUnset() (opens new window) Sets the element value at the specified offset to null.
on() (opens new window) Attaches an event handler to an event.
onUnsafeAttribute() (opens new window) This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() (opens new window) Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window) Returns a list of scenarios and the corresponding active attributes.
serializeValue() Prepares the field’s value to be stored somewhere, like the content table.
setAttributes() (opens new window) Sets the attribute values in a massive way.
setIsFresh() Sets whether the field is fresh.
setScenario() (opens new window) Sets the scenario for the model.
settingsAttributes() Returns the list of settings attribute names.
supportedTranslationMethods() Returns which translation methods the field supports.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.
valueType() Returns the PHPDoc type this field’s values will have.

# displayName()

Returns the display name of this class.

View source (opens new window)

Returns

string (opens new window) – The display name of this class.

# getContentColumnType()

Returns the column type that this field should get within the content table.

This method will only be called if hasContentColumn() returns true.

View source (opens new window)

Returns

string (opens new window) – The column type. yii\db\QueryBuilder::getColumnType() (opens new window) will be called to convert the give column type to the physical one. For example, string will be converted as varchar(255) and string(100) becomes varchar(100). not null will automatically be appended as well.

# getElementValidationRules()

Returns the validation rules for an element with this field.

Rules should be defined in the array syntax required by yii\base\Model::rules() (opens new window), with one difference: you can skip the first argument (the attribute list).

[
    // explicitly specify the field attribute
    [$this->handle, 'string', 'min' => 3, 'max' => 12],
    // skip the field attribute
    ['string', 'min' => 3, 'max' => 12],
    // you can only pass the validator class name/handle if not setting any params
    'bool',
]

To register validation rules that should only be enforced for live elements, set the rule scenario (opens new window) to live:

[
    ['string', 'min' => 3, 'max' => 12, 'on' => \craft\base\Element::SCENARIO_LIVE],
]

View source (opens new window)

Returns

array (opens new window)

# getSettingsHtml()

Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->foo.'</textarea>';

For more complex settings, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at src/templates/_settings.html, passing the settings to it:

return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
    'widget' => $this
]);

If you need to tie any JavaScript code to your settings, it’s important to know that any name and id attributes within the returned HTML will probably get namespaced, however your JavaScript code will be left untouched. For example, if getSettingsHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, Craft provides a couple handy methods that can help you deal with this:

So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml()
{
    // Figure out what the ID is going to be namespaced into
    $id = 'foo';
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
        'id' => $id,
        'namespacedId' => $namespacedId,
        'widget' => $this,
    ]);
}

And the _widget-settings.twig template might look like this:

<textarea id="{{ id }}" name="foo">{{ widget.foo }}</textarea>
<script type="text/javascript">
    var textarea = document.getElementById('{{ namespacedId }}');
</script>

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs().

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# getTableAttributeHtml()

Returns the HTML that should be shown for this field in Table View.

View source (opens new window)

Arguments

Returns

string (opens new window) – The HTML that should be shown for this field in Table View

# valueType()

Since
3.2.0

Returns the PHPDoc type this field’s values will have.

It will be used by the generated CustomFieldBehavior class.

If the values can be of more than one type, return multiple types separated by |s.

public static function phpDocType()
{
     return 'int|mixed|\\craft\\elements\\db\\ElementQuery';
}

View source (opens new window)

Returns

string (opens new window)

# Protected Methods

Method Description
defineRules() Returns the validation rules for attributes.
extractFieldsFor() (opens new window) Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
inputHtml() Returns the field’s input HTML.
isFresh() Returns whether this is the first time the element's content has been edited.
requestParamName() Returns the field’s param name on the request.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
searchKeywords() Returns the search keywords that should be associated with this field.

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# inputHtml()

Since
3.5.0

Returns the field’s input HTML.

View source (opens new window)

Arguments

Returns

string (opens new window) – The input HTML.

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.
TRANSLATION_METHOD_CUSTOM
TRANSLATION_METHOD_LANGUAGE
TRANSLATION_METHOD_NONE
TRANSLATION_METHOD_SITE
TRANSLATION_METHOD_SITE_GROUP