Aller au contenu principal
Version: 0.6.3

Plugin

Représente une extension Wordpress afin de pouvoir récupérer facilement des informations et surtout intéragir avec notamment dans la page des extensions.

Cette façade est notamment utilisé dans le fichier principale du plugin pour définir un updater ou des icônes. C'est également à cette endroit que l'on va utiliser les méthodes : onActivation, onCompletedUpdate par exemple.

plugins/my-plugin.php
$plugin = $kernel->getPlugin(__DIR__);
$plugin
    ->defineUpdater(new Gitlab(
        repo: 'chemin/du/repo',
        accessToken: "mon_access_token", // Si le projet est privée
        url: "https://selfhosted.gitlab.com" // Si votre gitlab est auto hébergé.
    ));

Méthodes​

updateRowMeta(string|callable $html)​

Ajoute du html dans la ligne du plugin dans la liste des extensions. Si il s'agit d'une fonction qui est passé en paramètre, elle doit retourner une chaîne de caractère.

Désactive la possibilité de désactive le plugin.

manageActionLinks(string $actionName, callable $actionCallback, bool $unset = false)​

Gère les liens d'actions, notamment pour ajouter des liens personnalisés.

addPluginNotice(string|callable $content, string $type = 'warning')​

Ajoute une alerte notice au sein de la ligne de l'extension dans la liste.

setIcons(array $icons)​

Définir un icône pour le plugin. Clé accepté : 1x, 2x, svg. Chacune prend l'URL vers l'icône en valeur.

onActivation(callable $callback)​

Execute du code après l'activation du plugin.

onDeactivation(callable $callback)​

Execute du code après la désactivation du plugin.

onCompletedUpdate(callable $callback)​

Execute du code après la mise à jour du plugin.

defineUpdater(GitInferface $git)​

Défini un updater pour le plugin. Pour le moment, uniquement Gitlab existe.