选项 Options API

概述

Options  API 是一种在数据库中存储数据的简单且标准化的方法。API 使创建、访问、更新和删除选项变得容易。所有数据都以给定的自定义名称存储在 wp_options 表中 。

1. 添加一个选项：

// 添加一个名为my_option的选项，并将它的默认值设置为true
// 注意，这个选项将保存在WordPress数据库的wp_options表中
add_option( 'my_option', true );

2. 获取一个选项：

// 获取名为my_option的选项的值
$my_option_value = get_option( 'my_option' );

3. 更新一个选项：

// 将名为my_option的选项的值更新为false
update_option( 'my_option', false );

4. 删除一个选项：

// 删除名为my_option的选项
delete_option( 'my_option' );

功能参考

添加/删除选项：

• add_option()
• delete_option()
• add_site_option()
• delete_site_option()

获取/更新选项：

• get_option()
• update_option()
• get_site_option()
• update_site_option()

例子

// Create an option to the database
add_option( $option, $value = , $deprecated = , $autoload = 'yes' );

// Removes option by name.
delete_option( $option );

// Fetch a saved option
get_option( $option, $default = false );

// Update the value of an option that was already added.
update_option( $option, $newvalue );

按类别列出的可用选项

讨论

• blacklist_keys：当评论在其内容、名称、URL、电子邮件或 IP 中包含任何这些词时，它将被标记为垃圾邮件。每行一个词或 IP。它将匹配内部单词，因此“press”将匹配“WordPress”。
  默认值：NULL
  数据类型：String（可能是多行）
• comment_max_links：如果评论包含此选项或更多的值，则在队列中保留评论。
  默认值：2
  数据类型：Int
• comment_moderation：在评论出现之前，管理员必须始终批准该评论。
  1  ： 是
  0  ： 假 （默认）
  数据类型：Int
• comments_notify: 当有人发表评论时给我发电子邮件。
  1  ： 是 （默认）
  0  ： 否
  数据类型：Int
• default_comment_status: 允许评论（可以用个别帖子覆盖）
  open  : 允许评论 （默认）
  closed  : 不允许评论
  数据类型：String
• default_ping_status：允许来自其他博客的链接通知（pingbacks 和 trackbacks）。
  open  : 允许来自其他博客的 pingbacks 和 trackbacks  （默认）
  closed  : 不允许来自其他博客的 pingbacks 和 trackbacks
  数据类型：String
• default_pingback_flag：尝试通知从文章链接到的任何博客（减慢发布速度）。
  1  ： 是 （默认）
  0  ： 否
  数据类型：Int
• moderation_keys：当评论在其内容、名称、URL、电子邮件或 IP 中包含任何这些词时，它将被保留在审核队列中。每行一个词或 IP。它将匹配内部单词，因此“press”将匹配“WordPress”。
  默认值：NULL
  数据类型：String（可能是多行）
• moderation_notify：当评论保留审核时给我发电子邮件。
  1  ： 是 （默认）
  0  ： 否
  数据类型：Int
• require_name_email：在评论出现之前，评论作者必须填写他/她的姓名和电子邮件。
  1  ： 是 （默认）
  0  ： 否
  数据类型：Int
• thread_comments：启用 WP-native 线程（嵌套）评论。
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int
• thread_comments_depth：设置评论的线程级别数。
  1 到 
  10  ：级别
  默认值：5
  数据类型：Int
• show_avatars: 头像显示
  1  : （默认） 显示头像
  0  : 不显示头像
  数据类型：Int
• avatar_rating: Maximum Rating
  G  : (default) 适用于所有观众
  PG  :  Possibly offensive, usually for audiences 13 and above
  R  :  Intended for adult audiences above 17
  X  :  Even more mature than above
  数据类型：String
• avatar_default：默认头像
  mystery ：（默认） 神秘人
  blank ： 空白
  gravatar_default  ：  Gravatar Logo
  identicon  ：  Identicon（生成）
  wavatar  ：  Wavatar（生成）
  monsterid  ：  MonsterID（生成）
  retro  ：  Retro（生成）
  数据类型：String
• close_comments_for_old_posts：自动关闭旧文章评论
  1  ： 是
  0  ： 否 （默认）
  数据类型：Integer
• close_comments_days_old: 自动关闭对早于 x 天的文章的评论
  默认值：14
  数据类型：Integer
• show_comments_cookies_opt_in：在评论表单上显示 cookies 选择加入复选框并启用评论 cookies
  1  ： 是 （默认为 4.9.8）
  0  ： 否
  数据类型：Int
