説明
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
関連
お勧め
Login rebuilder:プラグイン作ってみました(2024年11月7日 更新)
昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)
クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。カスタムフィールド関連関数のおさらい(2012年6月22日 更新)
カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)
この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。
ブロックエディターで現在の「ロケール」を取得した時のメモ(2024年8月10日 更新)
ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール(言語)を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。