函数文档

wp_heartbeat_set_suspension()

💡 云策文档标注

概述

wp_heartbeat_set_suspension() 是一个 WordPress 函数,用于在添加/编辑文章页面禁用 Heartbeat 的暂停功能。它通过过滤 Heartbeat 设置数组来实现。

关键要点

  • 函数作用:在 post.php 或 post-new.php 页面禁用 Heartbeat 的 suspension 设置。
  • 参数:接受一个 Heartbeat 设置数组作为必需参数。
  • 返回值:返回过滤后的 Heartbeat 设置数组。
  • 引入版本:WordPress 3.8.0。

代码示例

function wp_heartbeat_set_suspension( $settings ) {
	global $pagenow;

	if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) {
		$settings['suspension'] = 'disable';
	}

	return $settings;
}

📄 原文内容

Disables suspension of Heartbeat on the Add/Edit Post screens.

Parameters

$settingsarrayrequired
An array of Heartbeat settings.

Return

array Filtered Heartbeat settings.

Source

function wp_heartbeat_set_suspension( $settings ) {
	global $pagenow;

	if ( 'post.php' === $pagenow || 'post-new.php' === $pagenow ) {
		$settings['suspension'] = 'disable';
	}

	return $settings;
}

Changelog

Version Description
3.8.0 Introduced.