函数文档

wp_revisions_enabled()

💡 云策文档标注

概述

wp_revisions_enabled() 函数用于检查指定文章是否启用了修订功能。它通过调用 wp_revisions_to_keep() 函数来判断保留的修订数量是否为零。

关键要点

  • 参数:接受一个 WP_Post 对象作为必需参数。
  • 返回值:返回布尔值,如果保留的修订数量不为零则返回 true,否则返回 false。
  • 内部实现:直接调用 wp_revisions_to_keep($post) !== 0 进行判断。

代码示例

function wp_revisions_enabled( $post ) {
    return wp_revisions_to_keep( $post ) !== 0;
}

注意事项

  • 该函数自 WordPress 3.6.0 版本引入。
  • 与 wp_revisions_to_keep() 函数紧密相关,后者用于确定保留的修订数量。
  • 在多个核心功能中被使用,如 REST API 控制器和修订管理相关函数。

📄 原文内容

Determines whether revisions are enabled for a given post.

Parameters

$postWP_Postrequired
The post object.

Return

bool True if number of revisions to keep isn’t zero, false otherwise.

Source

function wp_revisions_enabled( $post ) {
	return wp_revisions_to_keep( $post ) !== 0;
}

Changelog

Version Description
3.6.0 Introduced.