Resource Information
| Method | POST |
|---|---|
| URL | https://public-api.wordpress.com/rest/v1.1/me/settings/ |
| Requires authentication? | No |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| context | (string) |
|
| http_envelope | (bool) |
|
| pretty | (bool) |
|
| meta | (string) | Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes |
| fields | (string) | Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title |
| callback | (string) | An optional JSONP callback function. |
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| enable_translator | (bool) | Is in-page translation enabled for the current user? |
| surprise_me | (bool) | Is "Surprise Me" mode enabled for the current user? |
| post_post_flag | (bool) | Is Post-post enabled for the current user? |
| holidaysnow | (bool) | Is holiday snow enabled for the current user? - (deprecated) |
| password | (string) | Set the current user's password. |
| display_name | (string) | Set the current user's display name. |
| first_name | (string) | Set the current user's first name. |
| last_name | (string) | Set the current user's last name. |
| description | (string) | Set the current user's About Me HTML. |
| user_email | (string) | Set this value to initiate a change to the current user's email address. |
| user_email_change_pending | (bool) | Is a change to the user's email address pending? (The client may set this to false to cancel a pending change.) |
| user_URL | (url) | Set the current user's public profile URL setting. |
| language | (string) | Set the current user's interface language code. |
| primary_site_ID | (int) | Set the current user's primary site ID. |
| comment_like_notification | (bool) | Are comment likes notification emails enabled for the current user? |
| mentions_notification | (bool) | Are mentions notification emails enabled for the current user? |
| subscription_delivery_email_default | (string) | Set the default email delivery frequency for new subscriptions (never, instantly, daily or weekly). |
| subscription_delivery_jabber_default | (bool) | Is jabber subscription enabled for new follows? |
| subscription_delivery_mail_option | (string) | Set how subscription emails should be formatted: as HTML (html) or as plain text (text). |
| subscription_delivery_day | (int) | Set when subscription emails should be delivered: 0: Sunday, 1: Monday, etc. (Applies when subscription_delivery_email_default equals weekly.) |
| subscription_delivery_hour | (int) | Set at what hour of the day subscription emails should be delivered. Uses even numbers from 0 to 22, inclusive. (Applies when subscription_delivery_email_default equals daily or weekly.) |
| subscription_delivery_email_blocked | (bool) | Are all WordPress.com subscription emails blocked for the current user? |
| two_step_backup_codes_printed | (bool) | Has the current user printed their backup codes? |
| two_step_sms_country | (string) | Set the country for SMS backup for the current user (e.g. "US"). |
| two_step_sms_phone_number | (string) | Set the phone number for SMS backup for the current user (should not include + or country code). |
| calypso_preferences | (object) | Set the preferences associated with a user's WordPress.com Calypso experience. |
| jetpack_connect | (string) | Add a new jetpack site slug to the jetpack connect sites list of the user |
| tracks_opt_out | (bool) | Did the user opted out of Tracks? |
| i18n_empathy_mode | (bool) | Has the user enabled I18n empathy mode? |
| use_fallback_for_incomplete_languages | (bool) | Should UI be displayed in default locale for languages with incomplete translations |
| gravatar_profile_hidden | (bool) | Is the gravatar profile hidden for this user? |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| enable_translator | (bool) | Is in-page translation enabled for the current user? |
| surprise_me | (bool) | Is "Surprise Me" mode enabled for the current user? |
| post_post_flag | (bool) | Is Post-post enabled for the current user? |
| holidaysnow | (bool) | Is holiday snow enabled for the current user? - (deprecated) |
| password | (string) | Always an empty string. |
| display_name | (string) | Get the current user's display name. |
| first_name | (string) | Get the current user's first name. |
| last_name | (string) | Get the current user's last name. |
| description | (string) | Get the current user's About Me HTML. |
| user_email | (string) | Get the current user's email address. |
| user_email_change_pending | (bool) | Is an email change pending for the current user? |
| new_user_email | (string) | Get the email address a pending change would switch to. |
| user_URL | (url) | Get the current user's public profile URL setting. |
| language | (string) | Get the current user's interface language code. |
| primary_site_ID | (int) | Get the current user's primary site ID. |
| comment_like_notification | (bool) | Are comment likes notification emails enabled for the current user? |
| mentions_notification | (bool) | Are mentions notification emails enabled for the current user? |
| subscription_delivery_email_default | (string) | Get the default email delivery frequency for new subscriptions (never, instantly, daily or weekly). |
| subscription_delivery_jabber_default | (bool) | Should new follows include jabber subscription? |
| subscription_delivery_mail_option | (string) | Get how subscription emails should be formatted: as HTML (html) or as plain text (text). |
| subscription_delivery_day | (int) | Get when subscription emails should be delivered: 0: Sunday, 1: Monday, etc. (Applies when subscription_delivery_email_default equals weekly.) |
| subscription_delivery_hour | (int) | Get at what hour of the day subscription emails should be delivered. Uses even numbers from 0 to 22, inclusive. (Applies when subscription_delivery_email_default equals daily or weekly.) |
| subscription_delivery_email_blocked | (bool) | Are all WordPress.com subscription emails blocked for the current user? |
| two_step_backup_codes_printed | (bool) | Has the current user printed their backup codes? |
| two_step_sms_country | (string) | Get the country for SMS backup for the current user (e.g. "US"). |
| two_step_sms_phone_number | (string) | Get the phone number for SMS backup for the current user (should not include + or country code). |
| calypso_preferences | (object) | Get the preferences associated with a user's WordPress.com Calypso experience. |
| jetpack_connect | (array) | Get the urls of the jetpack sites the user have attempted to connect from Calypso |
| locale_variant | (string) | The locale variant locale code, if any. |
| tracks_opt_out | (bool) | Did the user opted out of Tracks? |
| i18n_empathy_mode | (bool) | Has the user enabled I18n empathy mode? |
| use_fallback_for_incomplete_languages | (bool) | Should UI be displayed in default locale for languages with incomplete translations |
| gravatar_profile_hidden | (bool) | Is the gravatar profile hidden for this user? |
Resource Errors
These are the possible errors returned by this endpoint.
| HTTP Code | Error Identifier | Error Message |
|---|---|---|
| 403 | unauthorized | This setting cannot be changed prior to account activation. |
| 400 | invalid_input | user_login_can_be_changed can not be set by this endpoint. |
| 400 | invalid_input | The calypso_preferences setting must be valid JSON. |
| 400 | invalid_input | You must supply an ID for one of your own sites for primary_site_ID. |
| 403 | unallowed_setting | The two_step_enabled setting cannot be changed using this endpoint. |
| 403 | unallowed_setting | The two_step_sms_enabled setting cannot be changed using this endpoint. |
| 400 | not_yet_implemented | Setting two_step_backup_codes_printed is not yet implemented. |
| 403 | invalid_input | The two_step_sms_country setting cannot be changed while two step is enabled. |
| 403 | invalid_input | An unsupported country code was provided for two_step_sms_country. |
| 403 | invalid_input | The two_step_sms_phone_number setting cannot be changed while two step is enabled. |
Example
curl ''
<?php
$options = array (
'http' =>
array (
'ignore_errors' => true,
'method' => 'POST',
),
);
$context = stream_context_create( $options );
$response = file_get_contents(
'',
false,
$context
);
$response = json_decode( $response );
?>
