Changeset 9322

Timestamp:

01/09/2015 12:39:36 AM (10 years ago)

Author:

r-a-y

Message:

Properly highlight BuddyPress pages in a WordPress nav or page menu.

r8932 attempted to address how BuddyPress pages are highlighted in a
WordPress menu after the refactoring of bp_core_load_template() (see
r8821). r8932 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 #5997.

Location:

trunk/src/bp-core

Files:

• bp-core-catchuri.php (modified) (2 diffs)
• bp-core-filters.php (modified) (1 diff)

trunk/src/bp-core/bp-core-catchuri.php

@@ -343 +343 @@
     global $wp_query;
 
-    // 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(
+    // Reset the post
+    bp_theme_compat_reset_post( array(
+        'ID'          => 0,
         'is_404'      => true,
         'post_status' => 'publish',
-    );
-
-    // 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 );
+    ) );
 
     // Set theme compat to false since the reset post function automatically sets
@@ -394 +372 @@
     $located_template = apply_filters( 'bp_located_template', $template, $filtered_templates );
     if ( !empty( $located_template ) ) {
-
         // Template was located, lets set this as a valid page and not a 404.
         status_header( 200 );

trunk/src/bp-core/bp-core-filters.php

@@ -139 +139 @@
 }
 add_filter( 'nav_menu_meta_box_object', 'bp_core_exclude_pages_from_nav_menu_admin', 11, 1 );
+
+/**
+ * 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 );
 
 /**