public function ConvertLegacyMediaTagsToMarkup::tips in Convert Media Tags to Markup 8

Same name and namespace in other branches

1. 2.x src/Plugin/Filter/ConvertLegacyMediaTagsToMarkup.php \Drupal\convert_media_tags_to_markup\Plugin\Filter\ConvertLegacyMediaTagsToMarkup::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

src/Plugin/Filter/ConvertLegacyMediaTagsToMarkup.php, line 42

Class

ConvertLegacyMediaTagsToMarkup

Provides a filter for converting legacy media tags to markup.

Namespace

Drupal\convert_media_tags_to_markup\Plugin\Filter

Code

public function tips($long = FALSE) {
  return '<p>Coverts legacy imported media tags to images.</p>';
}