当前浏览:首页 / WordPress函数 / add_site_option()

add_site_option( string $option, mixed $value )

为当前网络添加新选项

addmore...

option 选项more...

sitemore...


描述

现有选项将不会更新。请注意,在3.3之前,情况并非如此。

另见


参数

$option

(string)(必填) 要添加的选项的名称。预期不会进行SQL转义。

$value

(mixed)(必填) 选项值,可以是任何值。预期不会进行SQL转义。


返回

(bool) 如果添加了该选项,则为true,否则为false。


更多信息

此函数与add_option()基本相同,但在使用WP 多站点时可在网络范围内工作。

唯一的主要区别是,在多站点上,整个站点的选项不会自动加载,而在单个站点上,该选项将自动加载。与在单个站点上使用add_option()不同,该功能不能被覆盖。



源码

查看源码 官方文档


更新日志

版本描述
4.4.0已修改为add_network_option()的封装器
2.8.0开始引入

使用示例

  • 示例1

    安装选项默认值

       
     	if ( 1 == $wpmu ) {
             if ( ! get_site_option( 'wporg_lead_options' ) ) {
                 add_site_option( 'wporg_lead_options', $wporg_lead_options_defaults, '', 'yes' );
             }
    	} else {
             if ( ! get_option( 'wporg_lead_options' ) ) {
                 add_option( 'wporg_lead_options', $wporg_lead_options_defaults, '', 'yes' );
             }
    	}
    
  • 示例2

    举例

    默认用法:

    add_site_option( 'my_option', 'my_value' );
    

    如果选项已存在,则执行以下操作:

    echo get_site_option( 'i_exist_already' );
    
    // Output: 'some_value'
    
    
    if ( add_site_option( 'i_exist_already', 'new_value' ) ) {
       echo get_site_option( 'i_exist_already' );
    } else {
       echo __( 'Already exists', 'textdomain' );
    }
    
  • 示例3

    参数$value列为可选参数。它不是可选的是必需的。