Changeset 10755

Timestamp:

05/14/2016 04:59:12 AM (9 years ago)

Author:

boonebgorges

Message:

Introduce bp_core_get_directory_page_id().

This convenience function provides a way for developers to get the ID of a WP
page corresponding to a BuddyPress component.

Props garrett-eclipse.
Fixes #7025.

Location:

trunk

Files:

• src/bp-core/bp-core-functions.php (modified) (1 diff)
• tests/phpunit/testcases/core/functions/bpCoreGetDirectoryPageId.php (added)

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

@@ -491 +491 @@
      */
     return apply_filters( 'bp_core_get_directory_page_ids', $page_ids );
+}
+
+/**
+ * Get the page ID corresponding to a component directory.
+ *
+ * @since 2.6.0
+ *
+ * @param string $component The slug representing the component. Defaults to the current component.
+ * @return int|bool The ID of the directory page associated with the component. False if none is found.
+ */
+function bp_core_get_directory_page_id( $component = null ) {
+        if ( ! $component ) {
+                $component = bp_current_component();
+        }
+
+    $bp_pages = bp_core_get_directory_page_ids( 'all' );
+
+    $page_id = false;
+    if ( $component && isset( $bp_pages[ $component ] ) ) {
+        $page_id = (int) $bp_pages[ $component ];
+        }
+
+        return $page_id;
 }