public function ShortcodeInterface::tips in Shortcode 8

Same name and namespace in other branches

1. 2.0.x src/Plugin/ShortcodeInterface.php \Drupal\shortcode\Plugin\ShortcodeInterface::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.

1 method overrides ShortcodeInterface::tips()

ShortcodeBase::tips in src/Plugin/ShortcodeBase.php

Generates a filter's tip.

File

src/Plugin/ShortcodeInterface.php, line 84

Class

ShortcodeInterface

Defines the interface for text processing shortcode plugins.

Namespace

Drupal\shortcode\Plugin

Code

public function tips($long = FALSE);