WordPress函数add_blog_option多站点添加配置信息

今天看到这个有意思的函数，应用场景应该不多，百度没搜到相关用法，当你的WordPress网站由很多子站组成，但主站需要更新子站配置信息时就需要这个add_blog_option函数来实现。它的功能很好理解，跟add_option一个意思，就是在option表中添加一个键值对数据，用作WordPress配置信息，只是多了个id参数用来指定是哪个WordPress网站而已，下面我们来看看它的官方文档说明及用法。

函数描述

为指定博客id添加一个新的配置项。

这个配置项不需要你序列化它，并且需要注意的是资源不能被序列化不能被添加为配置项。你可以为空值创建一个配置项，但必须有配置项的名称，即有键无值，通过更新方法来添加数据，注意，配置项的键名唯一，不能出现相同命名。

函数原型

add_blog_option函数位于wp-includes/ms-blogs.php文件中，源码如下：

function add_blog_option( $id, $option, $value ) {
    $id = (int) $id;
 
    if ( empty( $id ) )
        $id = get_current_blog_id();
 
    if ( get_current_blog_id() == $id )
        return add_option( $option, $value );
 
    switch_to_blog( $id );
    $return = add_option( $option, $value );
    restore_current_blog();
 
    return $return;
}

参数说明

add_blog_option( int $id, string $option, mixed $value )

$id

(整型) (必须) 博客id,可以为空，默认选择当前博客（奇怪，从上面源码可以看出，如果为空将会获取当前博客id,但参数却说是必须的。）

$option

(字符串) (必须) 配置项名称，不会被转义。

$value

(混合) (可选) 配置项对应的值，可以是任意值，不会被转义。

返回值

(布尔类型) 成功返回true，失败返回false。

使用实例

为博客id为2的博客添加一个名为test的配置项，值为www.daimadog.org。

$result=add_blog_option( 2, "test", "www.daimadog.org" )
$result ? echo "添加成功"; : echo "添加失败";

后面这句是判断的简写，看不懂没关系，自己用if写判断就好。