<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][12726] trunk: Pass extra args to template loading files.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/12726">12726</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12726","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-09-19 18:19:45 +0000 (Sat, 19 Sep 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/8350">#8350</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoretemplateloaderphp">trunk/src/bp-core/bp-core-template-loader.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/assets/templates/</li>
<li><a href="#trunktestsphpunitassetstemplatesindexphp">trunk/tests/phpunit/assets/templates/index.php</a></li>
<li><a href="#trunktestsphpunittestcasescoretemplateLoaderphp">trunk/tests/phpunit/testcases/core/templateLoader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoretemplateloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-template-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-template-loader.php 2020-09-18 20:58:20 UTC (rev 12725)
+++ trunk/src/bp-core/bp-core-template-loader.php 2020-09-19 18:19:45 UTC (rev 12726)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,14 +18,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get a BuddyPress template part for display in a theme.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $args parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug Template part slug. Used to generate filenames,
</span><span class="cx" style="display: block; padding: 0 10px"> * eg 'friends' for 'friends.php'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $name Optional. Template part name. Used to generate
</span><span class="cx" style="display: block; padding: 0 10px"> * secondary filenames, eg 'personal' for 'activity-personal.php'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Extra args to pass to locate_template().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return false|string Path to located template. See {@link bp_locate_template()}.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_get_template_part( $slug, $name = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_get_template_part( $slug, $name = null, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires at the start of bp_get_template_part().
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,11 +35,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This is a variable hook that is dependent on the slug passed in.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $args parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug Template part slug requested.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Template part name requested.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Extra args to pass to locate_template().
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'get_template_part_' . $slug, $slug, $name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'get_template_part_' . $slug, $slug, $name, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Setup possible parts.
</span><span class="cx" style="display: block; padding: 0 10px"> $templates = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,15 +54,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the template parts to be loaded.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $args parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $templates Array of templates located.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug Template part slug requested.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Template part name requested.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Extra args to pass to locate_template().
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $templates = apply_filters( 'bp_get_template_part', $templates, $slug, $name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $templates = apply_filters( 'bp_get_template_part', $templates, $slug, $name, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Return the part that is found.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return bp_locate_template( $templates, true, false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_locate_template( $templates, true, false, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,15 +74,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * prepended to the slug.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $args parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see bp_get_template_part() for full documentation.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug Template slug.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $name Template name.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Extra args to pass to locate_template().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return false|string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_get_asset_template_part( $slug, $name = null ) {
- return bp_get_template_part( "assets/{$slug}", $name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_get_asset_template_part( $slug, $name = null, $args = array() ) {
+ return bp_get_template_part( "assets/{$slug}", $name, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,6 +95,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * not found in either of those, it looks in the theme-compat folder last.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $args parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $template_names Template file(s) to search for, in order.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $load Optional. If true, the template file will be loaded when
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,9 +102,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * found. If false, the path will be returned. Default: false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $require_once Optional. Whether to require_once or require. Has
</span><span class="cx" style="display: block; padding: 0 10px"> * no effect if $load is false. Default: true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Extra args to pass to locate_template().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The template filename if one is located.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_locate_template( $template_names, $load = false, $require_once = true ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_locate_template( $template_names, $load = false, $require_once = true, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Bail when there are no templates to locate.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $template_names ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,7 +150,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If you want to override a specific template part, please either filter
</span><span class="cx" style="display: block; padding: 0 10px"> * 'bp_get_template_part' or add a new location to the template stack.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'bp_locate_template', $located, $template_name, $template_names, $template_locations, $load, $require_once );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( 'bp_locate_template', $located, $template_name, $template_names, $template_locations, $load, $require_once, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter here to allow/disallow template loading.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,7 +162,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $load_template = (bool) apply_filters( 'bp_locate_template_and_load', true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $load_template && $load && ! empty( $located ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- load_template( $located, $require_once );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ load_template( $located, $require_once, $args );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $located;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -320,22 +330,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Put a template part into an output buffer, and return it.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Added $args parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see bp_get_template_part() for a description of $slug and $name params.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see bp_get_template_part() for a description of $slug, $name and $args params.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $slug See {@link bp_get_template_part()}.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $name See {@link bp_get_template_part()}.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $echo If true, template content will be echoed. If false,
</span><span class="cx" style="display: block; padding: 0 10px"> * returned. Default: true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args See {@link bp_get_template_part()}.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|null If $echo, returns the template content.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function bp_buffer_template_part( $slug, $name = null, $echo = true ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function bp_buffer_template_part( $slug, $name = null, $echo = true, $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove 'bp_replace_the_content' filter to prevent infinite loops.
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'the_content', 'bp_replace_the_content' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_get_template_part( $slug, $name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_get_template_part( $slug, $name, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove 'bp_replace_the_content' filter to prevent infinite loops.
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_content', 'bp_replace_the_content' );
</span></span></pre></div>
<a id="trunktestsphpunitassetstemplatesindexphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/assets/templates/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/assets/templates/index.php (rev 0)
+++ trunk/tests/phpunit/assets/templates/index.php 2020-09-19 18:19:45 UTC (rev 12726)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,2 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+echo (int) $args['test'] + 1;
</ins></span></pre></div>
<a id="trunktestsphpunittestcasescoretemplateLoaderphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/core/templateLoader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/templateLoader.php (rev 0)
+++ trunk/tests/phpunit/testcases/core/templateLoader.php 2020-09-19 18:19:45 UTC (rev 12726)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,42 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group core
+ * @group core-template-loader
+ */
+class BP_Tests_Template_Loader_Functions extends BP_UnitTestCase {
+
+ public function setUp() {
+ if ( version_compare( bp_get_major_wp_version(), '5.5', '<' ) ) {
+ $this->markTestSkipped(
+ 'Passing variables in template parts was introduced in WordPress 5.5'
+ );
+ }
+
+ add_filter( 'bp_get_template_stack', array( $this, 'template_stack'), 10, 1 );
+
+ parent::setUp();
+ }
+
+ public function tearDown() {
+ remove_filter( 'bp_get_template_stack', array( $this, 'template_stack'), 10, 1 );
+
+ parent::tearDown();
+ }
+
+ public function template_stack( $stack = array() ) {
+ return array_merge(
+ array(
+ dirname( dirname( dirname( __FILE__ ) ) ) . '/assets/templates/',
+ )
+ );
+ }
+
+ /**
+ * @group bp_buffer_template_part
+ */
+ public function test_bp_buffer_template_part() {
+ $buffer = bp_buffer_template_part( 'index', null, false, array( 'test' => 1 ) );
+ $this->assertTrue( 2 === (int) $buffer );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>