get_submit_button
Returns a submit button, with provided text and appropriate class.
Description
(string) get_submit_button( (string) $text = '', (string) $type = 'primary large', (string) $name = 'submit', (constant) $wrap = true, (string) $other_attributes = '' );
Returns (string)
Submit button HTML.
Parameters (5)
- 0. $text — Optional. (string) =>
''
- The text of the button. Default Save Changes..
- 1. $type — Optional. (string) =>
'primary large'
- The type of button. Accepts primary,, secondary., or delete. Default primary large.
- 2. $name — Optional. (string) =>
'submit'
- 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 submit. - 3. $wrap — Optional. (constant) =>
true
- True if the output button should be wrapped in a paragraph tag, false otherwise. Default true.
- 4. $other_attributes — Optional. (string) =>
''
- Other attributes that should be output with the button, mapping attributes to their values, such as array( tabindex' => 1 )'. These attributes will be output as attribute=value"', such as tabindex=1"'. Other attributes can also be provided as a string such as tabindex=1"', though the array format is typically cleaner. Default empty.
Usage
if ( !function_exists( 'get_submit_button' ) ) { require_once ABSPATH . '/wp-admin/includes/template.php'; } // Optional. The text of the button. Default 'Save Changes'. $text = ''; // Optional. The type of button. Accepts 'primary', 'secondary', // or 'delete'. Default 'primary large'. $type = 'primary large'; $name = 'submit'; // Optional. True if the output button should be wrapped in a paragraph // tag, false otherwise. Default true. $wrap = true; $other_attributes = ''; // NOTICE! Understand what this does before running. $result = get_submit_button($text, $type, $name, $wrap, $other_attributes);
Defined (1)
The function is defined in the following location(s).
- /wp-admin/includes/template.php
- 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 ) ? '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;
- }