wp_enqueue_media

説明

void wp_enqueue_media( [ array $args = array() ] )
メディアJS APIに必要なスクリプト、スタイル、設定、テンプレートをエンキューする。

パラメータ

  • $args
    メディアスクリプト向けのパラメータを連想配列で指定(省略時はarray())。

返り値

返り値はありません。

注意

メディアページを拡張する際、自身が用意したJavaScriptファイルをエンキューする前に呼び出す。なお重複してエンキューしないよう'wp_enqueue_media'アクションが実行済みの場合は何もしないようになっている。

'media_view_settings'および'media_view_strings'フィルターを使用することで、独自の情報を自身が用意したJavaScriptで利用できる。


使用例

  • メディアJS APIに必要なスクリプトなどをエンキューする。
    wp_enqueue_media();

フィルター

[2.5.0]互換性を維持するため'media_upload_tabs'フィルターを呼び出す。パラメータ$tabsには以前使用されていたタブ情報の連想配列が格納されている。
$tabs = apply_filters( 'media_upload_tabs', $tabs );
[4.7.4]'media_library_show_audio_playlist'フィルターを呼び出す。パラメータ$showには初期値としてtrue([4.8.0]nullからtrueに変更)が格納されている。
$show_audio_playlist = apply_filters( 'media_library_show_audio_playlist', $show );
[4.7.4]'media_library_show_video_playlist'フィルターを呼び出す。パラメータ$showには初期値としてtrue([4.8.0]nullからtrueに変更)が格納されている。
$show_video_playlist = apply_filters( 'media_library_show_video_playlist', $show );
[4.7.4]'media_library_months_with_files'フィルターを呼び出す。パラメータ$monthsには初期値としてnullが格納されている。
$months = apply_filters( 'media_library_months_with_files', $months );
[5.8.0]'media_library_infinite_scrolling'フィルターを呼び出す。パラメータ$infiniteには初期値としてfalseが格納されている。
$infinite_scrolling = apply_filters( 'media_library_infinite_scrolling', $infinite );
[3.5.0]'media_view_settings'フィルターを呼び出す。パラメータ$settingsにはwp.media.view.settings(JavaScript)でアクセスできる各種情報の連想配列が、$postには対象の投稿情報(WP_Postオブジェクト)が格納されている。
$settings = apply_filters( 'media_view_settings', $settings, $post );
[3.5.0]'media_view_strings'フィルターを呼び出す。パラメータ$stringsにはwp.media.view.l10n(JavaScript)でアクセスできる翻訳テキストの連想配列が、$postには対象の投稿情報(WP_Postオブジェクト)が格納されている。
$settings = apply_filters( 'media_view_strings', $strings, $post );

アクション

[3.5.0]本関数を終了する前に'wp_enqueue_media'を呼び出す。
do_action( 'wp_enqueue_media' );

ソースファイル

/wp-includes/media.php

最終更新 : 2023年05月22日 04:44


お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。