register_setting

パラメータ

• $option_group
  グループ名（'general'、'discussion'、'media'、'reading'、'writing'、'options'の何れか）を指定。
• $option_name
  オプション名を指定。
• $args
  オプションデータの設定を連想配列で指定（省略時はarray()）。

  キー	内容	デフォルト値
  'type'	データタイプ（'string'、'boolean'、'integer'、'number'、'array'、'object'）	'string'
  'description'	オプションの説明	''
  'sanitize_callback'	サニタイズ用のコールバック関数	null
  'show_in_rest'	REST APIで使用可能にする場合はtrueはまた'schema'キーを持つ連想配列	false
  'default'	get_option関数呼び出し時のデフォルト値	なし
  'label'	オプションのラベル	''

返り値

注意

オプション値の設定情報を登録する。ブロックエディターの各ブロックで任意のオプション値を使う場合は本関数の呼び出しが必須となる。

パラメータ$args['sanitize_callback']が設定された場合は"sanitize_option_{$option_name}"フィルターのコールバック関数として適用される。

[3.0.0]パラメータ$option_groupの'misc'が非推奨になり、内部で'general'に書き換わる。

[3.5.0]パラメータ$option_groupの'privacy'が非推奨になり、内部で'reading'に書き換わる。

[4.7.0]本関数は/wp-includes/option.phpファイルに移動し、第3パラメータはサニタイズ用のコールバック関数から設定情報（連想配列）に変更された。

[6.6.0]パラメータ$argsに'label'が追加された。

使用例

• オプションの設定情報を登録する。

  function myblock_setting() {
  	register_setting( 'options', 'service_api_key', array(
  		'type' => 'string',
  		'sanitize_callback' => 'esc_attr',
  		'show_in_rest' => true,
  	) );
  add_action( 'rest_api_init', 'myblock_setting' );
  

フィルター

$args = apply_filters( 'register_setting_args', $args, $defaults, $option_group, $option_name );

アクション

do_action( 'register_setting', $option_group, $option_name, $args );

ソースファイル