Changeset 13524

Timestamp:

07/24/2023 10:27:28 AM (3 years ago)

Author:

imath

Message:

Improve the BP Rewrites API support of the Group Extension

The BP_Group_Extension::init() $args parameter (array) now accepts a new argument: $show_tab_callback. You can use this argument to inform about the callback function to use to check whether the Extension group's tab should be displayed or not. This callback function is called inside the BP_Group_Extension::setup_access_settings() to make sure to set the $show_tab argument once the current group has been defined by BuddyPress.

Third party plugin authors are strongly encouraged to use this new argument if they used to define the $show_tab argument according to the result of a function. Doing so in BuddyPress 12.0.0 won't make your extension behave as expected.

Fixes #8943
Closes ​https://github.com/buddypress/buddypress/pull/136

File:

• trunk/src/bp-groups/classes/class-bp-group-extension.php (modified) (5 diffs)

trunk/src/bp-groups/classes/class-bp-group-extension.php

@@ -197 +197 @@
 
         /**
-         * List of Group access levels.
-         *
-         * @since 12.0.0
-         * @var string[]
-         */
-        public $access_levels = array( 'noone', 'admin', 'mod', 'member', 'loggedin', 'anyone' );
-
-        /**
          * Whether the current user can visit the tab.
          *
@@ -514 +506 @@
          *                                           `array( 'mod', 'admin' )`. Defaults to 'anyone' for public groups
          *                                           and 'member' for private groups.
+         *    @type string|array  $show_tab_callback The function to execute to set the $show_tab argument.
          * }
          */
@@ -545 +538 @@
                                 'access'            => null,
                                 'show_tab'          => null,
+                                'show_tab_callback' => '',
                         )
                 );
 
-                $show_tab = $this->params['show_tab'];
-                if ( $show_tab && ! in_array( $show_tab, $this->access_levels, true ) && is_callable( $show_tab ) ) {
-                        $this->show_tab_callback = $show_tab;
-
-                        // Group Admin can always see.
-                        $this->params['show_tab'] = 'admin';
+                if ( $this->params['show_tab_callback'] && is_callable( $this->params['show_tab_callback'] ) ) {
+                        $this->show_tab_callback = $this->params['show_tab_callback'];
                 }
 
@@ -867 +857 @@
                 $this->user_can_see_nav_item = false;
 
+                // Use the provided callback to show or hide the Group extension tab.
+                if ( $this->show_tab_callback ) {
+                        $this->params['show_tab'] = call_user_func_array( $this->show_tab_callback, array( $this->group_id ) );
+                }
+
                 /*
                  * Backward compatibility for components that do not provide
-                 * explicit 'show_tab' parameter.
+                 * explicit 'show_tab_callback' or 'show_tab' parameters.
                  */
                 if ( empty( $this->params['show_tab'] ) ) {
@@ -1110 +1105 @@
                 if ( ( 'noone' !== $this->params['show_tab'] ) && bp_current_user_can( 'bp_moderate' ) ) {
                         return true;
-                }
-
-                if ( $this->show_tab_callback ) {
-                        return call_user_func( $this->show_tab_callback );
                 }