@@ -2540,20 +2540,20 @@ function compression_test() {
25402540 *
25412541 * @see get_submit_button()
25422542 *
2543- * @param string $text The text of the button (defaults to 'Save Changes')
2543+ * @param string $text Optional. The text of the button. Defaults to 'Save Changes'.
25442544 * @param string $type Optional. The type and CSS class(es) of the button. Core values
25452545 * include 'primary', 'small', and 'large'. Default 'primary'.
2546- * @param string $name The HTML name of the submit button. Defaults to "submit". If no
2547- * id attribute is given in $other_attributes below, $name will be
2548- * used as the button's id .
2549- * @param bool $wrap True if the output button should be wrapped in a paragraph tag,
2550- * false otherwise. Defaults to true.
2551- * @param array|string $other_attributes Other attributes that should be output with the button, mapping
2552- * attributes to their values, such as setting tabindex to 1, etc .
2553- * These key/value attribute pairs will be output as attribute="value",
2554- * where attribute is the key. Other attributes can also be provided
2555- * as a string such as 'tabindex="1"' , though the array format is
2556- * preferred. Default null.
2546+ * @param string $name Optional. The HTML name of the submit button. If no `id` attribute
2547+ * is given in the ` $other_attributes` parameter, ` $name` will be used
2548+ * as the button's `id`. Default 'submit' .
2549+ * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph tag,
2550+ * false otherwise. Default true.
2551+ * @param array|string $other_attributes Optional. Other attributes that should be output with the button,
2552+ * mapping attributes to their values, e.g. `array( 'id' => 'search-submit' )` .
2553+ * These key/value attribute pairs will be output as ` attribute="value"` ,
2554+ * where attribute is the key. Attributes can also be provided as a string,
2555+ * e.g. `id="search-submit"` , though the array format is generally preferred.
2556+ * Default null.
25572557 */
25582558function submit_button ( $ text = null , $ type = 'primary ' , $ name = 'submit ' , $ wrap = true , $ other_attributes = null ) {
25592559 echo get_submit_button ( $ text , $ type , $ name , $ wrap , $ other_attributes );
@@ -2564,20 +2564,20 @@ function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap
25642564 *
25652565 * @since 3.1.0
25662566 *
2567- * @param string $text Optional. The text of the button. Default 'Save Changes'.
2567+ * @param string $text Optional. The text of the button. Defaults to 'Save Changes'.
25682568 * @param string $type Optional. The type and CSS class(es) of the button. Core values
25692569 * include 'primary', 'small', and 'large'. Default 'primary large'.
2570- * @param string $name Optional. The HTML name of the submit button. Defaults to "submit".
2571- * If no id attribute is given in $other_attributes below , `$name` will
2572- * be used as the button's id . Default 'submit'.
2573- * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph
2574- * tag, false otherwise. Default true.
2570+ * @param string $name Optional. The HTML name of the submit button. If no `id` attribute
2571+ * is given in the ` $other_attributes` parameter , `$name` will be used
2572+ * as the button's `id` . Default 'submit'.
2573+ * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph tag,
2574+ * false otherwise. Default true.
25752575 * @param array|string $other_attributes Optional. Other attributes that should be output with the button,
2576- * mapping attributes to their values, such as `array( 'tabindex ' => '1 ' )`.
2577- * These attributes will be output as `attribute="value"`, such as
2578- * `tabindex="1"`. Other attributes can also be provided as a string such
2579- * as `tabindex="1 "`, though the array format is typically cleaner .
2580- * Default empty.
2576+ * mapping attributes to their values, e.g. `array( 'id ' => 'search-submit ' )`.
2577+ * These key/value attribute pairs will be output as `attribute="value"`,
2578+ * where attribute is the key. Attributes can also be provided as a string,
2579+ * e.g. `id="search-submit "`, though the array format is generally preferred .
2580+ * Default empty string .
25812581 * @return string Submit button HTML.
25822582 */
25832583function get_submit_button ( $ text = '' , $ type = 'primary large ' , $ name = 'submit ' , $ wrap = true , $ other_attributes = '' ) {
0 commit comments