public function MappyFilter::tips in Mappy 8

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

src/Plugin/Filter/MappyFilter.php, line 68

Class

MappyFilter

Provides a filter to display any HTML as plain text.

Namespace

Drupal\mappy\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t("Every [mappy:service address:'address'] token will be replaced with map.");
}