public function ShortcodeBase::tips in Shortcode 8

Same name and namespace in other branches

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

11 methods override ShortcodeBase::tips()

BlockShortcode::tips in shortcode_basic_tags/src/Plugin/Shortcode/BlockShortcode.php

Generates a filter's tip.

BootstrapColumnShortcode::tips in shortcode_example/src/Plugin/Shortcode/BootstrapColumnShortcode.php

Generates a filter's tip.

ButtonShortcode::tips in shortcode_basic_tags/src/Plugin/Shortcode/ButtonShortcode.php

Generates a filter's tip.

ClearShortcode::tips in shortcode_basic_tags/src/Plugin/Shortcode/ClearShortcode.php

Generates a filter's tip.

DropcapShortcode::tips in shortcode_basic_tags/src/Plugin/Shortcode/DropcapShortcode.php

Generates a filter's tip.

... See full list

File

src/Plugin/ShortcodeBase.php, line 150

Class

ShortcodeBase

Provides a base class for Shortcode plugins.

Namespace

Drupal\shortcode\Plugin

Code

public function tips($long = FALSE) {
  return '';
}