wp_playlist_shortcode:WordPress私的マニュアル

(3.9.0以降)
wp_playlist_shortcode - playlistショートコードの出力HTMLを生成する

string wp_playlist_shortcode( array $attr )

playlistショートコードの出力HTMLを生成する。

$attr

playlistショートコードのパラメータを連想配列で指定。

属性名	意味	省略時の値
'type'	メディアタイプとして'audio'、'video'を指定	'audio'
'order'	ソート順として'ASC'、'DESC'、'RAND'を指定	'ASC'
'orderby'	ソート対象として'menu_order'、'ID'などの投稿情報プロパティ名か，それらの組み合わせを指定	'menu_order ID'
'id'	親投稿ID（指定不可）	－
'include'	再生する投稿IDを指定	''
'exclude'	再生しない投稿IDを指定	''
'style'	スタイルとして'theme'、'light'、'dark'を指定	'light'
'tracklist'	トラックリストを表示する場合はtrueを指定	true
'tracknumbers'	トラック番号を表示する場合はtrueを指定	true
'images'	画像を表示する場合はtrueを指定	true
'artists'	アーティストを表示する場合はtrueを指定	true
'ids'	添付ファイルIDを指定	null

playlistショートコードの出力HTMLを返す。プレイ対象の添付ファイルが見つからない場合は''を返す。

playlistショートコードの実態関数で、基本的には呼び出すことはないと思われる。

パラメータ$attr['include']（または$attr['ids']）が空の場合、呼び出し時のget_post関数で取得される投稿情報の添付ファイル（子投稿情報）が対象となる。

'post_playlist'フィルターを利用することで、playlistショートコードの出力をカスタマイズ（独自実装）できる。

添付ファイルの投稿IDが125,126,130のplaylistショートコードの出力HTMLを生成する。
<?php $output = wp_playlist_shortcode( array( 'ids'=>'125,126,130' ) ); ?>

パラメータ$attrの解析前に'post_playlist'フィルターを呼び出す。パラメータ$outputには''が、$attrには本関数の値となる。フィルター関数が''以外を返すとそれを本関数の戻り値として返すようになっている。

$output = apply_filters( 'post_playlist', $output, $attr );

初回呼び出し時のみ'wp_playlist_scripts'アクションを呼び出す。パラメータ$typeには'audio'または'video'が、$styleには'theme'、'light'、'dark'のいずれかとなる。

do_action( 'wp_playlist_scripts', $type, $style );

/wp-includes/media.php