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年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2015年8月27日 登録)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。

Paste JSON text:プラグイン作ってみました(2012年1月19日 登録)

動作検証用のサーバーと本番サーバーで投稿データの同期作業(コピー&ペースト)を支援するプラグインです。動作検証用のサーバーで投稿記事をJSONテキストに変換してクリップボードにコピー。本番サーバーの新規投稿ページでクリップボードにコピーしたJSONテキストをペーストして、投稿記事のコピー&ペーストを実現します。複数サーバー間で投稿記事の同期を行っている方は、お試しあれ。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 登録)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

Login rebuilderのログ表示機能を紹介(2015年7月9日 登録)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

最終更新日時 : 2014-04-20 09:46