get_attached_media( string $type, int|WP_Post $post = 0 ): WP_Post[]

Compatibility

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

Parameters

$typestring

Mime type.

$postint|WP_Postoptional

Post ID or WP_Post object. Default is global $post.Default: 0

Return value

WP_Post[]

Array of media attached to the given post.

Performance profile

How much work a call to get_attached_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

8–34

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

Plugin surface

2 hooks

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

Called by

2

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach cache, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while get_attached_media() runs, in this order:

1. 1
   apply_filters( get_attached_media_args )filterline 5359 (+25 into the body)

   Filters arguments used to retrieve media attached to the given post.

2. 2
   apply_filters( get_attached_media )filterline 5372 (+38 into the body)

   Filters the list of media attached to the given post.

Uses · 3

• get_post()Retrieves post data given a post ID or post object.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_children()Retrieves all children of the post parent ID.

Used by · 2

• wp_audio_shortcode()Builds the Audio shortcode output.
• wp_video_shortcode()Builds the Video shortcode output.

Source code

View on Trac ↗View on GitHub ↗

5334function get_attached_media( $type, $post = 0 ) {5335	$post = get_post( $post );5336 5337	if ( ! $post ) {5338		return array();5339	}5340 5341	$args = array(5342		'post_parent'    => $post->ID,5343		'post_type'      => 'attachment',5344		'post_mime_type' => $type,5345		'posts_per_page' => -1,5346		'orderby'        => 'menu_order',5347		'order'          => 'ASC',5348	);5349 5350	/**5351	 * Filters arguments used to retrieve media attached to the given post.5352	 *5353	 * @since 3.6.05354	 *5355	 * @param array   $args Post query arguments.5356	 * @param string  $type Mime type of the desired media.5357	 * @param WP_Post $post Post object.5358	 */5359	$args = apply_filters( 'get_attached_media_args', $args, $type, $post );5360 5361	$children = get_children( $args );5362 5363	/**5364	 * Filters the list of media attached to the given post.5365	 *5366	 * @since 3.6.05367	 *5368	 * @param WP_Post[] $children Array of media attached to the given post.5369	 * @param string    $type     Mime type of the media desired.5370	 * @param WP_Post   $post     Post object.5371	 */5372	return (array) apply_filters( 'get_attached_media', $children, $type, $post );5373}

Changelog

Introduced in 3.6.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.