wp_playlist_shortcode

（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

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

関連

参考

Code Reference: wp_playlist_shortcode

お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。