wp_parse_args( string|array|object $args, array $defaults = array() )

Fusionne des arguments définis par l'utilisateur dans un tableau par défaut.

Paramètres

$args(string|array|object)requis

Valeur à fusionner avec $defaults.

$defaults(array)optionnel

Tableau par défaut.

Valeur par défaut : array()

Description / Informations supplémentaires

Cette fonction est utilisée à travers WordPress pour permettre à une chaîne ou à un tableau d'être fusionnés dans un autre tableau.

$args peut aussi être de type requête URL qui sera convertie en tableau et stockée dans $array.

Retourne

(array) Valeurs définies par l'utilisateur fusionnées à celles par défaut.

Déclaration et structure de la fonction wp_parse_args()

function wp_parse_args( $args, $defaults = 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;
}
wp_parse_str()

Parse une chaîne en variables pour être stockée dans un tableau.

Où est utilisée la fonction wp_parse_args() dans le CMS WordPress

Exemple

function wpdocs_ma_function( $args ) {
 
  $defaults = array(
    'name' => 'Mr. nobody',
    'favorite_color' => 'inconnue',
    'age' => 'inconnu',
  );
 
  $args = wp_parse_args( $args, $defaults );
 
  print_r( $args );
}
 
$args = array( 'age' => 36 );
wpdocs_ma_function( $args );
// Affiche : Array(
//   'name' => 'Mr. nobody',
//   'favorite_color' => 'inconnue',
//   'age' => 36,
// )

Sources

Codex WordPress : wp_parse_args()

Autres fonctions dans le même fichier : wp-includes/functions.php

Retour