theme_pager

Versions
5: theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array())
6: theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array(), $quantity = 9)
7: theme_pager($variables)

Format a query pager.

Menu callbacks that display paged query results should call theme('pager') to retrieve a pager control so that users can view other results.

Parameters

$tags An array of labels for the controls in the pager.

$limit The number of query results to display per page.

$element An optional integer to distinguish between multiple pagers on one page.

$parameters An associative array of query string parameters to append to the pager links.

Return value

An HTML string that generates the query pager.

Code

drupal/includes/pager.inc, line 111

<?php
function theme_pager($tags = array(), $limit = 10, $element = 0, $parameters = array()) {
  global $pager_total;
  $output = '';

  if ($pager_total[$element] > 1) {
    $output .= '<div class="pager">';
    $output .= theme('pager_first', ($tags[0] ? $tags[0] : t('« first')), $limit, $element, $parameters);
    $output .= theme('pager_previous', ($tags[1] ? $tags[1] : t('‹ previous')), $limit, $element, 1, $parameters);
    $output .= theme('pager_list', $limit, $element, ($tags[2] ? $tags[2] : 9 ), '', $parameters);
    $output .= theme('pager_next', ($tags[3] ? $tags[3] : t('next ›')), $limit, $element, 1, $parameters);
    $output .= theme('pager_last', ($tags[4] ? $tags[4] : t('last »')), $limit, $element, $parameters);
    $output .= '</div>';

    return $output;
  }
}
?>