Налаштування (settings)

Цей маршрут дозволяє отримати/оновити налаштування WordPress. Однак оновити таким чином можна лише основні налаштування (не всі).

Маршрут (кінцеві точки маршруту описані нижче):

/wp/v2/settings

Клас контролера: WP_REST_Settings_Controller{}

Зміст:




Схема ресурсу

Схема показує всі поля, які є об’єкта: поля об’єкта які поверне запит.

ПараметрОпис
title
рядок		Назва сайту.
description
рядок		Слоган сайту.
url
рядок		Адреса сайту (URL)
email
рядок		Email адміністратора. Використовується, наприклад, для сповіщення про нових користувачів.
timezone
рядок		Місто в тій же тимчасовій зоні, що і у вас.
date_format
рядок		Загальний формат дати.
time_format
рядок		Загальний формат часу.
start_of_week
число		Перший день тижня.
language
рядок		Код локалі WordPress.
use_smilies
true/false		Перетворювати смайли на зразок 🙂 і 😛 на картинки при показі.
default_category
число		Рубрика Постів за замовчуванням.
default_post_format
рядок		Формат постів за промовчанням.
posts_per_page
число		Максимум постів можна відобразити на сторінці.
default_ping_status
рядок		Дозволити посилання оповіщення з інших блогів (повідомлення та зворотні посилання) на нові статті. Можливо open, closed .
default_comment_status
рядок		Дозволити надсилання коментарів до нових статей. Можливо open, closed .

Опис маршруту

Запит OPTIONS до маршруту поверне повний опис цього маршруту: ендпоінти, їх параметри, схему.

$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/settings

GitHub

{
    "namespace": "wp/v2",
    "methods": [
        "GET",
        "POST",
        "PUT",
        "PATCH"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "args": []
        },
        {
            "methods": [
                "POST",
                "PUT",
                "PATCH"
            ],
            "args": {
                "title": {
                    "required": false,
                    "description": "Назва сайту.",
                    "type": "string"
                },
                "description": {
                    "required": false,
                    "description": "Слоган сайту.",
                    "type": "string"
                },
                "url": {
                    "required": false,
                    "description": "Адреса сайту (URL)",
                    "type": "string"
                },
                "email": {
                    "required": false,
                    "description": "Ця адреса використовується для адміністрування. Наприклад, для сповіщення про нових користувачів.",
                    "type": "string"
                },
                "timezone": {
                    "required": false,
                    "description": "Місто в тій же тимчасовій зоні, що і у вас.",
                    "type": "string"
                },
                "date_format": {
                    "required": false,
                    "description": "Загальний формат дати.",
                    "type": "string"
                },
                "time_format": {
                    "required": false,
                    "description": "Загальний формат часу.",
                    "type": "string"
                },
                "start_of_week": {
                    "required": false,
                    "description": "Перший день тижня.",
                    "type": "integer"
                },
                "language": {
                    "required": false,
                    "description": "Код локалі WordPress.",
                    "type": "string"
                },
                "use_smilies": {
                    "required": false,
                    "description": "Перетворювати смайли на кшталт :-) і :-P на картинки при показі.",
                    "type": "boolean"
                },
                "default_category": {
                    "required": false,
                    "description": "Рубрика для записів за замовчуванням.",
                    "type": "integer"
                },
                "default_post_format": {
                    "required": false,
                    "description": "За замовчуванням формат записів.",
                    "type": "string"
                },
                "posts_per_page": {
                    "required": false,
                    "description": "Максимум сторінок блогу для показу.",
                    "type": "integer"
                },
                "default_ping_status": {
                    "required": false,
                    "enum": [
                        "open",
                        "closed"
                    ],
                    "description": "Дозволити посилання оповіщення з інших блогів (повідомлення та зворотні посилання) на нові статті.",
                    "type": "string"
                },
                "default_comment_status": {
                    "required": false,
                    "enum": [
                        "open",
                        "closed"
                    ],
                    "description": "Дозволити надсилання коментарів до нових статей.",
                    "type": "string"
                }
            }
        }
    ],
    "Schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "settings",
        "type": "object",
        "properties": {
            "title": {
                "type": "string",
                "description": "Назва сайту.",
                "default": null
            },
            "description": {
                "type": "string",
                "description": "Слоган сайту.",
                "default": null
            },
            "url": {
                "type": "string",
                "description": "Адреса сайту (URL)",
                "default": null,
                "format": "uri"
            },
            "email": {
                "type": "string",
                "description": "Ця адреса використовується для адміністрування. Наприклад, для сповіщення про нових користувачів.",
                "default": null,
                "format": "email"
            },
            "timezone": {
                "type": "string",
                "description": "Місто в тій же тимчасовій зоні, що і у вас.",
                "default": null
            },
            "date_format": {
                "type": "string",
                "description": "Загальний формат дати.",
                "default": null
            },
            "time_format": {
                "type": "string",
                "description": "Загальний формат часу.",
                "default": null
            },
            "start_of_week": {
                "type": "integer",
                "description": "Перший день тижня.",
                "default": null
            },
            "language": {
                "type": "string",
                "description": "Код локалі WordPress.",
                "default": "en_US"
            },
            "use_smilies": {
                "type": "boolean",
                "description": "Перетворювати смайли на кшталт :-) і :-P на картинки при показі.",
                "default": true
            },
            "default_category": {
                "type": "integer",
                "description": "Рубрика для записів за замовчуванням.",
                "default": null
            },
            "default_post_format": {
                "type": "string",
                "description": "За замовчуванням формат записів.",
                "default": null
            },
            "posts_per_page": {
                "type": "integer",
                "description": "Максимум сторінок блогу для показу.",
                "default": 10
            },
            "default_ping_status": {
                "type": "string",
                "description": "Дозволити посилання оповіщення з інших блогів (повідомлення та зворотні посилання) на нові статті.",
                "default": null,
                "enum": [
                    "open",
                    "closed"
                ]
            },
            "default_comment_status": {
                "type": "string",
                "description": "Дозволити надсилання коментарів до нових статей.",
                "default": null,
                "enum": [
                    "open",
                    "closed"
                ]
            }
        }
    },
    "_links": {
        "self": "http://wptest.ru/wp-json/wp/v2/settings"
    }
}




