do_settings_fields()


WordPressのdo_settings_fields()関数は、設定ページにフィールドを表示するために使用されます。この関数は、設定ページに関連するすべての設定フィールドをレンダリングし、フォーム内で設定を変更できるようにします。

構文

do_settings_fields( string $page, string $section = '' );

引数の説明

  • $page (string) — 設定ページのスラッグ
  • $section (string) — 特定のセクション（オプション）

例 1: 設定ページでフィールドを表示する

この例では、`my_settings_page`という設定ページでフィールドを表示します。

<?php
do_settings_fields( 'my_settings_page' );
?>

例 2: 特定のセクションのフィールドを表示する

この例では、`general_settings`セクションに含まれるフィールドのみを表示します。

<?php
do_settings_fields( 'my_settings_page', 'general_settings' );
?>

例 3: フィールドを管理ページに追加する

`add_settings_field()`を使って設定フィールドを追加した後、`do_settings_fields()`を使ってそれを表示します。

<?php
add_settings_field( 'example_field', 'Example Field', 'example_field_callback', 'my_settings_page', 'general_settings' );
do_settings_fields( 'my_settings_page', 'general_settings' );
?>

例 4: 設定ページにセクションを追加する

`add_settings_section()`を使用してセクションを追加した後、そのセクション内でフィールドを表示します。

<?php
add_settings_section( 'general_settings', 'General Settings', 'general_settings_callback', 'my_settings_page' );
do_settings_fields( 'my_settings_page', 'general_settings' );
?>

例 5: 複数のフィールドを含む設定ページ

`do_settings_fields()`を使って、設定ページに複数のフィールドを表示します。

<?php
do_settings_fields( 'my_settings_page' );
do_settings_fields( 'another_settings_page' );
?>

注意点

  • フィールドは事前に`add_settings_field()`で追加されている必要があります。
  • セクション名を指定しない場合、指定したページに関連するすべてのフィールドが表示されます。
  • 設定ページを正しく設定していないと、フィールドが表示されません。

関連機能：