public function UrlEmbedFilter::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/UrlEmbedFilter.php, line 95

Contains \Drupal\url_embed\Plugin\Filter\UrlEmbedFilter.

Class

UrlEmbedFilter

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

Namespace

Drupal\url_embed\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return $this
      ->t('
        <p>You can embed URLs. Additional properties can be added to the URL tag like data-caption and data-align if supported. Examples:</p>
        <ul>
          <li><code>&lt;drupal-url data-embed-url="https://www.youtube.com/watch?v=xxXXxxXxxxX" data-url-provider="YouTube" /&gt;</code></li>
        </ul>');
  }
  else {
    return $this
      ->t('You can embed URLs.');
  }
}