class Pager

Same name in this branch
  1. 9 core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager
Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Element/Pager.php \Drupal\Core\Render\Element\Pager
  2. 8.9.x core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager
  3. 10 core/lib/Drupal/Core/Render/Element/Pager.php \Drupal\Core\Render\Element\Pager
  4. 10 core/lib/Drupal/Core/Pager/Pager.php \Drupal\Core\Pager\Pager
  5. 11.x core/lib/Drupal/Core/Render/Element/Pager.php \Drupal\Core\Render\Element\Pager
  6. 11.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).
  • #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

Expanded class hierarchy of Pager

37 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

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
View source
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

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. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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&#039;s class attribute. Overrides ElementInterface::setAttributes

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