La fonction wp_parse_args() (comme beaucoup d'autres sans-papiers) délivrer une chaîne au format suivant:
1 | var1 = valeur1 & var2 = valeur2 ... Varn = valeurN |
C'est un très répandue dans les fonctions de WordPress et est utile quand une fonction prend en charge paramteri multiples. Comme mentionné sujets et des variables par défaut en Javascript, Actionscript et PHP , il n'est pas nécessaire de passer des paramètres dans le mode de var1=value1&var2=value2...varn=valuen , puisque PHP est capable de gérer en toute sécurité passer des paramètres variables.
Synopsis
1 2 3 4 5 6 7 8 9 10 11 12 | / ** * Fusion de l'utilisateur défini des arguments dans un tableau par défaut. * * Cette fonction est utilisée tout au long de WordPress pour permettre chaîne ou un tableau deux * Pour être fusionnés dans un autre tableau. * * @ Depuis 2.2.0 * * @ Param (string | array) $ args Valeur de fusionner avec $ par défaut * @ Param (array) $ array par défaut qui sert les valeurs par défaut. * @ Return (array) Fusionné définis par l'utilisateur des valeurs à des défaillances. * / |
En fait, le premier paramètre peut aussi être un objet. Si l'on passe une corde avec des valeurs séparées par ampersen, la fonction est appelée de niveau inférieur WordPress wp_parse_str()
Exemple
Afin de clarifier le fonctionnement, nous voyons un exemple. . Imaginez avoir à écrire une fonction ( myFunc() ) qui prend en charge trois paramètres optionnels: par1, par2 e par3 . La déclaration sera bien sûr:
1 | $args ) { } function maFonction ($ args) {} |
Où est notre chaîne $ args dans le format:
1 | var1 = valeur1 & var2 = valeur2 ... Varn = valeurN |
Un appel pourrait être:
1 | ) ; maFonction ("PAR3 & par1 = bonjour = bonjour"); |
J'ai volontairement mis les paramètres dans n'importe quel ordre, une autre caractéristique qui le rend polyvalent. Voyons comment le travail de manière wp_parse_args() :
1 2 3 4 5 6 7 | $args ) { function maFonction ($ args) { wp_parse_args ( $args ) ; New_args wp_parse_args = $ ($ args); / / [ "par1" ] ; echo $ new_args ["PAR1"]; [ "par2" ] ; echo $ new_args ["par2"]; [ "par3" ] ; echo $ new_args ["PAR3"]; } |
non è impostato! Appeler notre fonction myFunc( "par3=ciao&par1=salve" ); constater que par2 n'est pas réglé! Et c'est pourquoi le second paramètre de la fonction wp_parse_args() :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | $args ) { function maFonction ($ args) { array ( "par1" => "salve" , Par défaut = $ array ("PAR1" => "Bonjour" "come" , "PAR2" => "comment" "va?" ) ; "PAR3" => "mal?"); / / wp_parse_args ( $args , $default ) ; New_args wp_parse_args = $ ($ args, $ defauts); / / [ "par1" ] ; echo $ new_args ["PAR1"]; [ "par2" ] ; echo $ new_args ["par2"]; [ "par3" ] ; echo $ new_args ["PAR3"]; } / / ) ; maFonction ("PAR3 = vous êtes-vous = & PAR1"); / / Nous / / Vous / / Comme / / Tu es |
La commodité de cette approche est la possibilité de valeurs par défaut prédéfinies qui sont utilisés quand il n'est pas dans la chaîne passée comme premier paramètre.
Pourquoi utiliser wp_parse_args ()
e array_merge() . Tout cela ne serait possible sans l'aide wp_parse_args() que PHP fournit déjà toutes les fonctions pour faire ce travail, voir par exemple: parse_str() et array_merge() . Utilisez wp_parse_args() devrait principalement pour 2 raisons:
- gère pour nous le passage d'un objet, un tableau ou une chaîne
- son comportement est modifié à travers les filtres de WordPress: voir apply_filters ()
[...] Lire la source de cet article: WordPress: wp_parse_args () | Auteur Undolog.com: [...]
[...] Voir l'article original encore: WordPress: wp_parse_args () | Auteur Undolog.com: [...]
[...] Pour WordPress comme nous avons vu: wp_parse_args (), la gestion des attributs est très simple et vous permet de définir des valeurs par défaut dans [...]
mise à jour: WordPress a mis à jour la documentation de cette fonction.