{"id":23113,"date":"2016-12-06T18:10:22","date_gmt":"2016-12-06T18:10:22","guid":{"rendered":"https:\/\/developer.wordpress.org\/?post_type=rest-api-handbook&p=23113"},"modified":"2024-01-16T20:30:17","modified_gmt":"2024-01-16T20:30:17","slug":"settings","status":"publish","type":"rest-api-handbook","link":"https:\/\/developer.wordpress.org\/rest-api\/reference\/settings\/","title":{"rendered":"Site Settings"},"content":{"rendered":"
\n
\n

Schema<\/h2>\n

The schema defines all the fields that exist within a Site Setting record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n title<\/code>\n <\/td>\n\n Site title.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n description<\/code>\n <\/td>\n\n Site tagline.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n url<\/code>\n <\/td>\n\n Site URL.<\/p>\n

\n JSON data type: string,
\n Format: uri\n <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n email<\/code>\n <\/td>\n\n This address is used for admin purposes, like new user notification.<\/p>\n

\n JSON data type: string,
\n Format: email\n <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n timezone<\/code>\n <\/td>\n\n A city in the same timezone as you.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n date_format<\/code>\n <\/td>\n\n A date format for all date strings.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n time_format<\/code>\n <\/td>\n\n A time format for all time strings.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n start_of_week<\/code>\n <\/td>\n\n A day number of the week that the week should start on.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n language<\/code>\n <\/td>\n\n WordPress locale code.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n use_smilies<\/code>\n <\/td>\n\n Convert emoticons like :-) and :-P to graphics on display.<\/p>\n

\n JSON data type: boolean <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n default_category<\/code>\n <\/td>\n\n Default post category.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n default_post_format<\/code>\n <\/td>\n\n Default post format.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n posts_per_page<\/code>\n <\/td>\n\n Blog pages show at most.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n show_on_front<\/code>\n <\/td>\n\n What to show on the front page<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n page_on_front<\/code>\n <\/td>\n\n The ID of the page that should be displayed on the front page<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n page_for_posts<\/code>\n <\/td>\n\n The ID of the page that should display the latest posts<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n default_ping_status<\/code>\n <\/td>\n\n Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n

One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n

\n default_comment_status<\/code>\n <\/td>\n\n Allow people to submit comments on new posts.<\/p>\n

\n JSON data type: string <\/p>\n

Context: <\/code><\/p>\n

One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n

\n site_logo<\/code>\n <\/td>\n\n Site logo.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n

\n site_icon<\/code>\n <\/td>\n\n Site icon.<\/p>\n

\n JSON data type: integer <\/p>\n

Context: <\/code><\/p>\n<\/td>\n<\/tr>\n<\/table><\/div>\n<\/section>\n

\n
\n
\n

Retrieve a Site Setting<\/h2>\n

Definition & Example Request<\/h3>\n

GET \/wp\/v2\/settings<\/code><\/p>\n

Query this endpoint to retrieve a specific Site Setting record.<\/p>\n

$ curl https:\/\/example.com\/wp-json\/wp\/v2\/settings<\/code>\n <\/div>\n

\n There are no arguments for this endpoint.<\/p><\/div>\n<\/section>\n
\n
\n

Update a Site Setting<\/h2>\n

Arguments<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n title<\/a><\/code>\n <\/td>\n\n Site title.\n <\/td>\n<\/tr>\n
\n description<\/a><\/code>\n <\/td>\n\n Site tagline.\n <\/td>\n<\/tr>\n
\n url<\/a><\/code>\n <\/td>\n\n Site URL.\n <\/td>\n<\/tr>\n
\n email<\/a><\/code>\n <\/td>\n\n This address is used for admin purposes, like new user notification.\n <\/td>\n<\/tr>\n
\n timezone<\/a><\/code>\n <\/td>\n\n A city in the same timezone as you.\n <\/td>\n<\/tr>\n
\n date_format<\/a><\/code>\n <\/td>\n\n A date format for all date strings.\n <\/td>\n<\/tr>\n
\n time_format<\/a><\/code>\n <\/td>\n\n A time format for all time strings.\n <\/td>\n<\/tr>\n
\n start_of_week<\/a><\/code>\n <\/td>\n\n A day number of the week that the week should start on.\n <\/td>\n<\/tr>\n
\n language<\/a><\/code>\n <\/td>\n\n WordPress locale code.\n <\/td>\n<\/tr>\n
\n use_smilies<\/a><\/code>\n <\/td>\n\n Convert emoticons like :-) and :-P to graphics on display.\n <\/td>\n<\/tr>\n
\n default_category<\/a><\/code>\n <\/td>\n\n Default post category.\n <\/td>\n<\/tr>\n
\n default_post_format<\/a><\/code>\n <\/td>\n\n Default post format.\n <\/td>\n<\/tr>\n
\n posts_per_page<\/a><\/code>\n <\/td>\n\n Blog pages show at most.\n <\/td>\n<\/tr>\n
\n show_on_front<\/a><\/code>\n <\/td>\n\n What to show on the front page\n <\/td>\n<\/tr>\n
\n page_on_front<\/a><\/code>\n <\/td>\n\n The ID of the page that should be displayed on the front page\n <\/td>\n<\/tr>\n
\n page_for_posts<\/a><\/code>\n <\/td>\n\n The ID of the page that should display the latest posts\n <\/td>\n<\/tr>\n
\n default_ping_status<\/a><\/code>\n <\/td>\n\n Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.
\n One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n
\n default_comment_status<\/a><\/code>\n <\/td>\n\n Allow people to submit comments on new posts.
\n One of: open<\/code>, closed<\/code>\n <\/td>\n<\/tr>\n
\n site_logo<\/a><\/code>\n <\/td>\n\n Site logo.\n <\/td>\n<\/tr>\n
\n site_icon<\/a><\/code>\n <\/td>\n\n Site icon.\n <\/td>\n<\/tr>\n<\/table><\/div>\n
\n

Definition<\/h3>\n

POST \/wp\/v2\/settings<\/code><\/p>\n

Example Request<\/h3>\n

<\/code>\n <\/div>\n<\/section>\n<\/div>\n","protected":false},"author":5896197,"featured_media":0,"parent":23078,"menu_order":0,"template":"","meta":{"_crdt_document":"","footnotes":""},"class_list":["post-23113","rest-api-handbook","type-rest-api-handbook","status-publish","hentry","type-handbook"],"revision_note":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23113","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook"}],"about":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/types\/rest-api-handbook"}],"author":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/users\/5896197"}],"version-history":[{"count":11,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23113\/revisions"}],"predecessor-version":[{"id":152003,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23113\/revisions\/152003"}],"up":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/rest-api-handbook\/23078"}],"wp:attachment":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/media?parent=23113"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}