Changeset 13123

Timestamp:

10/09/2021 06:10:51 PM (5 years ago)

Author:

imath

Message:

Admin: improve information about WP pages being used as BP directories

We are now using BuddyPress specific post states to inform a WordPress page is used as the BP Component's directory page. This information is displayed into the WP Admin Pages edit screen, for menu items linking to a BP Directory into the WP Admin Menu screen as well as into the Customizer Menu section.

Fixes #8470

Location:

trunk/src

Files:

• bp-activity/classes/class-bp-activity-component.php (modified) (1 diff)
• bp-blogs/classes/class-bp-blogs-component.php (modified) (1 diff)
• bp-core/admin/bp-core-admin-actions.php (modified) (2 diffs)
• bp-core/classes/class-bp-component.php (modified) (2 diffs)
• bp-groups/classes/class-bp-groups-component.php (modified) (1 diff)
• bp-members/classes/class-bp-members-component.php (modified) (1 diff)

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

@@ -547 +547 @@
                 parent::blocks_init( $blocks );
         }
+
+        /**
+         * Add the Activity directory state.
+         *
+         * @since 10.0.0
+         *
+         * @param array   $states Optional. See BP_Component::admin_directory_states() for description.
+         * @param WP_Post $post   Optional. See BP_Component::admin_directory_states() for description.
+         * @return array          See BP_Component::admin_directory_states() for description.
+         */
+        public function admin_directory_states( $states = array(), $post = null ) {
+                $bp = buddypress();
+
+                if ( isset( $bp->pages->activity->id ) && (int) $bp->pages->activity->id === (int) $post->ID ) {
+                        $states['page_for_activity_directory'] = _x( 'BP Activity Page', 'page label', 'buddypress' );
+                }
+
+                return parent::admin_directory_states( $states, $post );
+        }
 }

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

@@ -433 +433 @@
                 parent::blocks_init( $blocks );
         }
+
+        /**
+         * Add the Sites directory states.
+         *
+         * @since 10.0.0
+         *
+         * @param array   $states Optional. See BP_Component::admin_directory_states() for description.
+         * @param WP_Post $post   Optional. See BP_Component::admin_directory_states() for description.
+         * @return array          See BP_Component::admin_directory_states() for description.
+         */
+        public function admin_directory_states( $states = array(), $post = null ) {
+                $bp = buddypress();
+
+                if ( isset( $bp->pages->blogs->id ) && (int) $bp->pages->blogs->id === (int) $post->ID ) {
+                        $states['page_for_sites_directory'] = _x( 'BP Sites Page', 'page label', 'buddypress' );
+                }
+
+                return parent::admin_directory_states( $states, $post );
+        }
 }

trunk/src/bp-core/admin/bp-core-admin-actions.php

@@ -60 +60 @@
 add_action( 'bp_admin_menu', 'bp_admin_separator' );
 
+// Add a filter to include BP Components directory pages display states.
+add_filter( 'display_post_states', 'bp_admin_display_directory_states', 10, 2 );
+
 /**
  * When a new site is created in a multisite installation, run the activation
@@ -235 +238 @@
         do_action( 'bp_register_admin_settings' );
 }
+
+/**
+ * Dedicated filter to inform about BP components directory page states.
+ *
+ * @since 10.0.0
+ *
+ * @param string[] $post_states An array of post display states.
+ * @param WP_Post  $post        The current post object.
+ */
+function bp_admin_display_directory_states( $post_states = array(), $post = null ) {
+        /**
+         * Filter here to add BP Directory pages.
+         *
+         * Used internaly by BP_Component->admin_directory_states(). Please use the dynamic
+         * filter in BP_Component->admin_directory_states() to edit the directory state
+         * according to the component's ID.
+         *
+         * @since 10.0.0
+         *
+         * @param array    $value An empty array.
+         * @param WP_Post  $post  The current post object.
+         */
+        $directory_page_states = apply_filters( 'bp_admin_display_directory_states', array(), $post );
+
+        if ( $directory_page_states ) {
+                $post_states = array_merge( $post_states, $directory_page_states );
+        }
+
+        return $post_states;
+}

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

@@ -510 +510 @@
                 }
 
+                // Set directory page states.
+                add_filter( 'bp_admin_display_directory_states', array( $this, 'admin_directory_states' ), 10, 2 );
+
                 /**
                  * Fires at the end of the setup_actions method inside BP_Component.
@@ -988 +991 @@
                 do_action( 'bp_' . $this->id . '_blocks_init' );
         }
+
+        /**
+         * Add component's directory states.
+         *
+         * @since 10.0.0
+         *
+         * @param string[] $states An array of post display states.
+         * @param WP_Post  $post   The current post object.
+         * @return array           The component's directory states.
+         */
+        public function admin_directory_states( $states = array(), $post = null ) {
+                if ( $this->has_directory ) {
+                        /**
+                         * Filter here to edit the component's directory states.
+                         *
+                         * This is a dynamic hook that is based on the component string ID.
+                         *
+                         * @since 10.0.0
+                         *
+                         * @param string[] $states An array of post display states.
+                         */
+                        return apply_filters( 'bp_' . $this->id . '_admin_directory_states', $states );
+                }
+
+                return $states;
+        }
 }
 endif; // BP_Component.

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

@@ -1135 +1135 @@
                 );
         }
+
+        /**
+         * Add the Groups directory states.
+         *
+         * @since 10.0.0
+         *
+         * @param array   $states Optional. See BP_Component::admin_directory_states() for description.
+         * @param WP_Post $post   Optional. See BP_Component::admin_directory_states() for description.
+         * @return array          See BP_Component::admin_directory_states() for description.
+         */
+        public function admin_directory_states( $states = array(), $post = null ) {
+                $bp = buddypress();
+
+                if ( isset( $bp->pages->groups->id ) && (int) $bp->pages->groups->id === (int) $post->ID ) {
+                        $states['page_for_groups_directory'] = _x( 'BP Groups Page', 'page label', 'buddypress' );
+                }
+
+                return parent::admin_directory_states( $states, $post );
+        }
 }

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

@@ -938 +938 @@
                 );
         }
+
+        /**
+         * Add the Members directory states.
+         *
+         * @since 10.0.0
+         *
+         * @param array   $states Optional. See BP_Component::admin_directory_states() for description.
+         * @param WP_Post $post   Optional. See BP_Component::admin_directory_states() for description.
+         * @return array          See BP_Component::admin_directory_states() for description.
+         */
+        public function admin_directory_states( $states = array(), $post = null ) {
+                $bp = buddypress();
+
+                if ( isset( $bp->pages->members->id ) && (int) $bp->pages->members->id === (int) $post->ID ) {
+                        $states['page_for_members_directory'] = _x( 'BP Members Page', 'page label', 'buddypress' );
+                }
+
+                if ( bp_get_signup_allowed() || bp_get_members_invitations_allowed() ) {
+                        if ( isset( $bp->pages->register->id ) && (int) $bp->pages->register->id === (int) $post->ID ) {
+                                $states['page_for_bp_registration'] = _x( 'BP Registration Page', 'page label', 'buddypress' );
+                        }
+
+                        if ( isset( $bp->pages->activate->id ) && (int) $bp->pages->activate->id === (int) $post->ID ) {
+                                $states['page_for_bp_activation'] = _x( 'BP Activation Page', 'page label', 'buddypress' );
+                        }
+                }
+
+                return parent::admin_directory_states( $states, $post );
+        }
 }