<!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][12288] trunk/src/bp-core: Nav: Dynamically load component screen file when changing nav default.</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/12288">12288</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/12288","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-11-15 20:14:01 +0000 (Thu, 15 Nov 2018)</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'>Nav: Dynamically load component screen file when changing nav default.
BP 3.0.0 moved most screen controllers into files that are loaded only when
viewing the component. This introduced a regression into
`bp_core_new_nav_default()`, since the `screen_function` would not be available
(ie `! is_callable()`) at the time that the nav item is modified.
We resolve this by loading the component's screen functions in
`bp_core_new_nav_default()` when we detect that they're not present. To work
around cases where component slugs don't match the official component ID,
which corresponds to the file path, we introduce a new 'component_id' parameter
to be used when registering a new nav item.
Props imath, r-a-y.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7935">#7935</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorebuddybarphp">trunk/src/bp-core/bp-core-buddybar.php</a></li>
<li><a href="#trunksrcbpcoreclassesclassbpcomponentphp">trunk/src/bp-core/classes/class-bp-component.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorebuddybarphp"></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-buddybar.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-buddybar.php 2018-11-15 19:20:57 UTC (rev 12287)
+++ trunk/src/bp-core/bp-core-buddybar.php 2018-11-15 20:14:01 UTC (rev 12288)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,11 +17,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0 Introduced the `$component` parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.0.0 Introduced the `$component_id` argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array describing the new nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $name Display name for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $slug Unique URL slug for the nav item.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $component_id Optional. The ID of the component registering the nav item. Defaults to slug.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool|string $item_css_id Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $show_for_displayed_user Optional. Whether the nav item should be visible when viewing a
</span><span class="cx" style="display: block; padding: 0 10px"> * member profile other than your own. Default: true.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,6 +46,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => false, // Display name for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> 'slug' => false, // URL slug for the nav item.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'component_id' => '', // ID of the component registering the nav item.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'item_css_id' => false, // The CSS ID to apply to the HTML of the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_for_displayed_user' => true, // When viewing another user does this nav item show up?
</span><span class="cx" style="display: block; padding: 0 10px"> 'site_admin_only' => false, // Can only site admins see this nav item?
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,10 +93,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a link to the main BuddyPress navigation.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.4.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.6.0 Introduced the `$component` parameter. Began returning a BP_Core_Nav_Item object on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.6.0 Introduced the `$component` parameter. Began returning a BP_Core_Nav_Item
+ * object on success.
+ * @since 4.0.0 Introduced `$component_id` argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array describing the new nav item.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $component_id Optional. The ID of the component registering this nav item. Defaults to the
+ * the value of `$slug`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $name Display name for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $slug Unique URL slug for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool|string $item_css_id Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,6 +121,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp = buddypress();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'component_id' => '', // The component ID registering this nav item.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'name' => false, // Display name for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> 'slug' => false, // URL slug for the nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> 'item_css_id' => false, // The CSS ID to apply to the HTML of the nav item.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -136,11 +144,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ if ( empty( $r['component_id'] ) ) {
+ $r['component_id'] = $r['slug'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $r['item_css_id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r['item_css_id'] = $r['slug'];
</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"> $nav_item = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'component_id' => $r['component_id'],
</ins><span class="cx" style="display: block; padding: 0 10px"> 'name' => $r['name'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'slug' => $r['slug'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'link' => trailingslashit( bp_loggedin_user_domain() . $r['slug'] ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -342,6 +355,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // No subnav item has been requested in the URL, so set a new nav default.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $unfiltered_action ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! bp_is_current_action( $r['subnav_slug'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * If the screen function isn't available, attempt to find it.
+ *
+ * This is due to our conditional-loading code since v3.0.0.
+ */
+ if ( ! is_callable( $r['screen_function'] ) && ! empty( $parent_nav->component_id ) ) {
+ $file = $bp->core->path . 'bp-' . $parent_nav->component_id . '/screens/' . $r['subnav_slug'] . '.php';
+ $file_path = realpath( $file );
+
+ // Found the file, so require it.
+ if ( $file === $file_path && file_exists( $file ) ) {
+ require_once $file;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_callable( $r['screen_function'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_screens', $r['screen_function'], 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpcoreclassesclassbpcomponentphp"></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/classes/class-bp-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-component.php 2018-11-15 19:20:57 UTC (rev 12287)
+++ trunk/src/bp-core/classes/class-bp-component.php 2018-11-15 20:14:01 UTC (rev 12288)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -498,6 +498,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // No sub nav items without a main nav item.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $main_nav ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Always set the component ID.
+ $main_nav['component_id'] = $this->id;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> bp_core_new_nav_item( $main_nav, 'members' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Sub nav items are not required.
</span></span></pre>
</div>
</div>
</body>
</html>