public function FilterOEmbed::tips in oEmbed 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/FilterOEmbed.php, line 137

Contains \Drupal\filter\Plugin\Filter\FilterOEmbed.

Class

FilterOEmbed

Provides a fallback placeholder filter to use for missing filters.

Namespace

Drupal\oembed\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return t('Embed content by wrapping a supported URL in [embed] … [/embed]. Set options such as width and height with attributes [embed width="123" height="456"] … [/embed]. Unsupported options will be ignored.');
  }
  else {
    return t('Embed content by wrapping a supported URL in [embed] … [/embed].');
  }
}