选项

概述

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

本页面包含使用 Options API 所需的技术文档。默认选项列表可在选项参考中找到（链接至 Codex 版本，等待内容迁移到 HelpHub）。

请注意，_site_函数本质上与其对应函数相同。唯一的区别出现在 WP Multisite 中，当选项应用于整个网络时，数据会存储在wp_sitemeta表中，并使用给定的自定义名称。

函数参考

添加/删除选项:

• 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
  数据类型:字符串（可能是多行）
• comment_max_links: 如果评论包含此选项的值或更多，则将其保留在队列中。
  默认值：2
  数据类型:整数
• comment_moderation: 在评论显示之前，管理员必须始终批准该评论。
  1 : 是
  0 : 否 (默认)
  数据类型:整数
• comments_notify: 任何人发表评论时给我发送电子邮件。
  1 : 是 (默认)
  0 : 否
  数据类型:整数
• default_comment_status: 允许评论（可被单个帖子覆盖）
  open : 允许评论 (默认)
  closed : 禁止评论
  数据类型:字符串
• default_ping_status: 允许来自其他博客的链接通知（pingbacks 和 trackbacks）。
  open : 允许来自其他博客的 pingbacks 和 trackbacks (默认)
  closed : 禁止来自其他博客的 pingbacks 和 trackbacks
  数据类型:字符串
• default_pingback_flag: 尝试通知文章链接到的任何博客（会减慢发布速度）。
  1 : 是 (默认)
  0 : 否
  数据类型:整数
• moderation_keys: 当评论的内容、名称、URL、电子邮件或 IP 中包含这些单词中的任何一个时，它将被保留在审核队列中。每行一个单词或 IP。它将在单词内部进行匹配，因此"press"将匹配"WordPress"。
  默认值：NULL
  数据类型:字符串（可能是多行）
• moderation_notify: 当评论被保留以待审核时给我发送电子邮件。
  1 : 是 (默认)
  0 : 否
  数据类型:整数
• require_name_email: 在评论显示之前，评论作者必须填写其姓名和电子邮件。
  1 : 是 (默认)
  0 : 否
  数据类型:整数
• thread_comments: 启用 WP 原生线程（嵌套）评论。
  1 : 是
  0 : 否 (默认)
  数据类型:整数
• thread_comments_depth: 设置评论的线程级别数量。
  1 至
  10 : 级别
  默认值：5
  数据类型:整数
• show_avatars: 头像显示
  1 : (默认) 显示头像
  0 : 不显示头像
  数据类型:整数
• avatar_rating: 最大评级
  G : (默认) 适合所有观众
  PG : 可能具有冒犯性，通常适合 13 岁及以上观众
  R : 专为 17 岁以上成人观众设计
  X : 比上述更加成熟
  数据类型:字符串
• avatar_default: 默认头像
  mystery : (默认) Mystery Man
  blank : 空白
  gravatar_default : Gravatar Logo
  identicon : Identicon (生成)
  wavatar : Wavatar (生成)
  monsterid : MonsterID (生成)
  retro : Retro (生成)
  数据类型:字符串
• close_comments_for_old_posts: 自动关闭旧文章的评论
  1 : 是
  0 : 否 (默认)
  数据类型:整数
• close_comments_days_old: 自动关闭超过 x 天的文章的评论
  默认值：14
  数据类型:整数
• show_comments_cookies_opt_in: 在评论表单上显示 Cookie 选择复选框并启用评论 Cookie
  1 : 是 (自 4.9.8 起为默认)
  0 : 否
  数据类型:整数
• page_comments: 将评论分页
  1 : 是 (默认)
  0 : 否
  数据类型:整数
• comments_per_page:
  默认值：50
  数据类型:整数
• default_comments_page:
  默认值：'newest'
  数据类型:字符串
• comment_order:
  asc : (默认)
  desc :
  数据类型:字符串
• comment_whitelist: 评论作者必须有一个先前批准的评论
  1 : 是 (默认)
  0 : 否
  数据类型:

常规

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

链接

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

媒体

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

杂项

• hack_file: 使用遗留的 my-hacks.php 文件支持
  1 : 是
  0 : 否 (默认)
  数据类型:整数
• html_type: 博客页面的默认 MIME 类型 (text/html, text/xml+html 等)
  默认值：'text/html'
  数据类型:字符串 (MIME 类型)
• secret: 安装期间创建的密钥值，用于加盐等操作
  默认值：wp_generate_password(64)
  数据类型:字符串 (MD5)
• upload_path: 在此文件夹中存储上传内容（相对于 WordPress 根目录）
  默认值：NULL
  数据类型:字符串 (相对路径)
