public function FilterCKEditorMediaEmbed::tips in CKEditor Media Embed Plugin 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/FilterCKEditorMediaEmbed.php, line 75

Class

FilterCKEditorMediaEmbed

Provides a filter to convert URLs into links.

Namespace

Drupal\ckeditor_media_embed\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t('Oembed <code>&lt;oembed&gt;URL&lt;/oembed&gt;</code> tags are converted to the media embed HTML.');
}