Options are pieces of data that WordPress uses to store various preferences and configuration settings. Listed below are the options, along with some of the default values from the current WordPress install. By using the appropriate function, options can be added, changed, removed, and retrieved, from the wp_options table. This list accords to the WordPress 2.3.1 release, and does not include options that were deprecated by that version.
Definitions are normally typed, possible option-values are bolded, and option-value definitions are italicized. Data types are given after the possible values (if those are given) like this:
Data type: Integer
You can help make this page more complete!
Here are some things you can do to help:
- Add documentation to un-documented options, by adding a description, possible values, and the option's data type.
- List more options here, following the category structure (if they are not already listed).
- Correct errors by moving functions to better categories where appropriate, and of course fixing typos.
Read WordPress:Contributing to WordPress to find out more about how you can contribute to the effort!
View By Category
Discussion
- blacklist_keys
- When a comment contains any of these words in its content, name, URL, e-mail, or IP, it will be marked as spam. One word or IP per line. It will match inside words, so "press" will match "WordPress."
- Data type: String (possibly multi-line)
- comment_max_links
- Hold a comment in the queue if it contains the value of this option or more.
- Data type: Integer
- comment_moderation
- Before a comment appears, an administrator must always approve the comment.
- 1 : Yes
- 0 : True
- Data type: Integer
- comments_notify
- E-mail me when anyone posts a comment.
- 1 : Yes
- 0 : No
- Data type: Integer
- default_comment_status
- Allow comments (can be overridden with individual posts)
- open : Allow comments
- closed : Disallow comments
- Data type: String
- default_ping_status
- Allow link notifications from other blogs (pingbacks and trackbacks).
- open : Allow pingbacks and trackbacks from other blogs
- closed : Disallow pingbacks and trackbacks from other blogs
- Data type: String
- default_pingback_flag
- Attempt to notify any blogs linked to from the article (slows down posting).
- 1 : Yes
- 0 : No
- Data type: Integer
- moderation_keys
- When a comment contains any of these words in its content, name, URL, e-mail, or IP, it will be held in the moderation queue. One word or IP per line. It will match inside words, so "press" will match "WordPress."
- Data type: String (possibly multi-line)
- moderation_notify
- E-mail me when a comment is held for moderation.
- 1 : Yes
- 0 : No
- Data type: Integer
- require_name_email
- Before a comment appears, the comment author must fill out his/her name and email.
- 1 : Yes
- 0 : No
- Data type: Integer
|
General
- admin_email
- Administrator email
- Data type: String
- blogdescription
- Blog tagline
- Data type: String
- blogname
- Blog title
- Data type: String
- comment_registration
- Users must be registered and logged in to comment
- 1 : Yes
- 0 : No
- Data type: Integer
- date_format
- Default date format (see WordPress:Formatting Date and Time)
- Data type: String
- default_role
- The default role of users who register at the blog.
- subscriber :
- administrator :
- editor :
- author :
- contributor :
- Data type: String
- gmt_offset
- Times in the blog should differ by this value.
- -6 : GMT -6 (aka Central Time, USA)
- 0 : GMT (aka Greenwich Mean Time)
- Data type: Integer
- home
- Blog address (URL)
- Data type: String (URI)
- siteurl
- WordPress address (URL)
- Data type: String (URI)
- start_of_week
- The starting day of the week. Default is 0 (Sunday).
- 0 : Sunday
- 1 : Monday
- 2 : Tuesday
- 3 : Wednesday
- 4 : Thursday
- 5 : Friday
- 6 : Saturday
- Data type: Integer
- time_format
- Default time format (see WordPress:Formatting Date and Time)
- Data type: String
- users_can_register
- Anyone can register
- 1 : Yes
- 0 : No
- Data type: Integer
|
Miscellaneous
- hack_file
- Use legacy my-hacks.php file support
- 1 : Yes
- 0 : No
- Data type: Integer
- html_type
- Default MIME type for blog pages (text/html, text/xml+html, etc.)
- Data type: String (MIME type)
- secret
- Secret value created during installation used with salting, etc.
- Data type: String (MD5)
- upload_path
- Store uploads in this folder (relative to the WordPress root)
- Data type: String (relative path)
- uploads_use_yearmonth_folders
- Organize my uploads into month- and year-based folders
- 1 : Yes
- 0 : No
- Data type: Integer
- use_linksupdate
- Track links' update times
- 1 : Yes
- 0 : No
- Data type: Integer
|
Permalinks
- permalink_structure
- The desired structure of your blog's permalinks. Some examples:
- /%year%/%monthnum%/%day%/%postname%/ : Date and name based
- /archives/%post_id%/ : Numeric
- /%postname%/ : Post name-based
- You can see more examples by viewing WordPress:Using Permalinks.
- Data type: String
|
Privacy
- blog_public
- 1 : I would like my blog to be visible to everyone, including search engines (like Google, Sphere, Technorati) and archivers.
- 0 : I would like to block search engines, but allow normal visitors.
- Data type: Integer
|
Reading
- blog_charset
- Encoding for pages and feeds. The character encoding you write your blog in (UTF-8 is recommended).
- Data type: String
- gzipcompression
- WordPress should compress articles (with gzip) if browsers ask for them.
- 1 : Yes
- 0 : No
- Data type: Integer
- page_on_front
- The ID of the page that should be displayed on the front page. Requires show_on_front's value to be page.
- Data type: Integer
- posts_per_page
- Show at most x many posts on blog pages.
- Data type: Integer
- posts_per_rss
- Show at most x many posts in RSS feeds.
- Data type: Integer
- rss_excerpt_length
- Length of excerpts displayed in RSS feeds. Requires rss_use_excerpt to have a value of 1.
- Data type: Integer
- rss_language
- Language for RSS feeds (metadata purposes only)
- Data type: String (ISO two-letter language code)
- rss_use_excerpt
- Show an excerpt instead of the full text of a post in RSS feeds
- 1 : Yes
- 0 : No
- Data type: Integer
- show_on_front
- What to show on the front page
- posts : Your latest posts
- page : A static page (see page_on_front)
- Data type: String
|
Themes
- template
- The slug of the currently activated theme (how it is accessed by path, ex. /wp-content/themes/some-theme: some-theme would be the value)
- Data type: String
|
Writing
- default_category
- ID of the category that posts will be put in by default
- Data type: Integer
- default_email_category
- ID of the category that posts will be put in by default when written via e-mail
- Data type: Integer
- default_link_category
- ID of the category that links will be put in by default
- Data type: Integer
- default_post_edit_rows
- Size of the post box (in lines)
- Data type: Integer
- mailserver_login
- Mail server username for posting to WordPress by e-mail
- Data type: String
- mailserver_pass
- Mail server password for posting to WordPress by e-mail
- Data type: String
- mailserver_port
- Mail server port for posting to WordPress by e-mail
- Data type: Integer
- mailserver_url
- Mail server for posting to WordPress by e-mail
- Data type: String
- ping_sites
- When you publish a new post, WordPress automatically notifies the following site update services. For more about this, see WordPress:Update Services. Separate multiple service URLs with line breaks. Requires blog_public to have a value of 1.
- Data type: String (possibly multi-line)
- use_balanceTags
- Correct invalidly-nested XHTML automatically
- 1 : Yes
- 0 : No
- Data type: Integer
- use_smilies
- Convert emoticons like :-) and :P to graphics when displayed
- 1 : Yes
- 0 : No
- Data type: Integer
- use_trackback
- Enable sending and receiving of trackbacks
- 1 : Yes
- 0 : No
|
