submit_button() の使い方|説明・引数・注意点

説明

submit_button() は、管理画面の送信ボタンを出力する関数です。

基本構文

submit_button( string $text = null, string $type = 'primary', string $name = 'submit', bool $wrap = true, array|string $other_attributes = null ): void

引数

  • $text:ボタンの文字
  • $type:primary / secondary など
  • $name:name 属性
  • $wrap:p タグで囲むか
  • $other_attributes:その他の属性

戻り値

戻り値はありません(出力します)。

使い方(サンプル)

submit_button( '保存' );

注意点

  • 管理画面のスタイルに合ったボタンになります。

実務での使いどころ

  • 設定ページの、送信ボタンを、WordPressの管理画面のデザインで、出力するとき。
  • 複数のボタン(保存、リセット)を、$type を変えて、並べるとき。

よくあるミスと対処

  • 出力ではなく、文字列として受け取りたいのに、使っている。文字列には、get_submit_button() を使う。
  • $name を変えずに、複数のボタンの、判別ができない。
  • <form> の外で、呼んでいる。

NG例

$button = submit_button( '保存' ); // 出力されるだけで、変数には入らない

OK例

submit_button( '保存' );
submit_button( 'リセット', 'secondary', 'reset' );

使い分け早見表

関数 特徴
submit_button() 送信ボタンを、出力する
get_submit_button() 送信ボタンのHTMLを、文字列で返す
settings_fields() 保存用の隠しフィールドを、出力する

関連項目

settings_fields()、do_settings_sections()

公式リファレンス:submit_button() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました