Pager

Provides a render element for a pager.

The pager must be initialized with a call to pager_default_initialize() in order to render properly. When used with database queries, this is performed for you when you extend a select query with \Drupal\Core\Database\Query\PagerSelectExtender.

Properties:

• #element: (optional, int) The pager ID, to distinguish between multiple pagers on the same page (defaults to 0).
• #parameters: (optional) An associative array of query string parameters to append to the pager.
• #quantity: The maximum number of numbered page links to create (defaults to 9).
• #tags: (optional) An array of labels for the controls in the pages.
• #route_name: (optional) The name of the route to be used to build pager links. Defaults to '<none>', which will make links relative to the current URL. This makes the page more effectively cacheable.

$build['pager'] = [
  '#type' => 'pager',
];

Plugin annotation

@RenderElement("pager")

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\Pager

File

core/lib/Drupal/Core/Render/Element/Pager.php, line 33

Namespace

Drupal\Core\Render\Element

Members