tablesort_header

• Drupal 4.6
• Drupal 4.7
• Drupal 5
• Drupal 6
• Drupal 7

• View documentation
• List references

Definition

tablesort_header($cell, $header, $ts)
includes/tablesort.inc, line 74

Description

Format a column header.

If the cell in question is the column header for the current sort criterion, it gets special formatting. All possible sort criteria become links.

Parameters

$cell The cell to format.

$header An array of column headers in the format described in theme_table().

$ts The current table sort context as returned from tablesort_init().

Return value

A properly formatted cell, ready for _theme_table_cell().

Code

<?php
function tablesort_header($cell, $header, $ts) {
  // Special formatting for the currently sorted column header.
  if (is_array($cell) && isset($cell['field'])) {
    $title = t('sort by %s', array('%s' => $cell['data']));
    if ($cell['data'] == $ts['name']) {
      $ts['sort'] = (($ts['sort'] == 'asc') ? 'desc' : 'asc');
      $cell['class'] = 'active';
      $title = ($ts['sort'] == 'asc' ? t('sort ascending') : t('sort descending'));
      $image = '&nbsp;'. theme('image', 'misc/arrow-'. $ts['sort'] .'.png', t('sort icon'), $title);
    }
    else {
      // If the user clicks a different header, we want to sort ascending initially.
      $ts['sort'] = 'asc';
      $image = '';
    }
    $cell['data'] = l($cell['data'] . $image, $_GET['q'], array('title' => $title), 'sort='. $ts['sort'] .'&order='. urlencode($cell['data']). $ts['query_string'], NULL, FALSE, TRUE);

    unset($cell['field'], $cell['sort']);
  }
  return $cell;
}
?>