plugin_basename()

Définition : plugin_basename() transforme le chemin d’un fichier de plugin en chemin relatif au dossier des extensions WordPress. Son résultat permet d’identifier une extension dans diverses API de gestion et de filtrage.

Terminologie

Terme officiel : plugin_basename()

Autres appellations : Nom de base du plugin

À quoi cela sert

Cette fonction fournit un identifiant relatif exploitable pour désigner le fichier principal d’une extension. Elle évite de stocker un chemin absolu propre à un serveur, mais ne renvoie pas une URL publique.

Comment cela fonctionne

Elle normalise le chemin puis en retire le préfixe correspondant au répertoire des extensions pris en charge. Un fichier principal peut produire une valeur comme mon-plugin/mon-plugin.php. Le nom exact dépend de la position du fichier fourni.

Dans quel contexte l’utiliser

À utiliser lorsqu’une API attend le chemin relatif du plugin ou pour filtrer son lien d’action dans la liste des extensions.

Exemple concret

Un plugin ajoute un lien d’aide à son propre élément dans la page Extensions sans modifier ceux des autres plugins.

Exemple de code commenté

<?php
// Dans le fichier principal du plugin.
$atoolpha_basename = plugin_basename( __FILE__ );
add_filter( 'plugin_action_links_' . $atoolpha_basename,
    function ( $links ) {
        $links[] = '<a href="' . esc_url( admin_url( 'options-general.php' ) ) . '">Réglages</a>';
        return $links;
    }
);

Explication pas à pas de l’exemple

Le basename sert à composer le nom de filtre spécifique à ce plugin. Le callback ajoute un lien d’administration échappé. Cet exemple renvoie à la page générale des réglages, et non à une page créée par l’extension.

Résultat attendu

Seule l’entrée du plugin qui correspond au basename est enrichie d’un lien Réglages dans la liste des extensions.

Précautions et limites

Le chemin relatif ne garantit pas qu’un fichier existe. Exécuter ce calcul pour le fichier réellement visé et ne pas substituer plugin_basename() aux fonctions de chemin disque.