• upload_url_path: 上传文件夹的 URL 路径（默认为空 – 可在“所有设置”屏幕中编辑。
  数据类型:字符串 (URL 路径)
• uploads_use_yearmonth_folders: 按月份和年份组织我的上传内容
  1 : 是 (默认)
  0 : 否 (安全模式下的默认值)
  数据类型:整数
• use_linksupdate: 跟踪链接的更新时间
  1 : 是
  0 : 否 (默认)
  数据类型:整数

固定链接

• permalink_structure: 您希望的博客固定链接结构。一些示例：
  /%year%/%monthnum%/%day%/%postname%/: 基于日期和名称
  /archives/%post_id%/: 基于数字
  /%postname%/: 基于帖子名称
  默认值：NULL
  数据类型:字符串
• category_base: 博客分类固定链接的默认分类基础。
  默认值：NULL
  数据类型:字符串
• tag_base: 博客标签固定链接的默认标签基础。
  默认值：NULL
  数据类型:字符串

隐私

• blog_public:
  1 : 我希望我的博客对所有人可见，包括搜索引擎（如 Google、Sphere、Technorati）和归档站点。 (默认)
  0 : 我希望阻止搜索引擎，但允许普通访客。
  数据类型:整数

阅读

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

主题

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

写作

• default_category: 帖子默认归入的类别 ID
  默认值：1
  数据类型：整数
• default_email_category: 通过电子邮件撰写的帖子默认归入的类别 ID
  默认值：1
  数据类型：整数
• default_link_category: 链接默认归入的类别 ID
  默认值：2
  数据类型：整数
• default_post_edit_rows: 帖子编辑框的大小（行数）
  默认值：10
  数据类型：整数
• mailserver_login: 通过电子邮件向 WordPress 发布邮件时使用的邮件服务器用户名
  默认值：‘login@example.com'
  数据类型：字符串
• mailserver_pass: 通过电子邮件向 WordPress 发布邮件时使用的邮件服务器密码
  默认值：‘password'
  数据类型：字符串
• mailserver_port: 通过电子邮件向 WordPress 发布邮件时使用的邮件服务器端口
  默认值：110
  数据类型：整数
• mailserver_url: 用于通过电子邮件向 WordPress 发布邮件的邮件服务器
  默认值：‘mail.example.com'
  数据类型：字符串
• ping_sites: 当您发布新帖子时，WordPress 会自动通知以下站点更新服务。有关此功能的更多信息，请参阅更新服务。多个服务 URL 请用换行符分隔。需要 blog_public 的值为1。
  默认值：‘http://rpc.pingomatic.com/’
  数据类型：字符串（可能为多行）
• use_balanceTags: 自动修正无效嵌套的 XHTML
  1：是
  0：否（默认）
  数据类型：整数
• use_smilies: 在显示时将表情符号如:-)和:P转换为图形
  1：是（默认）
  0：否
  数据类型：整数
• use_trackback: 启用发送和接收 Trackbacks
  1：是
  0：否（默认）
• enable_app: 启用 Atom Publishing Protocol
  1：是
  0：否（默认）
  数据类型：整数
• enable_xmlrpc: 启用 WordPress、Movable Type、MetaWeblog 和 Blogger 的 XML-RPC 发布协议
  1：是
  0：否（默认）
  数据类型：整数

未分类

• active_plugins: 返回一个字符串数组，包含插件的主 php 文件路径。该路径相对于plugins文件夹。数组中的路径示例：/mainpage.php。
  默认值：array()
  数据类型：数组
• advanced_edit:
  默认值：0
  数据类型：整数
• recently_edited:
  默认值：NULL
  数据类型：
• image_default_link_type:
  默认值：‘file'
  数据类型：‘file'、‘none'
• image_default_size:
  默认值：NULL
  数据类型：‘thumbnail'、‘medium'、‘large'或自定义尺寸
• image_default_align:
  默认值：NULL
  数据类型：‘left'、‘right'、‘center'、‘none'
• sidebars_widgets: 返回侧边栏状态数组（活动和非活动小部件列表）。
  默认值：
  数据类型：数组
• sticky_posts:
  默认值：array()
  数据类型：
• widget_categories:
  默认值：array()
  数据类型：
• widget_text:
  默认值：array()
  数据类型：
• widget_rss:
  默认值：array()
  数据类型：

所有设置屏幕

WordPress 3.0移除了“设置 > 杂项”屏幕，部分选项无法访问（例如upload_url_path）。您可以使用“所有设置”屏幕查看和更改上述几乎所有选项。访问/wp-admin/options.php即可进入该屏幕。