説明
string wp_playlist_shortcode( array $attr )
playlistショートコードの出力HTMLを生成する。
パラメータ
- $attrplaylistショートコードのパラメータを連想配列で指定。
属性名 意味 省略時の値 '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.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?