wp_revisions_enabled( WP_Post $post ): bool
- Since
- 3.6.0
- Source
wp-includes/revision.php:781
Compatibility
- WordPress
- since 3.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
$postWP_Post- The post object.
Return value
bool- True if number of revisions to keep isn't zero, false otherwise.
Performance profile
How much work a call to wp_revisions_enabled() 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
- Scaling
- Constant
- Instructions
- 6
- Plugin surface
- None
- Called by
- 10
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 6.
Nothing here hands control to plugin code.
10 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below wp_revisions_enabled()
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_revisions_enabled() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | wp_revisions_to_keep() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 6 instructions, 6 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.
Uses · 1
- wp_revisions_to_keep()Determines how many revisions to retain for a given post.
Used by · 10
- WP_REST_Global_Styles_Revisions_Controller::get_items()Returns paginated revisions of the given global styles config custom post type.
- WP_REST_Revisions_Controller::get_items()Gets a collection of revisions.
- _wp_customize_publish_changeset()Publishes a snapshot's changes.
- wp_get_latest_revision_id_and_total_count()Returns the latest revision ID and count of revisions for a post.
- wp_get_post_revisions()Returns all revisions of specified post.
- wp_get_post_revisions_url()Returns the url for viewing and potentially restoring revisions of a given post.
- wp_prepare_revisions_for_js()Prepare revisions for JavaScript.
- wp_save_post_revision()Creates a revision for the current version of a post.
- wp_xmlrpc_server::wp_getRevisions()Retrieves revisions for a specific post.
- wp_xmlrpc_server::wp_restoreRevision()Restores a post revision.
Source code
function wp_revisions_enabled( $post ) { return wp_revisions_to_keep( $post ) !== 0;}Changelog
Introduced in 3.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/revision.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.