説明
パラメータ
- $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' );
フィルター
[4.7.0]'register_setting_args'フィルターを呼び出す。パラメータ$argsには本関数が受け取った内容が、$defaultsにはデフォルトの設定情報(連想配列)が、$option_groupと$option_nameには本関数が受け取った内容が格納されている。$args = apply_filters( 'register_setting_args', $args, $defaults, $option_group, $option_name );
アクション
[5.5.0]設定情報を格納する前に'register_setting'アクションを呼び出す。パラメータ$option_groupと$option_nameには本関数が受け取った内容が、$argsには設定情報が格納されている。do_action( 'register_setting', $option_group, $option_name, $args );
ソースファイル
/wp-includes/option.php
最終更新 : 2024年07月20日 13:57
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。