wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_parse_args › WordPress Function

Since2.2.0
Deprecatedn/a
› wp_parse_args ( $args, $defaults = array() )
Parameters: (2)
  • (string|array<string,mixed>|object) $args Value to merge with $defaults.
    Required: Yes
  • (array<string,mixed>) $defaults Optional. Array that serves as the defaults. Default empty array.
    Required: No
    Default: array()
Returns:
  • (array<string,mixed>) Merged user defined values with defaults.
Defined at:
Codex:
Change Log:
  • 2.3.0

Merges user defined arguments into defaults array.

This function is used throughout WordPress to allow for both string or array to be merged into another array. The keys of the returned array are documented as strings, since that is what callers mean by them, but they are not promised as such to static analysis. Integer keys remain reachable through arguments that are perfectly valid: json_decode( '{"0":"a"}' ) is an object whose properties get_object_vars() reports under an integer key, and parse_str() reads 0=a as one as well.


Related Functions: wp_parse_str, wp_parse_url, wp_parse_list, wp_parse_id_list, wp_paused_plugins

Source 

function wp_parse_args( $args, $defaults = array() ): array {
	if ( is_object( $args ) ) {
		$parsed_args = get_object_vars( $args );
	} elseif ( is_array( $args ) ) {
		$parsed_args =& $args;
	} else {
		wp_parse_str( $args, $parsed_args );
	}

	if ( is_array( $defaults ) && $defaults ) {
		return array_merge( $defaults, $parsed_args );
	}
	return $parsed_args;
}