class OEmbedWidget

Same name and namespace in other branches
  1. 10 core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php \Drupal\media\Plugin\Field\FieldWidget\OEmbedWidget
  2. 11.x core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php \Drupal\media\Plugin\Field\FieldWidget\OEmbedWidget
  3. 8.9.x core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php \Drupal\media\Plugin\Field\FieldWidget\OEmbedWidget

Plugin implementation of the 'oembed_textfield' widget.

@internal This is an internal part of the oEmbed system and should only be used by oEmbed-related code in Drupal core.

Plugin annotation


@FieldWidget(
  id = "oembed_textfield",
  label = @Translation("oEmbed URL"),
  field_types = {
    "string",
  },
)

Hierarchy

Expanded class hierarchy of OEmbedWidget

File

core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php, line 27

Namespace

Drupal\media\Plugin\Field\FieldWidget
View source
class OEmbedWidget extends StringTextfieldWidget {
  
  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    /** @var \Drupal\media\Plugin\media\Source\OEmbedInterface $source */
    $source = $items->getEntity()
      ->getSource();
    $message = $this->t('You can link to media from the following services: @providers', [
      '@providers' => implode(', ', $source->getProviders()),
    ]);
    if (!empty($element['value']['#description'])) {
      $element['value']['#description'] = [
        '#theme' => 'item_list',
        '#items' => [
          $element['value']['#description'],
          $message,
        ],
      ];
    }
    else {
      $element['value']['#description'] = $message;
    }
    return $element;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $target_bundle = $field_definition->getTargetBundle();
    if (!parent::isApplicable($field_definition) || $field_definition->getTargetEntityTypeId() !== 'media' || !$target_bundle) {
      return FALSE;
    }
    return MediaType::load($target_bundle)->getSource() instanceof OEmbedInterface;
  }

}

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