WordPressの鼓動

(3.6以降)
WordPressの鼓動 - 気になるajax、その名は「heartbeat」

説明

WordPressでは、Ajaxを利用する方法の1つとしてadd_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

WordPress標準のAjax利用方法

WordPress標準のAjaxアクションは、add_action関数を利用し、ログイン済みのユーザー向けと未ログインユーザー向けを個別に登録するようになっている。

/* ログイン済みユーザー向け */
add_action( 'wp_ajax_アクション名', '任意の関数名' );

/* 未ログインユーザー向け */
add_action( 'wp_ajax_nopriv_アクション名', '任意の関数名' );

上記のアクションを呼び出すURLは、どちらも「http://ドメイン名/wp-admin/admin-ajax.php?action=アクション名」のようなパターンとなる。

heartbeatアクション

このURLでわかるように、Ajaxアクションのレスポンス処理を行うのはadmin-ajax.phpなので、その中身を見てみると次のような記述が見つかった。

add_action( 'wp_ajax_nopriv_heartbeat', 'wp_ajax_nopriv_heartbeat', 1 );

このAjaxアクションは未ログインユーザー向けで、実際に開発環境にて「http://localhost/wp-admin/admin-ajax.php?action=heartbeat」にアクセスしてみると、次のようなレスポンスがあった。

{"server_time":1380606481}

このようにサーバー時間がJSON形式で返ってくる。サーバーの稼働状況を確認する場合などに便利なのかな

コールバック関数のwp_ajax_nopriv_heartbeat関数は、/wp-admin/includes/ajax-actions.phpに記載されており、コメントには「Heartbeat API (experimental)」と記載されている。「実験中」ということだろうね。

wp_ajax_nopriv_heartbeat関数の中を見てみると、2つのフィルターと次に示す1つのアクションが呼び出されるようになっている。もし独自の機能を追加するなら、このアクションを利用すればいい。

do_action( 'heartbeat_nopriv_tick', $response, $screen_id );
今後が気になる

さて、紹介したheartbeatアクションは3.6で追加されたもので、以前のバージョンでは使用できない。「experimental」ということなので、次のバージョンで変わる可能性はあるのだが、サーバー監視を考えている方には参考になる機能ではないだろうか。

関連

  • add_action - アクション関数を追加する

お勧めコンテンツ

wp_spam_comment(2013年9月6日 登録)

bool wp_spam_comment( $comment_id )
コメントをスパムにする。

get_userdata(2010年10月27日 登録)

mixed get_userdata( int $user_id )
ユーザIDを指定し、マッチするユーザ情報を取得する。

wp_upload_bits(2014年11月27日 登録)

array wp_upload_bits( string $name, null $deprecated, mixed $bits [ , string $time = null ] )
データをアップロードファイルとして保存する。

get_taxonomy(2014年7月3日 登録)

mixed get_taxonomy( string $taxonomy )
タクソノミー情報を取得する。

get_page(2010年4月14日 登録)

mixed get_page( mixed & $page [ , string $output = OBJECT [ , string $filter = 'raw' ] ] )
任意のページ情報を取得する。

最終更新日時 : 2013-10-01 15:22