register_setting()


WordPressのregister_setting()関数は、設定を登録し、データベースに保存するために使用されます。この関数は、設定ページを作成する際に重要な役割を果たします。

構文

register_setting( string $option_group, string $option_name, array $args = array() );

引数の説明:

  • $option_group(string) — 設定グループの名前。通常は設定ページのスラッグ。
  • $option_name(string) — データベースに保存されるオプションの名前。
  • $args(array) — オプションの引数。デフォルト値は空の配列。

例1: 基本的な設定の登録

この例では、設定グループとオプション名を指定して設定を登録します。

register_setting('my_option_group', 'my_option_name');

例2: サニタイズコールバックの追加

この例では、設定値を保存する前にサニタイズするためのコールバック関数を追加します。

register_setting('my_option_group', 'my_option_name', array('sanitize_callback' => 'my_sanitize_function'));

例3: デフォルト値の設定

この例では、設定にデフォルト値を指定します。

register_setting('my_option_group', 'my_option_name', array('default' => 'default_value'));

例4: 設定ページの作成

この例では、設定ページを作成し、設定を登録します。

function my_settings_page() { add_settings_section('my_section', 'My Section', 'my_section_callback', 'my_option_group'); add_settings_field('my_field', 'My Field', 'my_field_callback', 'my_option_group', 'my_section'); register_setting('my_option_group', 'my_option_name'); } add_action('admin_init', 'my_settings_page');

例5: 複数の設定を一度に登録

この例では、複数の設定を一度に登録します。

register_setting('my_option_group', 'my_option_name1'); register_setting('my_option_group', 'my_option_name2');

例6: 設定の削除

この例では、登録された設定を削除します。

unregister_setting('my_option_group', 'my_option_name');

例7: 設定の更新

この例では、設定値を更新します。

update_option('my_option_name', 'new_value');

例8: 設定値の取得

この例では、設定値を取得します。

$value = get_option('my_option_name');

注意点

  • 設定グループ名とオプション名は一意である必要があります。
  • サニタイズコールバックを使用して、不正なデータがデータベースに保存されないようにします。
  • 設定ページを作成する際は、適切な権限を持つユーザーのみがアクセスできるようにします。

関連機能: