bp_is_action_variable( string $action_variable = '', int|bool $position = false )

Check to see whether the current page matches a given action_variable.

Description

Along with bp_is_current_component() and bp_is_current_action(), this function is mostly used to help determine when to use a given screen function.

In BP parlance, action_variables are an array made up of the URL chunks appearing after the current_action in a URL. For example, http://example.com/groups/my-group/admin/group-settings $action_variables[0] is ‘group-settings’.

Parameters

$action_variable

(Optional) The action_variable being tested against.

Default value: ''

$position

(Optional) The array key you're testing against. If you don't provide a $position, the function will return true if the $action_variable is found *anywhere* in the action variables array.

Default value: false

Return

(bool) True if $action_variable matches at the $position provided.

Source

File: bp-core/bp-core-template.php

function bp_is_action_variable( $action_variable = '', $position = false ) {
    $is_action_variable = false;
 
    if ( false !== $position ) {
        // When a $position is specified, check that slot in the action_variables array.
        if ( $action_variable ) {
            $is_action_variable = $action_variable == bp_action_variable( $position );
        } else {
            // If no $action_variable is provided, we are essentially checking to see
            // whether the slot is empty.
            $is_action_variable = !bp_action_variable( $position );
        }
    } else {
        // When no $position is specified, check the entire array.
        $is_action_variable = in_array( $action_variable, (array)bp_action_variables() );
    }
 
    /**
     * Filters whether the current page matches a given action_variable.
     *
     * @since BuddyPress 1.5.0
     *
     * @param bool   $is_action_variable Whether the current page matches a given action_variable.
     * @param string $action_variable    The action_variable being tested against.
     * @param int    $position           The array key tested against.
     */
    return apply_filters( 'bp_is_action_variable', $is_action_variable, $action_variable, $position );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.5.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-template.php: bp_is_action_variable	Filters 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.
bp-core/bp-core-template.php: bp_action_variables()	Return the value of $bp->action_variables.

Used By
Used By	Description
bp-xprofile/screens/edit.php: xprofile_screen_edit_profile()	Handles the display of the profile edit page by loading the correct template file.
bp-xprofile/actions/delete-avatar.php: xprofile_action_delete_avatar()	Deletes the active avatar for a user.
bp-xprofile/classes/class-bp-xprofile-component.php: BP_XProfile_Component::late_includes()	Late includes method.
bp-messages/actions/bulk-delete.php: messages_action_bulk_delete()	Process a request to bulk delete messages.
bp-messages/actions/unread.php: bp_messages_action_mark_unread()	Handle marking a single message thread as unread.
bp-messages/actions/bulk-manage.php: bp_messages_action_bulk_manage()	Handle bulk management (mark as read/unread, delete) of message threads.
bp-messages/actions/delete.php: messages_action_delete_message()	Process a request to delete a message.
bp-messages/actions/read.php: bp_messages_action_mark_read()	Handle marking a single message thread as read.
bp-messages/classes/class-bp-messages-component.php: BP_Messages_Component::late_includes()	Late includes method.
bp-groups/screens/user/invites.php: groups_screen_group_invites()	Handle the loading of a user’s Groups > Invites page.
bp-groups/screens/single/admin/manage-members.php: groups_screen_group_admin_manage_members()	This function handles actions related to member management on the group admin.
bp-groups/screens/single/admin/group-avatar.php: groups_screen_group_admin_avatar()	Handle the display of a group’s Change Avatar page.
bp-groups/screens/single/invite.php: groups_screen_group_invite()	Handle the display of a group’s Send Invites page.
bp-groups/screens/single/invite.php: groups_remove_group_invite()	Process group invitation removal requests.
bp-groups/classes/class-bp-group-extension.php: BP_Group_Extension::setup_edit_hooks()	Hook this extension’s Edit panel into BuddyPress, if necessary.
bp-groups/bp-groups-template.php: bp_is_group_admin_screen()	Is the current page a specific group admin screen?
bp-groups/bp-groups-template.php: bp_groups_header_tabs()	Displays group header tabs.
bp-groups/bp-groups-template.php: bp_get_group_creation_previous_link()	Return the URL to the previous group creation step
bp-groups/bp-groups-template.php: bp_is_group_creation_step()	Check which step is displayed during the group creation process.
bp-groups/bp-groups-template.php: bp_has_groups()	Start the Groups Template Loop.
bp-friends/screens/requests.php: friends_screen_requests()	Catch and process the Requests page.
bp-core/deprecated/buddypress/1.6.php: bp_friends_header_tabs()	Displays Connections header tabs
bp-core/bp-core-template.php: bp_is_group_forum_topic()	Is the current page a group forum topic?
bp-core/bp-core-template.php: bp_is_group_forum_topic_edit()	Is the current page a group forum topic edit page?
bp-activity/actions/feeds.php: bp_activity_action_friends_feed()	Load a user’s friends’ activity feed.
bp-activity/actions/feeds.php: bp_activity_action_my_groups_feed()	Load the activity feed for a user’s groups.
bp-activity/actions/feeds.php: bp_activity_action_mentions_feed()	Load a user’s @mentions feed.
bp-activity/actions/feeds.php: bp_activity_action_favorites_feed()	Load a user’s favorites feed.
bp-activity/classes/class-bp-activity-component.php: BP_Activity_Component::late_includes()	Late includes method.

Show 24 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