wp_list_post_revisions( int|WP_Post $post = 0, string $type = 'all' )
- Since
- 2.6.0
- Source
wp-includes/post-template.php:2021
Description
Can output either a UL with edit links or a TABLE with diff interface, and restore action links.
Compatibility
- WordPress
- since 2.6.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
$postint|WP_Postoptional- Post ID or WP_Post object. Default is global $post.Default:
0 $typestringoptional- 'all' (default), 'revision' or 'autosave'Default:
'all'
Performance profile
How much work a call to wp_list_post_revisions() 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
- Scaling
- Scales with input
- Instructions
- 8–39
- Plugin surface
- None
- Called by
- 1
Reaches the database via get_post().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 66.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
do_action()one call below wp_list_post_revisions()
Further down the call graph this can also reach option, 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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_list_post_revisions() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8 | get_post() |
!is_array($type) | 17 | get_post(), wp_get_post_revisions() |
is_array($type) | 25–26 | get_post(), _deprecated_argument(), wp_get_post_revisions() |
!is_array($type) | 29–30 | get_post(), wp_get_post_revisions(), __() |
is_array($type) | 37–39 | get_post(), _deprecated_argument(), wp_get_post_revisions(), __() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 66 | 8–39 | 11 | |
| 8.5 | 66 | 8–39 | 11 | |
| 8.4 | 66 | 8–39 | 11 | |
| 8.3 | 66 | 8–39 | 11 | |
| 8.2 | 66 | 8–39 | 11 | |
| 8.1 | 66 | 8–39 | 11 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 67 | 8–40 | 11 |
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.
Uses · 7
- get_post()Retrieves post data given a post ID or post object.
- _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
- wp_get_post_revisions()Returns all revisions of specified post.
- current_user_can()Returns whether the current user has the specified capability.
- wp_is_post_autosave()Determines if the specified post is an autosave.
- wp_post_revision_title_expanded()Retrieves formatted date timestamp of a revision (linked to that revisions's page).
- __()Retrieves the translation of $text.
Used by · 1
- post_revisions_meta_box()Displays list of revisions.
Source code
function wp_list_post_revisions( $post = 0, $type = 'all' ) { $post = get_post( $post ); if ( ! $post ) { return; } // $args array with (parent, format, right, left, type) deprecated since 3.6. if ( is_array( $type ) ) { $type = ! empty( $type['type'] ) ? $type['type'] : $type; _deprecated_argument( __FUNCTION__, '3.6.0' ); } $revisions = wp_get_post_revisions( $post->ID ); if ( ! $revisions ) { return; } $rows = ''; foreach ( $revisions as $revision ) { if ( ! current_user_can( 'read_post', $revision->ID ) ) { continue; } $is_autosave = wp_is_post_autosave( $revision ); if ( ( 'revision' === $type && $is_autosave ) || ( 'autosave' === $type && ! $is_autosave ) ) { continue; } $rows .= "\t<li>" . wp_post_revision_title_expanded( $revision ) . "</li>\n"; } echo "<div class='hide-if-js'><p>" . __( 'JavaScript must be enabled to use this feature.' ) . "</p></div>\n"; echo "<ul class='post-revisions hide-if-no-js'>\n"; echo $rows; echo '</ul>';}Changelog
Introduced in 2.6.0. Unchanged from 6.7.7 through 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-includes/post-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.