云策 WordPress 开发者社区

函数文档

update_site_option()

查看官方原文 ↗
💡 云策文档标注

概述

update_site_option() 函数用于更新当前网络中已存在的选项值，是 update_network_option() 的包装函数，适用于多站点环境。

关键要点

  • 函数更新网络级别的选项值，参数 $option 和 $value 无需 SQL 转义
  • 返回布尔值：更新成功返回 true，否则返回 false
  • 从 WordPress 4.4.0 起，此函数改为 update_network_option() 的包装，数据存储在 sitemeta 表而非站点选项表
  • 仅在多站点启用时有效，否则调用 update_option()

代码示例

function update_site_option( $option, $value ) {
    return update_network_option( null, $option, $value );
}

注意事项

  • 函数名可能引起误解，实际操作网络元数据表，需注意多站点环境下的数据存储位置
  • 使用前应检查 is_multisite() 以确保功能适用性
📄 原文内容

Updates the value of an option that was already added for the current network.

Description

See also

Parameters

$optionstringrequired
Name of the option. Expected to not be SQL-escaped.
$valuemixedrequired
Option value. Expected to not be SQL-escaped.

Return

bool True if the value was updated, false otherwise.

Source

function update_site_option( $option, $value ) {
	return update_network_option( null, $option, $value );
}

View all references View on Trac View on GitHub

Uses Description
update_network_option()wp-includes/option.php

Updates the value of a network option that was already added.
Used by Description
deactivated_plugins_notice()wp-admin/includes/plugin.php

Renders an admin notice when a plugin was deactivated during an update.
wp_ajax_toggle_auto_updates()wp-admin/includes/ajax-actions.php

Handles enabling or disable plugin and theme auto-updates via AJAX.
WP_Recovery_Mode_Cookie_Service::recovery_mode_hash()wp-includes/class-wp-recovery-mode-cookie-service.php

Gets a form of wp_hash() specific to Recovery Mode.
update_network_option_new_admin_email()wp-includes/ms-functions.php

Sends a confirmation request email when a change of network admin email address is attempted.
WP_Theme::network_enable_theme()wp-includes/class-wp-theme.php

Enables a theme for all sites on the current network.
WP_Theme::network_disable_theme()wp-includes/class-wp-theme.php

Disables a theme for all sites on the current network.
WP_Automatic_Updater::after_core_update()wp-admin/includes/class-wp-automatic-updater.php

Checks whether to send an email and avoid processing future updates after attempting a core update.
WP_Automatic_Updater::send_email()wp-admin/includes/class-wp-automatic-updater.php

Sends an email upon the completion or failure of a background core update.
WP_Plugins_List_Table::prepare_items()wp-admin/includes/class-wp-plugins-list-table.php
grant_super_admin()wp-includes/capabilities.php

Grants Super Admin privileges.
revoke_super_admin()wp-includes/capabilities.php

Revokes Super Admin privileges.
dismiss_core_update()wp-admin/includes/update.php

Dismisses core update.
undismiss_core_update()wp-admin/includes/update.php

Undismisses core update.
upgrade_network()wp-admin/includes/upgrade.php

Executes network-level upgrade routines.
activate_plugin()wp-admin/includes/plugin.php

Attempts activation of plugin in a “sandbox” and redirects on success.
deactivate_plugins()wp-admin/includes/plugin.php

Deactivates a single plugin or multiple plugins.
wp_ajax_wp_compression_test()wp-admin/includes/ajax-actions.php

Handles compression testing via AJAX.
wp_salt()wp-includes/pluggable.php

Returns a salt to add to hashes.
set_site_transient()wp-includes/option.php

Sets/updates the value of a site transient.
welcome_user_msg_filter()wp-includes/ms-functions.php

Ensures that the welcome message is not empty. Currently unused.

Show 15 moreShow less

Changelog

Version Description
4.4.0 Modified into wrapper for update_network_option()
2.8.0 Introduced.

User Contributed Notes