Fonction PHP add_rewrite_var() : Tout ce que vous devez savoir

En tant que développeur WordPress, vous devrez peut-être enregistrer une variable de requête personnalisée à utiliser avec les règles de réécriture. La fonction add_rewrite_var() est une fonction de l'API WordPress qui vous permet d'ajouter une nouvelle variable de requête à la liste des variables de requête de réécriture reconnues. Dans cet article, nous examinerons en profondeur la fonction add_rewrite_var() et son utilisation.

Qu'est-ce que la fonction add_rewrite_var() ?

La fonction add_rewrite_var() est une fonction WordPress qui enregistre une variable de requête personnalisée. Cela rend la variable disponible pour une utilisation dans les règles de réécriture WordPress et l'analyse des requêtes.

Comment utiliser la fonction add_rewrite_var()

L'utilisation de la fonction add_rewrite_var() est simple. Elle accepte un seul paramètre : le nom de la variable de requête. Voici la syntaxe :

Syntaxe

add_rewrite_var( string $name ): void

Comme WordPress charge les fonctions tôt dans le cycle de vie de la requête, vous appelez généralement cette fonction à l'intérieur d'une fonction de rappel liée à l'action init. Voici un exemple d'utilisation correct :

Exemple

function my_custom_query_var() {
    add_rewrite_var( 'my_custom_var' );
}
add_action( 'init', 'my_custom_query_var' );

Dans cet exemple, nous enregistrons une nouvelle variable de requête nommée my_custom_var. Une fois enregistrée, vous pouvez accéder à sa valeur dans votre thème ou votre plugin en utilisant get_query_var( 'my_custom_var' ).

Conclusion

La fonction add_rewrite_var() est un outil WordPress utile pour enregistrer des variables de requête personnalisées pour les règles de réécriture. En comprenant sa syntaxe à un seul paramètre et les bonnes pratiques d'accrochage, vous pouvez facilement étendre l'analyse des requêtes WordPress. Nous espérons que cet article vous a été informatif et utile pour comprendre la fonction add_rewrite_var().

Pratique