WordPress.org

Languages: English • 中文(简体) • 日本語 (Add your language)

Description

Enqueues all scripts, styles, settings, and templates necessary to use all media JavaScript APIs.

This function should be called from the 'admin_enqueue_scripts' action hook, or later.

Usage

<?php wp_enqueue_media( $args ); ?>

Parameters

$args

(array) (optional) An array of arguments. Currently only one argument is used, 'post', which if passed will be used to set up the scripts for that post. Note: if you do not set this parameter, uploaded files will not be attached to a post.

Default: array()

Returns Values

This function does not return a value.

Examples

Default usage:

wp_enqueue_media();

Enqueue the media scripts for a particular post:

<?php

$args = array( 'post' => 34 );

wp_enqueue_media( $args );

?>

Notes

• Uses: do_action() - calls 'wp_enqueue_media' after enqueing the media.
• Uses: did_action( 'wp_enqueue_media' ) - Makes sure that the function is run only once.
• Uses: apply_filters():
  • Calls 'media_upload_tabs' with an array of the old thickbox media tabs to ensure plugins will work. The default tabs will then be reset.
  • Calls 'disable_captions' to check whether captions should be disabled.
  • Calls 'media_view_settings' with the array of settings and the post object.
  • Calls 'media_view_strings' with the array of strings used in the media viewer and the post object.
• Uses: wp.media (JavaScript) to call the media uploader
  • Documentation: http://www.grafikart.fr/tutoriels/wordpress/wp-media-uploader-403 (French video)

Change Log

Since: 3.5.0

Source File

wp_enqueue_media() is located in wp-includes/media.php

Related

Enqueue Styles

• wp_register_style()
• wp_deregister_style()
• wp_enqueue_style()
• wp_dequeue_style()
• wp_add_inline_style()
• wp_style_is()

Enqueue Scripts

• wp_register_script()
• wp_deregister_script()
• wp_enqueue_script()
• wp_dequeue_script()
• wp_add_inline_script()
• wp_script_is()
• wp_localize_script()
• wp_enqueue_media()

Front-End Hooks

• wp_enqueue_scripts
• wp_print_scripts
• wp_print_styles

Admin Hooks

• admin_enqueue_scripts
• admin_print_scripts
• admin_print_styles

Login Hooks

• login_enqueue_scripts