説明
パラメータ
- $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
関連
お勧め
oEmbed対応サイトを整理した(2020年4月6日 更新)
投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。
5.7の機能拡張:エクスポートファイルに更新日時が追加ほか(2021年2月23日 更新)
WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。
絵文字画像がPNGからSVGへ(2018年5月27日 更新)
WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。
投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)
rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。