Changeset 12726

Timestamp:

09/19/2020 06:19:45 PM (4 years ago)

Author:

dcavins

Message:

Pass extra args to template loading files.

Starting in WordPress 5.5, the template loading
functions will now allow additional arguments to be
passed through to the matched template file using a
new $args parameter.

This changeset passes an extra argument through
the BuddyPress template loading wrapper functions
to the underlying WordPress functions.

Props imath.

Fixes #8350.

Location:

trunk

Files:

• src/bp-core/bp-core-template-loader.php (modified) (13 diffs)
• tests/phpunit/assets/templates (added)
• tests/phpunit/assets/templates/index.php (added)
• tests/phpunit/testcases/core/templateLoader.php (added)

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

@@ -19 +19 @@
  *
  * @since 1.7.0
+ * @since 7.0.0 Added $args parameter.
  *
  * @param string      $slug Template part slug. Used to generate filenames,
@@ -24 +25 @@
  * @param string|null $name Optional. Template part name. Used to generate
  *                          secondary filenames, eg 'personal' for 'activity-personal.php'.
+ * @param array       $args Optional. Extra args to pass to locate_template().
  * @return false|string Path to located template. See {@link bp_locate_template()}.
  */
-function bp_get_template_part( $slug, $name = null ) {
+function bp_get_template_part( $slug, $name = null, $args = array() ) {
 
     /**
@@ -34 +36 @@
      *
      * @since 1.7.0
+     * @since 7.0.0 Added $args parameter.
      *
      * @param string $slug Template part slug requested.
      * @param string $name Template part name requested.
-     */
-    do_action( 'get_template_part_' . $slug, $slug, $name );
+     * @param array  $args Extra args to pass to locate_template().
+     */
+    do_action( 'get_template_part_' . $slug, $slug, $name, $args );
 
     // Setup possible parts.
@@ -51 +55 @@
      *
      * @since 1.7.0
+     * @since 7.0.0 Added $args parameter.
      *
      * @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 );
+     * @param array  $args      Extra args to pass to locate_template().
+     */
+    $templates = apply_filters( 'bp_get_template_part', $templates, $slug, $name, $args );
 
     // Return the part that is found.
-    return bp_locate_template( $templates, true, false );
+    return bp_locate_template( $templates, true, false, $args );
 }
 
@@ -69 +75 @@
  *
  * @since 2.6.0
+ * @since 7.0.0 Added $args parameter.
  *
  * @see bp_get_template_part() for full documentation.
@@ -74 +81 @@
  * @param string      $slug Template slug.
  * @param string|null $name Template name.
+ * @param array       $args Optional. Extra args to pass to locate_template().
  * @return false|string
  */
-function bp_get_asset_template_part( $slug, $name = null ) {
-    return bp_get_template_part( "assets/{$slug}", $name );
+function bp_get_asset_template_part( $slug, $name = null, $args = array() ) {
+    return bp_get_template_part( "assets/{$slug}", $name, $args );
 }
 
@@ -88 +96 @@
  *
  * @since 1.7.0
+ * @since 7.0.0 Added $args parameter.
  *
  * @param string|array $template_names Template file(s) to search for, in order.
@@ -94 +103 @@
  * @param bool         $require_once   Optional. Whether to require_once or require. Has
  *                                     no effect if $load is false. Default: true.
+ * @param array        $args           Optional. Extra args to pass to locate_template().
  * @return string The template filename if one is located.
  */
-function bp_locate_template( $template_names, $load = false, $require_once = true ) {
+function bp_locate_template( $template_names, $load = false, $require_once = true, $args = array() ) {
 
     // Bail when there are no templates to locate.
@@ -141 +151 @@
      * 'bp_get_template_part' or add a new location to the template stack.
      */
-    do_action( 'bp_locate_template', $located, $template_name, $template_names, $template_locations, $load, $require_once );
+    do_action( 'bp_locate_template', $located, $template_name, $template_names, $template_locations, $load, $require_once, $args );
 
     /**
@@ -153 +163 @@
 
     if ( $load_template && $load && ! empty( $located ) ) {
-        load_template( $located, $require_once );
+        load_template( $located, $require_once, $args );
     }
 
@@ -321 +331 @@
  *
  * @since 1.7.0
- *
- * @see bp_get_template_part() for a description of $slug and $name params.
+ * @since 7.0.0 Added $args parameter.
+ *
+ * @see bp_get_template_part() for a description of $slug, $name and $args params.
  *
  * @param string      $slug See {@link bp_get_template_part()}.
@@ -328 +339 @@
  * @param bool        $echo If true, template content will be echoed. If false,
  *                          returned. Default: true.
+ * @param array       $args See {@link bp_get_template_part()}.
  * @return string|null If $echo, returns the template content.
  */
-function bp_buffer_template_part( $slug, $name = null, $echo = true ) {
+function bp_buffer_template_part( $slug, $name = null, $echo = true, $args = array() ) {
     ob_start();
 
@@ -336 +348 @@
     remove_filter( 'the_content', 'bp_replace_the_content' );
 
-    bp_get_template_part( $slug, $name );
+    bp_get_template_part( $slug, $name, $args );
 
     // Remove 'bp_replace_the_content' filter to prevent infinite loops.