post_playlist

Filters the playlist output.

Description

apply_filters( 'post_playlist', (string) $var, (array) $attr, (int) $instance ); 

Passing a non-empty value to the filter will short-circuit generation of the default playlist output, returning the passed value instead.

Parameters (3)

0. $var (string) => ''
Playlist output. Default empty.
1. $attr (array)
An array of shortcode attributes.
2. $instance (int)
Unique numeric ID of this playlist shortcode instance.

Usage

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

Defined (1)

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

/wp-includes/media.php  
  1. $output = apply_filters( 'post_playlist', '', $attr, $instance );