WP_OEMBED_GET() │ WP 2.9.0
Функция wp_oembed_get()
позволяет встраивать объекты по заданному URL. Она пытается получить HTML-код с указанного URL, используя поддерживаемые провайдеры oEmbed в WordPress.
Что такое oEmbed?
oEmbed — это открытый формат, который облегчает встраивание контента с одного веб-сайта на другой. Контентом может быть фотография, видео, ссылка или любой другой тип данных.
Как использовать функцию wp_oembed_get()
Эта функция не кэширует результат. Чтобы использовать кэш, вы можете использовать объект WP_Embed
:
global $wp_embed;
echo $wp_embed->autoembed('https://www.youtube.com/watch?v=c6afCBCzLAY&t=2s');
/* Возвращает:
*/
Возврат значения
Функция возвращает строку с HTML-кодом встроенного элемента в случае успеха и false
, если произошла ошибка.
Синтаксис
wp_oembed_get( $url, $args );
- $url (string) (обязательный): URL, который должен быть встроен.
- $args (array|string): Дополнительные параметры для получения HTML-кода внедрения. По умолчанию:
''
.
Параметры
- width (int|string): Необязательный. Значение максимальной ширины, переданное провайдеру.
- height (int|string): Необязательный. Значение максимальной высоты, переданное провайдеру.
- discover (true|false): Необязательный. Указывает, следует ли пытаться обнаружить теги ссылки на данном URL для провайдера oEmbed, если URL провайдера не найден в списке встроенных провайдеров. По умолчанию:
true
.
Примеры использования
Пример 1: Встраивание с параметрами
Чтобы встроить видео с YouTube и указать его ширину:
$embed_code = wp_oembed_get('http://www.youtube.com/watch?v=AbcDeFg123', array('width' => 400));
Возврат:
Пример 2: Встраивание встроенного URL поддерживаемого oEmbed в WordPress
$embed_code = wp_oembed_get('http://www.youtube.com/watch?v=AbcDeFg123');
Возврат:
Примечание: Если видео недоступно, URL не будет обработан.
Примечания
- Чтобы узнать больше о функции
WP_oEmbed
, смотрите документацию.
Изменения
- С версии 2.9.0: Функция была добавлена в WordPress.
Связанные функции
get_oembed_response_data_for_url()
get_post_embed_html()
get_post_embed_url()
is_embed()
wp_embed_register_handler()
WP_Embed::delete_oembed_caches()
wp_get_audio_extensions()
wp_get_video_extensions()
wp_oembed_add_provider()
Эта функция является полезным инструментом для встраивания контента на ваш сайт WordPress с минимальными усилиями. Теперь вы можете легко использовать видео и другие медиафайлы, просто указав их URL.