函数文档

undismiss_core_update()

💡 云策文档标注

概述

undismiss_core_update() 函数用于取消对 WordPress 核心更新的忽略状态,通过移除指定版本和区域设置的键值来恢复更新通知。

关键要点

  • 函数接受两个必需参数:$version(版本字符串)和 $locale(区域设置字符串)。
  • 返回布尔值,表示操作是否成功(true 表示成功取消忽略,false 表示未找到对应忽略项)。
  • 内部操作基于站点选项 'dismissed_update_core',使用键 $version . '|' . $locale 进行标识。
  • 函数在 WordPress 2.7.0 版本中引入。

代码示例

function undismiss_core_update( $version, $locale ) {
    $dismissed = get_site_option( 'dismissed_update_core' );
    $key       = $version . '|' . $locale;

    if ( ! isset( $dismissed[ $key ] ) ) {
        return false;
    }

    unset( $dismissed[ $key ] );

    return update_site_option( 'dismissed_update_core', $dismissed );
}

注意事项

  • 此函数仅适用于多站点环境中的网络级别选项操作。
  • 相关函数包括 update_site_option() 和 get_site_option(),用于管理网络选项。
  • 函数 do_undismiss_core_update() 在 wp-admin/update-core.php 中调用此函数来处理核心更新的取消忽略操作。

📄 原文内容

Undismisses core update.

Parameters

$versionstringrequired
$localestringrequired

Return

bool

Source

function undismiss_core_update( $version, $locale ) {
	$dismissed = get_site_option( 'dismissed_update_core' );
	$key       = $version . '|' . $locale;

	if ( ! isset( $dismissed[ $key ] ) ) {
		return false;
	}

	unset( $dismissed[ $key ] );

	return update_site_option( 'dismissed_update_core', $dismissed );
}

Changelog

Version Description
2.7.0 Introduced.