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


お勧め

edit_custom_thumbnail_sizesフィルターを使ってみた(2022年5月30日 更新)

アップロード済みの画像は、トリミングや回転、反転といった編集が可能である。6.0.0で追加されたedit_custom_thumbnail_sizesフィルターは、編集された内容を反映させるサイズを拡張するものだったので、さっそく使ってみた。

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

新テーマ「Twenty Twenty-Three」にはfunctions.phpがない(2022年10月6日 更新)

WordPress 6.1に同梱された新テーマ「Twenty Twenty-Three」を見てみると、そこには見慣れたfunctions.phpがない。Full Site Editing(FSE)対応テーマってこんな感じなのかと思いつつ、テーマの設定がどうなっているのか調べてみた。

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

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