wp_clear_scheduled_hook()


WordPressのwp_clear_scheduled_hook()関数は、指定されたフックに関連するすべてのスケジュールされたイベントをクリアするために使用されます。この関数は、特定のアクションが不要になった場合に、スケジュールされたタスクを削除するのに役立ちます。

構文

wp_clear_scheduled_hook( string $hook, array $args = array() );

引数の説明:

  • $hook(string) — クリアするスケジュールされたイベントのフック名。
  • $args(array) — オプション。フックに関連する引数の配列。指定された引数に一致するイベントのみがクリアされます。

例1: 基本的な使用例

特定のフックに関連するすべてのスケジュールされたイベントをクリアします。

wp_clear_scheduled_hook('my_scheduled_action');

例2: 引数を指定してイベントをクリア

特定の引数を持つスケジュールされたイベントのみをクリアします。

wp_clear_scheduled_hook('my_scheduled_action', array('arg1', 'arg2'));

例3: プラグインの停止時にスケジュールをクリア

プラグインが無効化されたときに、関連するスケジュールをクリアします。

register_deactivation_hook(__FILE__, 'my_plugin_deactivate'); function my_plugin_deactivate() { wp_clear_scheduled_hook('my_plugin_cron_job'); }

例4: 特定の投稿タイプのスケジュールをクリア

特定の投稿タイプに関連するスケジュールをクリアします。

wp_clear_scheduled_hook('publish_future_post', array(get_post_type_object('post')->name));

例5: カスタムクーロンタスクのクリア

カスタムクーロンタスクをクリアします。

wp_clear_scheduled_hook('my_custom_cron_task');

例6: 複数の引数を持つイベントのクリア

複数の引数を持つスケジュールされたイベントをクリアします。

wp_clear_scheduled_hook('my_action', array('param1', 'param2', 'param3'));

例7: 特定のユーザーに関連するイベントのクリア

特定のユーザーに関連するスケジュールをクリアします。

wp_clear_scheduled_hook('user_cleanup', array(get_current_user_id()));

例8: 定期的なイベントのクリア

定期的に実行されるイベントをクリアします。

wp_clear_scheduled_hook('my_recurring_event');

注意点

  • この関数は、指定されたフックに関連するすべてのスケジュールされたイベントを削除します。重要なタスクが削除されないように注意してください。
  • 引数を指定しない場合、そのフックに関連するすべてのイベントがクリアされます。
  • スケジュールされたイベントが存在しない場合、この関数は何も行いません。

関連機能：