public function FilterInlineSms::tips in SMS Framework 8

Same name and namespace in other branches

1. 2.x modules/sms_sendtophone/src/Plugin/Filter/FilterInlineSms.php \Drupal\sms_sendtophone\Plugin\Filter\FilterInlineSms::tips()
2. 2.1.x modules/sms_sendtophone/src/Plugin/Filter/FilterInlineSms.php \Drupal\sms_sendtophone\Plugin\Filter\FilterInlineSms::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

modules/sms_sendtophone/src/Plugin/Filter/FilterInlineSms.php, line 49

Class

FilterInlineSms

Provides a filter to align elements.

Namespace

Drupal\sms_sendtophone\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t('Text between [sms][/sms] tags will be highlighted and appended with a "send to phone" button.');
}