Home › API reference › filter.module

_filter_tips

  1. drupal
    1. 4.7
    2. 5 filter.module
    3. 6 filter.module
    4. 7 filter.module
Versions
4.7 _filter_tips($format, $long = false)
5 – 6 _filter_tips($format, $long = FALSE)
7 _filter_tips($format_id, $long = FALSE)

Helper function for fetching filter tips.

▸ 3 functions call _filter_tips()

▾ 3 functions call _filter_tips()

filter_admin_format_form in modules/filter.module
Generate a filter format form.
filter_form in modules/filter.module
Generate a selector for choosing a format in a form.
filter_tips_long in modules/filter.module
Menu callback; show a page with long filter tips.

Code

modules/filter.module, line 883

<?php
function _filter_tips($format, $long = false) {
  if ($format == -1) {
    $formats = filter_formats();
  }
  else {
    $formats = array(db_fetch_object(db_query("SELECT * FROM {filter_formats} WHERE format = %d", $format)));
  }

  $tips = array();

  foreach ($formats as $format) {
    $filters = filter_list_format($format->format);

    $tips[$format->name] = array();
    foreach ($filters as $id => $filter) {
      if ($tip = module_invoke($filter->module, 'filter_tips', $filter->delta, $format->format, $long)) {
        $tips[$format->name][] = array(
          'tip' => $tip,
          'id' => $id,
        );
      }
    }
  }

  return $tips;
}
?>