# ActionColumn

> ActionColumn is a column for the yii\grid\GridView widget that displays buttons for viewing and manipulating the items.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [grid](/docs/api/yii/grid/index.md) › ActionColumn

| class | `yii\grid\ActionColumn` |
| --- | --- |
| Extends | [`Column`](/docs/api/yii/grid/column/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/grid/ActionColumn.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/grid/ActionColumn.php#L35) |

ActionColumn is a column for the [`GridView`](/docs/api/yii/grid/gridview/index.md) widget that displays buttons for viewing and manipulating the items.

To add an ActionColumn to the gridview, add it to the [columns](/docs/api/yii/grid/gridview/index.md#property-columns) configuration as follows:

```
'columns' => [
    // ...
    [
        'class' => ActionColumn::class,
        // you may configure additional properties here
    ],
]
```

For more details and usage information on ActionColumn, see the [guide article on data widgets](/docs/guide/output-data-widgets/index.md).

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-buttonOptions"></span>`$buttonOptions` | `array` | Html options to be applied to the [default button](/docs/api/yii/grid/actioncolumn/index.md#method-initDefaultButton). Default: `[]`. Available since 2.0.4. | `ActionColumn` |
| [`$buttons`](#property-buttons) | `array` | Button rendering callbacks. Default: `[]`. | `ActionColumn` |
| <span id="property-content"></span>[`$content`](/docs/api/yii/grid/column/index.md#property-content) | `callable` | This is a callable that will be used to generate the content of each cell. Default: `null`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="property-contentOptions"></span>[`$contentOptions`](/docs/api/yii/grid/column/index.md#property-contentOptions) | `array\|`[`Closure`](https://www.php.net/manual/en/class.closure.php) | The HTML attributes for the data cell tag. Default: `[]`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| [`$controller`](#property-controller) | `string\|null` | The ID of the controller that should handle the actions specified here. Default: `null`. | `ActionColumn` |
| <span id="property-filterOptions"></span>[`$filterOptions`](/docs/api/yii/grid/column/index.md#property-filterOptions) | `array` | The HTML attributes for the filter cell tag. Default: `[]`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="property-footer"></span>[`$footer`](/docs/api/yii/grid/column/index.md#property-footer) | `string` | The footer cell content. Default: `null`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="property-footerOptions"></span>[`$footerOptions`](/docs/api/yii/grid/column/index.md#property-footerOptions) | `array` | The HTML attributes for the footer cell tag. Default: `[]`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="property-grid"></span>[`$grid`](/docs/api/yii/grid/column/index.md#property-grid) | [`GridView`](/docs/api/yii/grid/gridview/index.md) | The grid view object that owns this column. Default: `null`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="property-header"></span>[`$header`](/docs/api/yii/grid/column/index.md#property-header) | `string\|null` | The header cell content. Default: `null`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="property-headerOptions"></span>`$headerOptions` | `array` | Default: `['class' => 'action-column']`. | `ActionColumn` |
| [`$icons`](#property-icons) | `array` | Button icons. Default: `['eye-open' => '<svg aria-hidden="true" style="display:inline-block;font-size:inherit;height:1em;overflow:visible;vertical-align:-.125em;width:1.125em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path fill="currentColor" d="M573 241C518 136 411 64 288 64S58 136 3 241a32 32 0 000 30c55 105 162 177 285 177s230-72 285-177a32 32 0 000-30zM288 400a144 144 0 11144-144 144 144 0 01-144 144zm0-240a95 95 0 00-25 4 48 48 0 01-67 67 96 96 0 1092-71z"/></svg>', 'pencil' => '<svg aria-hidden="true" style="display:inline-block;font-size:inherit;height:1em;overflow:visible;vertical-align:-.125em;width:1em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M498 142l-46 46c-5 5-13 5-17 0L324 77c-5-5-5-12 0-17l46-46c19-19 49-19 68 0l60 60c19 19 19 49 0 68zm-214-42L22 362 0 484c-3 16 12 30 28 28l122-22 262-262c5-5 5-13 0-17L301 100c-4-5-12-5-17 0zM124 340c-5-6-5-14 0-20l154-154c6-5 14-5 20 0s5 14 0 20L144 340c-6 5-14 5-20 0zm-36 84h48v36l-64 12-32-31 12-65h36v48z"/></svg>', 'trash' => '<svg aria-hidden="true" style="display:inline-block;font-size:inherit;height:1em;overflow:visible;vertical-align:-.125em;width:.875em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="currentColor" d="M32 464a48 48 0 0048 48h288a48 48 0 0048-48V128H32zm272-256a16 16 0 0132 0v224a16 16 0 01-32 0zm-96 0a16 16 0 0132 0v224a16 16 0 01-32 0zm-96 0a16 16 0 0132 0v224a16 16 0 01-32 0zM432 32H312l-9-19a24 24 0 00-22-13H167a24 24 0 00-22 13l-9 19H16A16 16 0 000 48v32a16 16 0 0016 16h416a16 16 0 0016-16V48a16 16 0 00-16-16z"/></svg>']`. Available since 2.0.42. | `ActionColumn` |
| <span id="property-options"></span>[`$options`](/docs/api/yii/grid/column/index.md#property-options) | `array` | The HTML attributes for the column group tag. Default: `[]`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| [`$template`](#property-template) | `string` | The template used for composing each cell in the action column. Default: `'{view} {update} {delete}'`. | `ActionColumn` |
| [`$urlCreator`](#property-urlCreator) | `callable\|null` | A callback that creates a button URL using the specified model information. Default: `null`. | `ActionColumn` |
| <span id="property-visible"></span>[`$visible`](/docs/api/yii/grid/column/index.md#property-visible) | `bool` | Whether this column is visible. Default: `true`. | [`Column`](/docs/api/yii/grid/column/index.md) |
| [`$visibleButtons`](#property-visibleButtons) | `array` | Visibility conditions for each button. Default: `[]`. Available since 2.0.7. | `ActionColumn` |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/baseobject/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/baseobject/index.md#method-__get) | Returns the value of an object property. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/baseobject/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/baseobject/index.md#method-__set) | Sets value of an object property. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/baseobject/index.md#method-__unset) | Sets an object property to null. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/baseobject/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/baseobject/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| [`createUrl()`](#method-createUrl) | Creates a URL for the given action and model. | `ActionColumn` |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/baseobject/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/baseobject/index.md#method-hasProperty) | Returns a value indicating whether a property is defined. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| [`init()`](#method-init) | Initializes the object. | `ActionColumn` |
| <span id="method-renderDataCell"></span>[`renderDataCell()`](/docs/api/yii/grid/column/index.md#method-renderDataCell) | Renders a data cell. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="method-renderFilterCell"></span>[`renderFilterCell()`](/docs/api/yii/grid/column/index.md#method-renderFilterCell) | Renders the filter cell. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="method-renderFooterCell"></span>[`renderFooterCell()`](/docs/api/yii/grid/column/index.md#method-renderFooterCell) | Renders the footer cell. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="method-renderHeaderCell"></span>[`renderHeaderCell()`](/docs/api/yii/grid/column/index.md#method-renderHeaderCell) | Renders the header cell. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="method-getHeaderCellLabel"></span>[`getHeaderCellLabel()`](/docs/api/yii/grid/column/index.md#method-getHeaderCellLabel) protected | Returns header cell label. | [`Column`](/docs/api/yii/grid/column/index.md) |
| [`initDefaultButton()`](#method-initDefaultButton) protected | Initializes the default button rendering callback for single button. | `ActionColumn` |
| [`initDefaultButtons()`](#method-initDefaultButtons) protected | Initializes the default button rendering callbacks. | `ActionColumn` |
| [`renderDataCellContent()`](#method-renderDataCellContent) protected | Renders the data cell content. | `ActionColumn` |
| <span id="method-renderFilterCellContent"></span>[`renderFilterCellContent()`](/docs/api/yii/grid/column/index.md#method-renderFilterCellContent) protected | Renders the filter cell content. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="method-renderFooterCellContent"></span>[`renderFooterCellContent()`](/docs/api/yii/grid/column/index.md#method-renderFooterCellContent) protected | Renders the footer cell content. | [`Column`](/docs/api/yii/grid/column/index.md) |
| <span id="method-renderHeaderCellContent"></span>[`renderHeaderCellContent()`](/docs/api/yii/grid/column/index.md#method-renderHeaderCellContent) protected | Renders the header cell content. | [`Column`](/docs/api/yii/grid/column/index.md) |

## Property details

### $buttons <span id="property-buttons"></span>

```php
public array $buttons = []
```

Button rendering callbacks.

The array keys are the button names (without curly brackets),
and the values are the corresponding button rendering callbacks. The callbacks should use the following
signature:

```
function ($url, $model, $key) {
    // return the button HTML code
}
```

where `$url` is the URL that the column creates for the button, `$model` is the model object
being rendered for the current row, and `$key` is the key of the model in the data provider array.

You can add further conditions to the button, for example only display it, when the model is
editable (here assuming you have a status field that indicates that):

```
[
    'update' => function ($url, $model, $key) {
        return $model->status === 'editable' ? Html::a('Update', $url) : '';
    },
],
```

### $controller <span id="property-controller"></span>

```php
public string|null $controller = null
```

The ID of the controller that should handle the actions specified here.

If not set, it will use the currently active controller. This property is mainly used by
[`$urlCreator`](/docs/api/yii/grid/actioncolumn/index.md#property-urlCreator) to create URLs for different actions. The value of this property will be prefixed
to each action name to form the route of the action.

### $icons <span id="property-icons"></span>

```php
public array $icons = ['eye-open' => '<svg aria-hidden="true" style="display:inline-block;font-size:inherit;height:1em;overflow:visible;vertical-align:-.125em;width:1.125em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path fill="currentColor" d="M573 241C518 136 411 64 288 64S58 136 3 241a32 32 0 000 30c55 105 162 177 285 177s230-72 285-177a32 32 0 000-30zM288 400a144 144 0 11144-144 144 144 0 01-144 144zm0-240a95 95 0 00-25 4 48 48 0 01-67 67 96 96 0 1092-71z"/></svg>', 'pencil' => '<svg aria-hidden="true" style="display:inline-block;font-size:inherit;height:1em;overflow:visible;vertical-align:-.125em;width:1em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M498 142l-46 46c-5 5-13 5-17 0L324 77c-5-5-5-12 0-17l46-46c19-19 49-19 68 0l60 60c19 19 19 49 0 68zm-214-42L22 362 0 484c-3 16 12 30 28 28l122-22 262-262c5-5 5-13 0-17L301 100c-4-5-12-5-17 0zM124 340c-5-6-5-14 0-20l154-154c6-5 14-5 20 0s5 14 0 20L144 340c-6 5-14 5-20 0zm-36 84h48v36l-64 12-32-31 12-65h36v48z"/></svg>', 'trash' => '<svg aria-hidden="true" style="display:inline-block;font-size:inherit;height:1em;overflow:visible;vertical-align:-.125em;width:.875em" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="currentColor" d="M32 464a48 48 0 0048 48h288a48 48 0 0048-48V128H32zm272-256a16 16 0 0132 0v224a16 16 0 01-32 0zm-96 0a16 16 0 0132 0v224a16 16 0 01-32 0zm-96 0a16 16 0 0132 0v224a16 16 0 01-32 0zM432 32H312l-9-19a24 24 0 00-22-13H167a24 24 0 00-22 13l-9 19H16A16 16 0 000 48v32a16 16 0 0016 16h416a16 16 0 0016-16V48a16 16 0 00-16-16z"/></svg>']
```

Button icons.

The array keys are the icon names and the values the corresponding html:
```
[
    'eye-open' => '<svg ...></svg>',
    'pencil' => Html::tag('span', '', ['class' => 'glyphicon glyphicon-pencil'])
]
```
Defaults to FontAwesome 5 free svg icons.

**Since**

2.0.42

### $template <span id="property-template"></span>

```php
public string $template = '{view} {update} {delete}'
```

The template used for composing each cell in the action column.

Tokens enclosed within curly brackets are treated as controller action IDs (also called *button names*
in the context of action column). They will be replaced by the corresponding button rendering callbacks
specified in [`$buttons`](/docs/api/yii/grid/actioncolumn/index.md#property-buttons). For example, the token `{view}` will be replaced by the result of
the callback `buttons['view']`. If a callback cannot be found, the token will be replaced with an empty string.

As an example, to only have the view, and update button you can add the ActionColumn to your GridView columns as follows:

```
['class' => 'yii\grid\ActionColumn', 'template' => '{view} {update}'],
```

### $urlCreator <span id="property-urlCreator"></span>

```php
public callable|null $urlCreator = null
```

A callback that creates a button URL using the specified model information.

The signature of the callback should be the same as that of [`createUrl()`](/docs/api/yii/grid/actioncolumn/index.md#method-createUrl)
Since 2.0.10 it can accept additional parameter, which refers to the column instance itself:

```
function (string $action, mixed $model, mixed $key, integer $index, ActionColumn $this) {
    //return string;
}
```

If this property is not set, button URLs will be created using [`createUrl()`](/docs/api/yii/grid/actioncolumn/index.md#method-createUrl).

### $visibleButtons <span id="property-visibleButtons"></span>

```php
public array $visibleButtons = []
```

Visibility conditions for each button.

The array keys are the button names (without curly brackets),
and the values are the boolean true/false or the anonymous function. When the button name is not specified in
this array it will be shown by default.
The callbacks must use the following signature:

```
function ($model, $key, $index) {
    return $model->status === 'editable';
}
```

Or you can pass a boolean value:

```
[
    'update' => \Yii::$app->user->can('update'),
],
```

**Since**

2.0.7

## Method details

### createUrl() <span id="method-createUrl"></span>

```php
public function createUrl(string $action, yii\db\ActiveRecordInterface $model, mixed $key, int $index): string
```

Creates a URL for the given action and model.

This method is called for each button and each row.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$action` | `string` | The button name (or action ID) |
| `$model` | [`yii\db\ActiveRecordInterface`](/docs/api/yii/db/activerecordinterface/index.md) | The data model |
| `$key` | `mixed` | The key associated with the data model |
| `$index` | `int` | The current row index |

**Returns**

`string`: The created URL

### init() <span id="method-init"></span>

```php
public function init(): mixed
```

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the
given configuration.

**Returns**

`mixed`

### initDefaultButton() <span id="method-initDefaultButton"></span>

```php
protected function initDefaultButton(string $name, string $iconName, array $additionalOptions = []): mixed
```

Initializes the default button rendering callback for single button.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$name` | `string` | Button name as it's written in template |
| `$iconName` | `string` | The icon name used as key in [`$icons`](/docs/api/yii/grid/actioncolumn/index.md#property-icons) |
| `$additionalOptions` | `array` | Array of additional options |

**Returns**

`mixed`

**Since**

2.0.11

### initDefaultButtons() <span id="method-initDefaultButtons"></span>

```php
protected function initDefaultButtons(): mixed
```

Initializes the default button rendering callbacks.

**Returns**

`mixed`

### renderDataCellContent() <span id="method-renderDataCellContent"></span>

```php
protected function renderDataCellContent(mixed $model, mixed $key, mixed $index): string
```

Renders the data cell content.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$model` | `mixed` | The data model |
| `$key` | `mixed` | The key associated with the data model |
| `$index` | `mixed` | The zero-based index of the data model among the models array returned by [`GridView::$dataProvider`](/docs/api/yii/widgets/baselistview/index.md#property-dataProvider). |

**Returns**

`string`: The rendering result