Wp Post Meta Revisions Save

plugin for https://core.trac.wordpress.org/ticket/20564

Project README

Build Status

=== WP-Post-Meta-Revisions ===

Allow selected post meta keys to be tracked in revisions.

== Description ==


Version 2.0.0 of this plugin introduces a streamlined storage format for revisioned meta that is not completely backwards compatible with previous versions of the plugin. Restoring revisions data from a previous version where array data was stored may not work as expected. If you need to be able to restore array data revisioned in previous versions, avoid upgrading or read the full issue to see how your data may be impacted: https://github.com/adamsilverstein/wp-post-meta-revisions/pull/56/.

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' );


  • 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
Open Source Agenda is not affiliated with "Wp Post Meta Revisions" Project. README Source: adamsilverstein/wp-post-meta-revisions
Open Issues
Last Commit
10 months ago

Open Source Agenda Badge

Open Source Agenda Rating