function hook_filter_tips
6.x core.php | hook_filter_tips($delta, $format, $long = FALSE) |
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
3 functions implement hook_filter_tips()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- filter_filter_tips in drupal-6.x/
modules/ filter/ filter.module - Implementation of hook_filter_tips().
- php_filter_tips in drupal-6.x/
modules/ php/ php.module - Implementation of hook_filter_tips().
- theme_filter_tips in drupal-6.x/
modules/ filter/ filter.pages.inc - Format a set of filter tips.
1 invocation of hook_filter_tips()
- _filter_tips in drupal-6.x/
modules/ filter/ filter.module - Helper function for fetching filter tips.
File
- documentation-6.x/
developer/ hooks/ core.php, line 681 - These are the hooks that are invoked by the Drupal core.
Code
function hook_filter_tips($delta, $format, $long = FALSE) {
if ($long) {
return t('To post pieces of code, surround them with <code>...</code> tags. For PHP code, you can use <?php ... ?>, which will also colour it based on syntax.');
}
else {
return t('You may post code using <code>...</code> (generic) or <?php ... ?> (highlighted PHP) tags.');
}
}