Utiliser l’API Endpoint pour créer une règle de réécriture d’url simple

Le Endpoint

Il n’est pas rare de vouloir créer une règle de réécriture simple et efficace sans avoir à la créer soit même, à tout penser etc…

C’est pour cela que WordPress propose l’endpoint qui fait partie de l’API de rewriting.

Comment l’utiliser ?

C’est vraiment une API très simple à utiliser, prenons l’exemple suivant :

« Je veux ajouter à la fin des liens de mes articles un paramètre qui va afficher la vidéo de l’article associée dans un champ méta ».

Alors comme ça, ça parait compliqué, mais en fait non ! Quelques lignes de code suffiront à le faire. Elles peuvent être ajoutées dans le fichier function.php du thème mais aussi dans un plugin.

Ajouter le Endpoint

Pour ajouter un endpoint, c’est tout simple, il suffit d’appeler la fonction add_rewrite_endpoint avec en premier paramètre le nom du endpoint et en deuxième paramètre les cas où WordPress va réécrire et ajouter le endpoint.
Le deuxième paramètre utilise des variables définies au sein de WordPress, vous avez accès à :

• EP_PERMALINK
• EP_ATTACHMENT
• EP_DATE
• EP_YEAR
• EP_MONTH
• EP_DAY
• EP_ROOT
• EP_COMMENTS
• EP_SEARCH
• EP_CATEGORIES
• EP_TAGS
• EP_AUTHORS
• EP_PAGES
• EP_ALL

[pastacode provider= »manual » lang= »php »]

add_action( 'init', 'add_video_endpoint' );
function add_video_endpoint() {
// J'ajoute un endpoint nommé vidéo à la fin des liens de mes articles
add_rewrite_endpoint( 'video', EP_PERMALINK );
}

[/pastacode]

C’est donc en créant des liens du type monsite.fr/chemin_vers_larticle/video/small que WordPress va réécrire et interpréter notre endpoint.

Utiliser le endpoint

Disons que nous voulons afficher la vidéo seule, et dans un template dédié.

Il faut commencer par détecter que le endpoint est actif et puis l’utiliser à son avantage.

[pastacode provider= »manual » lang= »php »]

add_action( 'parse_query', 'video_endpoint_parse_query' );

function video_endpoint_parse_query( $query ){
// Si je détecte dans nos query vars la vidéo et que la vlauer dans la query vars est small,medium ou marge
if( isset( $query->query_vars['video'] ) && in_array( $query->query_vars['video'], array( 'small', 'medium', 'large' ) ) ) {
// J'ajoute mon action au moment du template redirect
add_action( 'template_redirect', 'video_endpoint_template_loader' );
}
}

function video_endpoint_template_loader() {
global $wp_query;
// Récupérons le slug de la vidéo ( déjà vérifié plus haut )
$slug = $wp_query->query_vars['video'];
// Créons le nom du template à utiliser
$templates = array(
'single-video-'.$slug.'.php',
'single-video.php',
'single.php'
);
// Localisons le template
locate_template( $templates, true );
// Terminons tout ça :)
exit();
}

[/pastacode]

Donc là nous avons tout simplement détecté la présence de notre endpoint et vérifié qu’il soit renseigné comme nous l’attendions ( ici small, medium ou large ).

Puis nous avons ajouté une action lors du template_redirect et demandé le template correspondant au slug détecté plus haut. Donc les templates chargés peuvent être :

• single-video-small.php
• single-video-medium.php
• single-video-larger.php
• single-video.php si ceux-ci n’existent pas !
• Finalement single.php si aucun de ces templates ne sont trouvés

Et là on peut faire ce que l’on veut dans notre template, avoir une présentation spéciale, demander d’être connecté avant de continuer etc..

Conclusion

L’API des endpoint peut être très facilement utilisée et surtout dans des petits cas pratiques comme celui-ci. Afficher une mise en page pour l’impression, afficher l’article avec une présentation spéciale etc…
Elle est très rapide à mettre en place et il ne faut pas perdre de vue qu’elle reste très limitée, il va falloir ajouter les règles de réécriture à la main dans WordPress pour des cas plus compliqués, mais ce sera sûrement l’objet d’un autre article ;).