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

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

関数リファレンス/get submit button

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

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

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

使い方

<?php get_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
配列|文字列) (オプション) ボタンと一緒に出力する追加の属性と値。
初期値: 追加の属性なし。

戻り値

(文字列) 
Submit ボタンの HTML テキスト。

用例

submit_button() の用例 を見てください。

参考

  • 関連する関数 submit_button() はボタンを文字列として返すのではなく echo します。さらに $type のデフォルト値が異なり、'primary' なので、表示される HTML のクラスは 'button button-primary' です。

変更履歴

新規導入: 3.1

ソースファイル

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

submit_button()

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