Merge pull request #451 from Yoast/enrico/adds-republish-hooks

Add action hooks before and after republishing.

Author: enricobattocchi

src/post-republisher.php

@@ -257,6 +257,21 @@ public function is_rest_request() {
 	 * @return void
 	 */
 	public function republish( WP_Post $post, WP_Post $original_post ) {
+
+		/**
+		 * Fires before the Rewrite & Republish copy is republished to the original post.
+		 *
+		 * This action runs before any content, taxonomies, or meta are copied from the
+		 * Rewrite & Republish copy to the original post. Use this hook to perform actions
+		 * or modifications before the republishing process begins.
+		 *
+		 * @since 4.6
+		 *
+		 * @param WP_Post $post          The Rewrite & Republish copy.
+		 * @param WP_Post $original_post The original post that will be overwritten.
+		 */
+		\do_action( 'duplicate_post_before_republish', $post, $original_post );
+
 		// Remove WordPress default filter so a new revision is not created on republish.
 		\remove_action( 'post_updated', 'wp_save_post_revision', 10 );
 
@@ -272,6 +287,21 @@ public function republish( WP_Post $post, WP_Post $original_post ) {
 
 		// Re-enable the creation of a new revision.
 		\add_action( 'post_updated', 'wp_save_post_revision', 10, 1 );
+
+		/**
+		 * Fires after the Rewrite & Republish copy has been republished to the original post.
+		 *
+		 * This action runs after all content, taxonomies, and meta have been copied from
+		 * the Rewrite & Republish copy to the original post. The copy is marked as republished
+		 * but has not yet been deleted. Use this hook to perform cleanup or additional
+		 * processing after the republishing is complete.
+		 *
+		 * @since 4.6
+		 *
+		 * @param WP_Post $post          The Rewrite & Republish copy.
+		 * @param WP_Post $original_post The original post that has been updated.
+		 */
+		\do_action( 'duplicate_post_after_republish', $post, $original_post );
 	}
 
 	/**

tests/WP/Post_Republisher_Test.php

@@ -1428,4 +1428,34 @@ public function test_republish_does_not_remove_meta_deleted_from_copy() {
 		// This is the expected behavior based on how the duplicator works.
 		$this->assertEquals( 'original_value', \get_post_meta( $original->ID, 'custom_meta_to_remove', true ) );
 	}
+
+	/**
+	 * Tests that duplicate_post_before_republish is fired before duplicate_post_after_republish.
+	 *
+	 * @covers ::republish
+	 *
+	 * @return void
+	 */
+	public function test_republish_fires_hooks_in_correct_order() {
+		$action_order    = [];
+		$before_callback = static function () use ( &$action_order ) {
+			$action_order[] = 'before';
+		};
+		$after_callback  = static function () use ( &$action_order ) {
+			$action_order[] = 'after';
+		};
+
+		\add_action( 'duplicate_post_before_republish', $before_callback );
+		\add_action( 'duplicate_post_after_republish', $after_callback );
+
+		$original = $this->create_original_post();
+		$copy     = $this->create_rewrite_and_republish_copy( $original );
+
+		$this->instance->republish( $copy, $original );
+
+		\remove_action( 'duplicate_post_before_republish', $before_callback );
+		\remove_action( 'duplicate_post_after_republish', $after_callback );
+
+		$this->assertSame( [ 'before', 'after' ], $action_order );
+	}
 }