<!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][9595] trunk/src/bp-core/bp-core-template-loader.php: Adds hooks documentation for bp-core-template-loader.php.</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 { 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/9595">9595</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/9595","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-03-05 04:55:12 +0000 (Thu, 05 Mar 2015)</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'>Adds hooks documentation for bp-core-template-loader.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5940">#5940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoretemplateloaderphp">trunk/src/bp-core/bp-core-template-loader.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 2015-03-05 04:48:11 UTC (rev 9594)
+++ trunk/src/bp-core/bp-core-template-loader.php 2015-03-05 04:55:12 UTC (rev 9595)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,6 +32,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_template_part( $slug, $name = null ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Execute code for this part
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'get_template_part_' . $slug, $slug, $name );
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,6 +52,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $templates[] = $slug . '.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Allow template parts to be filtered
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $templates = apply_filters( 'bp_get_template_part', $templates, $slug, $name );
</span><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -215,6 +234,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove empties and duplicates
</span><span class="cx" style="display: block; padding: 0 10px"> $stack = array_unique( array_filter( $stack ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return (array) apply_filters( 'bp_get_template_stack', $stack ) ;
</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">@@ -278,20 +304,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $templates = array( "{$type}.php" );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Filter possible templates, try to match one, and set any BuddyPress theme
</span><span class="cx" style="display: block; padding: 0 10px"> // compat properties so they can be cross-checked later.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $templates = apply_filters( "bp_get_{$type}_template", $templates );
</del><span class="cx" style="display: block; padding: 0 10px"> $templates = bp_set_theme_compat_templates( $templates );
</span><span class="cx" style="display: block; padding: 0 10px"> $template = bp_locate_template( $templates );
</span><span class="cx" style="display: block; padding: 0 10px"> $template = bp_set_theme_compat_template( $template );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( "bp_{$type}_template", $template );
</span><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="cx" style="display: block; padding: 0 10px"> * Get the possible subdirectories to check for templates in
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since BuddyPress (1.7)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since BuddyPress (1.7.0)
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $templates Templates we are looking for
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Possible subfolders to look in
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -301,6 +348,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'community',
</span><span class="cx" style="display: block; padding: 0 10px"> ''
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_get_template_locations', $locations, $templates );
</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">@@ -325,6 +381,14 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_add_template_stack_locations', array_unique( $retval ), $stacks );
</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">@@ -352,7 +416,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allow BuddyPress components to parse the main query
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_parse_query', array( &$posts_query ) );
</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">@@ -373,7 +445,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_template_include_theme_supports( $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">- // Look for root BuddyPress template files in parent/child themes
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_template = apply_filters( 'bp_get_root_template', false, $template );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // A BuddyPress template file was located, so override the WordPress
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,6 +461,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $template = bp_set_template_included( $new_template );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_template_include_theme_supports', $template );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>