WordPress Шорткод wp_playlist_shortcode(): Справка, Примеры, Параметры

# WP_PLAYLIST_SHORTCODE() │ WP 3.9.0

Функция wp_playlist_shortcode() создает вывод плейлиста.

Эта функция отвечает за отображение плейлиста, который включает коллекцию аудио или видеофайлов в записях WordPress.

## Использует:

- get_children()
- get_posts()

## Хуки из функции

- post_playlist 
- wp_playlist_scripts

## Возврат

Строка. Вывод плейлиста. Пустая строка, если переданный тип не поддерживается.

## Использование

```php
wp_playlist_shortcode( $attr );

Параметры

$attr (массив) (обязательный)

Массив с настройками плейлиста по умолчанию:

• type (строка)
  Тип плейлиста для отображения. Принимает значения 'audio' или 'video'.
  По умолчанию: 'audio'

• order (строка)
  Определяет порядок элементов в плейлисте: 'ASC' для восходящего или 'DESC' для нисходящего.
  По умолчанию: 'ASC'

• orderby (строка)
  Любой столбец для сортировки плейлиста. Если передан массив $ids, используется порядок этого массива. В противном случае по умолчанию - 'menu_order ID'.

• id (целое число)
  Если явный массив $ids не присутствует, этот параметр определяет, какие вложения используются для плейлиста.
  По умолчанию: ID текущей записи

• ids (массив)
  Создает плейлист из этих явных ID вложений. Если пусто, плейлист создается из всех вложений типа $id.
  По умолчанию: ''

• exclude (массив)
  Список ID вложений, которые нужно исключить из плейлиста.
  По умолчанию: ''

• style (строка)
  Стиль плейлиста. Принимает 'light' или 'dark'.
  По умолчанию: 'light'

• tracklist (булевое)
  Показывать или скрывать плейлист.
  По умолчанию: true

• tracknumbers (булевое)
  Показывать или скрывать номера рядом с записями в плейлисте.
  По умолчанию: true

• images (булевое)
  Показывать или скрывать миниатюру видео или аудио.
  По умолчанию: true

• artists (булевое)
  Показывать или скрывать имена исполнителей в плейлисте.
  По умолчанию: true

Примеры

1. Отображение аудиоплейлиста в шаблоне

Предположим, нам нужно отобразить плейлист после содержимого, который будет содержать все аудиофайлы, прикрепленные к записям. Проще говоря, нам нужно сделать то, что делает шорткод .

echo wp_playlist_shortcode();

Результат будет выглядеть так:

HTML-код плейлиста:

    

        
        

            “Hold On (feat. Li0by)”
            Outside EP
            Pixaliz
        
    
    Audio Player
    

        
    
    

    

    

2. Отображение плейлиста указанных видеофайлов

Предположим, вы знаете ID видео, добавленных в медиа-библиотеку, которые равны 54 и 132. Теперь нам нужно показать эти видео в темном дизайне.

$attr = array(
    'type'  => 'video',
    'ids'   => '54,132',
    'style' => 'dark', 
);

echo wp_playlist_shortcode( $attr );

Результат будет выглядеть так:

HTML-код для видео:

    Video Player
    

        
    
    

    

    

3. Полная переопределение вывода

Функцию можно полностью переопределить с помощью хука post_playlist. Это делается аналогично тому, как это сделано с шорткодом галереи.

add_filter( 'post_playlist', 'my_playlist_shortcode', 10, 3 );

function my_playlist_shortcode( $empty_str, $attr, $instance ){
    if( $attr['type'] !== 'video' ){
        return '';
    }

    // Здесь мы пишем свой код для вывода плейлиста для видеофайлов
}

Заметки

• Глобальная переменная: $content_width

Изменения

С версии 3.9.0 — введено.

Связанные функции

• add_shortcode()
• apply_shortcodes()
• do_shortcode()
• shortcode_atts()

Эта статья содержит структурированную информацию о шорткоде для плейлистов в WordPress с простыми объяснениями и примерами кода, чтобы помочь новичкам лучше понять, как пользоваться этой функцией.