bp_get_current_group_description

Returns the description of the current group.

Description

(string) bp_get_current_group_description(); 

Returns (string)

The description of the current group, if there is one.


Usage

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

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. function bp_get_current_group_description() { 
  2. $current_group = groups_get_current_group(); 
  3. $current_group_desc = isset( $current_group->description ) ? $current_group->description : ''; 
  4.  
  5. /** 
  6. * Filters the description of the current group. 
  7. * This filter is used to apply extra filters related to formatting. 
  8. * @since 1.0.0 
  9. * @param string $current_group_desc Description of the current group. 
  10. */ 
  11. $desc = apply_filters( 'bp_get_group_description', $current_group_desc ); 
  12.  
  13. /** 
  14. * Filters the description of the current group. 
  15. * @since 2.1.0 
  16. * @param string $desc Description of the current group. 
  17. */