get_submit_button( string $text = '', string $type = 'primary large', string $name = 'submit', bool $wrap = true, array|string $other_attributes = '' ): string
Returns a submit button, with provided text and appropriate class.
Contents
Parameters
-
$textstring Optional -
The text of the button. Default 'Save Changes'.
Default:
'' -
$typestring Optional -
The type and CSS class(es) of the button. Core values include
'primary','small', and'large'.Default:
'primary large' -
$namestring Optional -
The HTML name of the submit button. Defaults to "submit".
If no id attribute is given in $other_attributes below,$namewill be used as the button's id. Default'submit'.Default:
'submit' -
$wrapbool Optional -
True if the output button should be wrapped in a paragraph tag, false otherwise.
Default:
true -
$other_attributesarray|string Optional -
Other attributes that should be output with the button, mapping attributes to their values, such as
array( 'tabindex' => '1' ).
These attributes will be output asattribute="value", such astabindex="1". Other attributes can also be provided as a string such astabindex="1", though the array format is typically cleaner.
Default:
''
Return
string Submit button HTML.
More Information
- $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 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 large’ results in a button with HTML classes ‘button button-primary button-large’.
- The related function submit_button() echos the button instead of returning it as a string. It has a different default
$type, ‘primary’, resulting in the HTML classes ‘button button-primary’.
Source
File: wp-admin/includes/template.php.
View all references
function get_submit_button( $text = '', $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = '' ) {
if ( ! is_array( $type ) ) {
$type = explode( ' ', $type );
}
$button_shorthand = array( 'primary', 'small', 'large' );
$classes = array( 'button' );
foreach ( $type as $t ) {
if ( 'secondary' === $t || 'button-secondary' === $t ) {
continue;
}
$classes[] = in_array( $t, $button_shorthand, true ) ? 'button-' . $t : $t;
}
// Remove empty items, remove duplicate items, and finally build a string.
$class = implode( ' ', array_unique( array_filter( $classes ) ) );
$text = $text ? $text : __( 'Save Changes' );
// Default the id attribute to $name unless an id was specifically provided in $other_attributes.
$id = $name;
if ( is_array( $other_attributes ) && isset( $other_attributes['id'] ) ) {
$id = $other_attributes['id'];
unset( $other_attributes['id'] );
}
$attributes = '';
if ( is_array( $other_attributes ) ) {
foreach ( $other_attributes as $attribute => $value ) {
$attributes .= $attribute . '="' . esc_attr( $value ) . '" '; // Trailing space is important.
}
} elseif ( ! empty( $other_attributes ) ) { // Attributes provided as a string.
$attributes = $other_attributes;
}
// Don't output empty name and id attributes.
$name_attr = $name ? ' name="' . esc_attr( $name ) . '"' : '';
$id_attr = $id ? ' id="' . esc_attr( $id ) . '"' : '';
$button = '<input type="submit"' . $name_attr . $id_attr . ' class="' . esc_attr( $class );
$button .= '" value="' . esc_attr( $text ) . '" ' . $attributes . ' />';
if ( $wrap ) {
$button = '<p class="submit">' . $button . '</p>';
}
return $button;
}
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
There should be a note in the documentation stating that this function, as it is, is not designed to be run outside wp-admin.
Running the function as it is outside wp-admin results in
Fatal error: Uncaught Error: Call to undefined function get_submit_button()