• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

Playlist ショートコード

提供: WordPress Codex 日本語版
移動先: 案内検索
この記事は翻訳時に編集が必要であるとマークされていました。その為Codex原文が大きく編集されている可能性があります。内容を確認される際は原文を参照していただき、可能であれば本項目へ反映させてください。よりよいCodexを作成するためのお手伝いをお願いします。

再生リスト機能を使うとシンプルなショートコードで WordPress のオーディオまたは動画ファイルのコレクションを表示できます。これは WordPress 3.9 で導入されました。次のように使います:

[playlist]

playlist ショートコードはオプションを指定して出力を変更することができます。

デフォルト

オプションのデフォルト値は次のとおりです:

<?php array(
    'type'          => 'audio',
    'order'         => 'ASC',
    'orderby'       => 'menu_order ID',
    'id'            => $post ? $post->ID : 0,
    'include'       => '',
    'exclude'       => '',
    'style'         => 'light',
    'tracklist'     => true,
    'tracknumbers'  => true,
    'images'        => true,
    'artists'       => true
);

各オプションの値

一部のオプションは指定された値によっては他のオプションを上書きする場合があります。うまく動かない時はそれを思い出してください。

'type'
文字列) (オプション) 表示する再生リストの種類。可能な値は 'audio' (オーディオ) または 'video' (動画)。
初期値: 'audio'
'order'
文字列) (オプション) 再生リスト内の項目を昇順 (ASC)、降順 (DESC) のどちらにするか。可能な値は 'ASC' または 'DESC'。
初期値: 'ASC'
'orderby'
文字列) (オプション) 再生リストをソートするためのカラム(複数でもよい)。ids が指定されていると、デフォルトが ids 配列内 ('post__in') の順序になる。
初期値: 'menu_order ID'
  • 参考: orderby に rand (ランダム再生) を指定できます
'id'
整数) (オプション) ids 配列が省略された場合、このパラメータで指定した投稿の添付ファイルが再生リストになります。
初期値: 現在の投稿の ID
'ids'
配列) (オプション) このパラメータ(添付ファイルの ID の配列)で明示的に指定した添付ファイルから再生リストを作ります。省略すると、id で指定した投稿の type で指定した種類の添付ファイルから再生リストが作られます。
初期値: 空の配列
'exclude'
配列) (オプション) 再生リストから除外する添付ファイルの ID のリスト。
初期値: 空の配列
'style'
文字列) (オプション) 再生リストのスタイル。可能な値は 'light' または 'dark'。
初期値: 'light'
'tracklist'
真偽値) (オプション) トラックリスト(曲名などのリスト)を表示するか (true) しないか (false)。
初期値: true
'tracknumbers'
真偽値) (オプション) トラックリスト内のエントリーに番号を表示するか (true) しないか (false)。
初期値: true
'images'
真偽値) (オプション) 動画やオーディオのサムネイルを表示するか (true) しないか (false)。アイキャッチ画像(投稿サムネイル)に相当。
初期値: true
'artists'
真偽値) (オプション) アーティスト名をトラックリストに表示するか (true) しないか (false)。
初期値: true

使い方

ショートコードはふつう投稿編集画面のコンテンツへ追加して使います。

デフォルト値による基本的な使い方:

[playlist]

スタイルを dark にする:

[playlist style="dark"]

種類を動画にする:

[playlist type="video"]

メディアライブラリーにあるオーディオファイルの id を指定する(種類のデフォルトはオーディオ):

[playlist ids="123,456,789"]

メディアライブラリーにある動画ファイルの id を指定し、スタイルを変える:

[playlist type="video" ids="123,456,789" style="dark"]

ソースファイル

playlist ショートコードは wp-includes/media.php にあります。

ショートコード: [audio] /en, [caption] /en, [embed] /en, [gallery] /en, [playlist] /en, [video] /en

最新英語版: WordPress Codex » Playlist Shortcode最新版との差分