WordPressで「Cronの処理過程かどうか」を判定

Question

前提

WordPressで定期的な処理を実装しています。
テスト用に以下のログ出力イベントを登録しました。

add_action( 'wp', 'prefixsetupschedule' );
function prefixsetupschedule() {
    if ( ! wp_next_scheduled( 'prefixhourlyevent' ) ) {
        wp_schedule_event(time(), 'hourly', 'prefixhourlyevent');
    }
}

add_action( 'prefixhourlyevent', 'prefixdothishourly' );
function prefixdothishourly() {
	error_log('prefixdothishourly を実行しました');
}

###発生している問題
現在開発中のためアクセスを自宅のIPアドレスに限定しています。
それが次のコードですが、これがあると上記のCron処理が起動しなくなることがわかりました。

add_action( 'init', 'allow' );
function allow() {
	$getip = $_SERVER["HTTP_X_FORWARDED_FOR"] ?? '';

	// 許可されたIPアドレス
	$whiteLists = [
		'222.222.222.22', // 開発中のため自宅だけ許可
	];

	// 許可されたIPアドレスでないならアクセスを禁止
	if( !in_array($getip, $whiteLists, true) ){
		wp_die('アクセスが許可されていません');
	}	
}

###試したこと
このallow()に問題があるなら、$whiteListsに「Cronの処理過程で使われるIPアドレス」を追加すれば問題は起こらないかもしれないと考えました。

で管理画面から下記のようにサーバーのIPアドレスを確認し

このIPアドレスを次のように$shiteListsに追加しました

	// 許可されたIPアドレス
	$whiteLists = [
		'222.222.222.22', // 開発中のため自宅だけ許可
		'111.111.111.11', // さらにCron用にサーバーのIPアドレスも許可 → これでは問題は解決せず
	];

が、これでは問題は解決せずやはりCronは起動しないままでした。

###質問
そこでタイトルの質問となりました。

つまり上記allow()は「許可されたIPアドレスならOK」としていますが、それに加えて「Cronの処理過程ならOK」としたらどうかと思い、その判定方法をお尋ねしたという経緯です。

要はallow()を下記のように変更し、$is_cron_accessに「Cronの処理過程かどうか」を持たせたいと考えています。

add_action( 'init', 'allow' );
function allow() {
	$getip = $_SERVER["HTTP_X_FORWARDED_FOR"] ?? '';

	// 許可されたIPアドレス
	$whiteLists = [
		'222.222.222.22', // 開発中のため自宅だけ許可
		'111.111.111.11', // さらにCron用にサーバーのIPアドレスも許可 → これでは問題は解決せず
	];

	// ここでCronの処理過程ならtrueと判定したい
	$is_cron_access = '';

	// 許可されたIPアドレスでなく、Cronの処理過程でもないならアクセスを禁止
	if( !in_array($getip, $whiteLists, true) && !$is_cron_access ){
		wp_die('アクセスが許可されていません');
	}
}

目的はサイトの閲覧を自身に限定している現在の状況に加え、Cronの処理も実現したい。ということになりますので、もしallow()を上のように変更する以外にもいい方法がありましたら是非教えていただけませんでしょうか。

Answer 1

doing_actionで特定のアクションを実行中であるか知ることができます

Comments

[murati]

よくこんなマニアックなフックをご存じですね。ありがとうございます。

リンク先には
doing_action( 'save_post' )
の例がありましたが、cronの場合save_postに入るのはどういったアクション名になると思いますか？

[murati]

あと、質問の図の緑のIPアドレスを追加してもダメなのはどうしてだと思いますか？
cronの実行はサーバーのIPアドレスではないのでしょうか？

[KazuhiroHatano]

wp_schedule_event は所定の時間が経過していたらdo_actionしてるだけです
実態としてはアクションフックです

DOING_CRON定数でもcron処理中であるか知ることはできます

しかしこれだと他のプラグインのcron処理を邪魔するかもしれません
なのでdoing_actionにて自分でスケジュールしたアクションフックに対してのみ
認証処理を行うようにしたほうが良いかと思います

[KazuhiroHatano]

うろ覚えで不確かですが、確かwp-cron.phpはサーバーサイドで
非同期処理で呼び出されるようになっていたはずで
リクエストがクライアントからではなくサーバーからになっていたかと思います

確かめたことはないですが
IPもサーバーのものかlocalになってるんじゃないでしょうか

[murati]

ご返信ありがとうございます。
save_postの件ですが、これは自分で設定したアクション名でいいわけですよね。つまり、

$is_cron_access = doing_action('prefixhourlyevent');
で、実行中ならtrueが入ってくれる

この使い方であっているでしょうか？

[murati]

DOING_CRONもあるんですね。IPの件もご説明感謝です。なんかすごい人見つけた感じです笑

[KazuhiroHatano]

> doing_action('prefixhourlyevent');

あってます
このハンドル名でwp-cron.phpからdo_actionされてるわけです

wp-cron.phpのコードはかなり短いので
cron周りを弄るときは一度目を通しておくと良いかと思います

https://github.com/WordPress/WordPress/blob/master/wp-cron.php

[murati]

$is_cron_access = doing_action('prefixhourlyevent');

ですが、以下のように使ってもダメでした。

～～～～～～～～～～
add_action( 'init', 'allow' );
function allow() {
$getip = $_SERVER["HTTP_X_FORWARDED_FOR"] ?? '';

// 許可されたIPアドレス
$whiteLists = [
'222.222.222.22', // 開発中のため自宅だけ許可
];

// ここでCronの処理過程ならtrueと判定
$is_cron_access = doing_action('prefixhourlyevent');
error_log('$is_cron_access = ' .json_encode($is_cron_access));

// 許可されたIPアドレスでなく、Cronの処理過程でもないならアクセスを禁止
if( !in_array($getip, $whiteLists, true) && !$is_cron_access ){
wp_die('アクセスが許可されていません');
}
}
～～～～～～～～～～

error_logとして
$is_cron_access = false
が出力されていてました。手ごわいです。

[murati]

失礼いたしました。こうだったぽいです。
$is_cron_access = defined('DOING_CRON') && DOING_CRON && ! doing_action( 'prefixhourlyevent' );