function FormatterBase::isApplicable

Same name and namespace in other branches

8.9.x core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::isApplicable()
10 core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::isApplicable()
11.x core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::isApplicable()

Returns if the formatter can be used for the provided field.

Parameters

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The field definition that should be checked.

Return value

bool TRUE if the formatter can be used, FALSE otherwise.

Overrides FormatterInterface::isApplicable

4 calls to FormatterBase::isApplicable()

CommentPermalinkFormatter::isApplicable in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentPermalinkFormatter.php: Returns if the formatter can be used for the provided field.
FileMediaFormatterBase::isApplicable in core/modules/file/src/Plugin/Field/FieldFormatter/FileMediaFormatterBase.php: Returns if the formatter can be used for the provided field.
FileSize::isApplicable in core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php: Returns if the formatter can be used for the provided field.
OEmbedFormatter::isApplicable in core/modules/media/src/Plugin/Field/FieldFormatter/OEmbedFormatter.php: Returns if the formatter can be used for the provided field.

14 methods override FormatterBase::isApplicable()

AggregatorTitleFormatter::isApplicable in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php: Returns if the formatter can be used for the provided field.
AuthorFormatter::isApplicable in core/modules/user/src/Plugin/Field/FieldFormatter/AuthorFormatter.php: Returns if the formatter can be used for the provided field.
AuthorNameFormatter::isApplicable in core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php: Returns if the formatter can be used for the provided field.
BaseFieldFileFormatterBase::isApplicable in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php: Returns if the formatter can be used for the provided field.
CommentPermalinkFormatter::isApplicable in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentPermalinkFormatter.php: Returns if the formatter can be used for the provided field.

... See full list

File

core/lib/Drupal/Core/Field/FormatterBase.php, line 166

Class

FormatterBase: Base class for 'Field formatter' plugin implementations.

Namespace

Drupal\Core\Field

Code

public static function isApplicable(FieldDefinitionInterface $field_definition) {
    // By default, formatters are available for all fields.
    return TRUE;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

Breadcrumb