Changeset 13377

Timestamp:

12/01/2022 05:02:24 AM (23 months ago)

Author:

imath

Message:

Introduce a function to get allowed post stati for BP directory pages

The bp_core_get_directory_pages_stati() function has been introduced to be able to get BP Directory pages having various registered post stati. So far only the publish post status was allowed. Filtering 'bp_core_get_directory_pages_stati', it's now possible to include other registered post stati. This new possibility gives a way to use WorPress Post Status to set custom & more granular user visibilities for components having a directory page.

Closes ​https://github.com/buddypress/buddypress/pull/40
Fixes #8772

File:

• trunk/src/bp-core/bp-core-functions.php (modified) (3 diffs)

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

@@ -665 +665 @@
 
 /**
+ * Get the BP Directory pages allowed stati.
+ *
+ * @since 11.0.0
+ *
+ * @return array The BP Directory pages allowed stati.
+ */
+function bp_core_get_directory_pages_stati() {
+    $default_page_status = array( 'publish' );
+
+    /**
+     * Filter here to edit the allowed BP Directory pages stati.
+     *
+     * @since 11.0.0
+     *
+     * @param array $default_page_status The default allowed BP Directory pages stati.
+     */
+    $page_stati = (array) apply_filters( 'bp_core_get_directory_pages_stati', $default_page_status );
+
+    // Validate the post stati, making sure each status is registered.
+    foreach ( $page_stati as $page_status_key => $page_status ) {
+        if ( ! get_post_status_object( $page_status ) ) {
+            unset( $page_stati[ $page_status_key ] );
+        }
+    }
+
+    if ( ! $page_stati ) {
+        $page_stati = $default_page_status;
+    }
+
+    return $page_stati;
+}
+
+/**
  * Get names and slugs for BuddyPress component directory pages.
  *
@@ -684 +717 @@
         // Get pages and IDs.
         $page_ids = bp_core_get_directory_page_ids();
-        if ( !empty( $page_ids ) ) {
+        if ( ! empty( $page_ids ) ) {
 
             // Always get page data from the root blog, except on multiblog mode, when it comes
@@ -690 +723 @@
             $posts_table_name = bp_is_multiblog_mode() ? $wpdb->posts : $wpdb->get_blog_prefix( bp_get_root_blog_id() ) . 'posts';
             $page_ids_sql     = implode( ',', wp_parse_id_list( $page_ids ) );
-            $page_names       = $wpdb->get_results( "SELECT ID, post_name, post_parent, post_title FROM {$posts_table_name} WHERE ID IN ({$page_ids_sql}) AND post_status = 'publish' " );
+            $page_stati_sql   = '\'' . implode( '\', \'', array_map( 'sanitize_key', bp_core_get_directory_pages_stati() ) ) . '\'';
+            $page_names       = $wpdb->get_results( "SELECT ID, post_name, post_parent, post_title FROM {$posts_table_name} WHERE ID IN ({$page_ids_sql}) AND post_status IN ({$page_stati_sql}) " );
 
             foreach ( (array) $page_ids as $component_id => $page_id ) {