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

Timestamp:

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

Author:

tw2113

Message:

Add hook documentation for the Blogs component

Fixes #5939

File:

• trunk/src/bp-blogs/bp-blogs-classes.php (modified) (2 diffs)

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

@@ -59 +59 @@
                 $this->blog_id = apply_filters( 'bp_blogs_blog_id_before_save', $this->blog_id, $this->id );
 
+                /**
+                 * Fires before the current blog item gets saved.
+                 *
+                 * Please use this hook to filter the properties above. Each part will be passed in.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param BP_Blogs_Blog Current instance of the blog item being saved. Passed by reference.
+                 */
                 do_action_ref_array( 'bp_blogs_blog_before_save', array( &$this ) );
 
@@ -80 +89 @@
                         return false;
 
+                /**
+                 * Fires after the current blog item gets saved.
+                 *
+                 * Please use this hook to filter the properties above. Each part will be passed in.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param BP_Blogs_Blog Current instance of the blog item being saved. Passed by reference.
+                 */
                 do_action_ref_array( 'bp_blogs_blog_after_save', array( &$this ) );