bp_get_send_message_button

Filters the "Private Message" button for member profile headers.

Description

apply_filters( 'bp_get_send_message_button', (bool) $bp_get_button ); 

Parameters (1)

0. $bp_get_button — Optional. (bool) => bp_get_button( apply_filters( 'bp_get_send_message_button_args', array( 'id' => 'private_message', 'component' => 'messages', 'must_be_logged_in' => true, 'block_self' => true, 'wrapper_id' => 'send-private-message', 'link_href' => bp_get_send_private_message_link(), 'link_text' => __( 'Private Message', 'buddypress' ), 'link_class' => 'send-message', ) ) )
See .

Usage

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

Defined (1)

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

/bp-messages/bp-messages-template.php  
  1. return apply_filters( 'bp_get_send_message_button',