<!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>[52095] trunk: Revisions: Introduce `wp_get_post_revisions_url()` to get URL for editing revisions.</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/52095">52095</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/52095","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-10 01:25:09 +0000 (Wed, 10 Nov 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Revisions: Introduce `wp_get_post_revisions_url()` to get URL for editing revisions.
There's now a way to get a link to a given post's revisions. Introducing `wp_get_post_revisions_url()` and its unit tests.
Props adamsilverstein, audrasjb, costdev, davidbaumwald, garrett-eclipse, georgestephanis, hellofromTonya, iaaxpage.
Fixes <a href="https://core.trac.wordpress.org/ticket/39062">#39062</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrevisionphp">trunk/src/wp-includes/revision.php</a></li>
<li><a href="#trunktestsphpunittestspostrevisionsphp">trunk/tests/phpunit/tests/post/revisions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrevisionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/revision.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/revision.php 2021-11-10 00:44:49 UTC (rev 52094)
+++ trunk/src/wp-includes/revision.php 2021-11-10 01:25:09 UTC (rev 52095)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -517,6 +517,40 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the url for viewing and potentially restoring revisions of a given post.
+ *
+ * @since 5.9.0
+ *
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return null|string The URL for editing revisions on the given post, otherwise null.
+ */
+function wp_get_post_revisions_url( $post_id = 0 ) {
+ $post = get_post( $post_id );
+
+ if ( ! $post instanceof WP_Post ) {
+ return null;
+ }
+
+ // If the post is a revision, return early.
+ if ( 'revision' === $post->post_type ) {
+ return get_edit_post_link( $post );
+ }
+
+ if ( ! wp_revisions_enabled( $post ) ) {
+ return null;
+ }
+
+ $revisions = wp_get_post_revisions( $post->ID, array( 'posts_per_page' => 1 ) );
+
+ if ( 0 === count( $revisions ) ) {
+ return null;
+ }
+
+ $revision = reset( $revisions );
+ return get_edit_post_link( $revision );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determine if revisions are enabled for a given post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span></span></pre></div>
<a id="trunktestsphpunittestspostrevisionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post/revisions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/revisions.php 2021-11-10 00:44:49 UTC (rev 52094)
+++ trunk/tests/phpunit/tests/post/revisions.php 2021-11-10 01:25:09 UTC (rev 52095)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -654,4 +654,163 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( $revision );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that wp_get_post_revisions_url() returns the revisions URL.
+ *
+ * @ticket 39062
+ *
+ * @dataProvider data_wp_get_post_revisions_url
+ *
+ * @covers ::wp_get_post_revisions_url
+ *
+ * @param int $revisions The number of revisions to create.
+ */
+ public function test_wp_get_post_revisions_url( $revisions ) {
+ wp_set_current_user( self::$admin_user_id );
+
+ $post_id = self::factory()->post->create( array( 'post_title' => 'Some Post' ) );
+ $latest_revision_id = null;
+
+ if ( 0 !== $revisions ) {
+ $latest_revision_id = $post_id;
+
+ for ( $i = 0; $i < $revisions; ++$i ) {
+ wp_update_post(
+ array(
+ 'ID' => $post_id,
+ 'post_title' => 'Some Post ' . $i,
+ )
+ );
+
+ $latest_revision_id++;
+ }
+ }
+
+ $expected = admin_url( 'revision.php?revision=' . $latest_revision_id );
+
+ $this->assertSame(
+ $expected,
+ wp_get_post_revisions_url( $post_id ),
+ 'Failed when passed the Post ID'
+ );
+
+ $this->assertSame(
+ $expected,
+ wp_get_post_revisions_url( $latest_revision_id ),
+ 'Failed when passed the latest revision ID'
+ );
+ }
+
+ /**
+ * Tests that wp_get_post_revisions_url() returns the revisions URL
+ * when passed a WP_Post object.
+ *
+ * @ticket 39062
+ *
+ * @dataProvider data_wp_get_post_revisions_url
+ *
+ * @covers ::wp_get_post_revisions_url
+ *
+ * @param int $revisions The number of revisions to create.
+ */
+ public function test_wp_get_post_revisions_url_with_post_object( $revisions ) {
+ wp_set_current_user( self::$admin_user_id );
+
+ $post = self::factory()->post->create_and_get( array( 'post_title' => 'Some Post' ) );
+ $latest_revision_id = null;
+
+ if ( 0 !== $revisions ) {
+ $latest_revision_id = $post->ID;
+
+ for ( $i = 0; $i < $revisions; ++$i ) {
+ wp_update_post(
+ array(
+ 'ID' => $post->ID,
+ 'post_title' => 'Some Post ' . $i,
+ )
+ );
+
+ $latest_revision_id++;
+ }
+ }
+
+ $expected = admin_url( 'revision.php?revision=' . $latest_revision_id );
+
+ $this->assertSame(
+ $expected,
+ wp_get_post_revisions_url( $post ),
+ 'Failed when passed the Post Object'
+ );
+
+ $this->assertSame(
+ $expected,
+ wp_get_post_revisions_url( $latest_revision_id ),
+ 'Failed when passed the latest revision ID'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_wp_get_post_revisions_url() {
+ return array(
+ 'one revision' => array( 'revisions' => 1 ),
+ 'multiple revisions' => array( 'revisions' => 2 ),
+ );
+ }
+
+ /**
+ * Tests that wp_get_post_revisions_url() returns NULL when a post does not exist.
+ *
+ * @ticket 39062
+ *
+ * @covers ::wp_get_post_revisions_url
+ */
+ public function test_wp_get_post_revisions_url_returns_null_when_post_does_not_exist() {
+ wp_set_current_user( self::$admin_user_id );
+ $post_id = 99999;
+ $this->assertNull( wp_get_post_revisions_url( $post_id ) );
+ }
+
+ /**
+ * Tests that wp_get_post_revisions_url() returns NULL when there are no revisions.
+ *
+ * @ticket 39062
+ *
+ * @covers ::wp_get_post_revisions_url
+ */
+ public function test_wp_get_post_revisions_url_returns_null_with_no_revisions() {
+ wp_set_current_user( self::$admin_user_id );
+ $post_id = self::factory()->post->create( array( 'post_title' => 'Some Post' ) );
+ $this->assertNull( wp_get_post_revisions_url( $post_id ) );
+ }
+
+ /**
+ * Tests that wp_get_post_revisions_url() returns NULL when revisions are disabled.
+ *
+ * @ticket 39062
+ *
+ * @covers ::wp_get_post_revisions_url
+ */
+ public function test_wp_get_post_revisions_url_returns_null_with_revisions_disabled() {
+ wp_set_current_user( self::$admin_user_id );
+
+ remove_post_type_support( 'post', 'revisions' );
+
+ $post_id = self::factory()->post->create( array( 'post_title' => 'Some Post' ) );
+
+ wp_update_post(
+ array(
+ 'ID' => $post_id,
+ 'post_title' => 'Some Post 2',
+ )
+ );
+
+ $this->assertNull( wp_get_post_revisions_url( $post_id ) );
+
+ add_post_type_support( 'post', 'revisions' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>