プラグインのアンインストール、有効化、無効化：一般的な機能と使い方

Question

私はワードプレスのプラグインを作っています。アンインストール機能に含めるべき典型的なものは何ですか？

たとえば、インストール機能で作成したテーブルを削除する必要がありますか？

オプションエントリをクリーンアップしますか？

他に何か？

Answer 1

3つの異なるフックがあります。それらは以下の場合にトリガーします。

• アンインストール
• 失活
• アクティベーション

シナリオ中に安全に機能を開始する方法

以下は、上記のアクション中に発生するコールバック関数を安全にフックするためのrightの方法を示しています。

あなたが使用するプラグインでこのコードを使用することができるように

• 普通の関数
• クラスまたは
• 外部クラス

3つの異なる デモプラグイン を見て、後で自分のプラグインにコードを実装できるようにします。

重要な注意事項

このトピックは非常に困難で非常に詳細で、1ダース以上のEdgeのケースがあるため、この答えは決して完璧ではありません。今後も改善していきますので、定期的に確認してください。

（1）プラグインの有効化/無効化/アンインストール.

プラグイン設定のコールバックはcoreによって引き起こされ、あなたはnoがcoreのやり方に影響を与えます。留意すべき点がいくつかあります。

• 決して にしないでください。セットアップコールバック中は何も（！）echo/printしないでください。これによりheaders already sentメッセージが表示され、コアはあなたのプラグインを無効にして削除することをお勧めします。
• 視覚的な出力を参照することはできません。 しかし私はすべての異なるコールバックにexit()ステートメントを追加したので、実際に何が起こっているのかについての洞察を得ることができます。それらのコメントを外して、機能しているものを見てください。
• __FILE__ != WP_PLUGIN_INSTALLをチェックし、そうでなければ（abort！）プラグインを本当にアンインストールしているかどうかを確認することが非常に重要です。開発中に単にon_deactivation()コールバックをトリガーすることをお勧めします。そうすれば、すべてを取り戻す必要がある時間を節約できます。少なくともこれが私の目的です。
• 私もいくつかのセキュリティ対策をします。いくつかは同様にコアによって行われますが、やあ！ 転ばぬ先の杖！。
  • まず、コアがロードされていないときに直接ファイルアクセスを許可しません。defined( 'ABSPATH' ) OR exit;
  • その後、現在のユーザーがこのタスクを実行できるかどうかを確認します。
  • 最後の作業として、参照元を確認します。注：エラーが発生したときに、wp_die()画面が適切な許可を求めて（そしてもう一度やり直したい場合は... yeah、sure）、予期しない結果が生じることがあります。これはcoreがあなたをリダイレクトし、現在の$GLOBALS['wp_list_table']->current_action();をerror_scrapeにセットし、そしてcheck_admin_referer('plugin-activation-error_' . $plugin);のための参照元をチェックする時に起こります。ここで$pluginは$_REQUEST['plugin']です。そのため、リダイレクトはページのロードの半分で行われ、この有線スクロールバーと画面に黄色の管理者通知/メッセージボックスが表示されます。このような場合は、落ち着いて、exit()とステップバイステップのデバッグでエラーを探してください。

（A）プレーン機能プラグイン

関数定義の前にコールバックをフックするとこれはうまくいかないかもしれないことを覚えておいてください。

<?php
defined( 'ABSPATH' ) OR exit;
/**
 * Plugin Name: (WCM) Activate/Deactivate/Uninstall - Functions
 * Description: Example Plugin to show activation/deactivation/uninstall callbacks for plain functions.
 * Author:      Franz Josef Kaiser/wecodemore
 * Author URL:  http://unserkaiser.com
 * Plugin URL:  http://wordpress.stackexchange.com/questions/25910/uninstall-activate-deactivate-a-plugin-typical-features-how-to/25979#25979
 */

function WCM_Setup_Demo_on_activation()
{
    if ( ! current_user_can( 'activate_plugins' ) )
        return;
    $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
    check_admin_referer( "activate-plugin_{$plugin}" );

    # Uncomment the following line to see the function in action
    # exit( var_dump( $_GET ) );
}

function WCM_Setup_Demo_on_deactivation()
{
    if ( ! current_user_can( 'activate_plugins' ) )
        return;
    $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
    check_admin_referer( "deactivate-plugin_{$plugin}" );

    # Uncomment the following line to see the function in action
    # exit( var_dump( $_GET ) );
}

function WCM_Setup_Demo_on_uninstall()
{
    if ( ! current_user_can( 'activate_plugins' ) )
        return;
    check_admin_referer( 'bulk-plugins' );

    // Important: Check if the file is the one
    // that was registered during the uninstall hook.
    if ( __FILE__ != WP_UNINSTALL_PLUGIN )
        return;

    # Uncomment the following line to see the function in action
    # exit( var_dump( $_GET ) );
}

