public function CodeFilter::tips in Code Filter 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/CodeFilter.php, line 43

Class

CodeFilter

Text filter for highlighting PHP source code.

Namespace

Drupal\codefilter\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return $this
      ->t('To post pieces of code, surround them with <code>...</code> tags. For PHP code, you can use <?php ... ?>, which will also colour it based on syntax.');
  }
  else {
    return $this
      ->t('You may post code using <code>...</code> (generic) or <?php ... ?> (highlighted PHP) tags.');
  }
}