DrupalAPI.de

1. drupal
   1. drupal6 core.php
   2. drupal7

Provide tips for using filters.

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

Übergabeparameter

$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.

Rückgabewert

The text of the filter tip.

Verwandte Themen

Hooks

Allow modules to interact with the Drupal core.

Code

modules/filter/filter.api.php, line 152

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