bbp_parse_args( string|array $args, array $defaults = array(), string $filter_key = '' )

Merge user defined arguments into defaults array.

Description

This function is used throughout Forums to allow for either a string or array to be merged into another array. It is identical to wp_parse_args() except it allows for arguments to be passively or aggressively filtered using the optional $filter_key parameter.

Parameters

$args

(string|array) (Required) Value to merge with $defaults

$defaults

(array) (Optional) Array that serves as the defaults.

Default value: array()

$filter_key

(string) (Optional) String to key the filters from

Default value: ''

Return

(array) Merged user defined values with defaults.

Source

File: bp-forums/common/functions.php

function bbp_parse_args( $args, $defaults = array(), $filter_key = '' ) {

	// Setup a temporary array from $args
	if ( is_object( $args ) ) {
		$r = get_object_vars( $args );
	} elseif ( is_array( $args ) ) {
		$r =& $args;
	} else {
		wp_parse_str( $args, $r );
	}

	// Passively filter the args before the parse
	if ( !empty( $filter_key ) ) {
		$r = apply_filters( 'bbp_before_' . $filter_key . '_parse_args', $r );
	}

	// Parse
	if ( is_array( $defaults ) && !empty( $defaults ) ) {
		$r = array_merge( $defaults, $r );
	}

	// Aggressively filter the args after the parse
	if ( !empty( $filter_key ) ) {
		$r = apply_filters( 'bbp_after_' . $filter_key . '_parse_args', $r );
	}

	// Return the parsed results
	return $r;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3839)	Introduced.

