submit_button( string $text = '', string $type = 'primary', string $name = 'submit', bool $wrap = true, array|string $other_attributes = '' )

Parameters

$textstringoptional

The text of the button. Defaults to 'Save Changes'.Default: ''

$typestringoptional

The type and CSS class(es) of the button. Core values include 'primary', 'small', and 'large'. Default 'primary'.Default: 'primary'

$namestringoptional

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'.Default: 'submit'

$wrapbooloptional

True if the output button should be wrapped in a paragraph tag, false otherwise. Default true.Default: true

$other_attributesarray|stringoptional

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 empty string.Default: ''

Uses · 1

• get_submit_button()Returns a submit button, with provided text and appropriate class.

Used by · 43

• Custom_Background::admin_page()Displays the custom background page.
• Custom_Image_Header::step_1()Displays first step of custom header image page.
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• WP_Comments_List_Table::extra_tablenav()
• WP_Links_List_Table::extra_tablenav()
• WP_List_Table::bulk_actions()Displays the bulk actions dropdown.
• WP_List_Table::search_box()Displays the search box.
• WP_MS_Sites_List_Table::extra_tablenav()Displays extra controls between bulk actions and pagination.
• WP_Media_List_Table::extra_tablenav()
• WP_Plugins_List_Table::extra_tablenav()
• WP_Plugins_List_Table::search_box()Displays the search box.
• WP_Posts_List_Table::extra_tablenav()

Source

View on Trac ↗View on GitHub ↗

2570function submit_button( $text = '', $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = '' ) {2571	echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );2572}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.