Есть три разных крючка. Они запускаются в следующих случаях:
- Удалить
- дезактивация
- активация
Как безопасно запускать функции во время сценариев
Ниже показаны правильные способы безопасного подключения функций обратного вызова, которые запускаются во время упомянутых действий.
Как вы могли бы использовать этот код в плагине, который использует
- простые функции,
- класс или
- внешний класс,
Я покажу три различных демо-плагина, которые вы можете просмотреть, а затем внедрит код в свои собственные плагины.
Важное примечание заранее!
Поскольку эта тема чрезвычайно сложная и очень подробная, и в ней более десятка случаев, этот ответ никогда не будет идеальным. Я буду продолжать улучшать его с течением времени, так что заходите регулярно.
(1) Активировать / деактивировать / удалить плагины.
Обратные вызовы установки плагина запускаются ядром, и вы не имеете никакого влияния на то, как ядро делает это. Есть несколько вещей, которые нужно иметь в виду:
- Никогда ,
echo/printничего (!) Во время обратных вызовов. Это приведет к headers already sentсообщению, и ядро порекомендует деактивировать и удалить ваш плагин ... не спрашивайте: я знаю ...
- Вы не увидите никакого визуального вывода. Но я добавил
exit()утверждения ко всем различным обратным вызовам, чтобы вы могли получить представление о том, что на самом деле происходит. Просто раскомментируйте их, чтобы увидеть, как все работает.
- Чрезвычайно важно проверить, если
__FILE__ != WP_PLUGIN_INSTALLи (если нет: прервать!), Чтобы увидеть, действительно ли кто-то удаляет плагин. Я бы порекомендовал просто вызывать 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) Архитектура на основе классов / ООП
Это самый распространенный пример современных плагинов.
<?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) Архитектура на основе классов / ООП с внешним объектом настройки
Этот сценарий предполагает , что вы получили главный файл плагина , и второй файл с именем setup.phpв подкаталоге плагина под названием inc: ~/wp-content/plugins/your_plugin/inc/setup.php. Это будет работать и тогда, когда папка плагина находится за пределами структуры папок WP по умолчанию, а также когда папка содержимого переименована или если ваш установочный файл назван по-другому. Только incпапка должна иметь такое же имя и расположение относительно корневого каталога плагинов.
Примечание. Вы можете просто взять три 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) Обновления плагинов
Если вы напишите плагин, который имеет свою собственную таблицу или параметры БД, могут возникнуть ситуации, когда вам нужно что-то изменить или обновить.
К сожалению, пока нет возможности запустить что-либо при установке плагина / темы или обновлении / обновлении. Рад, что есть обходной путь: подключите пользовательскую функцию к пользовательской опции (да, это хромая - но она работает).
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' );
Источник
Эта функция обновления - не очень хороший / хорошо написанный пример, но, как сказано: это пример, и техника работает хорошо. Улучшит это с более поздним обновлением.
