钩子文档

heartbeat_nopriv_tick

💡 云策文档标注

概述

heartbeat_nopriv_tick 是一个 WordPress Hook,在无权限环境下的 Heartbeat 心跳机制触发时执行。它允许替换传输方式为长轮询,主要用于处理 AJAX 请求。

关键要点

  • 触发时机:在无权限环境(如未登录用户)中 Heartbeat 心跳发生时
  • 主要用途:便于将传输方式替换为长轮询,优化 Heartbeat API 在无权限上下文中的处理
  • 参数:$response(无权限 Heartbeat 响应数组)和 $screen_id(屏幕 ID 字符串)
  • 相关函数:wp_ajax_nopriv_heartbeat() 用于通过 AJAX 处理无权限 Heartbeat API
  • 版本历史:自 WordPress 3.6.0 引入

代码示例

do_action( 'heartbeat_nopriv_tick', $response, $screen_id );

📄 原文内容

Fires when Heartbeat ticks in no-privilege environments.

Description

Allows the transport to be easily replaced with long-polling.

Parameters

$responsearray
The no-priv Heartbeat response.
$screen_idstring
The screen ID.

Source

do_action( 'heartbeat_nopriv_tick', $response, $screen_id );

Changelog

Version Description
3.6.0 Introduced.