public function FilterAutoP::tips in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/filter/src/Plugin/Filter/FilterAutoP.php \Drupal\filter\Plugin\Filter\FilterAutoP::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

core/modules/filter/src/Plugin/Filter/FilterAutoP.php, line 29

Class

FilterAutoP

Provides a filter to convert line breaks to HTML.

Namespace

Drupal\filter\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return $this
      ->t('Lines and paragraphs are automatically recognized. The <br /> line break, <p> paragraph and </p> close paragraph tags are inserted automatically. If paragraphs are not recognized simply add a couple of blank lines.');
  }
  else {
    return $this
      ->t('Lines and paragraphs break automatically.');
  }
}