post_submit_meta_box( WP_Post $post, array $args = array() )

Compatibility

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

Parameters

$postWP_Post

Current post object.

$argsarrayoptional

Array of arguments for building the post submit meta box.Default: array()

• $idstring

  Meta box 'id' attribute.

• $titlestring

  Meta box title.

• $callbackcallable

  Meta box display callback.

• $argsarray

  Extra meta box arguments.

Performance profile

How much work a call to post_submit_meta_box() 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

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

246–377

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

Plugin surface

3 hooks

Third-party callbacks on 'post_submitbox_minor_actions', 'post_submitbox_misc_actions', 'post_submitbox_start' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• querycontent queryget_post()one call below post_submit_meta_box()
• optionoption read or writeget_option()one call below post_submit_meta_box()

Further down the call graph this can also reach cache, serialize 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 · 114 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while post_submit_meta_box() runs, in this order:

1. 1
   do_action( post_submitbox_minor_actions )actionline 97 (+67 into the body)

   Fires after the Save Draft (or Save as Pending) and Preview (or Preview Changes) buttons in the Publish meta box.

2. 2
   do_action( post_submitbox_misc_actions )actionline 342 (+312 into the body)

   Fires after the post time/date setting in the Publish meta box.

3. 3
   do_action( post_submitbox_start )actionline 359 (+329 into the body)

   Fires at the beginning of the publishing actions section of the Publish meta box.

Uses · 28

• get_post_type_object()Retrieves a post type object by name.
• current_user_can()Returns whether the current user has the specified capability.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).
• __()Retrieves the translation of $text.
• esc_attr_e()Displays translated text that has been escaped for safe use in an attribute.
• is_post_type_viewable()Determines whether a post type is considered "viewable".
• esc_url()Checks and cleans a URL.
• get_preview_post_link()Retrieves the URL used for the post preview.
• _x()Retrieves translated string with gettext context.
• do_action()Calls the callback functions that have been added to an action hook.
• _e()Displays translated text.
• esc_attr()Escaping for HTML attributes.

Source code

View on Trac ↗View on GitHub ↗

30function post_submit_meta_box( $post, $args = array() ) {31	global $action;32 33	$post_id          = (int) $post->ID;34	$post_type        = $post->post_type;35	$post_type_object = get_post_type_object( $post_type );36	$can_publish      = current_user_can( $post_type_object->cap->publish_posts );37	?>38<div class="submitbox" id="submitpost">39 40<div id="minor-publishing">41 42	<?php // Hidden submit button early on so that the browser chooses the right button when form is submitted with Return key. ?>43	<div style="display:none;">44		<?php submit_button( __( 'Save' ), '', 'save' ); ?>45	</div>46 47	<div id="minor-publishing-actions">48		<div id="save-action">49			<?php50			if ( ! in_array( $post->post_status, array( 'publish', 'future', 'pending' ), true ) ) {51				$private_style = '';52				if ( 'private' === $post->post_status ) {53					$private_style = 'style="display:none"';54				}55				?>56				<input <?php echo $private_style; ?> type="submit" name="save" id="save-post" value="<?php esc_attr_e( 'Save Draft' ); ?>" class="button" />57				<span class="spinner"></span>58			<?php } elseif ( 'pending' === $post->post_status && $can_publish ) { ?>59				<input type="submit" name="save" id="save-post" value="<?php esc_attr_e( 'Save as Pending' ); ?>" class="button" />60				<span class="spinner"></span>61			<?php } ?>62		</div>63 64		<?php65		if ( is_post_type_viewable( $post_type_object ) ) :66			?>67			<div id="preview-action">68				<?php69				$preview_link = esc_url( get_preview_post_link( $post ) );70				if ( 'publish' === $post->post_status ) {71					$preview_button_text = __( 'Preview Changes' );72				} else {73					$preview_button_text = _x( 'Preview', 'verb' );74				}75 76				$preview_button = sprintf(77					'%1$s<span class="screen-reader-text"> %2$s</span>',78					$preview_button_text,79					/* translators: Hidden accessibility text. */80					__( '(opens in a new tab)' )81				);82				?>83				<a class="preview button" href="<?php echo $preview_link; ?>" target="wp-preview-<?php echo $post_id; ?>" id="post-preview"><?php echo $preview_button; ?></a>84				<input type="hidden" name="wp-preview" id="wp-preview" value="" />85			</div>86			<?php87		endif;88 89		/**90		 * Fires after the Save Draft (or Save as Pending) and Preview (or Preview Changes) buttons91		 * in the Publish meta box.92		 *93		 * @since 4.4.094		 *95		 * @param WP_Post $post WP_Post object for the current post.96		 */97		do_action( 'post_submitbox_minor_actions', $post );98		?>99		<div class="clear"></div>100	</div>101 102	<div id="misc-publishing-actions">103		<div class="misc-pub-section misc-pub-post-status">104			<?php _e( 'Status:' ); ?>105			<span id="post-status-display">106				<?php107				switch ( $post->post_status ) {108					case 'private':109						_e( 'Privately Published' );

Changelog

Introduced in 2.7.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/meta-boxes.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.