wp_playlist_shortcode

説明

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

最終更新 : 2014年04月20日 09:46



お勧め

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。

5.4.1でパーマリンクの仕様が一部変更された件(2020年5月12日 更新)

先月末にリリースされたバージョン5.4.1のアップデートにより、一部のサイトで投稿ページが従来通りに表示されなくなる不具合が発生し、サポートサイトにレポートが上がりました。この件について、ちょっとモヤモヤしたので自分なりに考えてみました。

使っていないか確認しないとね!(2022年6月7日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.25.9.0現在、廃止予定となっている関数をまとめて紹介する。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

テーブルの1列目をth要素にしてみる(2021年12月21日 更新)

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。