groups_promote_member( int $user_id, int $group_id, string $status )

Promote a member to a new status within a group.

Parameters Parameters


(int) (Required) ID of the user.


(int) (Required) ID of the group.


(string) (Required) The new status. 'mod' or 'admin'.

Top ↑

Return Return

(bool) True on success, false on failure.

Source Source

File: bp-groups/bp-groups-functions.php

function groups_promote_member( $user_id, $group_id, $status ) {

	if ( ! bp_is_item_admin() )
		return false;

	$member = new BP_Groups_Member( $user_id, $group_id );

	// Don't use this action. It's deprecated as of BuddyPress 1.6.
	do_action( 'groups_premote_member', $group_id, $user_id, $status );

	 * Fires before the promotion of a user to a new status.
	 * @since 1.6.0
	 * @param int    $group_id ID of the group being promoted in.
	 * @param int    $user_id  ID of the user being promoted.
	 * @param string $status   New status being promoted to.
	do_action( 'groups_promote_member', $group_id, $user_id, $status );

	return $member->promote( $status );

Top ↑

Changelog Changelog

Version Description
1.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.