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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。