WordPress心跳功能 Heartbeat API - 另一种定时任务

追格官方小助手/ 2022年11月14日/ WordPress/ 浏览 1655

关于 WordPress 定时任务,之前已介绍过了,如《WordPress如何禁用wp-cron定时任务或添加定时任务》《为WordPress添加定时任务》《WordPress怎么禁用定时任务》等文章。


不过,wp-cron 的机制导致在某些场景是不适用的。比如,打开一个页面后,在这个页面需要定时从服务器请求新数据。一般的,这个需求用js的的setInterval 定时发送AJAX请求就可以实现。


WordPress 也提供了一种方案,就是 Heartbeat API。


Heartbeat  API是WordPress内置的一个简单的服务器轮询API,允许近似实时的前端更新。


当页面加载时,客户端心跳代码设置一个间隔(称为“滴答”),每隔15-120秒运行一次。当它运行时,heartbeat收集数据通过jQuery事件发送,然后将其发送到服务器并等待响应。在服务器上,管理员ajax处理程序接收传递的数据,准备响应,过滤响应,然后以JSON格式返回数据。客户端接收此数据并触发最终jQuery事件,以指示数据已被接收。


如何使用 Heartbeat API 呢?


第一步,通过 heartbeat-send 事件,向服务器发送数据。


jQuery( document ).on( 'heartbeat-send', function ( event, data ) {
	// 需要向后台发送的数据,直接赋值到data就行
	data.myplugin_customfield = 'some_data';
});


第二步,在后台接收心跳数据,处理后,并返回结果给前端。


function myplugin_receive_heartbeat( array $response, array $data ) {
	// 检查收到的数据
	if ( empty( $data['myplugin_customfield'] ) ) {
		return $response;
	}

	// 处理收到的数据,这里的处理的方式是 sha1
	$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 );
});


上面的三步,和发起一个AJAX请求,不能说是一样,简直就是一模一样!


果然,大厂都是喜欢造轮子的。使用 Heartbeat API 的好处就是让代码更加“WordPress”。


最后,有个问题,如果我只需要在前端执行定时任务,而不需要从后端请求数据,还能使用 Heartbeat API 吗?


当然可以,只使用第一步就可以了!

发表评论

暂无评论,抢个沙发...

客服 工单