function tablesort_header

Formats 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().

File

includes/tablesort.inc, line 132

Code

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';
            $image = theme('tablesort_indicator', array(
                'style' => $ts['sort'],
            ));
        }
        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(
            'attributes' => array(
                'title' => $title,
            ),
            'query' => array_merge($ts['query'], array(
                'sort' => $ts['sort'],
                'order' => $cell['data'],
            )),
            'html' => TRUE,
        ));
        unset($cell['field'], $cell['sort']);
    }
    return $cell;
}