InputWidget

API reference › yii › widgets › InputWidget

class	`yii\widgets\InputWidget`
Extends	`yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/widgets/InputWidget.php`

4 subclasses

InputWidget is the base class for widgets that collect user inputs.

An input widget can be associated with a data $model and an $attribute, or a $name and a $value. If the former, the name and the value will be generated automatically (subclasses may call renderInputHtml() to follow this behavior).

Classes extending from this widget can be used in an ActiveForm using the widget() method, for example like this:

<?= $form->field($model, 'from_date')->widget('WidgetClassName', [
    // configure additional widget properties here
]) ?>

For more details and usage information on InputWidget, see the guide article on forms.

Properties

Property	Type	Description	Defined by
`$attribute`	`string\|null`	The model attribute that this widget is associated with. Default: `null`.	`InputWidget`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$field`	`ActiveField`	Active input field, which triggers this widget rendering. Default: `null`. Available since 2.0.11.	`InputWidget`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$model`	`yii\base\Model\|null`	The data model that this widget is associated with. Default: `null`.	`InputWidget`
`$name`	`string\|null`	The input name. Default: `null`.	`InputWidget`
`$options`	`array`	The HTML attributes for the input tag. Default: `[]`.	`InputWidget`
`$value`	`string`	The input value. Default: `null`.	`InputWidget`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`afterRun()`	This method is invoked right after a widget is executed.	`yii\base\Widget`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	Begins a widget.	`yii\base\Widget`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`end()` static	Ends a widget.	`yii\base\Widget`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getId()`	Returns the ID of the widget.	`yii\base\Widget`
`getView()`	Returns the view object that can be used to render views or view files.	`yii\base\Widget`
`getViewPath()`	Returns the directory containing the view files for this widget.	`yii\base\Widget`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the widget.	`InputWidget`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`render()`	Renders a view.	`yii\base\Widget`
`renderFile()`	Renders a view file.	`yii\base\Widget`
`run()`	Executes the widget.	`yii\base\Widget`
`setId()`	Sets the ID of the widget.	`yii\base\Widget`
`setView()`	Sets the view object to be used by this widget.	`yii\base\Widget`
`trigger()`	Triggers an event.	`yii\base\Component`
`widget()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`hasModel()` protected		`InputWidget`
`renderInputHtml()` protected	Render a HTML input tag.	`InputWidget`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Property details

$field

public yii\widgets\ActiveField $field = null

Active input field, which triggers this widget rendering.

This field will be automatically filled up in case widget instance is created via ActiveField::widget().

Since

2.0.11

$name

public string|null $name = null

The input name.

This must be set if $model and $attribute are not set.

Method details

init()

public function init(): mixed

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

Returns

mixed

hasModel()

protected function hasModel(): bool

Returns

bool: Whether this widget is associated with a data model.

renderInputHtml()

protected function renderInputHtml(string $type): string

Render a HTML input tag.

This will call Html::activeInput() if the input widget is tied to a model, or Html::input() if not.

Parameters

Parameter	Type	Description
`$type`	`string`	The type of the input to create.

Returns

string: The HTML of the input field.

Since

2.0.13

See also