function FilterInterface::tips
Same name in other branches
- 9 core/modules/filter/src/Plugin/FilterInterface.php \Drupal\filter\Plugin\FilterInterface::tips()
- 10 core/modules/filter/src/Plugin/FilterInterface.php \Drupal\filter\Plugin\FilterInterface::tips()
- 11.x core/modules/filter/src/Plugin/FilterInterface.php \Drupal\filter\Plugin\FilterInterface::tips()
Generates a filter's tip.
A filter's tips should be informative and to the point. Short tips are preferably one-liners.
@todo Split into getSummaryItem() and buildGuidelines().
Parameters
bool $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 template_preprocess_filter_tips() (TRUE).
Return value
string|null Translated text to display as a tip, or NULL if this filter has no tip.
1 method overrides FilterInterface::tips()
- FilterBase::tips in core/
modules/ filter/ src/ Plugin/ FilterBase.php - Generates a filter's tip.
File
-
core/
modules/ filter/ src/ Plugin/ FilterInterface.php, line 286
Class
- FilterInterface
- Defines the interface for text processing filter plugins.
Namespace
Drupal\filter\PluginCode
public function tips($long = FALSE);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.