get_attached_media( string $type, int|WP_Post $post )
Retrieves media attached to the passed post.
Description Description
Parameters Parameters
Return Return
(array) Found attachments.
Source Source
File: wp-includes/media.php
function get_attached_media( $type, $post = 0 ) { $post = get_post( $post ); if ( ! $post ) { return array(); } $args = array( 'post_parent' => $post->ID, 'post_type' => 'attachment', 'post_mime_type' => $type, 'posts_per_page' => -1, 'orderby' => 'menu_order', 'order' => 'ASC', ); /** * Filters arguments used to retrieve media attached to the given post. * * @since 3.6.0 * * @param array $args Post query arguments. * @param string $type Mime type of the desired media. * @param mixed $post Post ID or object. */ $args = apply_filters( 'get_attached_media_args', $args, $type, $post ); $children = get_children( $args ); /** * Filters the list of media attached to the given post. * * @since 3.6.0 * * @param array $children Associative array of media attached to the given post. * @param string $type Mime type of the media desired. * @param mixed $post Post ID or object. */ return (array) apply_filters( 'get_attached_media', $children, $type, $post ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
3.6.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
You can get all attached media, regardless of type, by passing an empty string:
or
Important to note that this function only returns the attachments that were first uploaded/added to the post.
Uploading an image to Post A(ID 1) and then adding that image later to Post B(ID 2) would give an empty array if the following code was used:
$media = get_attached_media( 'image', 2 );
var_dump( $media );
You’d only get array data if you upload your media and add it to Post B before any other post.
Examples
Get image attachment(s) to the current Post:
Get attachment(s) of mime-type ‘audio’ to the Post with an ID of 102:
It should be noted, that this function returns array of
WP_Post
objects, indexed by their ID, ordered by their “menu order” by default – that is where usually plugins handling attachment store their order positions…