Changeset 9218 for trunk/src/bp-blogs/bp-blogs-screens.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-screens.php (modified) (6 diffs)

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

@@ -18 +18 @@
                 return false;
 
+        /**
+         * Fires right before the loading of the My Blogs screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'bp_blogs_screen_my_blogs' );
 
@@ -34 +39 @@
                 return false;
 
+        /**
+         * Fires right before the loading of the Create A Blog screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'bp_blogs_screen_create_a_blog' );
 
@@ -47 +57 @@
                 bp_update_is_directory( true, 'blogs' );
 
+                /**
+                 * Fires right before the loading of the top-level Blogs screen template file.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 */
                 do_action( 'bp_blogs_screen_index' );
 
@@ -94 +109 @@
                         bp_update_is_directory( true, 'blogs' );
 
+                        /**
+                         * Fires if in the blog directory and BuddyPress needs Blog theme compatibility,
+                         * before the actions and filters are added.
+                         *
+                         * @since BuddyPress (1.5.0)
+                         */
                         do_action( 'bp_blogs_screen_index' );
 
@@ -123 +144 @@
          */
         public function directory_template_hierarchy( $templates ) {
-                // Setup our templates based on priority
+
+                /**
+                 * Filters the custom templates used for theme compat with the blog directory page.
+                 *
+                 * @since BuddyPress (1.8.0)
+                 *
+                 * @param array $value Array of template paths to add to template list to look for.
+                 */
                 $new_templates = apply_filters( 'bp_template_hierarchy_blogs_create', array(
                         'blogs/index-directory.php'
@@ -179 +207 @@
          */
         public function create_template_hierarchy( $templates ) {
-                // Setup our templates based on priority
+
+                /**
+                 * Filters the custom templates used for theme compat with the blog create page.
+                 *
+                 * @since BuddyPress (1.8.0)
+                 *
+                 * @param array $value Array of template paths to add to template list to look for.
+                 */
                 $new_templates = apply_filters( 'bp_template_hierarchy_blogs_create', array(
                         'blogs/index-create.php'