media.api.php

Same filename and directory in other branches
  1. 9 core/modules/media/media.api.php
  2. 8.9.x core/modules/media/media.api.php
  3. 10 core/modules/media/media.api.php

Hooks related to Media and its plugins.

File

core/modules/media/media.api.php

View source
<?php


/**
 * @file
 * Hooks related to Media and its plugins.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alters the information provided in \Drupal\media\Annotation\MediaSource.
 *
 * @param array $sources
 *   The array of media source plugin definitions, keyed by plugin ID.
 */
function hook_media_source_info_alter(array &$sources) {
    $sources['youtube']['label'] = t('Youtube rocks!');
}

/**
 * Alters an oEmbed resource URL before it is fetched.
 *
 * @param array $parsed_url
 *   A parsed URL, as returned by \Drupal\Component\Utility\UrlHelper::parse().
 * @param \Drupal\media\OEmbed\Provider $provider
 *   The oEmbed provider for the resource.
 *
 * @see \Drupal\media\OEmbed\UrlResolverInterface::getResourceUrl()
 */
function hook_oembed_resource_url_alter(array &$parsed_url, \Drupal\media\OEmbed\Provider $provider) {
    // Always serve YouTube videos from youtube-nocookie.com.
    if ($provider->getName() === 'YouTube') {
        $parsed_url['path'] = str_replace('://youtube.com/', '://youtube-nocookie.com/', $parsed_url['path']);
    }
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Title Deprecated Summary
hook_media_source_info_alter Alters the information provided in \Drupal\media\Annotation\MediaSource.
hook_oembed_resource_url_alter Alters an oEmbed resource URL before it is fetched.

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