bp_get_groups_action_link( string $action = '', string $query_args = '', bool $nonce = false )
Get a URL for a group component action.
Description
Parameters
- $action
-
(Optional)
Default value: ''
- $query_args
-
(Optional)
Default value: ''
- $nonce
-
(Optional)
Default value: false
Return
(string)
Source
File: bp-groups/bp-groups-template.php
function bp_get_groups_action_link( $action = '', $query_args = '', $nonce = false ) {
$current_group = groups_get_current_group();
$url = '';
// Must be a group.
if ( ! empty( $current_group->id ) ) {
// Append $action to $url if provided
if ( !empty( $action ) ) {
$url = bp_get_group_permalink( $current_group ) . $action;
} else {
$url = bp_get_group_permalink( $current_group );
}
// Add a slash at the end of our user url.
$url = trailingslashit( $url );
// Add possible query args.
if ( !empty( $query_args ) && is_array( $query_args ) ) {
$url = add_query_arg( $query_args, $url );
}
// To nonce, or not to nonce...
if ( true === $nonce ) {
$url = wp_nonce_url( $url );
} elseif ( is_string( $nonce ) ) {
$url = wp_nonce_url( $url, $nonce );
}
}
/**
* Filters a URL for a group component action.
*
* @since BuddyPress 2.1.0
*
* @param string $url URL for a group component action.
* @param string $action Action being taken for the group.
* @param string $query_args Query arguments being passed.
* @param bool $nonce Whether or not to add a nonce.
*/
return apply_filters( 'bp_get_groups_action_link', $url, $action, $query_args, $nonce );
}
Changelog
| Version | Description |
|---|---|
| BuddyPress 1.2.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.