函数文档

wp_heartbeat_settings()

💡 云策文档标注

概述

wp_heartbeat_settings() 函数用于设置 WordPress 心跳机制(Heartbeat)的默认参数,包括 AJAX URL 和 nonce 值,以支持前端与服务器的实时通信。

关键要点

  • 函数返回一个数组,包含心跳机制的设置参数。
  • 在非管理界面(is_admin() 返回 false)时,设置 ajaxurl 为 admin-ajax.php 的相对 URL。
  • 当用户已登录(is_user_logged_in() 返回 true)时,生成一个与 'heartbeat-nonce' 动作绑定的 nonce 值。
  • 该函数自 WordPress 3.6.0 版本引入。

代码示例

function wp_heartbeat_settings( $settings ) {
    if ( ! is_admin() ) {
        $settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' );
    }

    if ( is_user_logged_in() ) {
        $settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' );
    }

    return $settings;
}

📄 原文内容

Default settings for heartbeat.

Description

Outputs the nonce used in the heartbeat XHR.

Parameters

$settingsarrayrequired

Return

array Heartbeat settings.

Source

function wp_heartbeat_settings( $settings ) {
	if ( ! is_admin() ) {
		$settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' );
	}

	if ( is_user_logged_in() ) {
		$settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' );
	}

	return $settings;
}

Changelog

Version Description
3.6.0 Introduced.