bbp_get_logout_link

Return the logout link.

Description

(string) apply_filters( 'bbp_get_logout_link', (string) $a_href_wp_logout_url_redirect_to_class_button_logout_link_esc_html_log_out_bbpress_a, (unknown) $redirect_to ); 

Returns (string)

The logout link

Parameters (2)

0. $a_href_wp_logout_url_redirect_to_class_button_logout_link_esc_html_log_out_bbpress_a — Optional. (string) => '' . esc_html__( 'Log Out', 'bbpress' ) . ''
The href wp logout url redirect to class button logout link esc html log out bbpress a.
1. $redirect_to (unknown)
The redirect to.

Usage

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

Defined (1)

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

/includes/common/template.php  
  1. return apply_filters( 'bbp_get_logout_link', '<a href="' . wp_logout_url( $redirect_to ) . '" class="button logout-link">' . esc_html__( 'Log Out', 'bbpress' ) . '</a>', $redirect_to );