web-dev-qa-db-fra.com

Comment faire en sorte qu'un plugin nécessite un autre plugin?

Je construis un plugin qui ajoute des fonctionnalités supplémentaires à un plugin principal. Idéalement, dans l'écran d'administration des plugins, le lien "activer" doit être désactivé et une note en ligne doit être ajoutée pour indiquer à l'utilisateur d'installer et d'activer le plugin principal avant de pouvoir utiliser le plugin actuel.

plugin-development
26
kosinix

Merci pour les réponses les gars. Bien que les deux réponses me placent sur le bon chemin, aucune ne fonctionne en dehors de la boîte. Je partage donc mes solutions ci-dessous.

Méthode 1 - Utilisation de register_activation_hook:

Créez le plugin parent dans plugins/parent-plugin/parent-plugin.php:

<?php
/*
Plugin Name: Parent Plugin
Description: Demo plugin with a dependent child plugin.
Version: 1.0.0
*/

Créez le plugin enfant dans plugins/child-plugin/child-plugin.php:

<?php
/*
Plugin Name: Child Plugin
Description: Parent Plugin should be installed and active to use this plugin.
Version: 1.0.0
*/
register_activation_hook( __FILE__, 'child_plugin_activate' );
function child_plugin_activate(){

    // Require parent plugin
    if ( ! is_plugin_active( 'parent-plugin/parent-plugin.php' ) and current_user_can( 'activate_plugins' ) ) {
        // Stop activation redirect and show error
        wp_die('Sorry, but this plugin requires the Parent Plugin to be installed and active. <br><a href="' . admin_url( 'plugins.php' ) . '">&laquo; Return to Plugins</a>');
    }
}

Notez que je n'utilise pas deactivate_plugins( $plugin ); car, pour une raison quelconque, cela ne fonctionne pas. J'ai donc utilisé wp_die pour annuler la redirection d'activation et informer l'utilisateur.

Avantage:

  • Solution simple et ne génère pas de hits de base de données supplémentaires par rapport à la méthode 2

Désavantages:

  • wp_die screen est laid
  • l’écran wp_die apparaîtra TOUJOURS si vous avez activé simultanément les plugins parent et enfant en utilisant les cases à cocher de l’écran d’administration des plugins.

Méthode 2 - Utilisation de admin_init et admin_notices

Créez le plugin parent dans plugins/parent-plugin/parent-plugin.php:

<?php
/*
Plugin Name: Parent Plugin
Description: Demo plugin with a dependent child plugin.
Version: 1.0.0
*/

Créez le plugin enfant dans plugins/child-plugin/child-plugin.php:

<?php
/*
Plugin Name: Child Plugin
Description: Parent Plugin should be installed and active to use this plugin.
Version: 1.0.0
*/
add_action( 'admin_init', 'child_plugin_has_parent_plugin' );
function child_plugin_has_parent_plugin() {
    if ( is_admin() && current_user_can( 'activate_plugins' ) &&  !is_plugin_active( 'parent-plugin/parent-plugin.php' ) ) {
        add_action( 'admin_notices', 'child_plugin_notice' );

        deactivate_plugins( plugin_basename( __FILE__ ) ); 

        if ( isset( $_GET['activate'] ) ) {
            unset( $_GET['activate'] );
        }
    }
}

function child_plugin_notice(){
    ?><div class="error"><p>Sorry, but Child Plugin requires the Parent plugin to be installed and active.</p></div><?php
}

Avantage:

  • Fonctionne lorsque vous activez le plug-in Parent et Enfant en même temps en utilisant les cases à cocher

Désavantage:

  • Entraînez d’autres accès à la base de données lorsque le plug-in est en fait activé et désactivé une fois que admin_init est exécuté.

En ce qui concerne ma question concernant la désactivation du lien d'activation, je pourrais utiliser:

add_filter( 'plugin_action_links', 'disable_child_link', 10, 2 );
function disable_child_link( $links, $file ) {

    if ( 'child-plugin/child-plugin.php' == $file and isset($links['activate']) )
        $links['activate'] = '<span>Activate</span>';

    return $links;
}

Cependant, cela s’est avéré très peu pratique car il n’ya AUCUN endroit où mettre ce code. Je ne pouvais pas le mettre sur le plugin parent car le plugin parent devait être actif pour que ce code soit exécuté. N'appartient certainement pas au plugin enfant ni au fichier functions.php. Donc, je supprime cette idée.