• page_comments：将评论分成几页
  1  ： 是 （默认）
  0  ： 否
  数据类型：Int
• comments_per_page：默认
  值：50
  数据类型：Int
• default_comments_page：
  默认值：“最新”
  数据类型：String
• comment_order:
  asc  : （默认）
  desc  :
  数据类型：String
• comment_whitelist：评论作者必须有一个先前批准的评论
  1  ： 是 （默认）
  0  ： 否
  数据类型：

一般的

• admin_email：管理员邮箱
  默认值：'you@example.com'
  数据类型：String
• blogdescription: 博客标语
  默认值：'__('Just another WordPress weblog')'
  数据类型：String
• blogname: 博客标题
  默认值：'__('My Blog')'
  数据类型：String
• comment_registration：用户必须注册并登录才能发表评论
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int
• date_format: 默认日期格式
  默认: '__('F j, Y')'
  数据类型: String
• default_role：在博客注册的用户的默认角色。
  subscriber （默认）
  administrator
  editor
  author
  contributor
  数据类型：String
• gmt_offset: 博客中的时间应该与这个值不同。
  -6  ：  GMT -6（又名美国中部时间）
  0  ：  GMT（又名格林威治标准时间）
  默认值： 日期（'Z'）/ 3600
  数据类型：Int
• home: 博客地址 (URL)
  默认值：wp_guess_url()
  数据类型：String (URI)
• siteurl：WordPress地址（URL）
  默认wp_guess_url()
  数据类型：String（URI）
• start_of_week: 一周的开始日期。
  0  ： 星期日
  1  ： 星期一 （默认）
  2  ： 星期二
  3  ： 星期三
  4  ： 星期四
  5  ： 星期五
  6  ： 星期六
  数据类型：Int
• time_format: 默认时间格式
  Default: '__('g:i a')'
  数据类型：String
• timezone_string：时区
  默认值：NULL
  数据类型：String
• users_can_register：任何人都可以注册
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int

链接

• links_updated_date_format：
  默认__('F j, Y g:i a')
  数据类型：String
• links_recently_updated_prepend：
  默认为空
  数据类型： String
• links_recently_updated_append
  _默认_为空
  数据类型：String
• links_recently_updated_time
  默认值：120
  数据类型：Int

媒体

• thumbnail_size_w：默认
  值：150
  数据类型：Int
• thumbnail_size_h：默认
  值：150
  数据类型：Int
• thumbnail_crop：将缩略图裁剪到精确尺寸（通常缩略图是成比例的）
  1  ： 是 （默认）
  0  ： 否
  数据类型：Int
• medium_size_w：默认
  值：300
  数据类型：Int
• medium_size_h
  默认值：300
  数据类型：Int
• large_size_w
  默认值：1024
  数据类型：Int
• large_size_h
  默认值：1024
  数据类型：Int
• embed_autourls：尝试自动嵌入所有纯文本 URL
  默认值：1
  数据类型：Integer
• embed_size_w
  默认值：NULL
  数据类型：Int
• embed_size_h
  默认值：600
  数据类型：Int

其他

• hack_file：使用旧 my-hacks.php 文件支持
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int
• html_type：博客页面的默认 MIME 类型（text/html、text/xml+html 等）
  默认值：'text/html'
  数据类型：String（MIME 类型）
• secret：安装期间创建的秘密值与加盐等一起使用。
  默认值：wp_generate_password(64)
  数据类型：String (MD5)
• upload_path：在此文件夹中存储上传（相对于 WordPress 根目录）
  默认值：NULL
  数据类型：String（相对路径）
• upload_url_path：上传文件夹的URL路径（默认为空白-可在“所有设置”屏幕中编辑。
  数据类型：String（URL路径）
• uploads_use_yearmonth_folders：将我的上传组织到基于月份和年份的文件夹中
  1  ： 是 （默认）
  0  ： 否 （安全模式默认）
  数据类型：Int
• use_linksupdate：跟踪链接的更新次数
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int

永久链接

• permalink_structure：您博客永久链接的所需结构。一些示例：：
  /%year%/%monthnum%/%day%/%postname%/基于日期和名称
  /archives/%post_id%/：数字
  /%postname%/：基于帖子名称
  默认值：NULL
  数据类型：String
• category_base：您的博客类别永久链接的默认类别基础。
  默认值：NULL
  数据类型：String
• tag_base：博客标签永久链接的默认标签库。
  默认值：NULL
  数据类型：String

隐私

