<!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][9322] trunk/src/bp-core: Properly highlight BuddyPress pages in a WordPress nav or page menu.</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/9322">9322</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/9322","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>r-a-y</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-01-09 00:39:36 +0000 (Fri, 09 Jan 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'>Properly highlight BuddyPress pages in a WordPress nav or page menu.
<a href="http://buddypress.trac.wordpress.org/changeset/8932">r8932</a> attempted to address how BuddyPress pages are highlighted in a
WordPress menu after the refactoring of `bp_core_load_template()` (see
<a href="http://buddypress.trac.wordpress.org/changeset/8821">r8821</a>). <a href="http://buddypress.trac.wordpress.org/changeset/8932">r8932</a> resulted in declaring the BuddyPress parent page as the
current page even when it wasn't.
This commit removes this declaration and changes the highlighting method
to rely on the WP nav and page menu filters. This also fixes issues
with highlighting the BP parent page when the root profiles feature is
enabled (this previously did not work).
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5997">#5997</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorecatchuriphp">trunk/src/bp-core/bp-core-catchuri.php</a></li>
<li><a href="#trunksrcbpcorebpcorefiltersphp">trunk/src/bp-core/bp-core-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorecatchuriphp"></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-catchuri.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-catchuri.php 2015-01-09 00:24:15 UTC (rev 9321)
+++ trunk/src/bp-core/bp-core-catchuri.php 2015-01-09 00:39:36 UTC (rev 9322)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -342,35 +342,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_core_load_template( $templates ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_query;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // check if BP page belongs to, or is a child of, a BP directory page
- $page_id = false;
- foreach ( (array) buddypress()->pages as $page ) {
- if ( $page->name == buddypress()->unfiltered_uri[buddypress()->unfiltered_uri_offset] ) {
- $page_id = $page->id;
- break;
- }
- }
-
- // Set up reset post args
- $reset_post_args = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Reset the post
+ bp_theme_compat_reset_post( array(
+ 'ID' => 0,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'is_404' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'publish',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // BP page exists - fill in the $wp_query->post object
- //
- // bp_theme_compat_reset_post() looks at the $wp_query->post object to fill in
- // the post globals
- if ( ! empty( $page_id ) ) {
- $wp_query->post = get_post( $page_id );
- $reset_post_args['ID'] = $page_id;
- } else {
- $reset_post_args['ID'] = 0;
- }
-
- // Reset the post
- bp_theme_compat_reset_post( $reset_post_args );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Set theme compat to false since the reset post function automatically sets
</span><span class="cx" style="display: block; padding: 0 10px"> // theme compat to true
</span><span class="cx" style="display: block; padding: 0 10px"> bp_set_theme_compat_active( false );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -393,7 +371,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Filter the template locations so that plugins can alter where they are located
</span><span class="cx" style="display: block; padding: 0 10px"> $located_template = apply_filters( 'bp_located_template', $template, $filtered_templates );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $located_template ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> // Template was located, lets set this as a valid page and not a 404.
</span><span class="cx" style="display: block; padding: 0 10px"> status_header( 200 );
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->is_page = true;
</span></span></pre></div>
<a id="trunksrcbpcorebpcorefiltersphp"></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-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-filters.php 2015-01-09 00:24:15 UTC (rev 9321)
+++ trunk/src/bp-core/bp-core-filters.php 2015-01-09 00:39:36 UTC (rev 9322)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,6 +140,93 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'nav_menu_meta_box_object', 'bp_core_exclude_pages_from_nav_menu_admin', 11, 1 );
</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">+ * Adds current page CSS classes to the parent BP page in a WP Page Menu.
+ *
+ * Because BuddyPress primarily uses virtual pages, we need a way to highlight
+ * the BP parent page during WP menu generation. This function checks the
+ * current BP component against the current page in the WP menu to see if we
+ * should highlight the WP page.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval CSS classes for the current menu page in the menu
+ * @param WP_Post $page The page properties for the current menu item
+ * @return array
+ */
+function bp_core_menu_highlight_parent_page( $retval, $page ) {
+ if ( ! is_buddypress() ) {
+ return $retval;
+ }
+
+ $page_id = false;
+
+ // loop against all BP component pages
+ foreach ( (array) buddypress()->pages as $component => $bp_page ) {
+ // handles the majority of components
+ if ( bp_is_current_component( $component ) ) {
+ $page_id = (int) $bp_page->id;
+ }
+
+ // stop if not on a user page
+ if ( ! bp_is_user() && ! empty( $page_id ) ) {
+ break;
+ }
+
+ // members component requires an explicit check due to overlapping components
+ if ( bp_is_user() && 'members' === $component ) {
+ $page_id = (int) $bp_page->id;
+ break;
+ }
+ }
+
+ // duplicate some logic from Walker_Page::start_el() to highlight menu items
+ if ( ! empty( $page_id ) ) {
+ $_bp_page = get_post( $page_id );
+ if ( in_array( $page->ID, $_bp_page->ancestors, true ) ) {
+ $retval[] = 'current_page_ancestor';
+ }
+ if ( $page->ID === $page_id ) {
+ $retval[] = 'current_page_item';
+ } elseif ( $_bp_page && $page->ID === $_bp_page->post_parent ) {
+ $retval[] = 'current_page_parent';
+ }
+ }
+
+ $retval = array_unique( $retval );
+
+ return $retval;
+}
+add_filter( 'page_css_class', 'bp_core_menu_highlight_parent_page', 10, 2 );
+
+/**
+ * Adds current page CSS classes to the parent BP page in a WP Nav Menu.
+ *
+ * When {@link wp_nav_menu()} is used, this function helps to highlight the
+ * current BP parent page during nav menu generation.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval CSS classes for the current nav menu item in the menu
+ * @param WP_Post $item The properties for the current nav menu item
+ * @return array
+ */
+function bp_core_menu_highlight_nav_menu_item( $retval, $item ) {
+ // If we're not on a BP page or if the current nav item is not a page, stop!
+ if ( ! is_buddypress() || 'page' !== $item->object ) {
+ return $retval;
+ }
+
+ // get the WP page
+ $page = get_post( $item->object_id );
+
+ // see if we should add our highlight CSS classes for the page
+ $retval = bp_core_menu_highlight_parent_page( $retval, $page );
+
+ return $retval;
+}
+add_filter( 'nav_menu_css_class', 'bp_core_menu_highlight_nav_menu_item', 10, 2 );
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Set "From" name in outgoing email to the site name.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses bp_get_option() fetches the value for a meta_key in the wp_X_options table.
</span></span></pre>
</div>
</div>
</body>
</html>