bp_get_group_public_status

Return the status of the current group in the loop.

Description

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

Either Public or Private..

Returns (string)

Parameters (1)

0. $group — Optional. (bool) => false
Group object. Default: current group in loop.

Usage

  1. if ( !function_exists( 'bp_get_group_public_status' ) ) { 
  2. require_once ABSPATH . PLUGINDIR . 'buddypress/bp-groups/bp-groups-template.php'; 
  3.  
  4. // Optional. Group object. 
  5. // Default: current group in loop. 
  6. $group = false; 
  7.  
  8. // NOTICE! Understand what this does before running. 
  9. $result = bp_get_group_public_status($group); 
  10.  

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. function bp_get_group_public_status( $group = false ) { 
  2. global $groups_template; 
  3.  
  4. if ( empty( $group ) ) { 
  5. $group =& $groups_template->group; 
  6.  
  7. if ( $group->is_public ) { 
  8. return __( 'Public', buddypress ); 
  9. } else { 
  10. return __( 'Private', buddypress );