bp_get_group_leave_confirm_link

Generate the URL for confirming a request to leave a group.

Description

(string) bp_get_group_leave_confirm_link( (bool) $group = false ); 

Returns (string)

Parameters (1)

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

Usage

  1. if ( !function_exists( 'bp_get_group_leave_confirm_link' ) ) { 
  2. require_once ABSPATH . PLUGINDIR . 'buddypress/bp-groups/bp-groups-template.php'; 
  3.  
  4. // Optional. Group object. 
  5. // Default: Current group in the loop. 
  6. $group = false; 
  7.  
  8. // NOTICE! Understand what this does before running. 
  9. $result = bp_get_group_leave_confirm_link($group); 
  10.  

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. function bp_get_group_leave_confirm_link( $group = false ) { 
  2. global $groups_template; 
  3.  
  4. if ( empty( $group ) ) { 
  5. $group =& $groups_template->group; 
  6.  
  7. /** 
  8. * Filters the URL for confirming a request to leave a group. 
  9. * @since 1.0.0 
  10. * @since 2.5.0 Added the `$group` parameter. 
  11. * @param string $value URL for confirming a request to leave a group. 
  12. * @param object $group Group object. 
  13. */ 
  14. return apply_filters( 'bp_group_leave_confirm_link', wp_nonce_url( bp_get_group_permalink( $group ) . 'leave-group/yes', 'groups_leave_group' ), $group );