get_attached_media

Filters the list of media attached to the given post.

Description

apply_filters( 'get_attached_media', (array) $children, (string) $type, (mixed) $post ); 

Parameters (3)

0. $children (array)
Associative array of media attached to the given post.
1. $type (string)
Mime type of the media desired.
2. $post (mixed)
Post ID or object.

Usage

To run the hook, copy the example below.
  1. $children = apply_filters( 'get_attached_media', $children, $type, $post ); 
  2.  
  3. if ( !empty( $children ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the get_attached_media callback 
  2. function filter_get_attached_media( $children, $type, $post ) { 
  3. // make filter magic happen here... 
  4. return $children
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'get_attached_media', 'filter_get_attached_media', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'get_attached_media', 'filter_get_attached_media', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/media.php  
  1. return (array) apply_filters( 'get_attached_media', $children, $type, $post );