Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Pager.php

class Pager

Same name in this branch
  1. 11.1.x 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:

  • #element: (optional, int) The pager ID, to distinguish between multiple pagers on the same page (defaults to 0).
  • #pagination_heading_level: (optional) A heading level for the pager.
  • #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',
];

Hierarchy

  • class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
    • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
      • class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
        • class \Drupal\Core\Render\Element\Pager extends \Drupal\Core\Render\Element\RenderElementBase

Expanded class hierarchy of Pager

25 string references to 'Pager'
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.
CommentDefaultFormatter::viewElements in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php
Builds a renderable array for a field value.
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.

... See full list

File

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

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>',
        ];
    }
    
    /**
     * #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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 5
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
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::setAttributes public static function Sets a form element&#039;s class attribute. Overrides ElementInterface::setAttributes 2

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal