3つの異なるフックがあります。次の場合にトリガーします。
シナリオ中に機能を安全にトリガーする方法
以下に、上記のアクション中にトリガーされるコールバック関数を安全にフックする正しい方法を示します。
あなたが使用するプラグインでこのコードを使用できるように
検証できる3つの異なるデモプラグインを示し、後で独自のプラグインにコードを実装します。
重要なメモを前もって！
このトピックは非常に難しく、非常に詳細であり、多数のエッジケースがあるため、この答えは決して完璧ではありません。今後も改善していきますので、定期的にご確認ください。
（1）プラグインを有効化/無効化/アンインストールします。
プラグインのセットアップコールバックはコアによってトリガーされ、コアがこれを行う方法に影響はありません。留意すべきことがいくつかあります。
- 決して、これまでの
echo/printセットアップコールバック時に何も（！）。これによりheaders already sentメッセージが表示され、コアはプラグインを非アクティブ化および削除することを推奨します...尋ねないでください：わかっています...
- 視覚的な出力は表示されません。しかし、
exit()実際に何が起こっているかについての洞察を得ることができるように、すべての異なるコールバックにステートメントを追加しました。コメントを外して、機能するものを確認してください。
__FILE__ != WP_PLUGIN_INSTALLプラグインが実際にアンインストールされているかどうかを確認するためにand をチェックすることが非常に重要です（そうでない場合：abort！）。on_deactivation()開発中に単純にコールバックをトリガーすることをお勧めします。そうすれば、すべてを取り戻すために必要な時間を節約できます。少なくともこれは私がやっていることです。- 私もセキュリティの仕事をしています。一部はコアによっても行われますが、ちょっと！転ばぬ先の杖！。
- まず、コアがロードされていない場合、ファイルへの直接アクセスを許可しません。
defined( 'ABSPATH' ) OR exit;
- 次に、現在のユーザーがこのタスクを実行できるかどうかを確認します。
- 最後のタスクとして、リファラーを確認します。注：エラーが発生したときに、
wp_die()適切なアクセス許可を要求する画面で予期しない結果が発生する可能性があります（再試行したい場合はそうです）。これは、コアがユーザーをリダイレクトし、現在$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アーキテクチャ
このシナリオでは、メインのプラグインファイルと名前の第二のファイルだということを前提とsetup.php名付けられたプラグインのサブディレクトリにはinc：~/wp-content/plugins/your_plugin/inc/setup.php。これは、プラグインフォルダーがデフォルトの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' );
ソース
この更新関数は、あまり良くない/よく書かれた例ですが、前述のように：例であり、この手法はうまく機能します。後のアップデートでそれを改善します。
