wp_parse_args() WP 1.0

Merge 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.

No Hooks.

Return

Array. Merged user defined values with defaults.

Usage

wp_parse_args( $args, $defaults );

$args(string/array/object) (required)

Value to merge with $defaults.

$defaults(array)

Array that serves as the defaults.
Default: ''

Changelog

Code of wp parse args: wp-includes/functions.php ^{WP 5.4.1}

<?php
function wp_parse_args( $args, $defaults = '' ) {
	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 ) ) {
		return array_merge( $defaults, $parsed_args );
	}
	return $parsed_args;
}

Related Functions

From category: Helper Functions