public function PagerParametersInterface::findPage in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Pager/PagerParametersInterface.php \Drupal\Core\Pager\PagerParametersInterface::findPage()
2. 9 core/lib/Drupal/Core/Pager/PagerParametersInterface.php \Drupal\Core\Pager\PagerParametersInterface::findPage()

Returns the current page being requested for display within a pager.

Parameters

int $pager_id: (optional) An integer to distinguish between multiple pagers on one page.

Return value

int The number of the current requested page, within the pager represented by $element. This is determined from the URL query parameter \Drupal::request()->query->get('page'), or 0 by default. Note that this number may differ from the actual page being displayed. For example, if a search for "example text" brings up three pages of results, but a user visits search/node/example+text?page=10, this function will return 10, even though the default pager implementation adjusts for this and still displays the third page of search results at that URL.

File

core/lib/Drupal/Core/Pager/PagerParametersInterface.php, line 37

Class

PagerParametersInterface

Interface describing pager information contained within the request.

Namespace

Drupal\Core\Pager

Code

public function findPage($pager_id = 0);