Функция wp_playlist_shortcode()
является важным инструментом в WordPress, который позволяет создавать и отображать плейлисты аудио и видео файлов в записях. Она обрабатывает шорткод playlist
и выводит HTML-код для отображения списка файлов.
wp_playlist_shortcode( array $attr ): string
Эта функция принимает массив параметров, которые определяют, как должен выглядеть и вести себя плейлист.
Параметры функции
Параметр | Тип | Описание |
---|---|---|
type | string | Тип плейлиста: ‘audio’ или ‘video’. По умолчанию ‘audio’. |
order | string | Порядок сортировки: ‘ASC’ (по возрастанию) или ‘DESC’ (по убыванию). По умолчанию ‘ASC’. |
orderby | string | Колонка или колонки для сортировки. По умолчанию ‘menu_order ID’. |
id | int | ID записи, вложения которой используются в плейлисте. По умолчанию ID текущей записи. |
ids | array | Массив ID вложений для создания плейлиста. |
exclude | array | Массив ID вложений, которые нужно исключить из плейлиста. |
style | string | Стиль плейлиста: ‘light’ или ‘dark’. По умолчанию ‘light’. |
tracklist | bool | Показывать ли плейлист. По умолчанию true. |
tracknumbers | bool | Показывать ли номера треков. По умолчанию true. |
images | bool | Показывать ли миниатюры аудио/видео. По умолчанию true. |
artists | bool | Показывать ли имена исполнителей. По умолчанию true. |
Возвращает
Функция возвращает строку с HTML-кодом плейлиста. Если тип не поддерживается, возвращает пустую строку.
1. Базовый вызов
Чтобы вывести плейлист всех аудио файлов, прикрепленных к записи, можно использовать следующий шорткод:
echo wp_playlist_shortcode();
Это создаст стандартный плейлист с использованием параметров по умолчанию.
2. Изменение стиля плейлиста
Если вы хотите изменить стиль на темный, используйте:
echo wp_playlist_shortcode(array('style' => 'dark'));
3. Вывод видео файлов
Для вывода видео файлов с указанием их ID:
$attr = array(
'type' => 'video',
'ids' => '101,202,303',
);
echo wp_playlist_shortcode($attr);
4. Исключение определенных файлов
Если необходимо исключить определенные ID из плейлиста:
$attr = array(
'ids' => '101,202,303',
'exclude' => '202',
);
echo wp_playlist_shortcode($attr);
Примеры вывода
Пример 1: Аудио плейлист
Вот как может выглядеть HTML-код для аудио плейлиста:
<div class="wp-playlist wp-audio-playlist wp-playlist-light">
<div class="wp-playlist-current-item">
<img src="http://example.com/image.png" alt="">
<div class="wp-playlist-caption">
<span class="wp-playlist-item-meta wp-playlist-item-title">"Заголовок трека"</span>
<span class="wp-playlist-item-meta wp-playlist-item-artist">Исполнитель</span>
</div>
</div>
<div class="wp-playlist-tracks">
<div class="wp-playlist-item">
<a class="wp-playlist-caption" href="http://example.com/audio.mp3">
<span class="wp-playlist-item-title">"Трек 1"</span>
</a>
<div class="wp-playlist-item-length">3:10</div>
</div>
</div>
</div>
Пример 2: Видео плейлист
Для видео плейлиста HTML-код может выглядеть так:
<div class="wp-playlist wp-video-playlist wp-playlist-dark">
<div id="mep_0" class="mejs-container svg mejs-video">
<video src="http://example.com/video.mp4" controls></video>
</div>
<div class="wp-playlist-tracks">
<div class="wp-playlist-item">
<a class="wp-playlist-caption" href="http://example.com/video.mp4">
<span class="wp-playlist-item-title">"Видео 1"</span>
</a>
<div class="wp-playlist-item-length">2:08</div>
</div>
</div>
</div>
Использование хуков
Функция wp_playlist_shortcode()
также позволяет переопределять ее поведение с помощью хуков. Например:
add_filter('post_playlist', 'my_custom_playlist_shortcode', 10, 3);
function my_custom_playlist_shortcode($empty_str, $attr, $instance) {
if ($attr['type'] !== 'video') {
return '';
}
// Ваш код для вывода видео плейлиста
}
Заключение
Функция wp_playlist_shortcode()
в WordPress предоставляет гибкие возможности для создания аудио и видео плейлистов в записях. Используйте её параметры для кастомизации внешнего вида и поведения ваших плейлистов, чтобы обеспечить лучший пользовательский опыт.