public function PagerParameters::findPage in Drupal 9
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Pager/PagerParameters.php \Drupal\Core\Pager\PagerParameters::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.
Overrides PagerParametersInterface::findPage
File
- core/
lib/ Drupal/ Core/ Pager/ PagerParameters.php, line 48
Class
- PagerParameters
- Provides pager information contained within the current request.
Namespace
Drupal\Core\PagerCode
public function findPage($pager_id = 0) {
$pages = $this
->getPagerQuery();
return (int) ($pages[$pager_id] ?? 0);
}