public function ConvertUrlToEmbedFilter::tips in URL Embed 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/ConvertUrlToEmbedFilter.php, line 182

Class

ConvertUrlToEmbedFilter

Provides a filter to display embedded entities based on data attributes.

Namespace

Drupal\url_embed\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return $this
      ->t('<p>You can convert plain URLs to &lt;drupal-url&gt; HTML elements. Those elements are later converted to embeds using "Display embedded URLs" text filter.</p>');
  }
  else {
    return $this
      ->t('You can convert plain URLs to embed elements.');
  }
}