You are here

Home » API reference » Drupal 7 » filter.api.php

function callback_filter_tips in Drupal 7

Return help text for a filter.

Callback for hook_filter_info().

A filter's tips should be informative and to the point. Short tips are preferably one-liners.

Parameters

$filter: An object representing the filter.

$format: An object representing the text format the filter is contained in.

$long: Whether this callback should return a short tip to display in a form (FALSE), or whether a more elaborate filter tips should be returned for theme_filter_tips() (TRUE).

Return value

Translated text to display as a tip.

Related topics

Callbacks
Callback function signatures.

File

modules/filter/filter.api.php, line 264
Hooks provided by the Filter module.

Code

function callback_filter_tips($filter, $format, $long) {
  if ($long) {
    return t('Lines and paragraphs are automatically recognized. The <br /> line break, <p> paragraph and </p> close paragraph tags are inserted automatically. If paragraphs are not recognized simply add a couple blank lines.');
  }
  else {
    return t('Lines and paragraphs break automatically.');
  }
}