wppaste
WordPress

wp_transition_post_status( string $new_status, string $old_status, WP_Post $post )

Since
2.3.0
Source
wp-includes/post.php:5912
Fires actions related to the transitioning of a post's status.

Description

When a post is saved, the post status is "transitioned" from one status to another, though this does not always mean the status has actually changed before and after the save. This function fires a number of action hooks related to that transition: the generic 'transition_post_status' action, as well as the dynamic hooks '$old_statusto$new_status' and '$newstatus$post->post_type'. Note that the function does not transition the post object in the database.

For instance: When publishing a post for the first time, the post status may transition from 'draft' – or some other status – to 'publish'. However, if a post is already published and is simply being updated, the "old" and "new" statuses may both be 'publish' before and after the transition.

Compatibility

WordPress
since 2.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$new_statusstring
Transition to this post status.
$old_statusstring
Previous post status.
$postWP_Post
Post data.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
29

Executed per call on PHP 8.5. The body compiles to 29.

Plugin surface
3 hooks

Third-party callbacks on 'transition_post_status', '{$old_status}_to_{$new_status}', '{$new_status}_{$post->post_type}' run inside this call, and their cost is not bounded by anything here.

Called by
3

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

What it touches

  • hookthird-party callbacksdo_action()called directly

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always29do_action(), do_action(), do_action()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 29 instructions, 29 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 3

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

  1. do_action( transition_post_status )actionline 5922 (+10 into the body)

    Fires when a post is transitioned from one status to another.

  2. do_action( {$old_status}_to_{$new_status} )actionline 5940 (+28 into the body)

    Fires when a post is transitioned from one status to another.

  3. do_action( {$new_status}_{$post->post_type} )actionline 5980 (+68 into the body)

    Fires when a post is transitioned from one status to another.

Uses · 1

  • do_action()Calls the callback functions that have been added to an action hook.

Used by · 3

Source code

function wp_transition_post_status( $new_status, $old_status, $post ) {	/**	 * Fires when a post is transitioned from one status to another.	 *	 * @since 2.3.0	 *	 * @param string  $new_status New post status.	 * @param string  $old_status Old post status.	 * @param WP_Post $post       Post object.	 */	do_action( 'transition_post_status', $new_status, $old_status, $post ); 	/**	 * Fires when a post is transitioned from one status to another.	 *	 * The dynamic portions of the hook name, `$new_status` and `$old_status`,	 * refer to the old and new post statuses, respectively.	 *	 * Possible hook names include:	 *	 *  - `draft_to_publish`	 *  - `publish_to_trash`	 *  - `pending_to_draft`	 *	 * @since 2.3.0	 *	 * @param WP_Post $post Post object.	 */	do_action( "{$old_status}_to_{$new_status}", $post ); 	/**	 * Fires when a post is transitioned from one status to another.	 *	 * The dynamic portions of the hook name, `$new_status` and `$post->post_type`,	 * refer to the new post status and post type, respectively.	 *	 * Possible hook names include:	 *	 *  - `draft_post`	 *  - `future_post`	 *  - `pending_post`	 *  - `private_post`	 *  - `publish_post`	 *  - `trash_post`	 *  - `draft_page`	 *  - `future_page`	 *  - `pending_page`	 *  - `private_page`	 *  - `publish_page`	 *  - `trash_page`	 *  - `publish_attachment`	 *  - `trash_attachment`	 *	 * Please note: When this action is hooked using a particular post status (like	 * 'publish', as `publish_{$post->post_type}`), it will fire both when a post is	 * first transitioned to that status from something else, as well as upon	 * subsequent post updates (old and new status are both the same).	 *	 * Therefore, if you are looking to only fire a callback when a post is first	 * transitioned to a status, use the {@see 'transition_post_status'} hook instead.	 *	 * @since 2.3.0	 * @since 5.9.0 Added `$old_status` parameter.	 *	 * @param int     $post_id    Post ID.	 * @param WP_Post $post       Post object.	 * @param string  $old_status Old post status.	 */	do_action( "{$new_status}_{$post->post_type}", $post->ID, $post, $old_status );}

Changelog

Introduced in 2.3.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-includes/post.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.