bp_is_group_creation_step( string $step_slug )

Check which step is displayed during the group creation process.

Description

Parameters

$step_slug: (Required)

Return

(bool)

Source

function bp_is_group_creation_step( $step_slug ) {
 
    // Make sure we are in the groups component.
    if ( ! bp_is_groups_component() || ! bp_is_current_action( 'create' ) ) {
        return false;
    }
 
    $bp = buddypress();
 
    // If this the first step, we can just accept and return true.
    $keys = array_keys( $bp->groups->group_creation_steps );
    if ( !bp_action_variable( 1 ) && array_shift( $keys ) == $step_slug ) {
        return true;
    }
 
    // Before allowing a user to see a group creation step we must make sure
    // previous steps are completed.
    if ( !bp_is_first_group_creation_step() ) {
        if ( !bp_are_previous_group_creation_steps_complete( $step_slug ) ) {
            return false;
        }
    }
 
    // Check the current step against the step parameter.
    if ( bp_is_action_variable( $step_slug ) ) {
        return true;
    }
 
    return false;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.1.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-groups/bp-groups-template.php: bp_is_first_group_creation_step()	Is the user looking at the first step in the group creation process
bp-groups/bp-groups-template.php: bp_are_previous_group_creation_steps_complete()	Check all previous group creation steps are complete.
bp-core/bp-core-template.php: bp_is_groups_component()	Check whether the current page is part of the Groups component.
bp-core/bp-core-template.php: bp_is_current_action()	Check to see whether the current page matches a given action.
bp-core/bp-core-template.php: bp_is_action_variable()	Check to see whether the current page matches a given action_variable.
bp-core/bp-core-template.php: bp_action_variable()	Return the value of a given action variable.

Show 2 more uses Hide more uses

Used By
Used By	Description
bp-forums/groups.php: BBP_Forums_Group_Extension::create_screen()	Show forums and new forum form when creating a group
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::maybe_create_screen()	Call the create_screen() method, if we’re on the right page.
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::maybe_create_screen_save()	Call the create_screen_save() method, if we’re on the right page.
bp-templates/bp-nouveau/includes/groups/template-tags.php: bp_nouveau_group_manage_screen()	Load the requested Manage Screen for the current group.
bp-templates/bp-nouveau/includes/groups/functions.php: bp_nouveau_groups_enqueue_scripts()	Enqueue the groups scripts
bp-templates/bp-nouveau/includes/groups/functions.php: bp_nouveau_groups_localize_scripts()	Localize the strings needed for the Group’s Invite UI
bp-core/bp-core-attachments.php: bp_attachments_cover_image_is_edit()	Are we on a page to edit a cover photo?
bp-core/bp-core-avatars.php: bp_avatar_is_front_edit()	Checks whether Avatar UI should be loaded.

Show 3 more used by Hide more used by

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.

Contents