_wp_post_revision_fields( array|WP_Post $post = array(), bool $deprecated = false ): string[]
- Since
- 2.6.0, 4.5.0, 4.5.0
- Source
wp-includes/revision.php:22
Compatibility
- WordPress
- since 4.5.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
$postarray|WP_Postoptional- A post array or a WP_Post object being processed for insertion as a post revision. Default empty array.Default:
array() $deprecatedbooloptional- Not used.Default:
false
Return value
string[]- Array of fields that can be versioned.
Performance profile
How much work a call to _wp_post_revision_fields() 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
- 16–36
- Plugin surface
- 1 hook
- Called by
- 6
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 38.
Third-party callbacks on '_wp_post_revision_fields' run inside this call, and their cost is not bounded by anything here.
6 places 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
apply_filters()called directly
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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _wp_post_revision_fields() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_array($post) && $fields !== null | 16–17 | apply_filters() |
!is_array($post) && $fields !== null | 22–23 | get_post(), apply_filters() |
is_array($post) && $fields === null | 29–30 | __(), __(), __(), apply_filters() |
!is_array($post) && $fields === null | 35–36 | get_post(), __(), __(), __(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 38 instructions, 16–36 executed per call, 4 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 · 1
One hook fires while _wp_post_revision_fields() runs, in this order:
- apply_filters( _wp_post_revision_fields )filterline 54 (+32 into the body)
Filters the list of fields saved in post revisions.
Uses · 3
- get_post()Retrieves post data given a post ID or post object.
- __()Retrieves the translation of $text.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 6
- WP_REST_Autosaves_Controller::create_post_autosave()Creates autosave for the specified post.
- _wp_post_revision_data()Returns a post array ready to be inserted into the posts table as a post revision.
- wp_create_post_autosave()Creates autosave data for the specified post from `$_POST` data.
- wp_get_revision_ui_diff()Get the revision UI diff.
- wp_restore_post_revision()Restores a post to the specified revision.
- wp_save_post_revision()Creates a revision for the current version of a post.
Source code
function _wp_post_revision_fields( $post = array(), $deprecated = false ) { static $fields = null; if ( ! is_array( $post ) ) { $post = get_post( $post, ARRAY_A ); } if ( is_null( $fields ) ) { // Allow these to be versioned. $fields = array( 'post_title' => __( 'Title' ), 'post_content' => __( 'Content' ), 'post_excerpt' => __( 'Excerpt' ), ); } /** * Filters the list of fields saved in post revisions. * * Included by default: 'post_title', 'post_content' and 'post_excerpt'. * * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date', * 'post_date_gmt', 'post_status', 'post_type', 'comment_count', * and 'post_author'. * * @since 2.6.0 * @since 4.5.0 The `$post` parameter was added. * * @param string[] $fields List of fields to revision. Contains 'post_title', * 'post_content', and 'post_excerpt' by default. * @param array $post A post array being processed for insertion as a post revision. */ $fields = apply_filters( '_wp_post_revision_fields', $fields, $post ); // WP uses these internally either in versioning or elsewhere - they cannot be versioned. foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) { unset( $fields[ $protect ] ); } return $fields;}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.
$autosave parameter was deprecated and renamed to $deprecated.from the docblockWP_Post object can now be passed to the $post parameter.from the docblockAbout 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.