bp_group_status_message

Filters a message if the group is not visible to the current user.

Description

apply_filters( 'bp_group_status_message', (string) $message, (object) $group ); 

This will be true if it is a hidden or private group, and the user does not have access.

Parameters (2)

0. $message (string)
Message to display to the current user.
1. $group (object)
Group to get status message for.

Usage

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

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. echo apply_filters( 'bp_group_status_message', $message, $group );