interface OEmbedInterface in Drupal 10

Defines additional functionality for source plugins that use oEmbed.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\media\MediaSourceInterface
    • interface \Drupal\media\MediaSourceFieldConstraintsInterface
      • interface \Drupal\media\Plugin\media\Source\OEmbedInterface

6 files declare their use of OEmbedInterface

media.install in core/modules/media/media.install

Install, uninstall and update hooks for Media module.

media.module in core/modules/media/media.module

Provides media items.

OEmbedForm.php in core/modules/media_library/src/Form/OEmbedForm.php

OEmbedFormatter.php in core/modules/media/src/Plugin/Field/FieldFormatter/OEmbedFormatter.php

OEmbedResourceConstraintValidator.php in core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraintValidator.php

... See full list

File

core/modules/media/src/Plugin/media/Source/OEmbedInterface.php, line 10

Namespace

Drupal\media\Plugin\media\Source

interface OEmbedInterface extends MediaSourceFieldConstraintsInterface {

  /**
   * Returns the oEmbed provider names.
   *
   * The allowed providers can be configured by the user. If it is not
   * configured, all providers supported by the plugin are returned.
   *
   * @return string[]
   *   A list of oEmbed provider names.
   */
  public function getProviders();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	3
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	3
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	3
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	8
MediaSourceFieldConstraintsInterface::getSourceFieldConstraints	public	function	Gets media source-specific validation constraints for a source field.	1
MediaSourceInterface::createSourceField	public	function	Creates the source field definition for a type.
MediaSourceInterface::getMetadata	public	function	Gets the value for a metadata attribute for a given media item.
MediaSourceInterface::getMetadataAttributes	public	function	Gets a list of metadata attributes provided by this plugin.	2
MediaSourceInterface::getSourceFieldDefinition	public	function	Get the source field definition for a media type.
MediaSourceInterface::getSourceFieldValue	public	function	Get the primary value stored in the source field.
MediaSourceInterface::METADATA_FIELD_EMPTY		constant	Default empty value for metadata fields.
MediaSourceInterface::prepareFormDisplay	public	function	Prepares the media type fields for this source in the form display.
MediaSourceInterface::prepareViewDisplay	public	function	Prepares the media type fields for this source in the view display.
OEmbedInterface::getProviders	public	function	Returns the oEmbed provider names.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	9
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	9
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	7
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	1
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	1