33
kosinix

Essayez ceci, c'est commenté, cela devrait donc vous aider à le comprendre.

<?php
register_activation_hook( __FILE__, 'myplugin_activate' ); // Register myplugin_activate on
function myplugin_activate() {
    $plugin = plugin_basename( __FILE__ ); // 'myplugin'
    if ( is_plugin_active( 'plugin-directory/first-plugin.php' ) ) {
        // Plugin was active, do hook for 'myplugin'
    } else {
        // Plugin was not-active, uh oh, do not allow this plugin to activate
        deactivate_plugins( $plugin ); // Deactivate 'myplugin'
    }
}
?>

Si cela génère une erreur, vous pouvez également cocher 'option' de 'myplugin' et la définir sur false ou non activée.

2
MrJustin

Les deux solutions suggérées ont des défauts.

Méthode 1: Comme mentionné, l'écran wp_die () s'affichera quand même lorsque le plugin parent et le plugin enfant seront activés simultanément à l'aide des cases à cocher de l'écran d'administration des plugins.

Méthode 2: Dans certains cas d'utilisation, ce n'est pas bon car 'admin_init' est exécuté de manière après 'plugins_loaded' ( https://codex.wordpress.org/Plugin_API/Action_Reference ), et après le hook de désinstallation ( https://codex.wordpress.org/Function_Reference/register_uninstall_hook ). Ainsi, par exemple, si nous voulons que le module complémentaire exécute du code lors de la désinstallation, que le plug-in parent soit actif ou non, cette approche ne fonctionnera PAS.

Solution:

Tout d'abord, nous devons ajouter le code suivant à la fin du fichier principal PHP du plugin parent:

do_action( 'my_plugin_loaded' );

Cela enverra un événement/signal à tous les abonnés, indiquant que le plug-in principal a été chargé.

Ensuite, la classe de l'add-on devrait ressembler à ceci:

class My_Addon
{
    static function init ()
    {
        register_activation_hook( __FILE__, array( __CLASS__, '_install' ) );

        if ( ! self::_is_parent_active_and_loaded() ) {
            return;
        }
    }

    #region Parent Plugin Check

    /**
     * Check if parent plugin is activated (not necessarly loaded).
     *
     * @author Vova Feldman (@svovaf)
     *
     * @return bool
     */
    static function _is_parent_activated()
    {
        $active_plugins_basenames = get_option( 'active_plugins' );
        foreach ( $active_plugins_basenames as $plugin_basename ) {
            if ( false !== strpos( $plugin_basename, '/my-plugin-main-file.php' ) ) {
                return true;
            }
        }

        return false;
    }

    /**
     * Check if parent plugin is active and loaded.
     *
     * @author Vova Feldman (@svovaf)
     *
     * @return bool
     */
    static function _is_parent_active_and_loaded()
    {
        return class_exists( 'My_Plugin' );
    }

    /**
     *
     * @author Vova Feldman (@svovaf)
     */
    static function _install()
    {
        if ( ! self::_is_parent_active_and_loaded() ) {
            deactivate_plugins( basename( __FILE__ ) );

            // Message error + allow back link.
            wp_die( __( 'My Add-on requires My Plugin to be installed and activated.' ), __( 'Error' ), array( 'back_link' => true ) );
        }
    }

    #endregion Parent Plugin Check
}

if (My_Addon::_is_parent_active_and_loaded())
{
    // If parent plugin already included, init add-on.
    My_Addon::init();
}
else if (My_Addon::_is_parent_activated())
{
    // Init add-on only after the parent plugins is loaded.
    add_action( 'my_plugin_loaded', array( __CLASS__, 'init' ) );
}
else
{
    // Even though the parent plugin is not activated, execute add-on for activation / uninstall hooks.
    My_Addon::init();
}

J'espère que ça aide :)

2
vovafeldman

Je pense que vous avez besoin de TGM Plugin Activation .

TGM Plugin Activation est une bibliothèque PHP qui vous permet de demander ou de recommander facilement des plugins pour vos thèmes WordPress (et vos plugins). Il permet à vos utilisateurs d’installer, de mettre à jour et même d’activer automatiquement des plug-ins de manière unique ou globale à l’aide de classes, fonctions et interfaces WordPress natives. Vous pouvez référencer des plugins fournis, des plugins à partir du référentiel de plugins WordPress ou même des plugins hébergés ailleurs sur Internet.

0
Amir Hossein Hossein Zadeh