interface FormatterInterface

Interface definition for field formatter plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface
  • interface \Drupal\Core\Field\PluginSettingsInterface
    • interface \Drupal\Core\Field\FormatterInterface

Related topics

Field Formatter API

Define Field API formatter types.

File

core/lib/Drupal/Core/Field/FormatterInterface.php, line 12

Namespace

Drupal\Core\Field

Members

Name	Modifiers	Type	Description
FormatterInterface::isApplicable	public static	function	Returns if the formatter can be used for the provided field.
FormatterInterface::prepareView	public	function	Allows formatters to load information for field values being displayed.
FormatterInterface::settingsForm	public	function	Returns a form to configure settings for the formatter.
FormatterInterface::settingsSummary	public	function	Returns a short summary for the current formatter settings.
FormatterInterface::view	public	function	Builds a renderable array for a fully themed field.
FormatterInterface::viewElements	public	function	Builds a renderable array for a field value.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.
PluginSettingsInterface::defaultSettings	public static	function	Defines the default settings for this plugin.
PluginSettingsInterface::getSetting	public	function	Returns the value of a setting, or its default value if absent.
PluginSettingsInterface::getSettings	public	function	Returns the array of settings, including defaults for missing settings.
PluginSettingsInterface::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted.
PluginSettingsInterface::setSetting	public	function	Sets the value of a setting for the plugin.
PluginSettingsInterface::setSettings	public	function	Sets the settings for the plugin.
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.