You are here

Home » API reference » API Tokens 8 » ApiTokensFilter.php » ApiTokensFilter

public function ApiTokensFilter::tips in API Tokens 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Filter/ApiTokensFilter.php \Drupal\api_tokens\Plugin\Filter\ApiTokensFilter::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

src/Plugin/Filter/ApiTokensFilter.php, line 116

Class

ApiTokensFilter
Provides the API tokens filter.

Namespace

Drupal\api_tokens\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t('Replace API tokens.');
}