Changeset 11513

Timestamp:

03/16/2017 03:49:08 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Core: Make sure trashed activate and register pages are unset in bp_core_get_directory_page_ids().

This flips the order of 2 conditions, which incorrectly included trashed pages for the activate & register components.

In addition, normalize the return value & type-casting of bp_core_get_directory_page_ids() to ensure it is always an array, even if an empty one.

Fixes #7469.

Location:

trunk

Files:

• src/bp-core/admin/bp-core-admin-functions.php (modified) (1 diff)
• src/bp-core/bp-core-cache.php (modified) (2 diffs)
• src/bp-core/bp-core-functions.php (modified) (4 diffs)
• tests/phpunit/testcases/admin/functions.php (modified) (1 diff)

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

@@ -315 +315 @@
     // BP components cannot share a single WP page. Check for duplicate assignments, and post a message if found.
     $dupe_names = array();
-    $page_ids   = (array)bp_core_get_directory_page_ids();
+    $page_ids   = bp_core_get_directory_page_ids();
     $dupes      = array_diff_assoc( $page_ids, array_unique( $page_ids ) );
 

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

@@ -74 +74 @@
  * @param int $post_id ID of the page that was saved.
  */
-function bp_core_clear_directory_pages_cache_page_edit( $post_id ) {
-    if ( ! bp_is_root_blog() ) {
-        return;
-    }
+function bp_core_clear_directory_pages_cache_page_edit( $post_id = 0 ) {
 
     // Bail if BP is not defined here.
@@ -84 +81 @@
     }
 
+    // Bail if not on the root blog
+    if ( ! bp_is_root_blog() ) {
+        return;
+    }
+
     $page_ids = bp_core_get_directory_page_ids( 'all' );
 
-    if ( ! in_array( $post_id, (array) $page_ids ) ) {
+    // Bail if post ID is not a directory page
+    if ( ! in_array( $post_id, $page_ids ) ) {
         return;
     }

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

@@ -489 +489 @@
  */
 function bp_core_get_directory_page_ids( $status = 'active' ) {
-    $page_ids = bp_get_option( 'bp-pages' );
-
-    // Ensure that empty indexes are unset. Should only matter in edge cases.
-    if ( !empty( $page_ids ) && is_array( $page_ids ) ) {
-        foreach( (array) $page_ids as $component_name => $page_id ) {
-            if ( empty( $component_name ) || empty( $page_id ) ) {
-                unset( $page_ids[ $component_name ] );
-            }
-
-            // 'register' and 'activate' do not have components, but should be whitelisted.
-            if ( 'register' === $component_name || 'activate' === $component_name ) {
-                continue;
-            }
-
-            // Trashed pages should not appear in results.
-            if ( 'trash' == get_post_status( $page_id ) ) {
-                unset( $page_ids[ $component_name ] );
-
-            }
-
-            // Remove inactive component pages, if required.
-            if ( 'active' === $status && ! bp_is_active( $component_name ) ) {
-                unset( $page_ids[ $component_name ] );
-            }
+    $page_ids = bp_get_option( 'bp-pages', array() );
+
+    // Loop through pages
+    foreach ( $page_ids as $component_name => $page_id ) {
+
+        // Ensure that empty indexes are unset. Should only matter in edge cases.
+        if ( empty( $component_name ) || empty( $page_id ) ) {
+            unset( $page_ids[ $component_name ] );
         }
+
+        // Trashed pages should never appear in results.
+        if ( 'trash' == get_post_status( $page_id ) ) {
+            unset( $page_ids[ $component_name ] );
+        }
+
+        // 'register' and 'activate' do not have components, but should be whitelisted.
+        if ( in_array( $component_name, array( 'register', 'activate' ), true ) ) {
+            continue;
+        }
+
+        // Remove inactive component pages.
+        if ( ( 'active' === $status ) && ! bp_is_active( $component_name ) ) {
+            unset( $page_ids[ $component_name ] );
+        }
     }
 
@@ -520 +519 @@
      *
      * @since 1.5.0
-     *
-     * @param array $page_ids Array of directory pages.
-     */
-    return apply_filters( 'bp_core_get_directory_page_ids', $page_ids );
+     * @since 2.9.0 Add $status parameter
+     *
+     * @param array  $page_ids Array of directory pages.
+     * @param string $status   Page status to limit results to
+     */
+    return (array) apply_filters( 'bp_core_get_directory_page_ids', $page_ids, $status );
 }
 
@@ -663 +664 @@
     // Delete any existing pages.
     if ( 'delete' === $existing ) {
-        foreach ( (array) $pages as $page_id ) {
+        foreach ( $pages as $page_id ) {
             wp_delete_post( $page_id, true );
         }
@@ -889 +890 @@
     }
 
-    $page_ids = array_merge( (array) $new_page_ids, (array) bp_core_get_directory_page_ids( 'all' ) );
+    $page_ids = array_merge( $new_page_ids, bp_core_get_directory_page_ids( 'all' ) );
     bp_core_update_directory_page_ids( $page_ids );
 }

trunk/tests/phpunit/testcases/admin/functions.php

@@ -145 +145 @@
         ) ) );
 
-        $page_ids = array_merge( $new_page_ids, (array) bp_core_get_directory_page_ids( 'all' ) );
+        $page_ids = array_merge( $new_page_ids, bp_core_get_directory_page_ids( 'all' ) );
         bp_core_update_directory_page_ids( $page_ids );