Отримання налаштувань

Отримує всі налаштування сайту, зазначені у схемі. також функцію get_option() .

Вид запиту

Доступ: потрібна авторизація

GET /wp/v2/settings

Параметри запиту

Немає параметрів.

Приклад запиту

$ curl http://demo.wp-api.org/wp-json/wp/v2/settings

Відповідь:

{
	"title": "WordPress at a Glance",
	"description": "Working with WordPress",
	"url": "http://example.com/wp",
	"email": "[email protected]",
	"timezone": "",
	"date_format": "F j, Y",
	"time_format": "g:i a",
	"start_of_week": 1,
	"language": "ru_RU",
	"use_smilies": true,
	"default_category": 1,
	"default_post_format": "0",
	"posts_per_page": 10,
	"default_ping_status": "open",
	"default_comment_status": "open"
}




Оновлення налаштувань

Оновлює вказане налаштування. Оновити можна лише налаштування, зазначені у схемі. також функцію update_option() .

Вид запиту

Доступ: потрібна авторизація

POST|PUT|PATCH /wp/v2/settings

Параметри запиту

"title": {
	"required": false,
	"description": "Назва сайту.",
	"type": "string"
},
"description": {
	"required": false,
	"description": "Слоган сайту.",
	"type": "string"
},
"url": {
	"required": false,
	"description": "Адреса сайту (URL)",
	"type": "string"
},
"email": {
	"required": false,
	"description": "Ця адреса використовується для адміністрування. Наприклад, для сповіщення про нових користувачів.",
	"type": "string"
},
"timezone": {
	"required": false,
	"description": "Місто в тій же тимчасовій зоні, що і у вас.",
	"type": "string"
},
"date_format": {
	"required": false,
	"description": "Загальний формат дати.",
	"type": "string"
},
"time_format": {
	"required": false,
	"description": "Загальний формат часу.",
	"type": "string"
},
"start_of_week": {
	"required": false,
	"description": "Перший день тижня.",
	"type": "integer"
},
"language": {
	"required": false,
	"description": "Код локалі WordPress.",
	"type": "string"
},
"use_smilies": {
	"required": false,
	"description": "Перетворювати смайли на кшталт :-) і :-P на картинки при показі.",
	"type": "boolean"
},
"default_category": {
	"required": false,
	"description": "Рубрика для записів за замовчуванням.",
	"type": "integer"
},
"default_post_format": {
	"required": false,
	"description": "За замовчуванням формат записів.",
	"type": "string"
},
"posts_per_page": {
	"required": false,
	"description": "Максимум сторінок блогу для показу.",
	"type": "integer"
},
"default_ping_status": {
	"required": false,
	"enum": [
		"open",
		"closed"
	],
	"description": "Дозволити посилання оповіщення з інших блогів (повідомлення та зворотні посилання) на нові статті.",
	"type": "string"
},
"default_comment_status": {
	"required": false,
	"enum": [
		"open",
		"closed"
	],
	"description": "Дозволити надсилання коментарів до нових статей.",
	"type": "string"
}

Приклад запиту

$ curl -X POST -i http://demo.wp-api.org/wp-json/wp/v2/settings?title=Нова назва сайту

Відповідь:

{
	"title": "Нова назва сайту",
	"description": "Working with WordPress",
	"url": "http://example.com/wp",
	"email": "[email protected]",
	"timezone": "",
	"date_format": "F j, Y",
	"time_format": "g:i a",
	"start_of_week": 1,
	"language": "ru_RU",
	"use_smilies": true,
	"default_category": 1,
	"default_post_format": "0",
	"posts_per_page": 10,
	"default_ping_status": "open",
	"default_comment_status": "open"
}

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *