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

Description

See also

• get_submit_button()

Parameters

$textstringoptional

The text of the button. Defaults to ‘Save Changes’.

Default:''

$typestringoptional

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

Default:'primary'

$namestringoptional

The HTML name of the submit button. If no id attribute is given in the $other_attributes parameter, $name will be used as the button’s id. Default 'submit'.

Default:'submit'

$wrapbooloptional

True if the output button should be wrapped in a paragraph tag, false otherwise.

Default:true

$other_attributesarray|stringoptional

Other attributes that should be output with the button, mapping attributes to their values, e.g. array( 'id' => 'search-submit' ).
These key/value attribute pairs will be output as attribute="value", where attribute is the key. Attributes can also be provided as a string, e.g. id="search-submit", though the array format is generally preferred.

Default:''

More Information

This function cannot be used on the front end of the site, it is only available when loading the administration screens.

Parametr $type can be a single value, or a space separated list of values, or an array of values. The values determine the HTML classes of the button.

• If $type is ‘delete’, the classes are ‘button-secondary delete’.
• Otherwise the first class is ‘button’, followed by any of these in order of appearance:
  • type value ‘primary’ makes class ‘button-primary’
  • type value ‘small’ makes class ‘button-small’
  • type value ‘large’ makes class ‘button-large’
  • type value ‘secondary’ or ‘button-secondary’ is ignored (the ‘button’ class has the styling)
  • any other type value ‘foo’ makes the class ‘foo’

For example, the default $type ‘primary’ results in a button with HTML classes ‘button button-primary’.

This function does not return a value. The HTML for the button is output directly to the browser.

Uses the related function get_submit_button(), which returns the button as a string instead of echoing it. It has a different default $type, 'primary large', resulting in the HTML classes 'button button-primary button-large'.

Source

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

View all references View on Trac View on GitHub

Changelog