Changeset 9595

Timestamp:

03/05/2015 04:55:12 AM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-template-loader.php.

See #5940.

File:

• trunk/src/bp-core/bp-core-template-loader.php (modified) (10 diffs)

trunk/src/bp-core/bp-core-template-loader.php

@@ -33 +33 @@
 
     // Execute code for this part
+    /**
+     * Fires at the start of bp_get_template_part().
+     *
+     * This is a variable hook that is dependent on the slug passed in.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $slug Template part slug requested.
+     * @param string $name Template part name requested.
+     */
     do_action( 'get_template_part_' . $slug, $slug, $name );
 
@@ -43 +53 @@
 
     // Allow template parts to be filtered
+    /**
+     * Filters the template parts to be loaded.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param array  $templates Array of templates located.
+     * @param string $slug      Template part slug requested.
+     * @param string $name      Template part name requested.
+     */
     $templates = apply_filters( 'bp_get_template_part', $templates, $slug, $name );
 
@@ -216 +235 @@
     $stack = array_unique( array_filter( $stack ) );
 
+    /**
+     * Filters the "template stack" list of registered directories where templates can be found.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param array $stack Array of registered directories for template locations.
+     */
     return (array) apply_filters( 'bp_get_template_stack', $stack ) ;
 }
@@ -279 +305 @@
     }
 
+    /**
+     * Filters possible file paths to check for for a template.
+     *
+     * This is a variable filter based on the type passed into
+     * bp_get_query_template.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param array $templates Array of template files already prepared.
+     */
+    $templates = apply_filters( "bp_get_{$type}_template", $templates );
+
     // Filter possible templates, try to match one, and set any BuddyPress theme
     // compat properties so they can be cross-checked later.
-    $templates = apply_filters( "bp_get_{$type}_template", $templates );
     $templates = bp_set_theme_compat_templates( $templates );
     $template  = bp_locate_template( $templates );
     $template  = bp_set_theme_compat_template( $template );
 
+    /**
+     * Filters the path to a template file.
+     *
+     * This is a variable filter based on the type passed into
+     * bp_get_query_template.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $template Path to the most appropriate found template file.
+     */
     return apply_filters( "bp_{$type}_template", $template );
 }
@@ -292 +339 @@
  * Get the possible subdirectories to check for templates in
  *
- * @since BuddyPress (1.7)
+ * @since BuddyPress (1.7.0)
  * @param array $templates Templates we are looking for
  * @return array Possible subfolders to look in
@@ -302 +349 @@
         ''
     );
+
+    /**
+     * Filters the possible subdirectories to check for templates in.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param array $locations Array of subfolders to look in.
+     * @param array $templates Array of templates we are looking for.
+     */
     return apply_filters( 'bp_get_template_locations', $locations, $templates );
 }
@@ -326 +382 @@
     }
 
+    /**
+     * Filters the template locations to template files being searched for.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param array $value  Array of all template locations registered so far.
+     * @param array $stacks Array of template locations.
+     */
     return apply_filters( 'bp_add_template_stack_locations', array_unique( $retval ), $stacks );
 }
@@ -353 +417 @@
     }
 
-    // Allow BuddyPress components to parse the main query
+    /**
+     * Fires at the end of the bp_parse_query function.
+     *
+     * Allow BuddyPress components to parse the main query.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param WP_Query $posts_query WP_Query instance. Passed by reference.
+     */
     do_action_ref_array( 'bp_parse_query', array( &$posts_query ) );
 }
@@ -374 +446 @@
 function bp_template_include_theme_supports( $template = '' ) {
 
-    // Look for root BuddyPress template files in parent/child themes
+    /**
+     * Filters whether or not to override the template being loaded in parent/child themes.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param bool   $value    Whether or not there is a file override. Default false.
+     * @param string $template The path to the template file that is being used.
+     */
     $new_template = apply_filters( 'bp_get_root_template', false, $template );
 
@@ -383 +462 @@
     }
 
+    /**
+     * Filters the final template being loaded in parent/child themes.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $template The path to the template file that is being used.
+     */
     return apply_filters( 'bp_template_include_theme_supports', $template );
 }