Home › API reference › filter.pages.inc

theme_filter_tips

  1. drupal
    1. 4.7 filter.module
    2. 5 filter.module
    3. 6
    4. 7
Versions
4.7 theme_filter_tips($tips, $long = false, $extra = '')
5 – 6 theme_filter_tips($tips, $long = FALSE, $extra = '')
7 theme_filter_tips($variables)

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:

<?php
      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.

Code

drupal/modules/filter/filter.pages.inc, line 51

<?php
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>' . $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;
}
?>