submit_button

Advertisement

Summery Summery

Echoes a submit button, with provided text and appropriate class(es).

Syntax Syntax

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

Parameters Parameters

$text

(Optional) The text of the button (defaults to 'Save Changes')

Default value: null

$type

(Optional) The type and CSS class(es) of the button. Core values include 'primary', 'small', and 'large'. Default 'primary'.

Default value: 'primary'

$name

(Optional) The HTML name of the submit button. Defaults to "submit". If no id attribute is given in $other_attributes below, $name will be used as the button's id.

Default value: 'submit'

$wrap

(Optional) True if the output button should be wrapped in a paragraph tag, false otherwise. Defaults to true.

Default value: true

$other_attributes

(Optional) Other attributes that should be output with the button, mapping attributes to their values, such as setting tabindex to 1, etc. These key/value attribute pairs will be output as attribute="value", where attribute is the key. Other attributes can also be provided as a string such as 'tabindex="1"', though the array format is preferred.

Default value: null

Source Source

File: wp-admin/includes/template.php

function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
	echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
}

Advertisement

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

See also See also

Advertisement

Leave a Reply