public function CodeMirrorEditor::tips in The CodeMirror Editor 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/CodeMirrorEditor.php, line 66

Class

CodeMirrorEditor

Provides a 'CodeMirror' filter.

Namespace

Drupal\codemirror_editor\Plugin\Filter

Code

public function tips($long = FALSE) {
  $tip_arguments = [
    '@expression' => '<code data-mode="mode">...</code>',
  ];
  return $this
    ->t('Syntax highlight code surrounded by the <code>@expression</code> tags.', $tip_arguments);
}