register_setting() │ WP 2.7.0

add_action( 'admin_init', 'register_my_setting');
function register_my_setting() {
	register_setting( 'my_options_group', 'my_option_name', 'intval');
}

Ще приклади дивіться в описі API опцій .

Якщо реєстрація робиться і для сайту і для REST API, виклик функції потрібно повісити на обидва хуки admin_init . Якщо використовувати тільки хук admin_init, то в REST опція працювати не буде.

У цьому випадку опцію можна буде бачити при зверненнях до ендпоінту wp-json/wp/v2/settings.

add_action( 'admin_init', 'register_my_setting');
add_action( 'rest_api_init', 'register_my_setting');

function register_my_setting() {

	$ args = array (
		'sanitize_callback' => 'sanitize_text_field',
		'default' => '',
		'type' => 'string',
		'show_in_rest' => true,
	);

	register_setting( 'my_options_group', 'my_option_name', $args);
}

add_action( 'rest_api_init', 'register_block_core_site_logo_setting', 10);

/**
 * Register a core site setting for a site logo
 */
function register_block_core_site_logo_setting() {

	register_setting( 'general', 'site_logo', [
		'show_in_rest' => array(
			'name' => 'site_logo',
		),
		'type' => 'integer',
		'description' => __( 'Site logo.' ),
	]);
}

Якщо ви хочете зберегти масив у налаштуваннях, а також показати цей масив у кінцевій точці wp-json/wp/v2/settings, то потрібно вказати схему масиву в параметрі show_in_rest.

add_action( 'admin_init', 'wpdocs_foo_register_settings');
add_action( 'rest_api_init', 'wpdocs_foo_register_settings');

function wpdocs_foo_register_settings() {

	register_setting('general_setting', 'id');
	register_setting('general_setting', 'order');
	register_setting(
		'general_setting',
		'slider-data',
		array(
			'show_in_rest' => array(
				'name' => 'images_slide',
				'schema' => array(
					'type' => 'array',
					'items' => array(
						'id' => 'string',
						'order' => 'string',
					),
				),
			),
			'type' => 'array',
			'sanitize_callback' => array( $this, 'wpdocs_admin_post_save_data' ),
		)
	);
}

register_setting(
	'dp_example_settings_group',
	'dp_example_array_settings',
	array(
		'type' => 'object',
		'default' => array(
			'A',
			'B',
			'C',
		),
		'show_in_rest' => array(
			'schema' => array(
				'type' => 'object',
				'items' => array(
					'type' => 'string',
				),
			),
		),
	)
);

register_setting(
	'dp_example_settings_group',
	'dp_example_object_settings',
	array(
		'type' => 'object',
		'default' => array(
			'some_str' => 'A',
			'some_int' => 3,
		),
		'show_in_rest' => array(
			'schema' => array(
				'type' => 'object',
				'properties' => array(
					'some_str' => array(
						'type' => 'string',
					),
					'some_int' => array(
						'type' => 'integer',
					),
				),
			),
		),
	)
);

Як згадувалося в замітці вище sanitize може спрацювати двічі, коли опція вперше додається до БД. Тому, якщо є які-небудь критичні за продуктивністю моменти або інші моменти, які потрібно врахувати в цьому випадку, їх потрібно окремо обробити в sanitize функції.

add_action( 'admin_init', 'on_admin_init');

/*
 * Add custom options to whitelist, натиснувши valiated settings to be saved by form.
 */
function on_admin_init(): void
{
	register_setting( PLUGIN_SLUG, PLUGIN_SLUG, [ 'sanitize_callback' => 'my_sanitize_settings' ] );
}

/*
 * Sanitize the form input.
 */
function my_sanitize_settings( $input = NULL ):  
{
	// Detect multiple sanitizing passes.
	// Accomodates bug: https://core.trac.wordpress.org/ticket/21989
	static $pass_count = 0; $pass_count++;

	if ($pass_count <= 1) {
		// Handle any single-time / performane sensitive actions.

	}

	// Insert regular santizing code here.
}

Функція спрацьовує двічі тільки при першому збереженні налаштування та додаванні її до таблиці бази даних. Наступні оновлення налаштування виконують функцію sanitize_callback лише один раз. Так що якщо ви не виконуєте якусь дуже-дуже-дуже важку операцію з очищення, немає необхідності турбуватися про це.