WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Difference between revisions of "Post Status Transitions"

m (Add note about inherit = attachment.)
Line 12: Line 12:
 
* '<tt>future</tt>' - a post to publish in the future
 
* '<tt>future</tt>' - a post to publish in the future
 
* '<tt>private</tt>' - not visible to users who are not logged in
 
* '<tt>private</tt>' - not visible to users who are not logged in
* '<tt>inherit</tt>' - a revision. see get_children.
+
* '<tt>inherit</tt>' - a revision or attachment. see get_children.
 
* '<tt>trash</tt>' - post is in trashbin. added with [[Version 2.9]].
 
* '<tt>trash</tt>' - post is in trashbin. added with [[Version 2.9]].
   

Revision as of 02:32, 11 January 2013

WordPress 2.3 introduced some new actions that WordPress Plugins use to hook into status trasitions and workflow. Before, WordPress had a private_to_published action that only announced that a post moved from private to published. Now WordPress has actions for every possible transition.

codex status change.png

These actions are of the form 'status_to_status' where status is one of:

  • 'new' - When there's no previous status
  • 'publish' - A published post or page
  • 'pending' - post in pending review
  • 'draft' - a post in draft status
  • 'auto-draft' - a newly created post, with no content
  • 'future' - a post to publish in the future
  • 'private' - not visible to users who are not logged in
  • 'inherit' - a revision or attachment. see get_children.
  • 'trash' - post is in trashbin. added with Version 2.9.

When a pending post is published, the action pending_to_publish is triggered. The action is accompanied by the post object that is changing status.

A generic transition_post_status action is also emitted for every status change. It is accompanied by the new status, the old status, and the post object. WordPress Plugins can use this action to attach a function that intercepts all status changes.

The final action triggered during a status change is of the form status_object, where status is from the status list above and object is either page or post. For example, when a post is published, a publish_post action is triggered. The action is accompanied by the post ID and post object.

See the function wp_transition_post_status() for how these actions are formed. Use add_action() to attach functions to these actions.