Changeset 9383 for trunk/src/bp-forums/bp-forums-screens.php

Timestamp:

01/21/2015 12:13:52 AM (10 years ago)

Author:

tw2113

Message:

Add hook documentation to BP Forums component.

Fixes #5941.

File:

• trunk/src/bp-forums/bp-forums-screens.php (modified) (7 diffs)

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

@@ -29 +29 @@
         bp_update_is_directory( true, 'forums' );
 
+        /**
+         * Fires early in the initialization of bbPress-based areas of BuddyPress.
+         *
+         * @since BuddyPress (1.1.0)
+         */
         do_action( 'bbpress_init' );
 
@@ -76 +81 @@
         }
 
+        /**
+         * Fires right before the loading of the forums directory screen template file.
+         *
+         * @since BuddyPress (1.1.0)
+         */
         do_action( 'bp_forums_directory_forums_setup' );
 
+        /**
+         * Filters the template to load for the forums directory screen.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param string $template Path to the forums template to load.
+         */
         bp_core_load_template( apply_filters( 'bp_forums_template_directory_forums_setup', 'forums/index' ) );
     }
@@ -87 +104 @@
  */
 function bp_member_forums_screen_topics() {
+
+    /**
+     * Fires right before the loading of the forums topics started screen template file.
+     *
+     * @since BuddyPress (1.5.0)
+     */
     do_action( 'bp_member_forums_screen_topics' );
 
+    /**
+     * Filters the template to load for the forums topics started screen.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $template Path to the forums topics started template to load.
+     */
     bp_core_load_template( apply_filters( 'bp_member_forums_screen_topics', 'members/single/home' ) );
 }
@@ -96 +126 @@
  */
 function bp_member_forums_screen_replies() {
+
+    /**
+     * Fires right before the loading of the forums replied to screen template file.
+     *
+     * @since BuddyPress (1.5.0)
+     */
     do_action( 'bp_member_forums_screen_replies' );
 
+    /**
+     * Filters the template to load for the forums replied to screen.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $template Path to the forums replied to template to load.
+     */
     bp_core_load_template( apply_filters( 'bp_member_forums_screen_replies', 'members/single/home' ) );
 }
@@ -107 +150 @@
  */
 function bp_member_forums_screen_favorites() {
+
+    /**
+     * Fires right before the loading of the forums favorites screen template file.
+     *
+     * @since BuddyPress (1.5.0)
+     */
     do_action( 'bp_member_forums_screen_favorites' );
 
+    /**
+     * Filters the template to load for the forums favorites screen.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $template Path to the forums favorites template to load.
+     */
     bp_core_load_template( apply_filters( 'bp_member_forums_screen_favorites', 'members/single/home' ) );
 }
@@ -120 +176 @@
         return false;
 
+    /**
+     * Fires right before the loading of the forums single forum screen template file.
+     *
+     * @since BuddyPress (1.5.0)
+     */
     do_action( 'bp_forums_screen_single_forum' );
 
+    /**
+     * Filters the template to load for the forums single forum screen.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $template Path to the forums single forum template to load.
+     */
     bp_core_load_template( apply_filters( 'bp_forums_screen_single_forum', 'forums/single/forum' ) );
 }
@@ -134 +202 @@
         return false;
 
+    /**
+     * Fires right before the loading of the forums single topic screen template file.
+     *
+     * @since BuddyPress (1.5.0)
+     */
     do_action( 'bp_forums_screen_single_topic' );
 
+    /**
+     * Filters the template to load for the forums single topic screen.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param string $template Path to the forums single topic template to load.
+     */
     bp_core_load_template( apply_filters( 'bp_forums_screen_single_topic', 'forums/single/topic' ) );
 }