public function ViewsEmbedFilter::tips in Views entity embed 8

Same name and namespace in other branches

1. 2.0.x src/Plugin/Filter/ViewsEmbedFilter.php \Drupal\views_entity_embed\Plugin\Filter\ViewsEmbedFilter::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/ViewsEmbedFilter.php, line 100

Class

ViewsEmbedFilter

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

Namespace

Drupal\views_entity_embed\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return $this
      ->t('
        <p>You can embed Views. Additional properties can be added to the embed tag like data-caption and data-align if supported. Example:</p>
        <code><drupal-views data-view-display="default" data-view-name="content"></drupal-views></code>');
  }
  else {
    return $this
      ->t('You can embed Views entities.');
  }
}