bp_group_status_message
Filters a message if the group is not visible to the current user.
Description
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.
- $message = apply_filters( 'bp_group_status_message', $message, $group );
- if ( !empty( $message ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_group_status_message callback
- function filter_bp_group_status_message( $message, $group ) {
- // make filter magic happen here...
- return $message;
- };
- // add the filter
- add_filter( 'bp_group_status_message', 'filter_bp_group_status_message', 10, 2 );
- To remove a hook callback, use the example below.
- // remove the filter
- 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
- echo apply_filters( 'bp_group_status_message', $message, $group );