get_query_var( string $var, mixed $default = '' )

Retourne la valeur d'une variable de requête dans la class WP_Query.

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 : ''

Description / Informations supplémentaires

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 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' );

Retourne

(mixed) Contenu de la variable de requête.

Déclaration et structure de la fonction get_query_var()

function get_query_var( $query_var, $default_value = '' ) {
    global $wp_query;
    return $wp_query->get( $query_var, $default_value );
}

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

Exemples

Obtenir le numéro de pagination de la page actuelle :
$paged = get_query_var( 'paged', 1 );
Pour le numéro de pagination d'une pages statique en page d'accueil (modèle de page) :
$paged = get_query_var( 'page', 1 );

Sources

Codex WordPress : get_query_var()

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

Retour