register_activation_hook( string $file, callable $callback )

使用示例

• 示例1

  请注意，register_activation_hook不能从另一个钩子（例如‘plugins_loaded’或‘init’）中注册，因为这些钩子都是在加载或激活插件之前调用的。

  这将不起作用：

  function pluginInit() {
      require_once dirname(__FILE__) . '/includes/Activator.php';
      register_activation_hook( __FILE__, 'Activator', 'activate' ) );
  }
  add_action( 'plugins_loaded', 'pluginInit' );
  

• 示例2

  单例类模式

  如果您的插件使用单例类模式，请添加如下激活挂钩：

  class MyPlugin {
       static function install() {
              // do not generate any output here
       }
  }
  register_activation_hook( __FILE__, array( 'MyPlugin', 'install' ) );
  

  如果保存激活函数/方法的类位于其他文件中，请按如下方式注册激活函数：

  include_once dirname( __FILE__ ) . '/your_additional_file.php';
  register_activation_hook( __FILE__, array( 'YourAdditionalClass', 'on_activate_function' ) );
  

  或者，因为激活挂钩需要静态函数，如果您在__construct()中：

  register_activation_hook( __FILE__, array( 'MyPlugin', 'YOUR_METHOD_NAME' ) );
  

• 示例3

  这里有一条评论可能会因为提供了错误的信息而让人困惑。代码不必在主文件中，除非您正在执行类似于单个文件插件的操作。需要知道的是，第一个参数是启动代码所需的名称，而不是代码所在的文件。例如：
  
  Main plugin file: plugin/myplugin/myplugin.php
  include 'some_class.php';
  $obj = new other_class();

  Other plugin file: plugin/myplugin/some_class.php
  class some_class {
  __constructor() {
  register_activation_hook(__DIR__.'/myplugin.php',array($this,'activate');
  }
  public function activate() { ... }
  }
  

• 示例4

  如果在命名空间内调用此函数：

  register_activation_hook( __FILE__, __NAMESPACE__ . '\my_activate_callback' );
  

• 示例5

  根据@nacin（WordPress的首席开发人员），您不应该使用激活挂钩（尤其是在多站点上）。您应该这样做：

  “最好使用在admin_init上启动的升级程序，并根据存储选项按站点处理。”

  资料来源：https://core.trac.wordpress.org/ticket/14170#comment:68

• 示例6

  如果插件中有自定义重写规则，则可以刷新固定链接

  register_activation_hook( __FILE__, 'wpdocs_myplugin_activate' );
  
  function wpdocs_myplugin_activate() {
  	flush_rewrite_rules();
  }
  

• 示例7

  钩子函数有一个布尔参数$network_wide，用于指示插件是否已被网络激活。

  register_activation_hook(__FILE__, 'my_plugin_activate');
  function my_plugin_activate($network_wide){
  	if($network_wide){ //Plugin is network activated
  		$site_ids = get_sites(array('fields' => 'ids'));
  	    foreach($site_ids as $site_id){
  			//Perform something on all sites within the network
        		switch_to_blog($site_id);
        		my_plugin_install_site();
        		restore_current_blog();
      	}
  		return;
  	}
  
  	my_plugin_install_site();
  
  }
  
  function my_plugin_install_site(){
  	//Do something
  }
  

• 示例8

  使用可调用函数发送参数

  假设您的插件具有OOP结构，并且需要在其中遵守SOLID原则。
  因此，您需要在register_activation_hook函数中使用可调用函数进行依赖项注入。
  示例代码如下所示：

  注意：我使用了两种方式来显示在激活和停用钩子中带参数和不带参数的可调用函数，以便大胆地使用它们。在register_activation_hook中使用的是带参数的可调用函数。

  <?php
  /**
   * OOP WordPress Plugin Boilerplate
   *
   * Description for OOP Plugin
   *
   * @link              https://github.com/msn60/oop-wordpress-plugin-boilerplate
   * @since             1.0.0
   * @package           Plugin_Name_Name_Space
   *
   * @wordpress-plugin
   * Plugin Name:       OOP WordPress Plugin Boilerplate
   * Plugin URI:        https://github.com/msn60/oop-wordpress-pluging-boilerplate-light-version
   * Description:       Description for OOP Plugin
   * Version:           1.0.2
   * Author:            Mehdi Soltani <soltani.n.mehdi@gmail.com>
   * Author URI:        https://wpwebmaster.ir
   * License:           GPL-2.0+
   * License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
   */
  
  /*
   * Define your namespaces here by use keyword
   * */
  
  use Plugin_Name_Name_Space\Includes\Init\{
   Constant, Activator
  };
  use Plugin_Name_Name_Space\Includes\Config\Initial_Value;
  use Plugin_Name_Name_Space\Includes\Uninstall\{
  	Deactivator, Uninstall
  };
  
  /**
   * If this file is called directly, then abort execution.
   */
  if ( ! defined( 'ABSPATH' ) ) {
  	exit;
  }
  
  
  /**
   * Class Plugin_Name_Plugin
   *
   * This class is primary file of plugin which is used from
   * singletone design pattern.
   *
   * @package    Plugin_Name_Name_Space
   * @author     Your_Name <youremail@nomail.com>
   * @see        Plugin_Name_Name_Space\Includes\Init\Core Class
   * @see        Plugin_Name_Name_Space\Includes\Init\Constant Class
   * @see        Plugin_Name_Name_Space\Includes\Init\Activator Class
   * @see        Plugin_Name_Name_Space\Includes\Uninstall\Deactivator Class
   * @see        Plugin_Name_Name_Space\Includes\Uninstall\Uninstall Class
   */
  final class Plugin_Name_Plugin {
  	/**
  	 * Instance property of Plugin_Name_Plugin Class.
  	 * This is a property in your plugin primary class. You will use to create
  	 * one object from Plugin_Name_Plugin class in whole of program execution.
  	 *
  	 * @access private
  	 * @var    Plugin_Name_Plugin $instance create only one instance from plugin primary class
  	 * @static
  	 */
  	private static $instance;
  	/**
  	 * @var Initial_Value $initial_values An object  to keep all of initial values for theme
  	 */
  	protected $initial_values;
  
  
  	/**
  	 * Plugin_Name_Plugin constructor.
  	 * It defines related constant, include autoloader class, register activation hook,
  	 * deactivation hook and uninstall hook and call Core class to run dependencies for plugin
  	 *
  	 * @access private
  	 */
  	public function __construct() {
  		/*Define Autoloader class for plugin*/
  		$autoloader_path = 'includes/class-autoloader.php';
  		/**
  		 * Include autoloader class to load all of classes inside this plugin
  		 */
  		require_once trailingslashit( plugin_dir_path( __FILE__ ) ) . $autoloader_path;
  		/*Define required constant for plugin*/
  		Constant::define_constant();
  
  		/**
  		 * Register activation hook.
  		 * Register activation hook for this plugin by invoking activate
  		 * in Plugin_Name_Plugin class.
  		 *
  		 * @param string   $file     path to the plugin file.
  		 * @param callback $function The function to be run when the plugin is activated.
  		 */
  		register_activation_hook(
  			__FILE__,
  			function () {
  				$this->activate(
  					new Activator( intval( get_option( 'last_your_plugin_name_dbs_version' ) ) )
  				);
  			}
  		);
  		/**
  		 * Register deactivation hook.
  		 * Register deactivation hook for this plugin by invoking deactivate
  		 * in Plugin_Name_Plugin class.
  		 *
  		 * @param string   $file     path to the plugin file.
  		 * @param callback $function The function to be run when the plugin is deactivated.
  		 */
  		register_deactivation_hook(
  			__FILE__,
  			array( $this, 'deactivate' )
  		);
  	}
  
  	/**
  	 * Call activate method.
  	 * This function calls activate method from Activator class.
  	 * You can use from this method to run every thing you need when plugin is activated.
  	 *
  	 * @access public
  	 * @since  1.0.0
  	 * @see    Plugin_Name_Name_Space\Includes\Init\Activator Class
  	 */
  	public function activate( Activator $activator_object ) {
  		global $wpdb;
  		$activator_object->activate(
  			true,
  			new Table( $wpdb, PLUGIN_NAME_DB_VERSION, get_option( 'has_table_name' ) )
  		);
  	}
  
  	/**
  	 * Create an instance from Plugin_Name_Plugin class.
  	 *
  	 * @access public
  	 * @since  1.0.0
  	 * @return Plugin_Name_Plugin
  	 */
  	public static function instance() {
  		if ( is_null( ( self::$instance ) ) ) {
  			self::$instance = new self();
  		}
  
  		return self::$instance;
  	}
  	
  
  	/**
  	 * Load Core plugin class.
  	 *
  	 * @access public
  	 * @since  1.0.0
  	 */
  	public function run_plugin_name_plugin() {
  		// TODO: Do you codes here to run the plugin
  	}
  
  	/**
  	 * Call deactivate method.
  	 * This function calls deactivate method from Dectivator class.
  	 * You can use from this method to run every thing you need when plugin is deactivated.
  	 *
  	 * @access public
  	 * @since  1.0.0
  	 */
  	public function deactivate() {
  		Deactivator::deactivate();
  	}
  }
  
  
  $plugin_name_plugin_object = Plugin_Name_Plugin::instance();
  $plugin_name_plugin_object->run_plugin_name_plugin();
  
  
  

• 示例9

  有用的实例，例如，当我们需要为我们的插件功能创建一个DB表：
  

  function create_ourtable(){
  
  global $wpdb;
  $prefix = $wpdb->prefix;
  $form_db = $prefix . "ourtable";
  
  //Check if table exists. In case it's false we create it
  if($wpdb->get_var("SHOW TABLES LIKE '$form_db'") !== $form_db){
  
  $sql = "CREATE TABLE $form_db(id mediumint unsigned not null primary key auto_increment, dates timestamp, names varchar(500), wp_user mediumint unsigned)";
  
  require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
  dbDelta($sql);
  }