Changeset 9218 for trunk/src/bp-blogs/bp-blogs-functions.php

Timestamp:

12/09/2014 12:54:33 AM (10 years ago)

Author:

tw2113

Message:

Add hook documentation for the Blogs component

Fixes #5939

File:

• trunk/src/bp-blogs/bp-blogs-functions.php (modified) (14 diffs)

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

@@ -284 +284 @@
     }
 
+    /**
+     * Fires after BuddyPress has been made aware of a new site for activity tracking.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param BP_Blogs_Blog $recorded_blog Current blog being recorded. Passed by reference.
+     * @param bool          $is_private    Whether or not the current blog being recorded is private.
+     * @param bool          $is_recorded   Whether or not the current blog was recorded.
+     */
     do_action_ref_array( 'bp_blogs_new_blog', array( &$recorded_blog, $is_private, $is_recorded ) );
 }
@@ -428 +437 @@
     bp_blogs_update_blogmeta( $args['item_id'], 'last_activity', bp_core_current_time() );
 
+    /**
+     * Fires after BuddyPress has recorded metadata about a published blog post.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int     $ID    ID of the blog post being recorded.
+     * @param WP_Post $post  WP_Post object for the current blog post.
+     * @param string  $value ID of the user associated with the current blog post.
+     */
     do_action( 'bp_blogs_new_blog_post', $post->ID, $post, $args['user_id'] );
 }
@@ -791 +809 @@
  * first. See http://buddypress.trac.wordpress.org/ticket/3916.
  *
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
  * @access private
  */
@@ -812 +830 @@
 
     $blog_id = (int) $blog_id;
+
+    /**
+     * Fires before a "blog created" item is removed from blogs
+     * tracker and activity stream.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $blog_id ID of the blog having its item removed.
+     */
     do_action( 'bp_blogs_before_remove_blog', $blog_id );
 
@@ -819 +846 @@
     bp_blogs_delete_activity( array( 'item_id' => $blog_id, 'component' => $bp->blogs->id, 'type' => 'new_blog' ) );
 
+    /**
+     * Fires after a "blog created" item has been removed from blogs
+     * tracker and activity stream.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $blog_id ID of the blog who had its item removed.
+     */
     do_action( 'bp_blogs_remove_blog', $blog_id );
 }
@@ -835 +870 @@
     $user_id = (int) $user_id;
 
+    /**
+     * Fires before a blog is removed from the tracker for a specific user.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $blog_id ID of the blog being removed.
+     * @param int $user_id ID of the user having the blog removed for.
+     */
     do_action( 'bp_blogs_before_remove_blog_for_user', $blog_id, $user_id );
 
@@ -846 +889 @@
     ) );
 
+    /**
+     * Fires after a blog has been removed from the tracker for a specific user.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $blog_id ID of the blog that was removed.
+     * @param int $user_id ID of the user having the blog removed for.
+     */
     do_action( 'bp_blogs_remove_blog_for_user', $blog_id, $user_id );
 }
@@ -872 +923 @@
         $user_id = bp_loggedin_user_id();
 
+    /**
+     * Fires before removal of a blog post activity item from the activity stream.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $blog_id ID of the blog associated with the post that was removed.
+     * @param int $post_id ID of the post that was removed.
+     * @param int $user_id ID of the user having the blog removed for.
+     */
     do_action( 'bp_blogs_before_remove_post', $blog_id, $post_id, $user_id );
 
@@ -877 +937 @@
     bp_blogs_delete_activity( array( 'item_id' => $blog_id, 'secondary_item_id' => $post_id, 'component' => $bp->blogs->id, 'type' => 'new_blog_post' ) );
 
+    /**
+     * Fires after removal of a blog post activity item from the activity stream.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $blog_id ID of the blog associated with the post that was removed.
+     * @param int $post_id ID of the post that was removed.
+     * @param int $user_id ID of the user having the blog removed for.
+     */
     do_action( 'bp_blogs_remove_post', $blog_id, $post_id, $user_id );
 }
@@ -936 +1005 @@
     }
 
+    /**
+     * Fires after a blog comment activity item was removed from activity stream.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $blogid     Item ID for the blog associated with the removed comment.
+     * @param int $comment_id ID of the comment being removed.
+     * @param int $value      ID of the current logged in user.
+     */
     do_action( 'bp_blogs_remove_comment', $wpdb->blogid, $comment_id, bp_loggedin_user_id() );
 }
@@ -1111 +1189 @@
     global $bp;
 
+    /**
+     * Fires before all data related to a given blog is removed from blogs tracker
+     * and activity stream.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $blog_id ID of the blog whose data is being removed.
+     */
     do_action( 'bp_blogs_before_remove_data_for_blog', $blog_id );
 
@@ -1119 +1205 @@
     bp_blogs_delete_activity( array( 'item_id' => $blog_id, 'component' => $bp->blogs->id, 'type' => false ) );
 
+    /**
+     * Fires after all data related to a given blog has been removed from blogs tracker
+     * and activity stream.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $blog_id ID of the blog whose data is being removed.
+     */
     do_action( 'bp_blogs_remove_data_for_blog', $blog_id );
 }
@@ -1303 +1397 @@
         return false;
 
+    /**
+     * Fires before all blog associations are removed for a given user.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $user_id ID of the user whose blog associations are being removed.
+     */
     do_action( 'bp_blogs_before_remove_data', $user_id );
 
@@ -1308 +1409 @@
     BP_Blogs_Blog::delete_blogs_for_user( $user_id );
 
+    /**
+     * Fires after all blog associations are removed for a given user.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $user_id ID of the user whose blog associations were removed.
+     */
     do_action( 'bp_blogs_remove_data', $user_id );
 }