bp_get_group_is_public

Return whether the current group in the loop is public.

Description

bp_get_group_is_public( (bool) $group = false ); 

No longer used in BuddyPress.

Parameters (1)

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

Usage

  1. if ( !function_exists( 'bp_get_group_is_public' ) ) { 
  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_is_public($group); 
  10.  

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. function bp_get_group_is_public( $group = false ) { 
  2. global $groups_template; 
  3.  
  4. if ( empty( $group ) ) { 
  5. $group =& $groups_template->group; 
  6.  
  7. /** 
  8. * Filters whether the current group in the loop is public. 
  9. * @since 2.5.0 Added the `$group` parameter. 
  10. * @param bool $public True if the group is public. 
  11. * @param object $group Group object. 
  12. */ 
  13. return apply_filters( 'bp_get_group_is_public', $group->is_public, $group );