bp_core_parse_args_array( array $old_args_keys, array $func_args )

A utility for parsing individual function arguments into an array.

Description

The purpose of this function is to help with backward compatibility in cases where

function foo( $bar = 1, $baz = false, $barry = array(), $blip = false ) { // …

is deprecated in favor of

function foo( $args = array() ) { $defaults = array( ‘bar’ => 1, ‘arg2’ => false, ‘arg3’ => array(), ‘arg4’ => false, ); $r = wp_parse_args( $args, $defaults ); // …

The first argument, $old_args_keys, is an array that matches the parameter positions (keys) to the new $args keys (values):

$old_args_keys = array( 0 => ‘bar’, // because $bar was the 0th parameter for foo() 1 => ‘baz’, // because $baz was the 1st parameter for foo() 2 => ‘barry’, // etc 3 => ‘blip’ );

For the second argument, $func_args, you should just pass the value of func_get_args().

Parameters

$old_args_keys: (array) (Required) Old argument indexs, keyed to their positions.
$func_args: (array) (Required) The parameters passed to the originating function.

Return

(array) $new_args The parsed arguments.

Source

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

function bp_core_parse_args_array( $old_args_keys, $func_args ) {
	$new_args = array();

	foreach( $old_args_keys as $arg_num => $arg_key ) {
		if ( isset( $func_args[$arg_num] ) ) {
			$new_args[$arg_key] = $func_args[$arg_num];
		}
	}

	return $new_args;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.6.0	Introduced.

Used By
Used By	Description
bp-messages/classes/class-bp-messages-thread.php: BP_Messages_Thread::get_threads_for_user()	Get message threads.
bp-xprofile/classes/class-bp-xprofile-data-template.php: BP_XProfile_Data_Template::__construct()	Get activity items, as specified by parameters.
bp-messages/classes/class-bp-messages-box-template.php: BP_Messages_Box_Template::__construct()	Constructor method.
bp-groups/classes/class-bp-groups-template.php: BP_Groups_Template::__construct()	Constructor method.
bp-groups/classes/class-bp-groups-invite-template.php: BP_Groups_Invite_Template::__construct()	BP_Groups_Invite_Template constructor.
bp-groups/classes/class-bp-groups-membership-requests-template.php: BP_Groups_Membership_Requests_Template::__construct()	Constructor method.
bp-groups/classes/class-bp-groups-group.php: BP_Groups_Group::get()	Query for groups.
bp-groups/classes/class-bp-groups-group-members-template.php: BP_Groups_Group_Members_Template::__construct()	Constructor.
bp-groups/bp-groups-functions.php: groups_send_membership_request()	Create a group membership request.
bp-groups/bp-groups-functions.php: groups_send_invites()	Send all pending invites by a single user to a specific group.
bp-groups/bp-groups-functions.php: groups_get_group_members()	Fetch the members of a group.
bp-groups/bp-groups-functions.php: groups_edit_base_group_details()	Edit the base details for a group.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::get()	Get activity items, as specified by parameters.
bp-activity/classes/class-bp-activity-template.php: BP_Activity_Template::__construct()	Constructor method.

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