Changeset 8073

Timestamp:

03/06/2014 09:02:22 PM (11 years ago)

Author:

boonebgorges

Message:

Improved management of new_blog_post activity items at transition_post_status

Introduces bp_blogs_catch_transition_post_status(). This function, which
replaces bp_blogs_catch_published_post(), performs a similar task - determining
when a new blog post has been published, and recording the post in the activity
stream - but adds a corrolary for unpublishing that deletes the activity item.

Unit tests and deprecated function are included.

See #5333

Props henry.wright for an initial patch

Location:

trunk

Files:

• bp-blogs/bp-blogs-functions.php (modified) (2 diffs)
• bp-core/deprecated/2.0.php (modified) (2 diffs)
• tests/testcases/blogs/functions.php (modified) (1 diff)

trunk/bp-blogs/bp-blogs-functions.php

@@ -260 +260 @@
  * See #4090, #3746, #2546 for background.
  *
- * @since BuddyPress (1.9.0)
+ * @since BuddyPress (2.0.0)
  *
  * @param string $new_status New status for the post.
@@ -266 +266 @@
  * @param object $post Post data.
  */
-function bp_blogs_catch_published_post( $new_status, $old_status, $post ) {
-
-    // Only record published posts
-    if ( 'publish' !== $new_status ) {
+function bp_blogs_catch_transition_post_status( $new_status, $old_status, $post ) {
+
+    // Do nothing for edits
+    if ( $new_status === $old_status ) {
         return;
     }
 
-    // Don't record edits (publish -> publish)
-    if ( 'publish' === $old_status ) {
-        return;
-    }
-
-    return bp_blogs_record_post( $post->ID, $post );
-}
-add_action( 'transition_post_status', 'bp_blogs_catch_published_post', 10, 3 );
+    // Publishing a previously unpublished post
+    if ( 'publish' === $new_status ) {
+        return bp_blogs_record_post( $post->ID, $post );
+
+    // Unpublishing a previously published post
+    } else if ( 'publish' === $old_status ) {
+        return bp_blogs_remove_post( $post->ID );
+    }
+}
+add_action( 'transition_post_status', 'bp_blogs_catch_transition_post_status', 10, 3 );
 
 /**

trunk/bp-core/deprecated/2.0.php

@@ -1 +1 @@
 <?php
+/**
+ * Deprecated Functions
+ *
+ * @package BuddyPress
+ * @subpackage Core
+ * @deprecated 2.0.0
+ */
+
+// Exit if accessed directly
+if ( !defined( 'ABSPATH' ) ) exit;
 
 /**
@@ -7 +17 @@
     _deprecated_function( __FUNCTION__, '2.0.0', 'Use WP metadata API instead' );
 }
+
+/**
+ * @deprecated BuddyPress (2.0.0)
+ */
+function bp_blogs_catch_published_post() {
+    _deprecated_function( __FUNCTION__, '2.0', 'bp_blogs_catch_transition_post_status()' );
+}

trunk/tests/testcases/blogs/functions.php

@@ -266 +266 @@
         $this->assertNotEmpty( bp_blogs_add_blogmeta( 1, 'foo', 'baz' ) );
     }
+
+    /**
+     * @group bp_blogs_catch_transition_post_status
+     */
+    public function test_transition_post_status_publish_to_publish() {
+        $post_id = $this->factory->post->create( array(
+            'post_status' => 'publish',
+            'post_type' => 'post',
+        ) );
+        $post = get_post( $post_id );
+
+        // 'publish' => 'publish'
+        $this->assertTrue( $this->activity_exists_for_post( $post_id ), 'Published post should have activity' );
+
+        $post->post_status = 'publish';
+        $post->post_content .= ' foo';
+
+        wp_update_post( $post );
+
+        $this->assertTrue( $this->activity_exists_for_post( $post_id ), 'Published post should have activity (no change)' );
+    }
+
+    /**
+     * @group bp_blogs_catch_transition_post_status
+     */
+    public function test_transition_post_status_draft_to_draft() {
+        $post_id = $this->factory->post->create( array(
+            'post_status' => 'draft',
+            'post_type' => 'post',
+        ) );
+        $post = get_post( $post_id );
+
+        $this->assertFalse( $this->activity_exists_for_post( $post_id ), 'Unpublished post should not have activity' );
+
+        $post->post_status = 'draft';
+        $post->post_content .= ' foo';
+
+        wp_update_post( $post );
+
+        $this->assertFalse( $this->activity_exists_for_post( $post_id ), 'Unpublished post should not have activity (no change)' );
+    }
+
+    /**
+     * @group bp_blogs_catch_transition_post_status
+     */
+    public function test_transition_post_status_draft_to_publish() {
+        $post_id = $this->factory->post->create( array(
+            'post_status' => 'draft',
+            'post_type' => 'post',
+        ) );
+        $post = get_post( $post_id );
+
+        $this->assertFalse( $this->activity_exists_for_post( $post_id ), 'Unpublished post should not have activity' );
+
+        $post->post_status = 'publish';
+        $post->post_content .= ' foo';
+
+        wp_update_post( $post );
+
+        $this->assertTrue( $this->activity_exists_for_post( $post_id ), 'Published post should have activity' );
+    }
+
+    /**
+     * @group bp_blogs_catch_transition_post_status
+     */
+    public function test_transition_post_status_publish_to_draft() {
+        $post_id = $this->factory->post->create( array(
+            'post_status' => 'publish',
+            'post_type' => 'post',
+        ) );
+        $post = get_post( $post_id );
+
+        $this->assertTrue( $this->activity_exists_for_post( $post_id ), 'Published post should have activity' );
+
+        $post->post_status = 'draft';
+        $post->post_content .= ' foo';
+
+        wp_update_post( $post );
+
+        $this->assertFalse( $this->activity_exists_for_post( $post_id ), 'Unpublished post should not have activity' );
+    }
+
+    /**
+     * @group bp_blogs_catch_transition_post_status
+     */
+    public function test_transition_post_status_wp_delete_post() {
+        $post_id = $this->factory->post->create( array(
+            'post_status' => 'publish',
+            'post_type' => 'post',
+        ) );
+        $post = get_post( $post_id );
+
+        $this->assertTrue( $this->activity_exists_for_post( $post_id ), 'Published post should have activity' );
+
+        wp_delete_post( $post->ID );
+
+        $this->assertFalse( $this->activity_exists_for_post( $post_id ), 'Unpublished post should not have activity' );
+    }
+
+    /**
+     * @group bp_blogs_catch_transition_post_status
+     */
+    public function test_transition_post_status_wp_trash_post() {
+        $post_id = $this->factory->post->create( array(
+            'post_status' => 'publish',
+            'post_type' => 'post',
+        ) );
+        $post = get_post( $post_id );
+
+        $this->assertTrue( $this->activity_exists_for_post( $post_id ), 'Published post should have activity' );
+
+        wp_trash_post( $post->ID );
+
+        $this->assertFalse( $this->activity_exists_for_post( $post_id ), 'Unpublished post should not have activity' );
+    }
+
+    protected function activity_exists_for_post( $post_id ) {
+        $a = bp_activity_get( array(
+            'component' => buddypress()->blogs->id,
+            'action' => 'new_blog_post',
+            'item_id' => get_current_blog_id(),
+            'secondary_item_id' => $post_id,
+        ) );
+
+        return ! empty( $a['total'] );
+    }
 }