diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 35089d65eb..a3218f1fa3 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -1613,22 +1613,26 @@ function compression_test() { } /** - * Echos a submit button, with provided text and appropriate class + * Echoes a submit button, with provided text and appropriate class(es). * * @since 3.1.0 * - * @param string $text The text of the button (defaults to 'Save Changes') + * @see get_submit_button() + * + * @param string $text The text of the button (defaults to 'Save Changes') * @param string $type Optional. The type and CSS class(es) of the button. Core values * include 'primary', 'secondary', 'delete'. Default 'primary' - * @param string $name 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. - * @param bool $wrap True if the output button should be wrapped in a paragraph tag, - * false otherwise. Defaults to true - * @param array|string $other_attributes 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". - * Defaults to no other attributes. Other attributes can also be provided as a - * string such as 'tabindex="1"', though the array format is typically cleaner. + * @param string $name 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. + * @param bool $wrap True if the output button should be wrapped in a paragraph tag, + * false otherwise. Defaults to true + * @param array|string $other_attributes 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 null. */ function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) { echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );