wp_enqueue_media( array $args = array() )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Arguments for enqueuing media scripts.Default: array()

• $postint|WP_Post

  Post ID or post object.

Performance profile

How much work a call to wp_enqueue_media() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

599–682

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 766.

Plugin surface

9 hooks

Third-party callbacks on 'media_upload_tabs', 'media_library_show_audio_playlist', 'media_library_show_video_playlist' run inside this call, and their cost is not bounded by anything here.

Called by

7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• querycontent queryget_post()called directly
• cacheobject cachewp_cache_get()one call below wp_enqueue_media()
• serializeserialisationmaybe_unserialize()one call below wp_enqueue_media()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 50 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_enqueue_media() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 9

9 hooks fire while wp_enqueue_media() runs, in this order:

1. 1
   apply_filters( media_upload_tabs )filterline 4949 (+26 into the body)

   Filters the available tabs in the legacy (pre-3.5.0) media popup.

2. 2
   apply_filters( media_library_show_audio_playlist )filterline 4987 (+64 into the body)

   Allows showing or hiding the "Create Audio Playlist" button in the media library.

3. 3
   apply_filters( media_library_show_video_playlist )filterline 5015 (+92 into the body)

   Allows showing or hiding the "Create Video Playlist" button in the media library.

4. 4
   apply_filters( media_library_months_with_files )filterline 5041 (+118 into the body)

   Allows overriding the list of months displayed in the media library.

5. 5
   apply_filters( media_library_infinite_scrolling )filterline 5080 (+157 into the body)

   Filters whether the Media Library grid has infinite scrolling. Default `true`.

6. 6
   apply_filters( disable_captions )filterline 5087 (+164 into the body)

   Filters whether to disable captions.

7. 7
   apply_filters( media_view_settings )filterline 5282 (+359 into the body)

   Filters the media view settings.

8. 8
   apply_filters( media_view_strings )filterline 5292 (+369 into the body)

   Filters the media view strings.

9. 9
   do_action( wp_enqueue_media )actionline 5322 (+399 into the body)

   Fires at the conclusion of wp_enqueue_media().

Uses · 29

• did_action()Retrieves the number of times an action has been fired during the current request.
• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_option()Retrieves an option value based on an option name.
• wp_get_audio_extensions()Returns a filtered list of supported audio formats.
• wp_get_video_extensions()Returns a filtered list of supported video formats.
• get_allowed_mime_types()Retrieves the list of allowed mime types and file extensions.
• __()Retrieves the translation of $text.
• get_user_option()Retrieves user option that can be either per Site or per Network.
• add_query_arg()Retrieves a modified URL query string.
• admin_url()Retrieves the URL to the admin area for the current site.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.

Used by · 7

• Custom_Background::admin_load()Sets up the enqueue for the CSS & JavaScript files.
• Custom_Image_Header::js_includes()Sets up the enqueue for the JavaScript files.
• WP_Customize_Header_Image_Control::enqueue()Enqueues control related scripts/styles.
• WP_Customize_Media_Control::enqueue()Enqueue control related scripts/styles.
• WP_Widget_Media::enqueue_admin_scripts()Loads the required scripts and styles for the widget control.
• WP_Widget_Text::enqueue_admin_scripts()Loads the required scripts and styles for the widget control.
• media_buttons()Adds the media button to the editor.

Source code

View on Trac ↗View on GitHub ↗

4923function wp_enqueue_media( $args = array() ) {4924	// Enqueue me just once per page, please.4925	if ( did_action( 'wp_enqueue_media' ) ) {4926		return;4927	}4928 4929	global $content_width, $wpdb, $wp_locale;4930 4931	$defaults = array(4932		'post' => null,4933	);4934	$args     = wp_parse_args( $args, $defaults );4935 4936	/*4937	 * We're going to pass the old thickbox media tabs to `media_upload_tabs`4938	 * to ensure plugins will work. We will then unset those tabs.4939	 */4940	$tabs = array(4941		// handler action suffix => tab label4942		'type'     => '',4943		'type_url' => '',4944		'gallery'  => '',4945		'library'  => '',4946	);4947 4948	/** This filter is documented in wp-admin/includes/media.php */4949	$tabs = apply_filters( 'media_upload_tabs', $tabs );4950	unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] );4951 4952	$props = array(4953		'link'  => get_option( 'image_default_link_type' ), // DB default is 'file'.4954		'align' => get_option( 'image_default_align' ),     // Empty default.4955		'size'  => get_option( 'image_default_size' ),      // Empty default.4956	);4957 4958	$exts      = array_merge( wp_get_audio_extensions(), wp_get_video_extensions() );4959	$mimes     = get_allowed_mime_types();4960	$ext_mimes = array();4961	foreach ( $exts as $ext ) {4962		foreach ( $mimes as $ext_preg => $mime_match ) {4963			if ( preg_match( '#' . $ext . '#i', $ext_preg ) ) {4964				$ext_mimes[ $ext ] = $mime_match;4965				break;4966			}4967		}4968	}4969 4970	/**4971	 * Allows showing or hiding the "Create Audio Playlist" button in the media library.4972	 *4973	 * By default, the "Create Audio Playlist" button will always be shown in4974	 * the media library.  If this filter returns `null`, a query will be run4975	 * to determine whether the media library contains any audio items.  This4976	 * was the default behavior prior to version 4.8.0, but this query is4977	 * expensive for large media libraries.4978	 *4979	 * @since 4.7.44980	 * @since 4.8.0 The filter's default value is `true` rather than `null`.4981	 *4982	 * @link https://core.trac.wordpress.org/ticket/310714983	 *4984	 * @param bool|null $show Whether to show the button, or `null` to decide based4985	 *                        on whether any audio files exist in the media library.4986	 */4987	$show_audio_playlist = apply_filters( 'media_library_show_audio_playlist', true );4988	if ( null === $show_audio_playlist ) {4989		$show_audio_playlist = $wpdb->get_var(4990			"SELECT ID4991			FROM $wpdb->posts4992			WHERE post_type = 'attachment'4993			AND post_mime_type LIKE 'audio%'4994			LIMIT 1"4995		);4996	}4997 4998	/**4999	 * Allows showing or hiding the "Create Video Playlist" button in the media library.5000	 *5001	 * By default, the "Create Video Playlist" button will always be shown in5002	 * the media library.  If this filter returns `null`, a query will be run

Changelog

Introduced in 3.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/media.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.