function FilterInterface::tips

Same name and namespace in other branches
  1. 10 core/modules/filter/src/Plugin/FilterInterface.php \Drupal\filter\Plugin\FilterInterface::tips()
  2. 9 core/modules/filter/src/Plugin/FilterInterface.php \Drupal\filter\Plugin\FilterInterface::tips()
  3. 8.9.x core/modules/filter/src/Plugin/FilterInterface.php \Drupal\filter\Plugin\FilterInterface::tips()
  4. main 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.

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 265

Class

FilterInterface
Defines the interface for text processing filter plugins.

Namespace

Drupal\filter\Plugin

Code

public function tips();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.