函数文档

find_core_update()

💡 云策文档标注

概述

find_core_update() 函数用于查找 WordPress 核心的可用更新。它通过版本和区域设置参数匹配更新数据,返回更新对象或失败状态。

关键要点

  • 函数参数:$version(必需,版本字符串)和 $locale(必需,区域设置字符串)。
  • 返回值:成功时返回核心更新对象,失败时返回 false。
  • 内部逻辑:从 'update_core' 站点瞬态获取更新数据,遍历匹配版本和区域设置。

代码示例

function find_core_update( $version, $locale ) {
    $from_api = get_site_transient( 'update_core' );

    if ( ! isset( $from_api->updates ) || ! is_array( $from_api->updates ) ) {
        return false;
    }

    $updates = $from_api->updates;

    foreach ( $updates as $update ) {
        if ( $update->current === $version && $update->locale === $locale ) {
            return $update;
        }
    }

    return false;
}

注意事项

  • 函数自 WordPress 2.7.0 版本引入。
  • 依赖 get_site_transient() 获取更新数据,确保 'update_core' 瞬态已正确设置。
  • 相关函数包括 do_core_upgrade()、do_dismiss_core_update() 和 do_undismiss_core_update()。

📄 原文内容

Finds the available update for WordPress core.

Parameters

$versionstringrequired
Version string to find the update for.
$localestringrequired
Locale to find the update for.

Return

object|false The core update offering on success, false on failure.

Source

function find_core_update( $version, $locale ) {
	$from_api = get_site_transient( 'update_core' );

	if ( ! isset( $from_api->updates ) || ! is_array( $from_api->updates ) ) {
		return false;
	}

	$updates = $from_api->updates;

	foreach ( $updates as $update ) {
		if ( $update->current === $version && $update->locale === $locale ) {
			return $update;
		}
	}

	return false;
}

Changelog

Version Description
2.7.0 Introduced.