• blog_public:
  1  : 我希望每个人都能看到我的博客，包括搜索引擎（如 Google、Sphere、Technorati）和归档程序。 （默认）
  0  ： 我想阻止搜索引擎，但允许普通访问者。
  数据类型：Int

阅读

• blog_charset：页面和提要的编码。您编写博客所用的字符编码（推荐使用 UTF-8）。
  默认值：UTF-8
  数据类型：String
• gzipcompression: 如果浏览器要求，WordPress 应该压缩文章（使用 gzip）。
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int
• page_on_front：应显示在首页的页面ID。要求 show_on_front的值为 page。
  数据类型：Int
• page_for_posts：显示帖子的页面ID。show_on_front当它的值为 page时很有用 。
  数据类型：Int
• posts_per_page ：在博客页面上最多显示 x篇文章。
  默认值：10
  数据类型：Int
• posts_per_rss :在 RSS 提要中最多显示 x个帖子。
  默认值：10
  数据类型：Int
• rss_language：RSS 提要的语言（仅用于元数据）
  默认值：en
  数据类型：String（ISO 两字母语言代码）
• rss_use_excerpt：在 RSS 源中显示帖子的摘录而不是全文
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int
• show_on_front：在首页
  posts上显示的内容 ： 您的最新帖子 （默认）
  page ： 静态页面（参见page_on_front）
  数据类型：String

主题

• template：当前激活主题的 slug（如何通过路径访问它，例如。  /wp-content/themes/my-theme（my-theme将是此选项的值）。
  默认值：'default'
  数据类型：String
• stylesheet：当前激活的样式表 (style.css) 的 slug（如何通过路径访问它，例如 /wp-content/themes/my-style（my-style 将是此选项的值）
  默认值：'default'
  数据类型：String

写作

• default_category: 默认发布的分类ID 默认
  : 1
  数据类型: Integer

• default_email_category：通过电子邮件写入时默认将帖子放入的类别的ID 默认值
  ：1
  数据类型：Integer

• default_link_category: 默认链接分类ID 默认
  : 2
  数据类型: Integer

• default_post_edit_rows：邮箱的大小（以行为单位）
  默认值：10
  数据类型：Int

• mailserver_login: 用于通过电子邮件发布到 WordPress 的邮件服务器用户名
  默认值：'login@example.com'
  数据类型：String

• mailserver_pass: 用于通过电子邮件发布到 WordPress 的邮件服务器密码
  默认值：'password'
  数据类型：String

• mailserver_port：通过电子邮件发布到 WordPress 的邮件服务器端口
  默认值：110
  数据类型：Int

• mailserver_url：用于通过电子邮件发布到 WordPress 的邮件服务器
  默认值：'mail.example.com'
  数据类型：String

• ping_sites：当您发布新帖子时，WordPress 会自动通知以下站点更新服务。有关详细信息，请参阅 更新服务。用换行符分隔多个服务 URL。要求 blog_public 值为 1。
  默认值：' http://rpc.pingomatic.com/'
  数据类型：String（可能是多行）

• use_balanceTags：自动更正无效嵌套的 XHTML
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int

• use_smilies:  显示时将:-) 和 等表情转换为图形1  : 是 （默认）0  : 否__数据类型：Int:P

• use_trackback：启用发送和接收引用
  1  ： 是
  0  ： 否 （默认）

• enable_app：启用 Atom 发布协议
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int

• enable_xmlrpc：启用 WordPress、Movable Type、MetaWeblog 和 Blogger XML-RPC 发布协议
  1  ： 是
  0  ： 否 （默认）
  数据类型：Int

未分类

• active_plugins : 返回包含插件_主_php 文件路径的String数组 。该路径是相对于 插件 文件夹的。数组中的路径示例：/mainpage.php。
  默认值：array()
  数据类型：数组
• advanced_edit：
  默认值：0
  数据类型：Int
• recently_edited：
  默认值：NULL
  数据类型：
• image_default_link_type：
  默认值：“文件”
  数据类型：  “文件”，“无”
• image_default_size：
  默认值：NULL
  数据类型：  “缩略图”、“中”、“大”或自定义大小
• image_default_align:
  默认值：NULL
  数据类型：  'left', 'right', 'center', 'none'
• sidebars_widgets：返回侧边栏状态数组（活动和非活动小部件列表）。
  默认值：
  数据类型：数组
• sticky_posts：
  默认值：array()
  数据类型：
• widget_categories：
  默认值：array()
  数据类型：
• widget_text：
  默认值：array()
  数据类型：
• widget_rss：
  默认值：array()
  数据类型：