Changeset 13442 for trunk/src/bp-core/classes/class-bp-component.php

Timestamp:

03/27/2023 06:19:06 PM (4 years ago)

Author:

imath

Message:

Improve Components Member's single item navigation generation

• Edit the BP_Component Class so that it globalize navigation items before registering it.
• Introduce bp_get_component_navigations(), a new function that will be used to get Member's single navigation customizable slugs within the BuddyPress settings area.
• Perform all remaining bp_loggedin_user_domain() replacements (55) in favor of the bp_loggedin_user_url() function which uses BP Rewrites to build URLs.
• Improve bp_loggedin_user_link() by adding a new $chunks array of arguments to output escaped URL in templates.
• Adapt some PHPUnit testcases.

Props r-a-y, johnjamesjacoby, boonebgorges

Closes ​https://github.com/buddypress/buddypress/pull/78
See #4954

File:

• trunk/src/bp-core/classes/class-bp-component.php (modified) (4 diffs)

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

@@ -187 +187 @@
          */
         public $directory_title = '';
+
+        /**
+         * Component's main nav items.
+         *
+         * @since 12.0.0
+         * @var array
+         */
+        public $main_nav = array();
+
+        /**
+         * Component's main nav sub items.
+         *
+         * @since 12.0.0
+         * @var array
+         */
+        public $sub_nav  = array();
 
         /** Methods ***************************************************************/
@@ -529 +545 @@
 
                 // Setup navigation.
-                add_action( 'bp_setup_nav',              array( $this, 'setup_nav'              ), 10 );
+                add_action( 'bp_setup_nav',              array( $this, 'setup_nav'              ),  9 );
+
+                // Generate navigation.
+                add_action( 'bp_setup_nav',              array( $this, 'generate_nav'           ), 10, 0 );
 
                 // Setup WP Toolbar menus.
@@ -598 +617 @@
          *
          * @since 1.5.0
-         *
-         * @see bp_core_new_nav_item() For a description of the $main_nav
-         *      parameter formatting.
-         * @see bp_core_new_subnav_item() For a description of how each item
-         *      in the $sub_nav parameter array should be formatted.
+         * @since 12.0.0 Uses `BP_Component::$main_nav` && `BP_Component::$sub_nav` to globalize nav items.
          *
          * @param array $main_nav Optional. Passed directly to bp_core_new_nav_item().
@@ -611 +626 @@
          */
         public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
-
+                if ( isset( $main_nav['slug'] ) ) {
+                        // Always set the component ID.
+                        $this->main_nav['component_id'] = $this->id;
+
+                        if ( ! isset( $main_nav['rewrite_id'] ) ) {
+                                $this->main_nav['rewrite_id'] = 'bp_member_' . str_replace( '-', '_', $main_nav['slug'] );
+                        } elseif ( ! $main_nav['rewrite_id'] ) {
+                                unset( $main_nav['rewrite_id'] );
+                        }
+
+                        $this->main_nav = array_merge( $this->main_nav, $main_nav );
+
+                        // Sub nav items are not required.
+                        if ( ! empty( $sub_nav ) ) {
+                                foreach( (array) $sub_nav as $nav ) {
+                                        if ( ! isset( $nav['slug'], $nav['parent_slug'] ) ) {
+                                                continue;
+                                        }
+
+                                        if ( ! isset( $nav['rewrite_id'] ) ) {
+                                                $nav['rewrite_id'] = 'bp_member_' . str_replace( '-', '_', $nav['parent_slug'] ) . '_' . str_replace( '-', '_', $nav['slug'] );
+                                        } elseif ( ! $nav['rewrite_id'] ) {
+                                                unset( $nav['rewrite_id'] );
+                                        }
+
+                                        $this->sub_nav[] = $nav;
+                                }
+                        }
+                }
+        }
+
+        /**
+         * Generate component navigation using the nav/subnav set up in `BP_Component::setup_nav()`.
+         *
+         * @since 12.0.0
+         *
+         * @see bp_core_new_nav_item() For a description of the $main_nav
+         *      parameter formatting.
+         * @see bp_core_new_subnav_item() For a description of how each item
+         *      in the $sub_nav parameter array should be formatted.
+         */
+        public function generate_nav() {
                 // 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' );
+                if ( $this->main_nav ) {
+                        bp_core_new_nav_item( $this->main_nav, 'members' );
 
                         // Sub nav items are not required.
-                        if ( !empty( $sub_nav ) ) {
-                                foreach( (array) $sub_nav as $nav ) {
+                        if ( $this->sub_nav ) {
+                                foreach( (array) $this->sub_nav as $nav ) {
                                         bp_core_new_subnav_item( $nav, 'members' );
                                 }