public function FilterNull::tips in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/filter/src/Plugin/Filter/FilterNull.php \Drupal\filter\Plugin\Filter\FilterNull::tips()
2. 10 core/modules/filter/src/Plugin/Filter/FilterNull.php \Drupal\filter\Plugin\Filter\FilterNull::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 FilterBase::tips

File

core/modules/filter/src/Plugin/Filter/FilterNull.php, line 61

Class

FilterNull

Provides a fallback placeholder filter to use for missing filters.

Namespace

Drupal\filter\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t('Missing filter. All text is removed');
}