class Pager

Same name in this branch
  1. 11.x core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Pager.php \Drupal\Core\Render\Element\Pager
  2. 9 core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager
  3. 8.9.x core/lib/Drupal/Core/Render/Element/Pager.php \Drupal\Core\Render\Element\Pager
  4. 8.9.x core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager
  5. 10 core/lib/Drupal/Core/Render/Element/Pager.php \Drupal\Core\Render\Element\Pager
  6. 10 core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager

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:

@property $element (optional, int) The pager ID, to distinguish between multiple pagers on the same page (defaults to 0). @property $pagination_heading_level (optional) A heading level for the pager. @property $parameters (optional) An associative array of query string parameters to append to the pager. @property $quantity The maximum number of numbered page links to create (defaults to 9). @property $tags (optional) An array of labels for the controls in the pages. @property $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',
];

Attributes

#[RenderElement('pager')]

Hierarchy

Expanded class hierarchy of Pager

41 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.
AreaDisplayLinkTest::setUp in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
AreaDisplayLinkTest::testAreaDisplayLink in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
Tests the views area display_link handler.
Attachment::attachTo in core/modules/views/src/Plugin/views/display/Attachment.php
Allows displays to attach to other views.
Attachment::optionsSummary in core/modules/views/src/Plugin/views/display/Attachment.php
Provide the summary for attachment options in the views UI.

... See full list

17 #type uses of Pager
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.
MigrateMessageController::details in core/modules/migrate/src/Controller/MigrateMessageController.php
Displays a listing of migration messages for the given migration ID.

... See full list

File

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

Namespace

Drupal\Core\Render\Element
View source
class Pager extends RenderElementBase {
  
  /**
   * {@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,
      // The heading level to use for the pager.
'#pagination_heading_level' => 'h4',
      // 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>',
    ];
  }
  
  /**
   * Render API callback: Associates the appropriate cache context.
   *
   * This function is assigned as a #pre_render callback.
   *
   * @param array $pager
   *   A renderable array of #type => pager.
   *
   * @return array
   *   The render array with cache contexts added.
   */
  public static function preRenderPager(array $pager) {
    // Note: the default pager theme preprocess function
    // \Drupal\Core\Pager\PagerPreprocess::preprocessPager() also calls
    // \Drupal\Core\Pager\PagerManagerInterface::getUpdatedParameters(), which
    // maintains the existing query string. Therefore
    // \Drupal\Core\Pager\PagerPreprocess::preprocessPager() 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

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
MessengerTrait::$messenger protected property The messenger. 25
MessengerTrait::messenger public function Gets the messenger. 25
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 Render API callback: Associates 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 Deprecated public function Determines if the plugin is configurable.
RenderElementBase::$renderParent protected property The parent element.
RenderElementBase::$renderParentName protected property The parent key.
RenderElementBase::$storage protected property The storage.
RenderElementBase::addChild public function Adds a child render element. Overrides ElementInterface::addChild
RenderElementBase::changeType public function Change the type of the element. Overrides ElementInterface::changeType
RenderElementBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
RenderElementBase::createChild public function Creates a render object and attaches it to the current render object. Overrides ElementInterface::createChild
RenderElementBase::elementInfoManager protected function Returns the element info manager.
RenderElementBase::getChild public function Gets a child. Overrides ElementInterface::getChild
RenderElementBase::getChildren public function Returns child elements. Overrides ElementInterface::getChildren
RenderElementBase::initializeInternalStorage public function Initialize storage. Overrides ElementInterface::initializeInternalStorage
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::removeChild public function Removes a child. Overrides ElementInterface::removeChild
RenderElementBase::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes 2
RenderElementBase::setType protected function Set type on initialize. 1
RenderElementBase::toRenderable public function Returns a render array. Overrides ElementInterface::toRenderable
RenderElementBase::__construct public function Constructs a new render element object. Overrides PluginBase::__construct 6
RenderElementBase::__get public function Magic method: gets a property value.
RenderElementBase::__isset public function Magic method: checks if a property value is set.
RenderElementBase::__set public function Magic method: Sets a property value.
RenderElementBase::__sleep public function Overrides DependencySerializationTrait::__sleep
RenderElementBase::__unset public function Magic method: unsets a property value.
RenderElementBase::__wakeup public function Overrides DependencySerializationTrait::__wakeup
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.