アクティベーション

アクティベーションフックを設定するには、register_activation_hook()関数を使用します: 

  1. register_activation_hook(
  2.     __FILE__,
  3.     'pluginprefix_function_to_run'
  4. );

非アクティベーション

非アクティベーションフックを設定するには、register_deactivation_hook()関数を使用します: 

  1. register_deactivation_hook(
  2.     __FILE__,
  3.     'pluginprefix_function_to_run'
  4. );

これらの関数の最初のパラメータは、プラグインヘッダーコメントを配置したメインプラグインファイルを指します。通常、これらの2つの関数はメインプラグインファイル内からトリガーされますが、他のファイルに配置されている場合は、最初のパラメータを更新してメインプラグインファイルを正しく指す必要があります。

例

アクティベーションフックの最も一般的な使用法の1つは、プラグインがカスタム投稿タイプを登録する際にWordPressのパーマリンクを更新することです。これにより、厄介な404エラーが解消されます。

上記の例を見てみましょう: 

  1. /**
  2.  * Register the "book" custom post type
  3.  */
  4. function pluginprefix_setup_post_type() {
  5.     register_post_type( 'book', ['public' => true ] );
  6. }
  7. add_action( 'init', 'pluginprefix_setup_post_type' );
  9. /**
  10.  * Activate the plugin.
  11.  */
  12. function pluginprefix_activate() {
  13.     // Trigger our function that registers the custom post type plugin.
  14.     pluginprefix_setup_post_type();
  15.     // Clear the permalinks after the post type has been registered.
  16.     flush_rewrite_rules();
  17. }
  18. register_activation_hook( __FILE__, 'pluginprefix_activate' );

カスタム投稿タイプの登録に不慣れな場合でも心配しないでください – これは後で説明されます。この例は非常に一般的であるため、単に使用されています。

上記の例を使用して、このプロセスを逆にしてプラグインを非アクティブ化する方法は次のとおりです: 

  1. /**
  2.  * Deactivation hook.
  3.  */
  4. function pluginprefix_deactivate() {
  5.     // Unregister the post type, so the rules are no longer in memory.
  6.     unregister_post_type( 'book' );
  7.     // Clear the permalinks to remove our post type's rules from the database.
  8.     flush_rewrite_rules();
  9. }
  10. register_deactivation_hook( __FILE__, 'pluginprefix_deactivate' );

アクティベーションおよび非アクティベーションフックに関するさらなる情報については、以下の優れたリソースを参照してください: