public function 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 theme_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

File

drupal/core/modules/filter/lib/Drupal/filter/Plugin/FilterBase.php, line 153

Contains \Drupal\filter\Plugin\Filter\FilterBase.

Class

FilterBase

Provides a base class for Filter plugins.

Namespace

Code

public function tips($long = FALSE) {
}