WordPress 6.5 prend désormais en charge les dépendances des plugins, ce qui permet aux développeurs de gérer plus facilement les relations entre les plugins.

WordPress 6.5 Il est maintenant possible de créer des dépendances entre les plugins.

L'extensibilité de WordPress est l'une de ses caractéristiques les plus utiles, et il y parvient grâce aux plugins et à l'API Hooks. De nombreux plugins sont construits au-dessus d'autres plugins afin d'étendre leurs fonctionnalités. L'objectif de la fonctionnalité de dépendance des plugins est de rendre le processus d'installation et d'activation des plugins étendus et des plugins dont ils dépendent cohérent et simple.

Nouvel en-tête de plug-in

Un nouvel en-tête "Requires Plugins" est maintenant introduit. Cet en-tête doit contenir une liste d'alias de plugins, séparés par des virgules et formatés par WordPress.org, listant les autres plugins dont le plugin dépend. Par exemple, le format devrait ressembler à ceci : my-plugin, another-plugin. Notez que la liste des alias ne peut pas contenir le chemin vers le fichier principal du plugin, seulement l'alias du plugin.

Comment utiliser le nouvel en-tête

Il suffit d'ajouter un nouvel élément dans l'en-tête du plugin avec le nom "Requires Plugins".

demande

en ce qui concernePlug-ins de dépendanceavec les exigences suivantes :

1. Avant d'installer le plugin, ses dépendances doivent être installées.
2. Avant d'activer un plugin, ses dépendances doivent être activées.

Plugins dépendants

Pour les plugins dépendants, les conditions suivantes sont requises :

1. Il n'est pas possible de désactiver les plugins dépendants lorsque leurs dépendances sont activées.
2. Après avoir installé ses dépendances, il n'est pas possible de les supprimer.

Que se passe-t-il si la dépendance n'est plus satisfaite ?

Si vous supprimez un plugin dépendant via FTP ou d'autres moyens, la page d'administration de WordPress affichera une notification vous rappelant que vous devez installer et/ou activer le plugin dépendant associé. En outre, une notification d'erreur sera affichée sur la ligne du plugin pour chaque dépendance, vous avertissant qu'un plugin ne fonctionne pas correctement parce que ses dépendances ont été supprimées.

Que se passe-t-il si la mise à jour d'un plugin comporte de nouvelles dépendances ?

Pour l'instant, vous pouvez continuer à mettre à jour les plugins même s'ils ont des dépendances, et ces dépendances resteront actives. Lorsque vous opérez sur la page Gérer les plugins, vous recevrez une notification vous rappelant que vous devez installer et/ou activer les dépendances concernées.

Que se passe-t-il en cas de dépendance circulaire ?

Une dépendance circulaire est une boucle formée entre deux ou plusieurs plugins qui dépendent l'un de l'autre, ce qui entraîne une relation d'exigence peu claire entre les plugins.

Par exemple, le plugin A a besoin du plugin B, le plugin B a besoin du plugin C et le plugin C a besoin du plugin A.

La fonction "Plugin Dependencies" permet de détecter les dépendances circulaires et d'afficher une notification à l'utilisateur l'avertissant qu'il existe des besoins non satisfaits entre les plugins. Cela signifie que ces plugins ne peuvent pas être activés. Les utilisateurs doivent contacter les auteurs des plugins pour qu'ils résolvent ces références circulaires si nécessaire.

Le codage défensif est-il encore nécessaire ?

OUI. La fonction de dépendance des plugins permet aux utilisateurs d'installer et d'activer plus facilement les plugins dont ils ont besoin et les avertit lorsqu'ils sont manquants. Cela signifie que les auteurs de plugins peuvent supprimer en toute sécurité les fonctions de vérification et de notification lorsque les utilisateurs n'installent pas ou n'activent pas les plugins dont ils ont besoin.
Cependant, actuellement, la fonction de dépendance des plugins n'inclut pas de version minimale ou maximale pour les plugins dépendants, et ne prend pas en compte l'ordre dans lequel les plugins sont chargés. Par conséquent, les auteurs de plugins doivent continuer à utiliser l'option fonction|classe|interface_exists() et la vérification des versions pour s'assurer que leurs plugins fonctionnent correctement lorsqu'une fonctionnalité spécifique est disponible, même si les plugins dont ils dépendent ne sont pas disponibles au moment du chargement.

Les dépendances des plugins affectent-elles WP-CLI ?

La fonctionnalité "Plugin Dependencies" n'empêche pas l'installation de plugins dépendants sans dépendances via WP-CLI, car il est supposé que les utilisateurs utilisant WP-CLI sont des utilisateurs avancés qui comprennent les dépendances des plugins. Cependant, pour éviter que les dépendances soient perdues et ignorées, WP-CLI ne peut pas activer les plugins dépendants tant que les dépendances ne sont pas activées.

