# LinkPager

> Renders Bootstrap pagination links for a yii\data\Pagination object.

[API reference](/docs/api/index.md) › [Bootstrap 6](/docs/extensions/bootstrap6/reference/index.md) › LinkPager

| class | `yii2\extensions\bootstrap6\LinkPager` |
| --- | --- |
| Extends | [`Widget`](/docs/extensions/bootstrap6/reference/widget/index.md) » [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Uses traits | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md), [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| Source | [`src/LinkPager.php`](https://github.com/yii2-extensions/bootstrap6/blob/main/src/LinkPager.php#L29) |

Renders Bootstrap pagination links for a [`Pagination`](/docs/api/yii/data/pagination/index.md) object.

To use it in every `GridView`/`ListView`, register it in the DI container as the definition of
[`LinkPager`](/docs/api/yii/widgets/linkpager/index.md).

See also: <https://getbootstrap.com/docs/6.0/components/pagination/>.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-activePageCssClass"></span>`$activePageCssClass` | `string` | CSS class of the active (current) page item. Default: `'active'`. | `LinkPager` |
| <span id="property-autoIdPrefix"></span>[`$autoIdPrefix`](/docs/api/yii/base/widget/index.md#property-autoIdPrefix) static | `string` | The prefix to the automatically generated widget IDs. Default: `'w'`. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-clientEvents"></span>[`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) | `array<string,` [`yii\web\JsExpression`](/docs/api/yii/web/jsexpression/index.md)`\|string>` | Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="property-clientOptions"></span>[`$clientOptions`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientOptions) | `array<string, mixed>\|false` | Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="property-disableCurrentPageButton"></span>`$disableCurrentPageButton` | `bool` | Whether to render the current page button as disabled. Default: `false`. | `LinkPager` |
| <span id="property-disabledListItemSubTagOptions"></span>`$disabledListItemSubTagOptions` | `array<string, mixed>` | HTML attributes merged into the links of disabled page items. Default: `[]`. | `LinkPager` |
| <span id="property-disabledPageCssClass"></span>`$disabledPageCssClass` | `string` | CSS class of the disabled page items. Default: `'disabled'`. | `LinkPager` |
| <span id="property-firstPageCssClass"></span>`$firstPageCssClass` | `string` | CSS class of the "first" page item. Default: `'first'`. | `LinkPager` |
| <span id="property-firstPageLabel"></span>`$firstPageLabel` | `bool\|string` | Label of the "first" page button (not HTML-encoded), `true` for the page number, or `false` to omit it. Default: `false`. | `LinkPager` |
| <span id="property-hideOnSinglePage"></span>`$hideOnSinglePage` | `bool` | Whether to render nothing when there is only one page. Default: `true`. | `LinkPager` |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/widget/index.md#property-id) | `string` | Id of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-lastPageCssClass"></span>`$lastPageCssClass` | `string` | CSS class of the "last" page item. Default: `'last'`. | `LinkPager` |
| <span id="property-lastPageLabel"></span>`$lastPageLabel` | `bool\|string` | Label of the "last" page button (not HTML-encoded), `true` for the page number, or `false` to omit it. Default: `false`. | `LinkPager` |
| <span id="property-linkContainerOptions"></span>`$linkContainerOptions` | `array<string, mixed>` | HTML attributes of every page item; the `tag` option sets the tag name (default `li`). Default: `['class' => ['page-item']]`. | `LinkPager` |
| <span id="property-linkOptions"></span>`$linkOptions` | `array<string, mixed>` | HTML attributes of every page link. Default: `['class' => ['page-link']]`. | `LinkPager` |
| <span id="property-listOptions"></span>`$listOptions` | `array<string, mixed>` | HTML attributes of the list tag; the `tag` option sets the tag name (default `ul`). Default: `['class' => ['pagination']]`. | `LinkPager` |
| <span id="property-maxButtonCount"></span>`$maxButtonCount` | `int` | Maximum number of internal page buttons. Default: `10`. | `LinkPager` |
| <span id="property-nextPageCssClass"></span>`$nextPageCssClass` | `string` | CSS class of the "next" page item. Default: `'next'`. | `LinkPager` |
| <span id="property-nextPageLabel"></span>`$nextPageLabel` | `false\|string` | Label of the "next" page button (not HTML-encoded), or `false` to omit it. Default: `'<span aria-hidden="true">&raquo;</span>'`. | `LinkPager` |
| <span id="property-options"></span>`$options` | `array<string, mixed>` | HTML attributes of the container tag; the `tag` option sets the tag name (default `nav`). Default: `[]`. | `LinkPager` |
| <span id="property-pageCssClass"></span>`$pageCssClass` | `string` | CSS class of the internal page items. Default: `'page-item'`. | `LinkPager` |
| <span id="property-pagination"></span>`$pagination` | [`yii\data\Pagination`](/docs/api/yii/data/pagination/index.md)`\|null` | Pagination that provides the page count, the current page, and the page URLs. Default: `null`. | `LinkPager` |
| <span id="property-prevPageCssClass"></span>`$prevPageCssClass` | `string` | CSS class of the "previous" page item. Default: `'prev'`. | `LinkPager` |
| <span id="property-prevPageLabel"></span>`$prevPageLabel` | `false\|string` | Label of the "previous" page button (not HTML-encoded), or `false` to omit it. Default: `'<span aria-hidden="true">&laquo;</span>'`. | `LinkPager` |
| <span id="property-registerLinkTags"></span>`$registerLinkTags` | `bool` | Whether to register `<link>` tags for the first, previous, next, and last pages in the view head. Default: `false`. | `LinkPager` |
| <span id="property-size"></span>`$size` | [`yii2\extensions\bootstrap6\enum\Size`](/docs/extensions/bootstrap6/reference/enum/size/index.md)`\|string\|null` | Size modifier rendered as the `pagination-{value}` class (`sm` or `lg`), or `null` for the default size. Default: `null`. | `LinkPager` |
| <span id="property-theme"></span>`$theme` | [`yii2\extensions\bootstrap6\enum\Theme`](/docs/extensions/bootstrap6/reference/enum/theme/index.md)`\|string\|null` | Theme color rendered as the `theme-{value}` class on the list, or `null` for the default color. Default: `null`. | `LinkPager` |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/widget/index.md#property-view) | [`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/widget/index.md#property-viewPath) read-only | `string` | The directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## 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/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-addAttributes"></span>[`addAttributes()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addAttributes) | Adds a set of HTML attributes; attributes already set with the same name are replaced. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addClass"></span>[`addClass()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addClass) | Adds one or more CSS classes to the existing classes; duplicated classes are collapsed. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addCssStyle"></span>[`addCssStyle()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addCssStyle) | Adds CSS style properties to the `style` attribute. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-afterRun"></span>[`afterRun()`](/docs/api/yii/base/widget/index.md#method-afterRun) | This method is invoked right after a widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attribute"></span>[`attribute()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-attribute) | Sets an HTML attribute value. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-beforeRun"></span>[`beforeRun()`](/docs/api/yii/base/widget/index.md#method-beforeRun) | This method is invoked right before the widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-begin"></span>[`begin()`](/docs/api/yii/base/widget/index.md#method-begin) static | Begins a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-class"></span>[`class()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-class) | Replaces the existing CSS classes with the specified ones. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/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) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-end"></span>[`end()`](/docs/api/yii/base/widget/index.md#method-end) static | Ends a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getId"></span>[`getId()`](/docs/api/yii/base/widget/index.md#method-getId) | Returns the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/widget/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/widget/index.md#method-getViewPath) | Returns the directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`init()`](#method-init) | Initializes the widget and validates [`$size`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-size) and [`$theme`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-theme). | `LinkPager` |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/widget/index.md#method-render) | Renders a view. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/widget/index.md#method-renderFile) | Renders a view file. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`run()`](#method-run) |  | `LinkPager` |
| <span id="method-setId"></span>[`setId()`](/docs/api/yii/base/widget/index.md#method-setId) | Sets the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/widget/index.md#method-setView) | Sets the view object to be used by this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-widget"></span>[`widget()`](/docs/api/yii/base/widget/index.md#method-widget) static | Creates a widget instance and runs it. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`getPageRange()`](#method-getPageRange) protected | Returns the first and last internal page indexes to render. | `LinkPager` |
| <span id="method-pluginInitialization"></span>[`pluginInitialization()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-pluginInitialization) protected | Returns the JavaScript that initializes a plugin with its normalized constructor options. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="method-registerClientEvents"></span>[`registerClientEvents()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerClientEvents) protected | Registers the JavaScript event handlers listed in [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) at [`View::POS_END`](/docs/api/yii/web/view/index.md#const-POS_END). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`registerLinkTags()`](#method-registerLinkTags) protected | Registers the relational link tags returned by [`Pagination::getLinks()`](/docs/api/yii/data/pagination/index.md#method-getLinks). | `LinkPager` |
| <span id="method-registerPlugin"></span>[`registerPlugin()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerPlugin) protected | Registers the plugin asset, the plugin initialization when needed, and the [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`renderPageButton()`](#method-renderPageButton) protected | Renders a page item. | `LinkPager` |
| [`renderPageButtons()`](#method-renderPageButtons) protected | Renders the list of page items, or an empty `string` when a single page is hidden. | `LinkPager` |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_INIT"></span>[`EVENT_INIT`](/docs/api/yii/base/widget/index.md#event-EVENT_INIT) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the widget is initialized via [`init()`](/docs/api/yii/base/widget/index.md#method-init). Event name: `'init'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_BEFORE_RUN"></span>[`EVENT_BEFORE_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_BEFORE_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_AFTER_RUN"></span>[`EVENT_AFTER_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_AFTER_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Method details

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

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

Initializes the widget and validates [`$size`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-size) and [`$theme`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-theme).

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$size`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-size) or [`$theme`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-theme) is not a value of its enum.

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

```php
public function run(): string
```

**Returns**

`string`

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$pagination`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-pagination) is not set.

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

```php
protected function getPageRange(yii\data\Pagination $pagination): array{int, int}
```

Returns the first and last internal page indexes to render.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$pagination` | [`yii\data\Pagination`](/docs/api/yii/data/pagination/index.md) |  |

**Returns**

`array{int, int}`

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

```php
protected function registerLinkTags(yii\data\Pagination $pagination): void
```

Registers the relational link tags returned by [`Pagination::getLinks()`](/docs/api/yii/data/pagination/index.md#method-getLinks).

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$pagination` | [`yii\data\Pagination`](/docs/api/yii/data/pagination/index.md) |  |

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

```php
protected function renderPageButton(string $label, int $page, string $class, bool $disabled, bool $active, array<string, mixed> $linkOptions = []): string
```

Renders a page item.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$label` | `string` | Link content; it is not HTML-encoded. |
| `$page` | `int` | Zero-based page index. |
| `$class` | `string` | CSS class of the item, or an empty `string` for [`$pageCssClass`](/docs/extensions/bootstrap6/reference/linkpager/index.md#property-pageCssClass). |
| `$disabled` | `bool` | Whether the item is disabled. |
| `$active` | `bool` | Whether the item is the current page. |
| `$linkOptions` | `array<string, mixed>` | Extra HTML attributes of the link. |

**Returns**

`string`: Generated HTML.

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

```php
protected function renderPageButtons(yii\data\Pagination $pagination): string
```

Renders the list of page items, or an empty `string` when a single page is hidden.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$pagination` | [`yii\data\Pagination`](/docs/api/yii/data/pagination/index.md) |  |

**Returns**

`string`