class 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

Name	Modifiers	Type	Description
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
DependencySerializationTrait::__wakeup	public	function
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.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.
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.
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.
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.
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.