bp_create_excerpt

Filters the final generated excerpt.

Description

apply_filters( 'bp_create_excerpt', (string) $text, (string) $original_text, (int) $length, (array) $options ); 

Parameters (4)

0. $text (string)
Generated excerpt.
1. $original_text (string)
Original text provided.
2. $length (int)
Length of returned string, including ellipsis.
3. $options (array)
Array of HTML attributes and options.

Usage

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

Defined (2)

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

/bp-core/bp-core-template.php  
  1. return apply_filters( 'bp_create_excerpt', $text, $original_text, $length, $options ); 
  1. return apply_filters( 'bp_create_excerpt', $truncate, $original_text, $length, $options );