wp_enqueue_media() の使い方|説明・引数・注意点

説明

wp_enqueue_media() は、メディアアップローダー(ライブラリ選択ダイアログ)に必要なスクリプトとスタイルを読み込む関数です。

基本構文

wp_enqueue_media( array $args = array() ): void

引数

  • $args:post(関連付ける投稿)など

戻り値

戻り値はありません。

使い方(サンプル)

add_action( 'admin_enqueue_scripts', function() {
	wp_enqueue_media();
} );

注意点

  • 管理画面で独自のメディア選択ボタンを作るときに必要です。
  • admin_enqueue_scripts フックで呼びます。

実務での使いどころ

  • 独自のメディアアップロードボタンで、メディアライブラリのダイアログ(wp.media)を使うとき。
  • 管理画面の独自設定ページに、画像の選択欄を作るとき。

よくあるミスと対処

  • wp.media を使う前に、この関数を呼んでいない。メディア用のスクリプトやテンプレートが、読み込まれない。
  • すべての管理画面で呼んでいる。必要なページだけで呼ぶ(admin_enqueue_scripts フックの中で、画面を判定する)。
  • 画像を選択するJavaScript自体は、別に自分のスクリプトを用意して、wp_enqueue_script() で読み込む必要がある。

NG例

add_action( 'admin_enqueue_scripts', function () {
	wp_enqueue_media(); // すべての管理画面で、読み込まれる
} );

OK例

add_action( 'admin_enqueue_scripts', function ( $hook ) {
	if ( 'toplevel_page_my-settings' === $hook ) {
		wp_enqueue_media();
	}
} );

使い分け早見表

やりたいこと 使うもの
メディアライブラリのダイアログを使う wp_enqueue_media()
自分のスクリプトを読み込む wp_enqueue_script()
自分のCSSを読み込む wp_enqueue_style()

関連項目

wp_enqueue_script()、wp_get_attachment_url()

公式リファレンス:wp_enqueue_media() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました