wp_get_schedules() の使い方｜説明・引数・注意点

説明

基本構文

wp_get_schedules(): array

引数

引数はありません。

戻り値

実行間隔の配列（interval と display を持つ）。

使い方（サンプル）

$schedules = wp_get_schedules();

注意点

• 独自の間隔は、cron_schedules フィルターで追加できます。

実務での使いどころ

• wp_schedule_event() に指定できる、実行間隔の、一覧を確認するとき。
• 独自の実行間隔（5分ごとなど）が、登録されているかを、確認するとき。

よくあるミスと対処

• 既定にない間隔（例：every_five_minutes）を、登録せずに、指定している。cron_schedules フィルターで、追加する。
• 間隔の名前（キー）ではなく、秒数を、渡している。

NG例

wp_schedule_event( time(), 300, 'my_task' ); // 秒数ではなく、間隔の名前を指定する

OK例

add_filter( 'cron_schedules', function ( $schedules ) {
	$schedules['every_five_minutes'] = array(
		'interval' => 300,
		'display'  => '5分ごと',
	);
	return $schedules;
} );
wp_schedule_event( time(), 'every_five_minutes', 'my_task' );

使い分け早見表

関連項目

wp_schedule_event()

公式リファレンス：wp_get_schedules() | Function | WordPress Developer Resources