WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru Хостинг, VPS/VDS и отдельные сервера только на SSD дисках. 7 дней бесплатного тестирования.

Рубрика: API

API Настроек

add_settings_error()

Регистрирует сообщение о проверке опции, чтобы позднее показать это сообщение пользователю. Обычно такое сообщение - это ошибка проверки данных.

add_settings_field()

Создает поле опции для указанной секции (указанного блока настроек).

add_settings_section()

Создает новый блок (секцию), в котором выводятся поля настроек. Т.е. в этот блок затем добавляются опции, с помощью add_settings_field()

do_settings_fields()

Выводит на экран поля опций, относящихся к указанной секции.

do_settings_sections()

Выводит на экран все блоки опций, относящиеся к указанной странице настроек в админ-панели.

get_settings_errors()

Получает сообщения зарегистрированные функцией add_settings_error().

register_setting()

Регистрирует новую опцию и callback функцию (функцию обратного вызова) для обработки значения опции при её сохранении в БД.

settings_errors()

Выводит на экран сообщения (уведомления и ошибки) зарегистрированные функцией add_settings_error().

settings_fields()

Выводит скрытые поля формы на странице настроек (option_page, _wpnonce, ...).

unregister_setting()

Позволяет отменить зарегистрированные ранее настройки (опции). Чаще всего используется с функцией деактивации плагина: register_deactivation_hook().

HTTP API

status_header()

Устанавливает указанный статус в заголовок HTTP ответа сервера. Код состояния HTTP (200, 404 и т.д.).

wp_get_http_headers()

Получает HTTP заголовки указанного URL.

wp_remote_get()

Получает удаленную страницу используя HTTP GET метод. Обертка для использования curl. Результат содержит HTTP заголовки и данные самой станицы, и возвращается в виде массива.

wp_remote_head()

Получает ответ HTTP запроса. Используется HEAD метод запроса. Получает только заголовки, без тела ответа.

wp_remote_post()

Обертка для использования curl. Получает удаленную страницу используя HTTP POST метод. Результат содержит HTTP заголовки и данные самой станицы, и возвращается в виде массива.

wp_remote_request()

Создает любой тип HTTP запроса и возвращает ответ запроса в виде массива.

wp_remote_retrieve_body()

Получает только тело (контент) ответа, который был получен с помощью любой из функций типа wp_remote_*, например wp_remote_get().

wp_remote_retrieve_cookie()

Получает данные отдельной указанной куки из переданного ответа на запрос.

wp_remote_retrieve_cookie_value()

Получает значение отдельной куки по указанному имени куки из переданного массива ответа на запрос.

wp_remote_retrieve_cookies()

Получает все данные всех куков из переданного ответа на запрос.

wp_remote_retrieve_header()

Получает указанное поле заголовка ответа из переданного объекта ответа.

wp_remote_retrieve_headers()

Получает все поля заголовка ответа из переданного объекта ответа.

wp_remote_retrieve_response_code()

Получает код ответа (статус ответа) из переданного объекта запроса.

wp_remote_retrieve_response_message()

Получает сообщение ответа из переданного объекта ответа.

wp_safe_remote_request()

Получает данные по переданному HTTP запросу (УРЛ). Данные возвращаются в виде массива: тело, заголовки, статус ответа...

REST API

get_rest_url()

Получает URL конечной точки REST API.

register_rest_field()

Регистрирует новое REST поле для указанного типа REST объекта (ресурса).

register_rest_route()

Регистрирует маршрут и конечные точки REST API. Говоря проще регистрирует URL по которому будет срабатывать указанная PHP функция.

rest_ensure_response()

Проверяет и, если надо, преобразует переданные данные в объект класса WP_HTTP_Response.

rest_is_boolean()

Определяет, является ли переданное значение логическим или подобно логическому. Т.е. также как и PHP не учитывает тип значение: 1 - true, 0 - false.

rest_output_link_wp_head()

Выводит ссылку на корневой REST API маршрут в секции <head> на всех страницах сайта.

API перезаписи URL (ЧПУ)

add_permastruct()

Добавляет новую структуру ЧПУ для постоянных ссылок.

add_rewrite_endpoint()

Добавляет конечную точку, например /trackback/. Добавляются дополнительные правила перезаписи ЧПУ с указанной конечной точкой.

add_rewrite_rule()

Добавляет новое правило перезаписи URL (ЧПУ) в структуру правил WordPress.

add_rewrite_tag()

Добавляет/обновляет тег запроса ( например: '%pagetype%' ), который можно использовать в ЧПУ. Этот тег будет заменен на регулярное выражение, а оно затем на конструкцию запроса вида: ?pagetype=mypage.

flush_rewrite_rules()

Обновляет правила перезаписи ЧПУ: удаляет имеющиеся, генерирует и записывает новые.

remove_permastruct()

Удаляет ранее добавленную структуру ЧПУ (постоянных ссылок).

remove_rewrite_tag()

Удаляет существующий тег запроса, например %postname%.

Cron API

wp_clear_scheduled_hook()

Удаляет все крон-задачи прикрепленные к указанному хуку и имеющие указанные параметры. Работает на основе wp_unschedule_event().

wp_cron()

Запускает все запланированные Крон события, время которых подошло.

wp_doing_cron()

Определяет является ли текущий запрос, запросом к Крону. Условный тег.

wp_get_schedules()

Получает поддерживаемые Cron интервалы времени.

wp_next_scheduled()

Возвращает метку времени (timestamp) когда должно сработать следующее по расписанию cron задание. Позволяет проверить есть ли в крон указанное задание.

wp_schedule_event()

Создает многоразовую крон-задачу. Устанавливает хук, который будет вызываться каждый раз через указанный интервал времени.

wp_schedule_single_event()

Создает одноразовую крон-задачу. Устанавливает хук, который будет вызван всего один раз в указанное время.

wp_unschedule_event()

Удаляет из расписания указанное крон событие (задание). Для удаления нужно указать все данные: метку времени, имя хука и параметры.

wp_unschedule_hook()

Удаляет из расписания крон абсолютно все крон задачи по указанному хуку. Тут не важно какие параметры были указаны при регистрации задачи.