public function FilterBase::tips in Drupal 8

Same name and namespace in other branches

9 core/modules/filter/src/Plugin/FilterBase.php \Drupal\filter\Plugin\FilterBase::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.

Overrides FilterInterface::tips

9 methods override FilterBase::tips()

FilterAlign::tips in core/modules/filter/src/Plugin/Filter/FilterAlign.php: Generates a filter's tip.
FilterAutoP::tips in core/modules/filter/src/Plugin/Filter/FilterAutoP.php: Generates a filter's tip.
FilterCaption::tips in core/modules/filter/src/Plugin/Filter/FilterCaption.php: Generates a filter's tip.
FilterHtml::tips in core/modules/filter/src/Plugin/Filter/FilterHtml.php: Generates a filter's tip.
FilterHtmlEscape::tips in core/modules/filter/src/Plugin/Filter/FilterHtmlEscape.php: Generates a filter's tip.

... See full list

File

core/modules/filter/src/Plugin/FilterBase.php, line 153

Class

FilterBase: Provides a base class for Filter plugins.

Namespace

Drupal\filter\Plugin

Code

public function tips($long = FALSE) {
}

You are here