Contents
bp_action_variable( int $position )
Return the value of a given action variable.
Description
Parameters
- $position
-
(int) (Required) The key of the action_variables array that you want.
Return
(string|bool) $action_variable The value of that position in the array, or false if not found.
Source
File: bp-core/bp-core-template.php
function bp_action_variable( $position = 0 ) {
$action_variables = bp_action_variables();
$action_variable = isset( $action_variables[ $position ] )
? $action_variables[ $position ]
: false;
/**
* Filters the value of a given action variable.
*
* @since BuddyPress 1.5.0
*
* @param string|bool $action_variable Requested action variable based on position.
* @param int $position The key of the action variable requested.
*/
return apply_filters( 'bp_action_variable', $action_variable, $position );
}
Changelog
| Version | Description |
|---|---|
| BuddyPress 1.5.0 | Introduced. |
Related
Uses
| Uses | Description |
|---|---|
| bp-core/bp-core-template.php: bp_action_variable |
Filters 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 | Description |
|---|---|
| bp-core/bp-core-template.php: bp_is_activity_edit() |
Is the current page a single activity item edit permalink? |
| bp-document/screens/folders.php: document_screen_single_folder() |
Load an individual folder screen. |
| bp-document/classes/class-bp-document-component.php: BP_Document_Component::setup_globals() |
Set up component global data. |
| bp-document/bp-document-template.php: bp_has_folders() |
Initialize the folder loop. |
| bp-document/bp-document-template.php: bp_has_document() |
Initialize the document loop. |
| bp-templates/bp-nouveau/includes/document/functions.php: bp_nouveau_document_localize_scripts() |
Localize the strings needed for the messages UI |
| bp-groups/bp-groups-template.php: bp_get_group_current_invite_tab() |
Returns the current group invite tab slug. |
| bp-groups/screens/single/folders.php: document_screen_group_single_folder() |
Load an individual folder screen. |
| bp-core/bp-core-template.php: bp_is_single_folder() |
Is the current page a single folder item permalink? |
| bp-core/bp-core-template.php: bp_is_single_document() |
Is the current page a single document item permalink? |
| bp-forums/groups.php: BBP_Forums_Group_Extension::display_forums() |
Output the forums for a group in the edit screens |
| bp-forums/common/template.php: bbp_is_reply_edit() |
Check if current page is a reply edit page |
| bp-forums/common/template.php: bbp_is_topic_edit() |
Check if current page is a topic edit page |
| bp-forums/functions.php: bbp_filter_modify_page_title() |
Add the topic title to the |
| bp-media/bp-media-template.php: bp_has_media() |
Initialize the media loop. |
| bp-media/screens/albums.php: media_screen_single_album() |
Load an individual album screen. |
| bp-media/classes/class-bp-media-component.php: BP_Media_Component::setup_globals() |
Set up component global data. |
| bp-xprofile/bp-xprofile-template.php: bp_get_current_profile_group_id() |
Return the current profile group ID. |
| bp-xprofile/bp-xprofile-template.php: bp_get_profile_group_name() |
Return the XProfile group name. |
| bp-xprofile/screens/edit.php: xprofile_screen_edit_profile() |
Handles the display of the profile edit page by loading the correct template file. |
| bp-messages/actions/notices.php: bp_messages_action_edit_notice() |
Handle editing of sitewide notices. |
| bp-messages/actions/star.php: bp_messages_star_action_handler() |
Action handler to set a message’s star status for those not using JS. |
| bp-messages/screens/view.php: messages_screen_conversation() |
Load an individual conversation screen. |
| bp-messages/actions/delete.php: messages_action_delete_message() |
Process a request to delete a message. |
| bp-messages/actions/view.php: messages_action_conversation() |
Process a request to view a single message thread. |
| bp-messages/classes/class-bp-messages-component.php: BP_Messages_Component::late_includes() |
Late includes method. |
| bp-messages/bp-messages-template.php: bp_get_thread() |
Initialize the messages template loop for a specific thread and sets thread. |
| bp-messages/bp-messages-template.php: bp_get_messages_form_action() |
Return the form action for Messages HTML forms. |
| 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/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/screens/single/activity-permalink.php: groups_screen_group_activity_permalink() |
Handle the display of a single group activity item. |
| bp-groups/actions/create.php: groups_action_create_group() |
Catch and process group creation form submissions. |
| bp-groups/classes/class-bp-groups-group-members-template.php: BP_Groups_Group_Members_Template::__construct() |
Constructor. |
| bp-groups/classes/class-bp-groups-component.php: BP_Groups_Component::setup_globals() |
Set up component global data. |
| bp-groups/bp-groups-template.php: bp_get_group_current_admin_tab() |
Returns the current group admin tab slug. |
| bp-groups/bp-groups-template.php: bp_get_group_current_members_tab() |
Returns the current group members tab slug. |
| bp-groups/bp-groups-template.php: bp_groups_header_tabs() |
Displays group header tabs. |
| bp-groups/bp-groups-template.php: bp_groups_filter_title() |
Displays group filter titles. |
| bp-groups/bp-groups-template.php: bp_get_group_creation_form_action() |
Get the group creation next step url. |
| 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_get_group_admin_form_action() |
Generate the ‘action’ attribute for a group admin form. |
| bp-friends/actions/add-friend.php: friends_action_add_friend() |
Catch and process connection requests. |
| bp-friends/actions/remove-friend.php: friends_action_remove_friend() |
Catch and process Remove Connection requests. |
| bp-friends/screens/requests.php: friends_screen_requests() |
Catch and process the Requests page. |
| bp-integrations/learndash/buddypress/components/BpGroupCourses.php: BpGroupCourses::loadSubMenuTemplate() |
Display the tab sub menu before the tab content |
| bp-integrations/learndash/buddypress/components/BpGroupCourses.php: BpGroupCourses::display() |
Display the tab content based on the selected sub tab |
| bp-integrations/learndash/buddypress/components/BpGroupReports.php: BpGroupReports::display() |
Display the tab content based on the selected sub tab |
| bp-integrations/learndash/buddypress/components/BpGroupReports.php: BpGroupReports::loadSubMenuTemplate() |
Display the tab sub menu before the tab content |
| bp-templates/bp-nouveau/includes/media/functions.php: bp_nouveau_media_localize_scripts() |
Localize the strings needed for the messages UI |
| 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/template-tags.php: bp_nouveau_get_nav_classes() |
Retrieve a space separated list of classes for the current nav item. |
| bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_pagination() |
Pagination for loops |
| bp-core/deprecated/buddypress/1.6.php: bp_friends_header_tabs() |
Displays Connections header tabs |
| bp-core/deprecated/buddypress/1.6.php: bp_friends_filter_title() |
Filters the title for the Connections component |
| bp-core/bp-core-template.php: bp_is_group_leaders() |
Is the current page a group’s Leaders page? |
| bp-core/bp-core-template.php: bp_is_single_album() |
Is the current page a single album item permalink? |
| bp-core/bp-core-template.php: bp_is_groups_directory() |
Is the current page the groups directory? |
| 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_get_options_nav() |
Output the “options nav”, the secondary-level single item navigation menu. |
| bp-core/bp-core-buddybar.php: bp_core_register_nav_screen_function() |
Register a screen function for an item in the main nav array. |
| bp-core/bp-core-avatars.php: bp_core_avatar_reset_query() |
Reset the week parameter of the WordPress main query if needed. |
| bp-activity/screens/permalink.php: bp_activity_action_permalink_router() |
Catch and route requests for single activity item permalinks. |
| bp-activity/actions/delete.php: bp_activity_action_delete_activity() |
Delete specific activity item and redirect to previous page. |
| bp-activity/actions/favorite.php: bp_activity_action_mark_favorite() |
Mark activity as liked. |
| bp-activity/actions/spam.php: bp_activity_action_spam_activity() |
Mark specific activity item as spam and redirect to previous page. |
| bp-activity/actions/unfavorite.php: bp_activity_action_remove_favorite() |
Remove activity from likes. |
| bp-activity/bp-activity-template.php: bp_has_activities() |
Initialize the activity loop. |
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.