function PagerManagerInterface::getUpdatedParameters
Same name in other branches
- 9 core/lib/Drupal/Core/Pager/PagerManagerInterface.php \Drupal\Core\Pager\PagerManagerInterface::getUpdatedParameters()
- 8.9.x core/lib/Drupal/Core/Pager/PagerManagerInterface.php \Drupal\Core\Pager\PagerManagerInterface::getUpdatedParameters()
- 11.x core/lib/Drupal/Core/Pager/PagerManagerInterface.php \Drupal\Core\Pager\PagerManagerInterface::getUpdatedParameters()
Gets the URL query parameter array of a pager link.
Adds to or adjusts the 'page' URL query parameter so that if you follow the link, you'll get page $index for pager $element on the page.
The 'page' URL query parameter is a comma-delimited string, where each value is the target content page for the corresponding pager $element. For instance, if we have 5 pagers on a single page, and we want to have a link to a page that should display the 6th content page for the 3rd pager, and the 1st content page for all the other pagers, then the URL query will look like this: ?page=0,0,5,0,0 (page numbering starts at zero).
Parameters
array $query: An associative array of URL query parameters to add to.
int $element: An integer to distinguish between multiple pagers on one page.
int $index: The index of the target page, for the given element, in the pager array.
Return value
array The altered $query parameter array.
File
-
core/
lib/ Drupal/ Core/ Pager/ PagerManagerInterface.php, line 164
Class
- PagerManagerInterface
- This is a service for pager information.
Namespace
Drupal\Core\PagerCode
public function getUpdatedParameters(array $query, $element, $index);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.