public function FilterCaption::tips in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/filter/src/Plugin/Filter/FilterCaption.php \Drupal\filter\Plugin\Filter\FilterCaption::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
- core/
modules/ filter/ src/ Plugin/ Filter/ FilterCaption.php, line 101 - Contains \Drupal\filter\Plugin\Filter\FilterCaption.
Class
- FilterCaption
- Provides a filter to caption elements.
Namespace
Drupal\filter\Plugin\FilterCode
public function tips($long = FALSE) {
if ($long) {
return $this
->t('
<p>You can caption images, videos, blockquotes, and so on. Examples:</p>
<ul>
<li><code><img src="" data-caption="This is a caption" /></code></li>
<li><code><video src="" data-caption="The Drupal Dance" /></code></li>
<li><code><blockquote data-caption="Dries Buytaert">Drupal is awesome!</blockquote></code></li>
<li><code><code data-caption="Hello world in JavaScript.">alert("Hello world!");</code></code></li>
</ul>');
}
else {
return $this
->t('You can caption images (<code>data-caption="Text"</code>), but also videos, blockquotes, and so on.');
}
}