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



お勧め

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。