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



お勧め

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クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。