bp_activity_get_action( string $component_id, string $key )

Retrieve the current action from a component and key.

Parameters Parameters


(string) (Required) The unique string ID of the component.


(string) (Required) The action key.

Top ↑

Return Return

(string|bool) Action value if found, otherwise false.

Source Source

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

function bp_activity_get_action( $component_id, $key ) {

	// Return false if any of the above values are not set.
	if ( empty( $component_id ) || empty( $key ) ) {
		return false;

	$actions = bp_activity_get_actions();
	$retval  = false;

	if ( isset( $actions->{$component_id}->{$key} ) ) {
		$retval = $actions->{$component_id}->{$key};

	 * Filters the current action by component and key.
	 * @since 1.1.0
	 * @param string|bool $retval       The action key.
	 * @param string      $component_id The unique string ID of the component.
	 * @param string      $key          The action key.
	return apply_filters( 'bp_activity_get_action', $retval, $component_id, $key );

Top ↑

Changelog Changelog

Version Description
1.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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