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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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', 'compact' and 'large'. Default 'primary large'.Default: 'primary large'

$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: ''

Return value

string

Submit button HTML.

Performance profile

How much work a call to get_submit_button() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

52–80

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 108.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below get_submit_button()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_submit_button() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.

Used by · 4

• _list_meta_row()Outputs a single row of public meta data in the Custom Fields meta box.
• get_media_item()Retrieves HTML form for modifying the image attachment.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).
• wp_media_insert_url_form()Creates the form for external url.

Source code

View on Trac ↗View on GitHub ↗

2600function get_submit_button( $text = '', $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = '' ) {2601	if ( ! is_array( $type ) ) {2602		$type = explode( ' ', $type );2603	}2604 2605	$button_shorthand = array( 'primary', 'small', 'large', 'compact' );2606	$classes          = array( 'button' );2607 2608	foreach ( $type as $t ) {2609		if ( 'secondary' === $t || 'button-secondary' === $t ) {2610			continue;2611		}2612 2613		$classes[] = in_array( $t, $button_shorthand, true ) ? 'button-' . $t : $t;2614	}2615 2616	// Remove empty items, remove duplicate items, and finally build a string.2617	$class = implode( ' ', array_unique( array_filter( $classes ) ) );2618 2619	$text = $text ? $text : __( 'Save Changes' );2620 2621	// Default the id attribute to $name unless an id was specifically provided in $other_attributes.2622	$id = $name;2623	if ( is_array( $other_attributes ) && isset( $other_attributes['id'] ) ) {2624		$id = $other_attributes['id'];2625		unset( $other_attributes['id'] );2626	}2627 2628	$attributes = '';2629	if ( is_array( $other_attributes ) ) {2630		foreach ( $other_attributes as $attribute => $value ) {2631			$attributes .= $attribute . '="' . esc_attr( $value ) . '" '; // Trailing space is important.2632		}2633	} elseif ( ! empty( $other_attributes ) ) { // Attributes provided as a string.2634		$attributes = $other_attributes;2635	}2636 2637	// Don't output empty name and id attributes.2638	$name_attr = $name ? ' name="' . esc_attr( $name ) . '"' : '';2639	$id_attr   = $id ? ' id="' . esc_attr( $id ) . '"' : '';2640 2641	$button  = '<input type="submit"' . $name_attr . $id_attr . ' class="' . esc_attr( $class );2642	$button .= '" value="' . esc_attr( $text ) . '" ' . $attributes . ' />';2643 2644	if ( $wrap ) {2645		$button = '<p class="submit">' . $button . '</p>';2646	}2647 2648	return $button;2649}

Changelog

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 7.1.0 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.