Heartbeat API 是一个内置于 WordPress 的简单服务器轮询 API，可实现近乎实时的前端更新。

工作原理

页面加载时，客户端 Heartbeat 代码会设置一个间隔（称为“tick"），每 15-120 秒运行一次。运行时，Heartbeat 收集数据并通过 jQuery 事件发送，然后将其发送到服务器并等待响应。在服务器上，admin-ajax 处理器接收传入的数据，准备响应，过滤响应，然后以 JSON 格式返回数据。客户端接收此数据并触发最终的 jQuery 事件以指示数据已接收。

自定义 Heartbeat 事件的基本流程如下：

  1. 向要发送的数据添加额外字段（JS heartbeat-send 事件）
  2. 在 PHP 中检测已发送的字段，并添加额外的响应字段（heartbeat_received 过滤器）
  3. 在 JS 中处理返回的数据（JS heartbeat-tick）

（您可以根据所需功能选择仅使用其中一或两个事件。）

使用 API

使用 Heartbeat API 需要两种独立的功能：JavaScript 中的发送和接收回调，以及 PHP 中用于处理传入数据的服务器端过滤器。

向服务器发送数据

当 Heartbeat 向服务器发送数据时，您可以包含自定义数据。这可以是您想发送到服务器的任何数据，也可以是一个简单的 true 值，以表示您期望接收数据。

jQuery( document ).on( 'heartbeat-send', function ( event, data ) {
	// Add additional data to Heartbeat data.
	data.myplugin_customfield = 'some_data';
});

在服务器端接收和响应

在服务器端，您可以检测此数据，并向响应添加额外数据。

/**
 * 接收 Heartbeat 数据并作出响应。
 *
 * 处理通过 Heartbeat 请求接收的数据，并返回额外数据以传递给前端。
 *
 * @param array $response 要返回给前端的 Heartbeat 响应数据。
 * @param array $data     从前端接收的数据（未加斜杠）。
 *
 * @return array
 */
function myplugin_receive_heartbeat( array $response, array $data ) {
	// 如果未接收到我们的数据，则不发送任何数据返回。
	if ( empty( $data['myplugin_customfield'] ) ) {
		return $response;
	}

	// 计算我们的数据并返回。在此示例中，我们将对其进行哈希处理。
	$received_data = $data['myplugin_customfield'];

	$response['myplugin_customfield_hashed'] = sha1( $received_data );
	return $response;
}
add_filter( 'heartbeat_received', 'myplugin_receive_heartbeat', 10, 2 );

处理响应

回到前端，您可以处理接收此返回数据。

jQuery( document ).on( 'heartbeat-tick', function ( event, data ) {
	// 检查我们的数据并使用它。
	if ( ! data.myplugin_customfield_hashed ) {
		return;
	}

	alert( 'The hash is ' + data.myplugin_customfield_hashed );
});


并非所有功能都需要这三个步骤。例如，如果您不需要向服务器发送任何数据，您可以仅使用后两个步骤。