bp_get_group_description_excerpt

Get an excerpt of a group description.

Description

(string) bp_get_group_description_excerpt( (bool) $group = false ); 

Returns (string)

Excerpt.

Parameters (1)

0. $group — Optional. (bool) => false
The group being referenced. Defaults to the group currently being iterated on in the groups loop.

Usage

  1. if ( !function_exists( 'bp_get_group_description_excerpt' ) ) { 
  2. require_once ABSPATH . PLUGINDIR . 'buddypress/bp-groups/bp-groups-template.php'; 
  3. $group = false; 
  4.  
  5. // NOTICE! Understand what this does before running. 
  6. $result = bp_get_group_description_excerpt($group); 
  7.  

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. function bp_get_group_description_excerpt( $group = false ) { 
  2. global $groups_template; 
  3.  
  4. if ( empty( $group ) ) { 
  5. $group =& $groups_template->group; 
  6.  
  7. /** 
  8. * Filters the excerpt of a group description. 
  9. * @since 1.0.0 
  10. * @param string $value Excerpt of a group description. 
  11. * @param object $group Object for group whose description is made into an excerpt. 
  12. */ 
  13. return apply_filters( 'bp_get_group_description_excerpt', bp_create_excerpt( $group->description ), $group );