方法介绍
一个安全的添加键值对配置属性到数据库表的方法。如果已经存在这个配置属性呢,那就随风飘过。保存之后就可以用get_option()
方法来查询,用update_option()
来更新配置属性,用delete_option()
方法来更新配置属性。
你不需要去序列化这些属性值。如果需要序列化,那它会在存到数据库之前被序列化。你可以先添加配置属性,而不设置属性值,可以稍后设置。
调用add_option
前先检测此配置属性是否已经设置,不存在的话就返回false
。下一步呢就会去确保要添加的属性值不是被保护属性名称或者是非配置属性名称,要么就dies
并返回一个错误信息,如果检测到有复写被保护属性的话。如果此配置属性名称为被保护,并且不存在,那就会新增这个配置属性。
注意:add_option
使用get_option
来决定是否已经存在这个配置属性,那返回false
的话作为默认值,如果设置了false
作为配置属性值(比如:通过update_option($option_name, false)
),然后继续add_option
方法会改变它的值,因为对于add_option
方法来说那这个配置属性是不存在的。
vs. update_option()
如果你想确认给定的配置属性是否成功配置,可以使用update_option()
来检测配置属性,并用期望的值来更新,或者不存在的话就直接忽略。
NB:如果要使用update_option()
方法的话不可以把autoload='no'
这样设置,这样你就不确定这个配置属性是否存在了,那就需要在add_option()
调用之前先调用delete_option()
来删除它。
使用方法
<?php add_option( $option, $value, $deprecated, $autoload ); ?>
参数
$option
(string
) (required
) 要添加的配置属性名称。但是不能超过64个字符。使用下划线分隔单词,不允许使用大写字幕-将来会存储到数据库里。
默认: None
$value
(mixed
) (optional
) 要设置的配置属性值。最大2^32
字节数据
$deprecated
(string
) (optional
) 在Wordpress 2.3版本中就弃用了。
默认: ''
$autoload
(string
) (optional
) 是否允许wp_load_alloptions()
这个方法来自动加载此属性(会在每个页面加载的时候将配置属性存储在对象缓存中)。有效值:yes or no。
默认: yes
返回值
(boolean
)
返回False
则标识添加失败,True
则表示添加成功。
示例
<?php add_option( 'myhack_extraction_length', '255', '', 'yes' ); ?>
源文件
add_option()
源文件在 wp-includes/option.php。