register_activation_hook(   __FILE__, 'WCM_Setup_Demo_on_activation' );
register_deactivation_hook( __FILE__, 'WCM_Setup_Demo_on_deactivation' );
register_uninstall_hook(    __FILE__, 'WCM_Setup_Demo_on_uninstall' );

（B）クラスベースの/ OOPアーキテクチャ

これは最近のプラグインで最も一般的な例です。

<?php
defined( 'ABSPATH' ) OR exit;
/**
 * Plugin Name: (WCM) Activate/Deactivate/Uninstall - CLASS
 * Description: Example Plugin to show activation/deactivation/uninstall callbacks for classes/objects.
 * Author:      Franz Josef Kaiser/wecodemore
 * Author URL:  http://unserkaiser.com
 * Plugin URL:  http://wordpress.stackexchange.com/questions/25910/uninstall-activate-deactivate-a-plugin-typical-features-how-to/25979#25979
 */


register_activation_hook(   __FILE__, array( 'WCM_Setup_Demo_Class', 'on_activation' ) );
register_deactivation_hook( __FILE__, array( 'WCM_Setup_Demo_Class', 'on_deactivation' ) );
register_uninstall_hook(    __FILE__, array( 'WCM_Setup_Demo_Class', 'on_uninstall' ) );

add_action( 'plugins_loaded', array( 'WCM_Setup_Demo_Class', 'init' ) );
class WCM_Setup_Demo_Class
{
    protected static $instance;

    public static function init()
    {
        is_null( self::$instance ) AND self::$instance = new self;
        return self::$instance;
    }

    public static function on_activation()
    {
        if ( ! current_user_can( 'activate_plugins' ) )
            return;
        $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
        check_admin_referer( "activate-plugin_{$plugin}" );

        # Uncomment the following line to see the function in action
        # exit( var_dump( $_GET ) );
    }

    public static function on_deactivation()
    {
        if ( ! current_user_can( 'activate_plugins' ) )
            return;
        $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
        check_admin_referer( "deactivate-plugin_{$plugin}" );

        # Uncomment the following line to see the function in action
        # exit( var_dump( $_GET ) );
    }

    public static function on_uninstall()
    {
        if ( ! current_user_can( 'activate_plugins' ) )
            return;
        check_admin_referer( 'bulk-plugins' );

        // Important: Check if the file is the one
        // that was registered during the uninstall hook.
        if ( __FILE__ != WP_UNINSTALL_PLUGIN )
            return;

        # Uncomment the following line to see the function in action
        # exit( var_dump( $_GET ) );
    }

    public function __construct()
    {
        # INIT the plugin: Hook your callbacks
    }
}

（C）外部セットアップオブジェクトを持つクラスベースの/ OOPアーキテクチャ

このシナリオでは、inc：setup.phpという名前のプラグインのサブディレクトリに、メインのプラグインファイルと~/wp-content/plugins/your_plugin/inc/setup.phpという名前の2番目のファイルがあると想定しています。これは、プラグインフォルダがデフォルトのWPフォルダ構造の外側にある場合や、コンテンツディレクトリの名前が変更された場合や、セットアップファイルの名前が異なる場合にも機能します。 incフォルダだけがプラグインのルートディレクトリからの相対的な同じ名前と場所を持つ必要があります。

注：3つのregister_*_hook()*関数とクラスを取り出して、それらをプラグインにドロップするだけで済みます。

メインプラグインファイル：

<?php
defined( 'ABSPATH' ) OR exit;
/**
 * Plugin Name: (WCM) Activate/Deactivate/Uninstall - FILE/CLASS
 * Description: Example Plugin
 * Author:      Franz Josef Kaiser/wecodemore
 * Author URL:  http://unserkaiser.com
 * Plugin URL:  http://wordpress.stackexchange.com/questions/25910/uninstall-activate-deactivate-a-plugin-typical-features-how-to/25979#25979
 */


register_activation_hook(   __FILE__, array( 'WCM_Setup_Demo_File_Inc', 'on_activation' ) );
register_deactivation_hook( __FILE__, array( 'WCM_Setup_Demo_File_Inc', 'on_deactivation' ) );
register_uninstall_hook(    __FILE__, array( 'WCM_Setup_Demo_File_Inc', 'on_uninstall' ) );

add_action( 'plugins_loaded', array( 'WCM_Setup_Demo_File', 'init' ) );
class WCM_Setup_Demo_File
{
    protected static $instance;

    public static function init()
    {
        is_null( self::$instance ) AND self::$instance = new self;
        return self::$instance;
    }

    public function __construct()
    {
        add_action( current_filter(), array( $this, 'load_files' ), 30 );
    }

    public function load_files()
    {
        foreach ( glob( plugin_dir_path( __FILE__ ).'inc/*.php' ) as $file )
            include_once $file;
    }
}

セットアップファイル：

<?php
defined( 'ABSPATH' ) OR exit;

class WCM_Setup_Demo_File_Inc
{
    public static function on_activation()
    {
        if ( ! current_user_can( 'activate_plugins' ) )
            return;
        $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
        check_admin_referer( "activate-plugin_{$plugin}" );

        # Uncomment the following line to see the function in action
        # exit( var_dump( $_GET ) );
    }

