public function Markdown::tips in Markdown 3.0.x

Same name and namespace in other branches

1. 8 src/Plugin/Filter/Markdown.php \Drupal\markdown\Plugin\Filter\Markdown::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/Markdown.php, line 238

Class

Markdown

Provides a filter for Markdown.

Namespace

Drupal\markdown\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->getParser()
    ->tips($long);
}