函数文档

rest_is_integer()

💡 云策文档标注

概述

rest_is_integer() 函数用于判断给定值是否为整数或整数类似值。它通过检查数值性和四舍五入后的相等性来实现。

关键要点

  • 函数接受一个参数 $maybe_integer,类型为 mixed,必需,表示待评估的值。
  • 返回布尔值:如果值为整数则返回 true,否则返回 false。
  • 函数实现基于 is_numeric() 和 round() 函数,确保数值类型和整数特性。
  • 该函数在 WordPress 5.5.0 版本中引入。

代码示例

function rest_is_integer( $maybe_integer ) {
    return is_numeric( $maybe_integer ) && round( (float) $maybe_integer ) === (float) $maybe_integer;
}

注意事项

  • 该函数用于 REST API 相关验证,例如在 rest_validate_integer_value_from_schema() 中被调用。
  • 注意参数可以是任何类型,但函数会先检查是否为数值,再判断整数特性。

📄 原文内容

Determines if a given value is integer-like.

Parameters

$maybe_integermixedrequired
The value being evaluated.

Return

bool True if an integer, otherwise false.

Source

function rest_is_integer( $maybe_integer ) {
	return is_numeric( $maybe_integer ) && round( (float) $maybe_integer ) === (float) $maybe_integer;
}

Changelog

Version Description
5.5.0 Introduced.