函数文档

_get_cron_array()

💡 云策文档标注

概述

_get_cron_array() 函数用于从 WordPress 数据库中检索 cron 事件数组,并处理版本升级以确保数据一致性。它返回一个包含所有 cron 事件的数组,供其他函数调用。

关键要点

  • 函数从 'cron' 选项获取 cron 事件数组,如果数据不是数组则返回空数组。
  • 检查数组中的 'version' 键,如果不存在则调用 _upgrade_cron_array() 进行升级。
  • 移除 'version' 键后返回处理后的 cron 数组,确保返回类型始终为数组。

代码示例

function _get_cron_array() {
    $cron = get_option( 'cron' );
    if ( ! is_array( $cron ) ) {
        return array();
    }

    if ( ! isset( $cron['version'] ) ) {
        $cron = _upgrade_cron_array( $cron );
    }

    unset( $cron['version'] );

    return $cron;
}

注意事项

  • 从 WordPress 6.1.0 版本起,返回类型被修改为始终返回数组,提高了函数的一致性。
  • 该函数自 WordPress 2.1.0 引入,是内部函数,通常不直接调用,而是通过其他 cron 相关函数间接使用。

📄 原文内容

Retrieves cron info array option.

Return

array[] Array of cron events.

Source

function _get_cron_array() {
	$cron = get_option( 'cron' );
	if ( ! is_array( $cron ) ) {
		return array();
	}

	if ( ! isset( $cron['version'] ) ) {
		$cron = _upgrade_cron_array( $cron );
	}

	unset( $cron['version'] );

	return $cron;
}

Changelog

Version Description
6.1.0 Return type modified to consistently return an array.
2.1.0 Introduced.