register_setting()

register_setting( string $option_group, string $option_name, array $args = array() )

<?php
/**
 * Регистрация настройки "my_custom_setting".
 *
 * @param string $option_group Название группы настроек.
 * @param string $option_name Название опции.
 * @param array $args Дополнительные параметры настройки.
 */
register_setting( 'my_settings_group', 'my_custom_setting', array(
    'type'              => 'string',
    'description'       => 'Описание настройки',
    'sanitize_callback' => 'my_custom_sanitize_function',
    'show_in_rest'      => true,
    'default'           => 'default_value'
) );
/**
 * Функция обратного вызова для очистки значения опции.
 *
 * @param mixed $value Значение опции.
 * @return mixed Очищенное значение опции.
 */
function my_custom_sanitize_function( $value ) {
    // Очистка значения опции.
    return sanitize_text_field( $value );
}
?>

/**
 * Register settings for the 'general' option group.
 */
register_setting( 'general', 'my_option', array(
    'type'              => 'string',
    'description'       => 'My option description',
    'sanitize_callback' => 'sanitize_text_field',
    'show_in_rest'      => true,
    'default'           => 'Default value',
) );

/**
 * Save the value of the 'my_option' option.
 */
function save_my_option() {
    $value = $_POST['my_option'];
    update_option( 'my_option', $value );
}
add_action( 'admin_post_save_my_option', 'save_my_option' );

/**
 * Sanitize the value of the 'my_option' option.
 *
 * @param mixed $value The value to sanitize.
 * @return mixed Sanitized value.
 */
function sanitize_my_option( $value ) {
    // Sanitize the value here.
    return $value;
}
add_filter( 'sanitize_option_my_option', 'sanitize_my_option' );

/**
 * Include the 'my_option' data in the REST API response.
 *
 * @param array $response The REST API response.
 * @return array Modified REST API response.
 */
function include_my_option_in_rest( $response ) {
    $my_option = get_option( 'my_option' );
    $response['my_option'] = $my_option;
    return $response;
}
add_filter( 'rest_prepare_settings', 'include_my_option_in_rest' );

Вопросы и ответы

Как зарегистрировать новую настройку?

Для регистрации новой настройки в WordPress используется функция register_setting(). Она принимает три параметра: $option_group, $option_name и $args.

$option_group — это имя группы настроек, которое должно соответствовать допустимому ключу опции. В WordPress уже предопределены некоторые допустимые ключи опций, такие как ‘general’, ‘discussion’, ‘media’, ‘reading’, ‘writing’ и ‘options’.

$option_name — это имя опции, которую нужно очистить и сохранить.

$args — это массив данных, используемых для описания настройки при ее регистрации. В массиве можно указать тип данных, описание, функцию очистки значений опции и другие параметры.

register_setting( 'general', 'my_option', array(
    'type'              => 'string',
    'description'       => 'My custom option',
    'sanitize_callback' => 'sanitize_text_field',
    'show_in_rest'      => true,
    'default'           => 'default value'
) );

Какой должен быть тип данных для зарегистрированной настройки?

Для зарегистрированной настройки можно указать следующие типы данных: ‘string’, ‘boolean’, ‘integer’, ‘number’, ‘array’ и ‘object’.

register_setting( 'general', 'my_option', array(
    'type' => 'string',
) );

Как описать данные, связанные с зарегистрированной настройкой?

Для описания данных, связанных с зарегистрированной настройкой, можно использовать параметр description. В этом параметре можно указать описание данных, которые прикреплены к данной настройке.

register_setting( 'general', 'my_option', array(
    'description' => 'My custom option',
) );

Какой должна быть функция обратного вызова для санитизации значения настройки?

Функция обратного вызова для санитизации значения настройки должна быть определена в параметре sanitize_callback при регистрации настройки с помощью функции register_setting(). Эта функция должна принимать один аргумент — значение настройки, и возвращать санитизированное значение.

Пример:

function sanitize_callback_example($value) {
    // Санитизация значения настройки
    $sanitized_value = sanitize_text_field($value);
    return $sanitized_value;
}
register_setting('general', 'example_setting', array(
    'sanitize_callback' => 'sanitize_callback_example',
));

Как включить данные, связанные с настройкой, в REST API?

Для включения данных, связанных с настройкой, в REST API, необходимо установить параметр show_in_rest в значение true при регистрации настройки с помощью функции register_setting().

Пример:

register_setting('general', 'example_setting', array(
    'show_in_rest' => true,
));

Как установить значение по умолчанию для зарегистрированной настройки?

Значение по умолчанию для зарегистрированной настройки можно установить с помощью параметра default при регистрации настройки с помощью функции register_setting().

Пример:

register_setting('general', 'example_setting', array(
    'default' => 'default_value',
));

Как получить значение зарегистрированной настройки?

Для получения значения зарегистрированной настройки в WordPress используется функция get_option(). Эта функция принимает один параметр — имя настройки, и возвращает ее значение.

$option_value = get_option( 'option_name' );

Как изменить значение зарегистрированной настройки?

Для изменения значения зарегистрированной настройки в WordPress используется функция update_option(). Эта функция принимает два параметра — имя настройки и новое значение.

update_option( 'option_name', 'new_value' );

Как удалить зарегистрированную настройку?

Для удаления зарегистрированной настройки в WordPress используется функция unregister_setting(). Эта функция принимает два параметра — имя группы настроек и имя настройки.

unregister_setting( 'option_group', 'option_name' );

Функция register_setting() в WordPress используется для регистрации настроек и их данных. Она позволяет задать тип данных, описание, функцию санитизации и другие параметры для настройки. Зарегистрированные настройки могут быть получены с помощью функции get_option(), изменены с помощью функции update_option() и удалены с помощью функции unregister_setting().