wp_enqueue_media

（3.5.0以降）
wp_enqueue_media - メディアJS APIに必要なスクリプトなどをエンキューする

説明

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

参考

Code Reference: wp_enqueue_media

お勧め

投稿一覧ページに「更新日時」カラムを追加してみた（2019年8月27日 更新）

サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。

連番のユーザーIDを回避できないか考えた（2019年6月4日 更新）

WordPressのユーザーIDは最初の管理者が1、次に追加したユーザーが2といった感じの連番になる。連番のIDはサイトによっては好ましくないケースがあり、連番を回避する方法がないか検討した。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

4.2.3でちょっと変わったショートコード（2018年5月27日 更新）

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

「投稿に挿入」時のタグをちょっとカスタマイズ（2011年7月29日 更新）

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される（キャプションを指定した場合はタグも）。それらの画像をLightBox（JavaScriptライブラリ）で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。