Used By
Used By	Description
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::get_items()	Retrieve Topics.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::get_items()	Retrieve Replies.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::get_item()	Retrieve a single reply.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::get_items()	Retrieve Forums.
bp-forums/core/update.php: bbp_create_initial_content()	Create a default forum, topic, and reply
bp-forums/core/theme-compat.php: bbp_theme_compat_reset_post()	This fun little function fills up some WordPress globals with dummy data to stop your average page template from complaining about it missing.
bp-forums/core/functions.php: bbp_register_view()	Register a Forums view
bp-forums/core/functions.php: bbp_view_query()	Run the view’s query
bp-forums/templates/default/bbpress-functions.php: BBP_Default::__construct()	The main Forums (Default) Loader
bp-forums/topics/template.php: bbp_get_topic_tag_description()	Return the description of the current tag
bp-forums/topics/template.php: bbp_get_form_topic_status_dropdown()	Returns topic status downdown
bp-forums/topics/template.php: bbp_get_form_topic_type_dropdown()	Returns topic type select box (normal/sticky/super sticky)
bp-forums/topics/template.php: bbp_get_topic_reply_link()	Return the link to go directly to the reply form
bp-forums/topics/template.php: bbp_get_topic_trash_link()	Return the trash link of the topic
bp-forums/topics/template.php: bbp_get_topic_close_link()	Return the close link of the topic
bp-forums/topics/template.php: bbp_get_topic_stick_link()	Return the stick link of the topic
bp-forums/topics/template.php: bbp_get_topic_merge_link()	Return the merge link of the topic
bp-forums/topics/template.php: bbp_get_topic_spam_link()	Return the spam link of the topic
bp-forums/topics/template.php: bbp_get_topic_edit_link()	Return the edit link of the topic
bp-forums/topics/template.php: bbp_get_topic_tag_list()	Return the tags of a topic
bp-forums/topics/template.php: bbp_get_topic_admin_links()	Return admin links for topic.
bp-forums/topics/template.php: bbp_get_topic_subscription_link()	Get the forum subscription link
bp-forums/topics/template.php: bbp_get_topic_favorite_link()	Get the forum favorite link
bp-forums/topics/template.php: bbp_get_topic_author_link()	Return the author link of the topic
bp-forums/topics/template.php: bbp_get_topic_author_role()	Return the topic author role
bp-forums/topics/template.php: bbp_get_topic_pagination()	Returns pagination links of a topic within the topic loop
bp-forums/topics/template.php: bbp_has_topics()	The main topic loop. WordPress makes this easy for us
bp-forums/topics/functions.php: bbp_update_topic_revision_log()	Update the revision log of the topic
bp-forums/topics/functions.php: bbp_update_topic()	Handle all the extra meta stuff from posting a new topic
bp-forums/topics/functions.php: bbp_insert_topic()	A wrapper for wp_insert_post() that also includes the necessary meta values for the topic to function properly.
bp-forums/users/template.php: bbp_get_forums_for_current_user()	Get the forums the current user has the ability to see and post to
bp-forums/users/template.php: bbp_get_author_link()	Return the author link of the post
bp-forums/users/template.php: bbp_user_can_view_forum()	Check if the user can access a specific forum
bp-forums/users/template.php: bbp_get_user_subscribe_link()	Return the link to subscribe/unsubscribe from a forum or topic
bp-forums/users/template.php: bbp_get_user_favorites_link()	User favorites link
bp-forums/users/template.php: bbp_get_admin_link()	Return the link to the admin section
bp-forums/users/template.php: bbp_get_author_ip()	Return the author IP address of a post
bp-forums/users/template.php: bbp_get_user_nicename()	Return a users nicename to the screen
bp-forums/forums/template.php: bbp_get_form_forum_type_dropdown()	Return the forum type dropdown
bp-forums/forums/template.php: bbp_get_form_forum_status_dropdown()	Return the forum status dropdown
bp-forums/forums/template.php: bbp_get_form_forum_visibility_dropdown()	Return the forum visibility dropdown
bp-forums/forums/template.php: bbp_list_forums()	Output a list of forums (can be used to list subforums)
bp-forums/forums/template.php: bbp_get_forum_subscription_link()	Get the forum subscription link
bp-forums/forums/template.php: bbp_forum_get_subforums()	Return subforums of given forum
bp-forums/forums/template.php: bbp_has_forums()	The main forum loop.
bp-forums/forums/functions.php: bbp_update_forum()	Updates the counts of a forum.
bp-forums/forums/functions.php: bbp_insert_forum()	A wrapper for wp_insert_post() that also includes the necessary meta values for the forum to function properly.
bp-forums/common/widgets.php: BBP_Stats_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/widgets.php: BBP_Replies_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/widgets.php: BBP_Search_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/widgets.php: BBP_Forums_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/widgets.php: BBP_Topics_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/widgets.php: BBP_Login_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/widgets.php: BBP_Views_Widget::parse_settings()	Merge the widget settings into defaults array.
bp-forums/common/template.php: bbp_title()	Custom page title for Forums pages
bp-forums/common/template.php: bbp_get_breadcrumb()	Return a breadcrumb ( forum -> topic -> reply )
bp-forums/common/template.php: bbp_get_the_content()	Return a textarea or TinyMCE if enabled
bp-forums/common/template.php: bbp_get_wp_login_action()	Return the login form action url
bp-forums/common/template.php: bbp_get_dropdown()	Output a select box allowing to pick which forum/topic a new topic/reply belongs in.
bp-forums/common/functions.php: bbp_get_statistics()	Get the forum statistics
bp-forums/common/functions.php: bbp_filter_anonymous_post_data()	Filter anonymous post data
bp-forums/common/functions.php: bbp_check_for_duplicate()	Check for duplicate topics/replies
bp-forums/activity.php: BBP_BuddyPress_Activity::record_activity()	Wrapper for recoding Forums actions to the BuddyBoss activity stream
bp-forums/activity.php: BBP_BuddyPress_Activity::delete_activity()	Wrapper for deleting Forums actions from BuddyBoss activity stream
bp-forums/replies/template.php: bbp_get_topic_split_link()	Get split topic link
bp-forums/replies/template.php: bbp_get_reply_edit_link()	Return the edit link of the reply
bp-forums/replies/template.php: bbp_get_reply_trash_link()	Return the trash link of the reply
bp-forums/replies/template.php: bbp_get_reply_spam_link()	Return the spam link of the reply
bp-forums/replies/template.php: bbp_get_reply_move_link()	Get move reply link
bp-forums/replies/template.php: bbp_get_reply_to_link()	Return the link for a reply to a reply
bp-forums/replies/template.php: bbp_get_reply_admin_links()	Return admin links for reply
bp-forums/replies/template.php: bbp_get_reply_author_role()	Return the reply author role
bp-forums/replies/template.php: bbp_get_reply_author_link()	Return the author link of the reply
bp-forums/replies/template.php: bbp_has_replies()	The main reply loop. WordPress makes this easy for us
bp-forums/replies/functions.php: bbp_list_replies()	List replies
bp-forums/replies/functions.php: bbp_update_reply()	Handle all the extra meta stuff from posting a new reply or editing a reply
bp-forums/replies/functions.php: bbp_update_reply_revision_log()	Update the revision log of the reply
bp-forums/replies/functions.php: bbp_insert_reply()	A wrapper for wp_insert_post() that also includes the necessary meta values for the reply to function properly.
bp-forums/search/functions.php: bbp_search_query()	Run the search query
bp-forums/search/template.php: bbp_has_search_results()	The main search loop. WordPress does the heavy lifting.
bp-core/deprecated/buddyboss/1.0.php: bbp_get_single_topic_description()	Return a fancy description of the current topic, including total topics, total replies, and last activity.
bp-core/deprecated/buddyboss/1.0.php: bbp_get_single_forum_description()	Return a fancy description of the current forum, including total topics, total replies, and last activity.

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