WP-Post-Meta-Revisions

plugin banner

Allow selected post meta keys to be tracked in revisions.

Author:Adam Silverstein - code developed with others (profile at wordpress.org)
WordPress version required:4.1
WordPress version tested:6.2.2
Plugin version:2.0.0
Added to WordPress repository:04-12-2014
Last updated:17-07-2023
Rating, %:84
Rated by:5
Plugin URI:https://github.com/adamsilverstein/wp-post-me...
Total downloads:14 186
Active installs:500+
plugin download
Click to start download

This plugin implements a post meta revisioning feature as arrived at in https://core.trac.wordpress.org/ticket/20564.

The goal of releasing this code as a plugin is to allow as many people as possible to easily test the post meta revisioning feature, and also hopefully move towards inclusion of the feature into core, following the Features as Plugins model.

Further development of the code for this plugin will continue on its GitHub repository. Pull requests welcome!

To use this plugin, you must be running WordPress 4.1 or newer, two hooks were added in 4.1 that are required for this implementation.

To revision a post meta, you add its key via a filter:

function add_meta_keys_to_revision( $keys ) {
    $keys[] = 'meta-key-to-revision';
    return $keys;
}
add_filter( 'wp_post_revision_meta_keys', 'add_meta_keys_to_revision' );

Features:

  • Allows for a whitelisted array of ‘revisioned’ meta keys (which can change at any time)
  • A revision for the meta is stored on save (if the meta value has changed)
  • A meta revision save (if changed) is also triggered during auto-saves
  • Restoring a revision restores the revisioned meta field’s values at that revision (including auto-saves)
  • Supports storing of multiple values for a single key (and restoring them)
  • Adds revisioned meta to the preview data via get_post_metadata
  • Includes unit tests demonstrating feature
  • Travis CI tests integrated with GitHub repository, props @mattheu
Screenshots
ChangeLog