Є три різні гачки. Вони спрацьовують у таких випадках:
- Видалити
- Деактивація
- Активація
Як запустити функції безпечно під час сценаріїв
Нижче показано правильні способи безпечного підключення функцій зворотного виклику, які спрацьовують під час згаданих дій.
Як ви могли використовувати цей код у плагіні, який використовує
- прості функції,
- клас або
- зовнішній клас,
Я покажу три різні демо-плагіни, які ви можете перевірити, а потім пізніше впроваджуйте код у свої власні плагіни.
Важлива примітка наперед!
Оскільки ця тема є надзвичайно складною та дуже детальною і має десяток + крайових випадків, ця відповідь ніколи не буде ідеальною. Я з часом продовжуватиму вдосконалюватись, тому перевіряйте регулярно.
(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) Архітектура на базі класу / 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 за замовчуванням, а також, коли вміст dir перейменовано або у випадках, коли ваш файл налаштування названий іншим. Тільки 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' );
Джерело
Ця функція оновлення є не дуже приємним / добре написаним прикладом, але як сказано: Це приклад, і техніка працює добре. Поліпшимо це з наступним оновленням.
