class Pager in Drupal 9

Provides a render element for a pager.

The pager must be initialized with a call to \Drupal\Core\Pager\PagerManagerInterface::createPager() 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, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\Pager

7 string references to 'Pager'

AreaDisplayLinkTest::assertWarningMessages in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php

Assert the warning messages are shown after changing the page_1 display.

DisplayLink::validate in core/modules/views/src/Plugin/views/area/DisplayLink.php

Validate that the plugin is correct and can be saved.

DisplayPluginBase::buildOptionsForm in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php

Provide a form to edit options for this plugin.

DisplayPluginBase::optionsSummary in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php

Provides the default summary for options in the views UI.

PagersCacheContext::getLabel in core/lib/Drupal/Core/Cache/Context/PagersCacheContext.php

Returns the label of the cache context.

... See full list

15 #type uses of Pager

AggregatorController::buildPageList in core/modules/aggregator/src/Controller/AggregatorController.php

Builds a listing of aggregator feed items.

CommentAdminOverview::buildForm in core/modules/comment/src/Form/CommentAdminOverview.php

Form constructor for the comment overview administration form.

DbLogController::overview in core/modules/dblog/src/Controller/DbLogController.php

Displays a listing of database log messages.

DbLogController::topLogMessages in core/modules/dblog/src/Controller/DbLogController.php

Shows the most frequent log messages of a given event type.

EntityListBuilder::render in core/lib/Drupal/Core/Entity/EntityListBuilder.php

Builds the entity listing as renderable array for table.html.twig.

... See full list

File

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

Namespace

Drupal\Core\Render\Element

class Pager extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return [
      '#pre_render' => [
        static::class . '::preRenderPager',
      ],
      '#theme' => 'pager',
      // The pager ID, to distinguish between multiple pagers on the same page.
      '#element' => 0,
      // An associative array of query string parameters to append to the pager
      // links.
      '#parameters' => [],
      // The number of pages in the list.
      '#quantity' => 9,
      // An array of labels for the controls in the pager.
      '#tags' => [],
      // The name of the route to be used to build pager links. By default no
      // path is provided, which will make links relative to the current URL.
      // This makes the page more effectively cacheable.
      '#route_name' => '<none>',
    ];
  }

  /**
   * #pre_render callback to associate the appropriate cache context.
   *
   *
   * @param array $pager
   *   A renderable array of #type => pager.
   *
   * @return array
   */
  public static function preRenderPager(array $pager) {

    // Note: the default pager theme process function
    // template_preprocess_pager() also calls
    // \Drupal\Core\Pager\PagerManagerInterface::getUpdatedParameters(), which
    // maintains the existing query string. Therefore
    // template_preprocess_pager() adds the 'url.query_args' cache context,
    // which causes the more specific cache context below to be optimized away.
    // In other themes, however, that may not be the case.
    $pager['#cache']['contexts'][] = 'url.query_args.pagers:' . $pager['#element'];
    return $pager;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
Pager::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Pager::preRenderPager	public static	function	#pre_render callback to associate the appropriate cache context.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.