    public static function on_deactivation()
    {
        if ( ! current_user_can( 'activate_plugins' ) )
            return;
        $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
        check_admin_referer( "deactivate-plugin_{$plugin}" );

        # Uncomment the following line to see the function in action
        # exit( var_dump( $_GET ) );
    }

    public static function on_uninstall()
    {
        if ( ! current_user_can( 'activate_plugins' ) )
            return;
        check_admin_referer( 'bulk-plugins' );

        // Important: Check if the file is the one
        // that was registered during the uninstall hook.
        if ( __FILE__ != WP_UNINSTALL_PLUGIN )
            return;

        # Uncomment the following line to see the function in action
        # exit( var_dump( $_GET ) );
    }
}

（2）プラグインの更新

独自のDBテーブルまたはオプションを持つプラグインを作成する場合は、状況を変更またはアップグレードする必要があるシナリオがあるかもしれません。

残念ながら、これまでのところプラグイン/テーマのインストールや更新/アップグレードで何かを実行する可能性はありません。喜んで回避策があります：カスタムオプションにカスタム関数をフックします（ええ、それは足りないです - しかしそれはうまくいきます）。

function prefix_upgrade_plugin() 
{
    $v = 'plugin_db_version';
    $update_option = null;
    // Upgrade to version 2
    if ( 2 !== get_option( $v ) ) 
    {
        if ( 2 < get_option( $v ) )
        {
            // Callback function must return true on success
            $update_option = custom_upgrade_cb_fn_v3();

            // Only update option if it was an success
            if ( $update_option )
                update_option( $v, 2 );
        }
    }

    // Upgrade to version 3, runs just after upgrade to version 2
    if ( 3 !== get_option( $v ) ) 
    {
        // re-run from beginning if previous update failed
        if ( 2 < get_option( $v ) )
            return prefix_upgrade_plugin();

        if ( 3 < get_option( $v ) )
        {
            // Callback function must return true on success
            $update_option = custom_upgrade_cb_fn_v3();

            // Only update option if it was an success
            if ( $update_option )
                update_option( $v, 3 );
        }
    }

    // Return the result from the update cb fn, so we can test for success/fail/error
    if ( $update_option )
        return $update_option;

return false;
}
add_action('admin_init', 'prefix_upgrade_plugin' );

^出典

この更新関数はあまり良くない/よく書かれた例ですが、言われるように：それは例であり、そしてテクニックはうまくいきます。後のアップデートでそれを改善するでしょう。

Answer 2

現在のシステムでPHP versionやインストールされている拡張機能などの必要な機能をテストするには、次のようなものを使用できます。

<?php  # -*- coding: utf-8 -*-
/**
 * Plugin Name: T5 Check Plugin Requirements
 * Description: Test for PHP version and installed extensions
 * Plugin URI:
 * Version:     2013.03.31
 * Author:      Thomas Scholz
 * Author URI:  http://toscho.de
 * Licence:     MIT
 * License URI: http://opensource.org/licenses/MIT
 */

/*
 * Don't start on every page, the plugin page is enough.
 */
if ( ! empty ( $GLOBALS['pagenow'] ) && 'plugins.php' === $GLOBALS['pagenow'] )
    add_action( 'admin_notices', 't5_check_admin_notices', 0 );

/**
 * Test current system for the features the plugin needs.
 *
 * @return array Errors or empty array
 */
function t5_check_plugin_requirements()
{
    $php_min_version = '5.4';
    // see http://www.php.net/manual/en/extensions.alphabetical.php
    $extensions = array (
        'iconv',
        'mbstring',
        'id3'
    );
    $errors = array ();

    $php_current_version = phpversion();

    if ( version_compare( $php_min_version, $php_current_version, '>' ) )
        $errors[] = "Your server is running PHP version $php_current_version but
            this plugin requires at least PHP $php_min_version. Please run an upgrade.";

    foreach ( $extensions as $extension )
        if ( ! extension_loaded( $extension ) )
            $errors[] = "Please install the extension $extension to run this plugin.";

    return $errors;

}

/**
 * Call t5_check_plugin_requirements() and deactivate this plugin if there are error.
 *
 * @wp-hook admin_notices
 * @return  void
 */
function t5_check_admin_notices()
{
    $errors = t5_check_plugin_requirements();

    if ( empty ( $errors ) )
        return;

    // Suppress "Plugin activated" notice.
    unset( $_GET['activate'] );

    // this plugin's name
    $name = get_file_data( __FILE__, array ( 'Plugin Name' ), 'plugin' );

    printf(
        '<div class="error"><p>%1$s</p>
        <p><i>%2$s</i> has been deactivated.</p></div>',
        join( '</p><p>', $errors ),
        $name[0]
    );
    deactivate_plugins( plugin_basename( __FILE__ ) );
}

PHP 5.5のチェックを付けてテストします。