LinkPager

API reference › yii › widgets › LinkPager

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

LinkPager displays a list of hyperlinks that lead to different pages of target.

LinkPager works with a Pagination object which specifies the total number of pages and the current page number.

Note that LinkPager only generates the necessary HTML markups. In order for it to look like a real pager, you should provide CSS styles for it.

LinkPager is CSS-agnostic by default and does not apply any framework-specific classes; supply the classes your CSS framework expects via $options and $linkContainerOptions. For example, to opt back into Bootstrap pagination styles:

echo LinkPager::widget(
    [
        'pagination' => $pagination,
        'options' => ['class' => 'pagination'],
    ],
);

For more details and usage information on LinkPager, see the guide article on pagination.

Properties

Property	Type	Description	Defined by
`$activePageCssClass`	`string`	The CSS class for the active (currently selected) page button. Default: `'active'`.	`LinkPager`
`$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`
`$disableCurrentPageButton`	`bool`	Whether to render current page button as disabled. Default: `false`. Available since 2.0.12.	`LinkPager`
`$disabledListItemSubTagOptions`	`array`	The options for the disabled tag to be generated inside the disabled list element. Default: `[]`. Available since 2.0.11.	`LinkPager`
`$disabledPageCssClass`	`string`	The CSS class for the disabled page buttons. Default: `'disabled'`.	`LinkPager`
`$firstPageCssClass`	`string`	The CSS class for the “first” page button. Default: `'first'`.	`LinkPager`
`$firstPageLabel`	`string\|bool`	The text label for the “first” page button. Default: `false`.	`LinkPager`
`$hideOnSinglePage`	`bool`	Hide widget when only one page exist. Default: `true`.	`LinkPager`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$lastPageCssClass`	`string`	The CSS class for the “last” page button. Default: `'last'`.	`LinkPager`
`$lastPageLabel`	`string\|bool`	The text label for the “last” page button. Default: `false`.	`LinkPager`
`$linkContainerOptions`	`array`	HTML attributes which will be applied to all link containers Default: `[]`. Available since 2.0.13.	`LinkPager`
`$linkOptions`	`array`	HTML attributes for the link in a pager container tag. Default: `[]`.	`LinkPager`
`$maxButtonCount`	`int`	Maximum number of page buttons that can be displayed. Default: `10`.	`LinkPager`
`$nextPageCssClass`	`string`	The CSS class for the “next” page button. Default: `'next'`.	`LinkPager`
`$nextPageLabel`	`string\|bool`	The label for the “next” page button. Default: `'»'`.	`LinkPager`
`$options`	`array`	HTML attributes for the pager container tag. Default: `[]`.	`LinkPager`
`$pageCssClass`	`string`	The CSS class for the each page button. Default: `null`. Available since 2.0.7.	`LinkPager`
`$pagination`	`yii\data\Pagination`	The pagination object that this pager is associated with. Default: `null`.	`LinkPager`
`$prevPageCssClass`	`string`	The CSS class for the “previous” page button. Default: `'prev'`.	`LinkPager`
`$prevPageLabel`	`string\|bool`	The text label for the “previous” page button. Default: `'«'`.	`LinkPager`
`$registerLinkTags`	`bool`	Whether to register link tags in the HTML header for prev, next, first and last page. Default: `false`.	`LinkPager`
`$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 pager.	`LinkPager`
`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.	`LinkPager`
`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`
`getPageRange()` protected		`LinkPager`
`registerLinkTags()` protected	Registers relational link tags in the html header for prev, next, first and last page.	`LinkPager`
`renderPageButton()` protected	Renders a page button.	`LinkPager`
`renderPageButtons()` protected	Renders the page buttons.	`LinkPager`

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

$disabledListItemSubTagOptions

public array $disabledListItemSubTagOptions = []

The options for the disabled tag to be generated inside the disabled list element.

In order to customize the html tag, please use the tag key.

$disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];

Since

2.0.11

$firstPageLabel

public string|bool $firstPageLabel = false

The text label for the “first” page button.

Note that this will NOT be HTML-encoded. If it’s specified as true, page number will be used as label. Default is false that means the “first” page button will not be displayed.

$lastPageLabel

public string|bool $lastPageLabel = false

The text label for the “last” page button.

Note that this will NOT be HTML-encoded. If it’s specified as true, page number will be used as label. Default is false that means the “last” page button will not be displayed.

$maxButtonCount

public int $maxButtonCount = 10

Maximum number of page buttons that can be displayed.

Defaults to 10.

$nextPageLabel

public string|bool $nextPageLabel = '&raquo;'

The label for the “next” page button.

Note that this will NOT be HTML-encoded. If this property is false, the “next” page button will not be displayed.

$pagination

public yii\data\Pagination $pagination = null

The pagination object that this pager is associated with.

You must set this property in order to make LinkPager work.

$prevPageLabel

public string|bool $prevPageLabel = '&laquo;'

The text label for the “previous” page button.

Note that this will NOT be HTML-encoded. If this property is false, the “previous” page button will not be displayed.

$registerLinkTags

public bool $registerLinkTags = false

Whether to register link tags in the HTML header for prev, next, first and last page.

Defaults to false to avoid conflicts when multiple pagers are used on one page.

Method details

init()

public function init(): mixed

Initializes the pager.

Returns

mixed

run()

public function run(): mixed

Executes the widget.

This overrides the parent implementation by displaying the generated page buttons.

Returns

mixed

getPageRange()

protected function getPageRange(): array

Returns

array: The begin and end pages that need to be displayed.

registerLinkTags()

protected function registerLinkTags(): mixed

Registers relational link tags in the html header for prev, next, first and last page.

These links are generated using Pagination::getLinks().

Returns

mixed

See also

https://www.w3.org/TR/html401/struct/links.html#h-12.1.2

renderPageButton()

protected function renderPageButton(string $label, int $page, string $class, bool $disabled, bool $active): string

Renders a page button.

You may override this method to customize the generation of page buttons.

Parameters

Parameter	Type	Description
`$label`	`string`	The text label for the button
`$page`	`int`	The page number
`$class`	`string`	The CSS class for the page button.
`$disabled`	`bool`	Whether this page button is disabled
`$active`	`bool`	Whether this page button is active

Returns

string: The rendering result

renderPageButtons()

protected function renderPageButtons(): string

Renders the page buttons.

Returns

string: The rendering result