function theme_filter_tips

Returns HTML for a set of filter tips.

Parameters

$variables: An associative array containing:

  • tips: An array containing descriptions and a CSS ID in the form of 'module-name/filter-id' (only used when $long is TRUE) for each filter in one or more text formats. Example: 
array(
  'Full HTML' => array(
    0 => array(
      'tip' => 'Web page addresses and e-mail addresses turn into links automatically.',
      'id' => 'filter/2',
    ),
  ),
);
  • long: (optional) Whether the passed-in filter tips contain extended explanations, i.e. intended to be output on the path 'filter/tips' (TRUE), or are in a short format, i.e. suitable to be displayed below a form element. Defaults to FALSE.

See also

_filter_tips()

Related topics

Default theme implementations
Functions and templates for the user interface to be implemented by themes.
2 theme calls to theme_filter_tips()
filter_tips_long in drupal/modules/filter/filter.pages.inc
Page callback: Displays a page with long filter tips.
theme_filter_guidelines in drupal/modules/filter/filter.module
Returns HTML for guidelines for a text format.

File

drupal/modules/filter/filter.pages.inc, line 53
User page callbacks for the Filter module.

Code

function theme_filter_tips($variables) {
  $tips = $variables['tips'];
  $long = $variables['long'];
  $output = '';
  $multiple = count($tips) > 1;
  if ($multiple) {
    $output = '<h2>' . t('Text Formats') . '</h2>';
  }
  if (count($tips)) {
    if ($multiple) {
      $output .= '<div class="compose-tips">';
    }
    foreach ($tips as $name => $tiplist) {
      if ($multiple) {
        $output .= '<div class="filter-type filter-' . drupal_html_class($name) . '">';
        $output .= '<h3>' . check_plain($name) . '</h3>';
      }
      if (count($tiplist) > 0) {
        $output .= '<ul class="tips">';
        foreach ($tiplist as $tip) {
          $output .= '<li' . ($long ? ' id="filter-' . str_replace("/", "-", $tip['id']) . '">' : '>') . $tip['tip'] . '</li>';
        }
        $output .= '</ul>';
      }
      if ($multiple) {
        $output .= '</div>';
      }
    }
    if ($multiple) {
      $output .= '</div>';
    }
  }
  return $output;
}