この記事は最後に更新してから1年以上経過しています。

WordPressの鼓動

（3.6以降）
気になるajax、その名は「heartbeat」

説明

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

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

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

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

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

この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」ということなので、次のバージョンで変わる可能性はあるのだが、サーバー監視を考えている方には参考になる機能ではないだろうか。

最終更新 : 2013年10月01日 15:22

get_stylesheet（2019年10月17日更新）

string get_stylesheet( )

現在のテーマ名を取得する。

wp_get_nav_menu_object（2018年5月27日更新）

mixed wp_get_nav_menu_object( string $menu )

ナビゲーションメニューデータを取得する。

wp_constrain_dimensions（2016年8月17日更新）

array wp_constrain_dimensions( int $current_width, int $current_height [ , int $max_width = 0 [ , int $max_height = 0 ] ] )

縦横比を維持した縮小サイズを取得する。

do_all_trackbacks（2020年12月11日更新）

void do_all_trackbacks()

すべてのトラックバックを実行する。

is_php_version_compatible（2020年8月31日更新）

bool is_php_version_compatible( string $required )

PHPバージョンの互換性を調べる。