bp_embed_get_cache

Filters the cache value to be used in the oEmbed, if exists.

Description

apply_filters( 'bp_embed_get_cache', (string) $cache, (int) $id, (string) $cachekey, (string) $url, (array) $attr, (array) $rawattr ); 

Parameters (6)

0. $cache (string)
Empty initial cache value.
1. $id (int)
ID that the caching is for.
2. $cachekey (string)
Key to use for the caching in the database.
3. $url (string)
The URL attempting to be embedded.
4. $attr (array)
Parsed shortcode attributes.
5. $rawattr (array)
Unparsed shortcode attributes.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-embed.php  
  1. $cache = apply_filters( 'bp_embed_get_cache', $cache, $id, $cachekey, $url, $attr, $rawattr );