add_settings_field

説明

void add_settings_field( string $id, string $title, callable $callback, string $page [ , string $section = 'default' [ , array $args = array() ] ] )
設定ページに新しいフィールド(入力要素)を追加する。

パラメータ

  • $id
    フィールドのスラッグを指定。
  • $title
    フィールド名を指定。
  • $callback
    フィールド名の入力要素を出力するコールバック関数を指定。
  • $page
    設定ページのスラッグ('general'、'reading'、'writing'、'discussion'、'media'など)を指定。
  • $section
    セクションのスラッグを指定(省略時は'default')。
  • $args
    フィールド設定に関する内容(label_for、[4.2.0]classキー)を連想配列で指定(省略時はarray())。

返り値

返り値はありません。

注意

設定内容は、グローバル変数$wp_settings_fields[ $page ][ $section ][ $id ]に格納される。

パラメータ$callbackのコールバック関数で出力する入力要素のname属性は register_setting関数で登録したオプション名を指定する必要がある。

[3.0.0]パラメータ$pageが非推奨の'misc'の場合、'general'に変更される。

[3.5.0]パラメータ$pageが非推奨の'privacy'の場合、'reading'に変更される。

[4.2.0]パラメータ$argsにキーclassが追加される。

キー内容省略時
label_forlabel要素のfor属性を指定''
classtr要素のclass属性を指定''

パラメータ$argsにlabel_forキーの値を指定すると、フィールド名はlabel要素で囲まれ、そのfor属性に適用される。label_forキーの値が空の場合はlabel要素で囲まれない。

パラメータ$argsにclassキーの値を指定すると、tr要素のclass属性に適用される。


使用例

  • 一般設定ページに新しいフィールドを追加する
    add_settings_field( 'oauth_client_id', 'Client ID', 'oauth_client_id_field', 'general' );

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-admin/includes/template.php

最終更新 : 2024年01月30日 17:18



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。