diff --git a/src/wp-admin/includes/template.php b/src/wp-admin/includes/template.php index 1d4a8e8da1..e667400f33 100644 --- a/src/wp-admin/includes/template.php +++ b/src/wp-admin/includes/template.php @@ -2540,20 +2540,20 @@ function compression_test() { * * @see get_submit_button() * - * @param string $text The text of the button (defaults to 'Save Changes') + * @param string $text Optional. 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', 'small', and 'large'. 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 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. + * @param string $name Optional. 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'. + * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph tag, + * false otherwise. Default true. + * @param array|string $other_attributes Optional. 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 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 ); @@ -2564,20 +2564,20 @@ function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap * * @since 3.1.0 * - * @param string $text Optional. The text of the button. Default 'Save Changes'. + * @param string $text Optional. 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', 'small', and 'large'. Default 'primary large'. - * @param string $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 'submit'. - * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph - * tag, false otherwise. Default true. + * @param string $name Optional. 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'. + * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph tag, + * false otherwise. Default true. * @param array|string $other_attributes 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 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. + * 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 empty string. * @return string Submit button HTML. */ function get_submit_button( $text = '', $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = '' ) {