hook_filter_tips

Provide tips for using filters.

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

Parameters

$delta: Which of this module's filters to use. Modules which only implement one filter can ignore this parameter.

$format: Which format we are providing tips for.

$long: If set to true, long tips are requested, otherwise short tips are needed.

Return value

The text of the filter tip.

Related topics

Hooks

Allow modules to interact with the Drupal core.

File

developer/hooks/core.php, line 673

These are the hooks that are invoked by the Drupal core.

Code

<?php
function hook_filter_tips($delta, $format, $long = FALSE) {
  if ($long) {
    return t('To post pieces of code, surround them with &lt;code&gt;...&lt;/code&gt; tags. For PHP code, you can use &lt;?php ... ?&gt;, which will also colour it based on syntax.');
  }
  else {
    return t('You may post code using &lt;code&gt;...&lt;/code&gt; (generic) or &lt;?php ... ?&gt; (highlighted PHP) tags.');
  }
}
?>