Cela peut affecter la commande wp plugin activate -all, qui peut devoir être exécutée plusieurs fois si des dépendances apparaissent avant les siennes. Nous prévoyons de travailler avec les responsables de WP-CLI pour explorer les moyens d'alléger ce fardeau en ajustant l'ordre de chargement du noyau de WordPress, de WP-CLI, ou des deux.

limitations

Plugins hébergés sur WordPress.org

Les plugins hébergés sur WordPress.org ne peuvent déclarer des dépendances qu'avec des plugins également hébergés sur WordPress.org. Si votre plugin doit dépendre d'un plugin qui n'est pas hébergé sur WordPress.org, il est recommandé de ne pas utiliser "Nécessite des plugins"Marqueur.

Le plugin n'est pas hébergé sur WordPress.org

Les plugins de dépendances qui ne sont pas hébergés sur WordPress.org peuvent déclarer leurs dépendances, que ces dépendances soient hébergées sur WordPress.org ou ailleurs. Cependant, veuillez noter que les utilisateurs ne seront pas en mesure de trouver des liens d'installation pour les dépendances tierces dans l'interface utilisateur, ce qui signifie que les utilisateurs devront installer ces dépendances manuellement.

Doit utiliser des plugins comme dépendances

Actuellement, le noyau de WordPress ne supporte pas officiellement les plugins indispensables en tant que dépendances. Nous allons ajouter un nouveau plugin à la liste des plugins de la catégorie#60504La question continuera d'être discutée dans le rapport et de plus amples informations seront communiquées lorsqu'une décision sera prise concernant un éventuel soutien futur.

Thèmes nécessitant des plugins

Actuellement, les dépendances des plugins ne prennent pas encore en charge les plugins requis par le thème. Par conséquent, les auteurs de thèmes doivent continuer à utiliser les contrôles et les méthodes de messagerie qu'ils ont déjà mis en place.

Nouveaux filtres

Nous avons introduit un fichier appelé wp_plugin_dependencies_slug qui permet de modifier les dépendances du plugin. Par exemple, si une déclaration de plugin dépend de l'élément mon-pluginet il existe une version avancée de l'outil mon-pluginLa version avancée peut ensuite être filtrée par slug en le convertissant en mon-plugin-proafin que le plugin puisse détecter de nouvelles dépendances.

Paramètres :

• chaîne $slug: Alias.

exemple d'utilisation

Modifications de l'interface utilisateur

Plugins > Plugins installés

Nous avons apporté les modifications suivantes aux lignes de dépendance du plugin :

1. La ligne Dépendance du plugin contient désormais une liste des dépendances requises et fournit des liens vers les pages correspondantes du plugin afin que les utilisateurs puissent les installer et les activer.
2. Si le plugin a des dépendances désinstallées et inactives, le lien "Activer" sera désactivé pour éviter les erreurs d'utilisation.
3. Si les plugins dépendants du plugin sont actifs, les liens Désactiver et Supprimer seront désactivés pour s'assurer que les plugins dépendants restent actifs.
4. Pour les opérations par lots qui dépendent de plugins, cette fonction est désormais désactivée afin d'éviter des situations potentiellement confuses.

à l'avance

impératrice

Plugins > Ajouter un nouveau plugin

Nous avons apporté les modifications suivantes :

1. Si le plugin a des dépendances non satisfaites, les boutons Installer maintenant et Activer dans la fiche du plugin et le module d'information sur le plugin seront désactivés. Cela empêche l'utilisateur de tenter d'installer ou d'activer le plugin tant que toutes ses dépendances ne sont pas satisfaites.
2. La Dependency Plugin Card affiche désormais une notification listant ses dépendances et fournissant un lien "More Details" vers la page Dependency Information. Les utilisateurs peuvent utiliser ce lien pour en savoir plus sur la dépendance et peuvent "Installer maintenant" ou "Activer" directement à partir de cette page.
3. Le module d'information sur les plugins reste désormais ouvert lorsque l'on clique sur le bouton, et les utilisateurs peuvent procéder à l'installation et à l'activation des plugins à l'aide d'AJAX directement depuis le module, sans quitter la page en cours.

à l'avance

impératrice

Pour commencer

Grâce à l'approche AJAX unifiée désormais utilisée sur l'écran Plugins > Ajouter un nouveau, l'activation d'un plugin ne redirige plus automatiquement l'utilisateur vers l'écran Plugins > Plugins installés ou vers la page Getting Started conçue par l'auteur du plugin. Cela signifie que les utilisateurs peuvent installer et activer plusieurs plugins sans quitter leur contexte actuel.

Généralement, les plugins avec une expérience de démarrage incluent une sorte de mécanisme de vérification. Par exemple, si l'utilisateur installe et active le plugin via WP-CLI, l'expérience de démarrage est déclenchée lorsque l'utilisateur entre dans l'un des écrans de configuration du plugin. Cette implémentation est indépendante des dépendances du plugin, et l'utilisateur peut également activer le plugin via le lien d'activation sur l'écran Plugins > Installed Plugins.

