WP_Query::get()

Définition : WP_Query::get() est une méthode qui lit la valeur d’une variable enregistrée dans une instance WP_Query. Elle permet d’inspecter les paramètres d’une recherche sans récupérer directement le contenu d’une publication.

Terminologie

Appellation / équivalent : WP_Query::get — lecture d’une variable de requête

Autres appellations : Lecture de paramètre WP_Query, Query variable getter

Comprendre le fonctionnement

Chaque objet WP_Query contient un ensemble de variables qui décrivent la recherche, telles que posts_per_page, post_type ou certaines conditions d’archive. La méthode get() retourne la valeur de la variable demandée, ou la valeur de repli indiquée lorsqu’elle n’existe pas.

Elle est souvent utilisée dans les callbacks de pre_get_posts pour examiner la requête qui va être exécutée. Pour modifier un paramètre, il existe la méthode set(). Il ne faut pas confondre WP_Query::get() avec get_post_meta(), get_option() ou la fonction globale get_query_var(), qui ne consultent pas exactement la même source.

Exemple concret

Un gestionnaire d’extension lit posts_per_page avant de décider s’il doit modifier la taille de la requête principale.

Exemple de code commenté

<?php
// Dans le callback pre_get_posts, l'objet $query est fourni par WP.
add_action( 'pre_get_posts', function ( $query ) {
    if ( is_admin() || ! $query->is_main_query() ) {
        return;
    }
    $limite = $query->get( 'posts_per_page' );
    // $limite contient la valeur courante du paramètre demandé.
} );