Changeset 12288

Timestamp:

11/15/2018 08:14:01 PM (6 years ago)

Author:

boonebgorges

Message:

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 #7935.

Location:

trunk/src/bp-core

Files:

• bp-core-buddybar.php (modified) (8 diffs)
• classes/class-bp-component.php (modified) (1 diff)

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

@@ -18 +18 @@
  * @since 1.1.0
  * @since 2.6.0 Introduced the `$component` parameter.
+ * @since 4.0.0 Introduced the `$component_id` argument.
  *
  * @param array|string $args {
@@ -23 +24 @@
  *     @type string      $name                    Display name for the nav item.
  *     @type string      $slug                    Unique URL slug for the nav item.
+ *     @type string      $component_id            Optional. The ID of the component registering the nav item. Defaults to slug.
  *     @type bool|string $item_css_id             Optional. 'id' attribute for the nav item. Default: the value of `$slug`.
  *     @type bool        $show_for_displayed_user Optional. Whether the nav item should be visible when viewing a
@@ -45 +47 @@
         'name'                    => false, // Display name for the nav item.
         'slug'                    => false, // URL slug for the nav item.
+        'component_id'            => '',    // ID of the component registering the nav item.
         'item_css_id'             => false, // The CSS ID to apply to the HTML of the nav item.
         'show_for_displayed_user' => true,  // When viewing another user does this nav item show up?
@@ -91 +94 @@
  *
  * @since 2.4.0
- * @since 2.6.0 Introduced the `$component` parameter. Began returning a BP_Core_Nav_Item object on success.
+ * @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.
  *
  * @param array|string $args {
  *     Array describing the new nav item.
+ *     @type string      $component_id            Optional. The ID of the component registering this nav item. Defaults to the
+ *                                                the value of `$slug`.
  *     @type string      $name                    Display name for the nav item.
  *     @type string      $slug                    Unique URL slug for the nav item.
@@ -115 +122 @@
 
     $defaults = array(
+        'component_id'            => '',    // The component ID registering this nav item.
         'name'                    => false, // Display name for the nav item.
         'slug'                    => false, // URL slug for the nav item.
@@ -137 +145 @@
     }
 
+    if ( empty( $r['component_id'] ) ) {
+        $r['component_id'] = $r['slug'];
+    }
+
     if ( empty( $r['item_css_id'] ) ) {
         $r['item_css_id'] = $r['slug'];
@@ -142 +154 @@
 
     $nav_item = array(
+        'component_id'            => $r['component_id'],
         'name'                    => $r['name'],
         'slug'                    => $r['slug'],
@@ -343 +356 @@
         if ( empty( $unfiltered_action ) ) {
             if ( ! bp_is_current_action( $r['subnav_slug'] ) ) {
+                /*
+                 * 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;
+                    }
+                }
+
                 if ( is_callable( $r['screen_function'] ) ) {
                     add_action( 'bp_screens', $r['screen_function'], 3 );

trunk/src/bp-core/classes/class-bp-component.php

@@ -499 +499 @@
         // No sub nav items without a main nav item.
         if ( !empty( $main_nav ) ) {
+            // Always set the component ID.
+            $main_nav['component_id'] = $this->id;
+
             bp_core_new_nav_item( $main_nav, 'members' );