<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[27699] trunk/src/wp-includes/revision.php: Inline documentation for hooks in wp-includes/revision.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27699">27699</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-03-25 08:59:55 +0000 (Tue, 25 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/revision.php.
Props adamsilverstein, DrewAPicture.
Fixes <a href="http://core.trac.wordpress.org/ticket/26979">#26979</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrevisionphp">trunk/src/wp-includes/revision.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrevisionphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/revision.php (27698 => 27699)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/revision.php 2014-03-25 08:55:44 UTC (rev 27698)
+++ trunk/src/wp-includes/revision.php 2014-03-25 08:59:55 UTC (rev 27699)
</span><span class="lines">@@ -16,8 +16,6 @@
</span><span class="cx"> * @since 2.6.0
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields.
- *
</del><span class="cx"> * @param array $post Optional a post array to be processed for insertion as a post revision.
</span><span class="cx"> * @param bool $autosave optional Is the revision an autosave?
</span><span class="cx"> * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
</span><span class="lines">@@ -33,7 +31,20 @@
</span><span class="cx"> 'post_excerpt' => __( 'Excerpt' ),
</span><span class="cx"> );
</span><span class="cx">
</span><del>- // Runs only once
</del><ins>+ /**
+ * Filter 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
+ *
+ * @param array $fields List of fields to revision. Contains 'post_title',
+ * 'post_content', and 'post_excerpt' by default.
+ */
</ins><span class="cx"> $fields = apply_filters( '_wp_post_revision_fields', $fields );
</span><span class="cx">
</span><span class="cx"> // WP uses these internally either in versioning or elsewhere - they cannot be versioned
</span><span class="lines">@@ -99,7 +110,21 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', true, $last_revision, $post ) ) {
</del><ins>+ /**
+ * Filter whether the post has changed since the last revision.
+ *
+ * By default a revision is saved only if one of the revisioned fields has changed.
+ * This filter can override that so a revision is saved even if nothing has changed.
+ *
+ * @since 3.6.0
+ *
+ * @param bool $check_for_changes Whether to check for changes before saving a new revision.
+ * Default true.
+ * @param int $last_revision ID of the last revision.
+ * @param int $post Post ID.
+ *
+ */
+ if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', $check_for_changes = true, $last_revision, $post ) ) {
</ins><span class="cx"> $post_has_changed = false;
</span><span class="cx">
</span><span class="cx"> foreach ( array_keys( _wp_post_revision_fields() ) as $field ) {
</span><span class="lines">@@ -237,8 +262,16 @@
</span><span class="cx"> if ( is_wp_error($revision_id) )
</span><span class="cx"> return $revision_id;
</span><span class="cx">
</span><del>- if ( $revision_id )
</del><ins>+ if ( $revision_id ) {
+ /**
+ * Fires once a revision has been saved.
+ *
+ * @since 2.6.0
+ *
+ * @param int $revision_id Post revision ID.
+ */
</ins><span class="cx"> do_action( '_wp_put_post_revision', $revision_id );
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return $revision_id;
</span><span class="cx"> }
</span><span class="lines">@@ -283,8 +316,6 @@
</span><span class="cx"> *
</span><span class="cx"> * @uses wp_get_post_revision()
</span><span class="cx"> * @uses wp_update_post()
</span><del>- * @uses do_action() Calls 'wp_restore_post_revision' on post ID and revision ID if wp_update_post()
- * is successful.
</del><span class="cx"> *
</span><span class="cx"> * @param int|object $revision_id Revision ID or revision object.
</span><span class="cx"> * @param array $fields Optional. What fields to restore from. Defaults to all.
</span><span class="lines">@@ -324,6 +355,14 @@
</span><span class="cx"> // Update last edit user
</span><span class="cx"> update_post_meta( $post_id, '_edit_last', get_current_user_id() );
</span><span class="cx">
</span><ins>+ /**
+ * Fires after a post revision has been restored.
+ *
+ * @since 2.6.0
+ *
+ * @param int $post_id Post ID.
+ * @param int $revision_id Post revision ID.
+ */
</ins><span class="cx"> do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
</span><span class="cx">
</span><span class="cx"> return $post_id;
</span><span class="lines">@@ -350,8 +389,17 @@
</span><span class="cx"> if ( is_wp_error( $delete ) )
</span><span class="cx"> return $delete;
</span><span class="cx">
</span><del>- if ( $delete )
</del><ins>+ if ( $delete ) {
+ /**
+ * Fires once a post revision has been deleted.
+ *
+ * @since 2.6.0
+ *
+ * @param int $revision_id Post revision ID.
+ * @param object|array $revision Post revision object or array.
+ */
</ins><span class="cx"> do_action( 'wp_delete_post_revision', $revision->ID, $revision );
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return $delete;
</span><span class="cx"> }
</span><span class="lines">@@ -406,7 +454,6 @@
</span><span class="cx"> * @since 3.6.0
</span><span class="cx"> *
</span><span class="cx"> * @uses post_type_supports()
</span><del>- * @uses apply_filters() Calls 'wp_revisions_to_keep' hook on the number of revisions.
</del><span class="cx"> *
</span><span class="cx"> * @param object $post The post object.
</span><span class="cx"> * @return int The number of revisions to keep.
</span><span class="lines">@@ -422,6 +469,16 @@
</span><span class="cx"> if ( ! post_type_supports( $post->post_type, 'revisions' ) )
</span><span class="cx"> $num = 0;
</span><span class="cx">
</span><ins>+ /**
+ * Filter the number of revisions to save for the given post.
+ *
+ * Overrides the value of WP_POST_REVISIONS.
+ *
+ * @since 3.6.0
+ *
+ * @param int $num Number of revisions to store.
+ * @param WP_Post $post Post object.
+ */
</ins><span class="cx"> return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>