• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/submit button

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/submit button」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

指定されたテキストと適切なクラスを使って、送信ボタンを表示します。

注意: この関数は管理画面からのみ利用可能です。WordPress サイトのフロントエンドでは使えません。

使い方

<?php submit_button( $text, $type, $name, $wrap, $other_attributes ) ?>

パラメータ

$text
文字列) (オプション) ボタンのテキスト。
初期値: Save Changes – 日本語版では「変更を保存」
$type
文字列|配列) (オプション) ボタンの種類。よく使う値は: primary, secondary, delete
初期値: primary large
参考: $type はひとつの値、スペースで区切った値のリスト、値の配列のいずれか。値はボタンの HTML クラスを決定する。
  • $type が 'delete' なら、クラスは 'button delete'
  • それ以外なら最初のクラスが 'button' で、以下のどれかが出現順に続く:
    • 値が 'primary' なら、クラス 'button-primary'
    • 値が 'small' なら、クラス 'button-small'
    • 値が 'large' なら、クラス 'button-large'
    • 値が 'secondary' または 'button-secondary' なら無視される(クラス 'button' にスタイル指定あり)
    • 他の値、例えば 'foo' なら、クラス 'foo'
例えば $type のデフォルト値 'primary large' は、ボタンの HTML クラス 'button button-primary button-large' になる。
$name
文字列) (オプション) 送信ボタンの HTML の name 属性の値。もし $other_attributes に ID 属性がなければ、$name がボタンの ID 属性の値にも使われる。
初期値: submit
$wrap
真偽値) (オプション) true なら、出力するボタンを <p> タグで囲む。false なら囲まない。
初期値: true
$other_attributes
配列|文字列) (オプション) ボタンと一緒に出力する追加の属性と値。例えば array( 'tabindex' => '1' )
初期値: 追加の属性なし。

戻り値

この関数は値を返しません。ボタンの HTML が Web ブラウザーへ直接出力されます。

用例

デフォルトの使い方

submit_button();

これは次のような HTML を出力し、「変更を保存」というテキストのボタンを表示します。

<input type="submit" name="submit" id="submit" class="button button-primary" value="変更を保存"  />

カスタムテキストを使う

カスタムテキストをつけたボタンを出力するには、次のように第 1 パラメータを使います。

submit_button( '送信' );

第 2 ボタンの表示

WordPress は secondary(第 2)と primary(第 1)のボタンに異なるスタイルをつけます。primary ボタンは青色で、secondary ボタンの灰色より目立ちます。デフォルトでは、submit_button() は primary ボタンを出力します。代わりに secondary ボタンを表示するには、$type パラメータに 'secondary' をセットします。

submit_button( 'リセット', 'secondary' );

削除ボタンの表示

デフォルトでは、WordPress は削除ボタンにカスタムスタイルをつける様子はありませんが、HTML クラス 'delete' を付与します。しかし将来はこれが変わる可能性があるので、削除ボタンを表示するとき $type'delete' を指定するようにしましょう。

submit_button( '削除', 'delete' );

デフォルトでは、削除ボタンは primary ではなく secondary ボタンと同じように表示されます。もし primary ボタンのように表示したければ、次のようにすれば可能です。

submit_button( '削除', 'delete button-primary' );

$name パラメータを使う

ボタンの HTML の name 属性をセットしたければ $name パラメータを使います。デフォルトは 'submit' です。

submit_button( '設定を保存', 'primary', 'wpdocs-save-settings' );

デフォルトでは、$name がボタンの id 属性にも使われます。これを変えるには $other_attributes パラメータを利用して id を指定します。

$other_attributes = array( 'id' => 'wpdocs-button-id' );

submit_button( '設定を保存', 'primary', 'wpdocs-save-settings', true, $other_attributes );

$wrap パラメータを使う

$wrap パラメータはボタンを <p> タグで囲むかどうか制御します。囲むのがデフォルトですが、ボタンをどこへどのように表示したいかによってこれは役に立ったり邪魔だったりします。これをオフするには第 4 パラメータに false を指定します。

submit_button( '送信', 'primary', 'submit-form', false );

他の HTML 属性を指定する

$other_attributes パラメータを使ってボタンへ HTML の属性を追加できます。例えば:

$other_attributes = array( 'tabindex' => '1' );

submit_button( '実行!', 'secondary', '', true, $other_attributes );

参考

  • 表示する代わりにボタンを文字列として返す関数 get_submit_button() を使用します。$type のデフォルトが異なり、'primary large' なので、出力される HTML クラスは 'button button-primary button-large' です。
  • この関数はサイトのフロントエンドでは使えません。管理画面をロードするときのみ使用可能です。

変更履歴

新規導入: 3.1

ソースファイル

submit_button()/wp-admin/includes/template.php にあります。

get_submit_button()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/submit_button最新版との差分