get_query_var( string $var, mixed $default = '' )
Retourne la valeur d'une variable de requête dans la class WP_Query
.
Description
Cette fonction ne retourne que les variables de requête publique qui sont reconnues par WP_Query. Cela signifie que si vous créer vos propres urls avec leurs propres variables de requête il faudra adapter une autre solution pour recevoir ces variables.
Variables de requête personnalisées
Pour ajouter de nouvelles variables à une url (ex : http://mysite.com/some_page/?my_var=foo), utiliser la fonction add_query_arg()
.
Pour autoriser et ajouter ces variables on peut utiliser le filtre 'query_vars' qui est lancé avant que les propriétés de variables ne soient générées dans WP_Query :
function themeslug_query_vars( $qvars ) {
$qvars[] = 'custom_query_var';
return $qvars;
}
add_filter( 'query_vars', 'themeslug_query_vars' );
Paramètres
$var
(string) (Requis) Clé de la variable à retourner.
$default
(mixed) (Optionnel) Valeur à retourner si la variable de requête n'est pas réglée.
Valeur par défaut : ''
Retourne
(mixed) Contenu de la variable de requête.
Structure de la fonction get_query_var()
Définie dans le fichier wp-includes/query.php à la ligne 26 :
function get_query_var( $var, $default = '' ) {
global $wp_query;
return $wp_query->get( $var, $default );
}
Où trouver la fonction get_query_var()
dans le CMS Wordpress
Exemples
Sources
Codex Wordpress : get_query_var()
Autres fonctions dans le même fichier : wp-includes/query.php