wp_get_scheduled_event()


WordPressの関数wp_get_scheduled_event()は、スケジュールされたイベントの詳細を取得するために使用されます。この関数は特定のフックに関連付けられたイベントを検索し、そのデータを返します。

シンタックス

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

引数の説明

  • $hook (string) — イベントをトリガーするためのフック名。
  • $args (array) — イベントに関連付けられた引数。デフォルトは空の配列。

戻り値

  • WP_Event — スケジュールされたイベントのオブジェクト。
  • null — イベントが見つからない場合。

使用例

例1: 特定のフックに関連付けられたイベントを取得する

$event = wp_get_scheduled_event( 'my_custom_hook' );
if ( $event ) {
    echo $event->timestamp;
}

例2: 引数付きのイベントを取得する

$args = array( 'post_id' => get_the_ID() );
$event = wp_get_scheduled_event( 'my_custom_hook', $args );
if ( $event ) {
    echo 'イベントが見つかりました。';
}

例3: スケジュールされたイベントのタイムスタンプを表示する

$event = wp_get_scheduled_event( 'daily_backup' );
if ( $event ) {
    echo '次の実行時間: ' . date( 'Y-m-d H:i:s', $event->timestamp );
}

例4: イベントがスケジュールされているかを確認する

if ( wp_get_scheduled_event( 'cleanup_hook' ) ) {
    echo 'イベントがスケジュールされています。';
} else {
    echo 'イベントはスケジュールされていません。';
}

例5: 複数の引数を使用したイベントの取得

$args = array( 'user_id' => get_current_user_id(), 'action' => 'update' );
$event = wp_get_scheduled_event( 'user_action_hook', $args );
if ( $event ) {
    var_dump( $event );
}

注意事項

  • フック名が正しく指定されていない場合、wp_get_scheduled_event()はnullを返します。
  • 関数が返すWP_Eventオブジェクトには、timestamp、schedule、argsなどのプロパティが含まれます。

関連機能：