renouveléWP_Plugin_Dependenciesressembler

WP_Plugin_Dependencies Une nouvelle classe est introduite.

Les méthodes API publiques suivantes sont disponibles :

• méthode statique initialisation() Initialise les dépendances du plugin en lisant l'en-tête "Requires Plugins" du plugin et en récupérant les données de l'API qui dépendent du plugin. Chaque exécution n'a lieu qu'une seule fois.

• méthode statique has_dependents( $plugin_file ) Détermine si un plugin particulier a d'autres plugins qui en dépendent.

Paramètres :

• $plugin_file: Chemin d'accès au fichier du plugin, relatif au répertoire du plugin.

Valeur de retour :

• bool: Un booléen indiquant si le plugin a d'autres plugins qui dépendent de lui.

• méthode statique has_dependencies( $plugin_file ): Permet de déterminer si un plugin particulier a d'autres plugins comme dépendances.

Paramètres :

• $plugin_file: Chemin d'accès au fichier du plugin, relatif au répertoire du plugin.

Valeur de retour :

• bool: valeur booléenne indiquant si le plugin a d'autres plugins comme dépendances.
  

• méthode statique has_active_dependents( $plugin_file ): Permet de déterminer si un plugin particulier a d'autres plugins activés en tant que dépendances.

Paramètres :

• $plugin_file: Chemin d'accès au fichier du plugin, relatif au répertoire du plugin.

Valeur de retour :

• boolValeur booléenne indiquant si le plugin a d'autres plugins activés en tant que dépendances.

• méthode statique get_dependents( $slug ): Utilisé pour obtenir les chemins d'accès aux fichiers des autres plugins qui dépendent du plugin spécifié.

Paramètres :

• $slug: Etiquette de dépendance.

Valeur de retour :

• array: Tableau contenant les chemins d'accès aux fichiers de plugin dépendants par rapport au répertoire du plugin.
  

• méthode statique get_dependencies( $plugin_file ): :
  • Description : les slugs utilisés pour obtenir les plugins dépendants requis par le plugin spécifié.
  • Paramètres :
    • $plugin_file: Chemin d'accès aux fichiers qui dépendent du plugin, par rapport au répertoire du plugin.
  • Valeur de retour :
    • array: Un tableau de limaces qui dépendent du plugin.
      
• méthode statique get_dependent_filepath( $slug ): :
  • Description : permet d'obtenir le chemin d'accès au fichier du plugin dépendant spécifié.
  • Paramètres :
    • $slug: Dépend de l'intitulé du plugin.
  • Valeur de retour :
    • chaîne|false: Chemin d'accès au fichier du plugin dépendant, relatif au répertoire du plugin. Retourne false si le plugin n'a pas de dépendances.
      
• méthode statique get_dependency_filepath( $slug ): :
  • Description : permet d'obtenir le chemin d'accès au fichier de la dépendance spécifiée par rapport au répertoire du plugin.
  • Paramètres :
    • $slug: Etiquette de dépendance.
  • Valeur de retour :
    • chaîne|false: Le chemin d'accès au fichier de la dépendance par rapport au répertoire du plugin s'il est installé, sinon false.
      
• méthode statique has_unmet_dependencies( $plugin_file ): :
  • Description : permet de déterminer si le plugin spécifié a des dépendances non satisfaites.
  • Paramètres :
    • $plugin_file: Le chemin d'accès au fichier du plugin, relatif au répertoire du plugin.
  • Valeur de retour :
    • bool: si le plugin a des dépendances non satisfaites.
      
• méthode statique has_circular_dependency( $plugin_file ): :
  • Description : permet de déterminer s'il existe une dépendance circulaire pour le plugin spécifié.
  • Paramètres :
    • $plugin_file: Le chemin d'accès au fichier du plugin, relatif au répertoire du plugin.
  • Valeur de retour :
    • bool: si le plugin a des dépendances circulaires.
      
• méthode statique get_dependent_names( $plugin_file ): :
  • Description : permet d'obtenir le nom du plugin pour lequel le plugin doit être spécifié.
  • Paramètres :
    • $plugin_file: Le chemin d'accès au fichier du plugin, relatif au répertoire du plugin.
  • Valeur de retour :
    • array: tableau de noms de dépendances.
      
• méthode statique get_dependency_names( $plugin_file ): :
  • Description : permet d'obtenir le nom du plugin requis pour le plugin spécifié.
  • Paramètres :
    • $plugin_file: Chemin d'accès aux fichiers qui dépendent du plugin, par rapport au répertoire du plugin.
  • Valeur de retour :
    • array: Tableau de noms de dépendances.
      
• méthode statique get_dependency_data( $slug ): :
  • Description : permet de renvoyer les données de l'API pour la dépendance spécifiée.
  • Paramètres :
    • $slug: Etiquette de dépendance.
  • Valeur de retour :
    • array|false: données API pour la dépendance en cas de succès, sinon false.

Pour en savoir plus, visitez le siteJournal officiel.