Contents

Code Reference Functions bp_core_get_directory_page_ids()

bp_core_get_directory_page_ids( string $status = 'active' )

Fetch a list of BP directory pages from the appropriate meta table.

Description

Parameters

$status

(Optional) 'active' to return only pages associated with active components, 'all' to return all saved pages. When running save routines, use 'all' to avoid removing data related to inactive components. Default: 'active'.

Default value: 'active'

Return

(array|string) An array of page IDs, keyed by component names, or an empty string if the list is not found.

Source

File: bp-core/bp-core-functions.php

507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
function bp_core_get_directory_page_ids( $status = 'active' ) {
    $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', 'activate', 'terms' and 'privacy' do not have components, but should be whitelisted.
        if ( in_array( $component_name, array( 'register', 'activate', 'terms', 'privacy', 'profile_dashboard', 'new_forums_page' ), true ) ) {
            continue;
        }
 
        // Remove inactive component pages.
        if ( ( 'active' === $status ) && ! bp_is_active( $component_name ) ) {
            unset( $page_ids[ $component_name ] );
        }
    }
 
    /**
     * Filters the list of BP directory pages from the appropriate meta table.
     *
     * @since BuddyPress 1.5.0
     * @since BuddyPress 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 );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.5.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.
bp-core/bp-core-functions.php: bp_core_get_directory_page_ids

Filters the list of BP directory pages from the appropriate meta table.
bp-core/bp-core-options.php: bp_get_option()

Retrieve an option.
Used By
Used By Description
bp-members/bp-members-functions.php: bp_activate_page_content()

Function to add the content on activate page.
bp-members/bp-members-functions.php: bp_register_page_content()

Function to add the content on register page
bp-members/bp-members-functions.php: bp_members_directory_page_content()

Function to add the content on top of members listing.
bp-media/bp-media-functions.php: bp_media_directory_page_content()

Function to add the content on top of media listing
bp-integrations/learndash/bp-learndash-filters.php: bb_group_wp_admin_bar_updates_menu()

Learndash Plugin updates Group Page admin bar Edit link to dashboard home page instead of the platform groups page.
bp-integrations/learndash/bp-learndash-filters.php: bb_ld_group_archive_slug_change()

Filter to fix conflict between Learndash Plugin groups archive page and Platform Groups page.
bp-groups/bp-groups-functions.php: bp_group_directory_page_content()

Function to add the content on top of group listing
bp-core/compatibility/bp-incompatible-plugins-helper.php: bp_core_memberpress_the_content()

Fix Memberpress Privacy for BuddyPress pages.
bp-core/classes/class-bp-rest-settings-endpoint.php: BP_REST_Settings_Endpoint::get_buddyboss_platform_settings()

Get BuddyBoss Platform Settings.
bp-activity/bp-activity-functions.php: bp_activity_directory_page_content()

Function to add the content on top of activity listing
bp-templates/bp-nouveau/includes/members/functions.php: bp_nouveau_admin_bar_member_dashboard()

Adds a ‘Dashbaord’ link in admin bar.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_signup_terms_privacy()

Output a terms of service and privacy policy pages if activated
bp-core/admin/bp-core-admin-pages.php: bp_core_admin_register_page_fields()

Register page fields
bp-core/admin/bp-core-admin-pages.php: bp_core_admin_register_registration_page_fields()

Register registration page fields
bp-core/admin/bp-core-admin-functions.php: bp_core_admin_create_background_page()

Catch and process an admin directory page.
bp-core/admin/bp-core-admin-functions.php: bp_core_activation_notice()

Verify that some BP prerequisites are set up properly, and notify the admin if not.
bp-core/bp-core-update.php: bp_migrate_directory_page_titles()

Update WP pages so that their post_title matches the legacy component directory title.
bp-core/profile-search/bps-directory.php: bp_ps_directories()

Returns array of BuddyBoss Profile Search directories.
bp-core/bp-core-functions.php: bp_nav_menu_get_loggedout_pages()

Create fake “post” objects for BP’s logged-out nav menu for use in the WordPress “Menus” settings page.
bp-core/bp-core-functions.php: bp_core_get_directory_page_id()

Get the page ID corresponding to a component directory.
bp-core/bp-core-functions.php: bp_core_get_directory_pages()

Get names and slugs for BuddyPress component directory pages.
bp-core/bp-core-functions.php: bp_core_add_page_mappings()

Creates necessary directory pages.
bp-core/bp-core-functions.php: bp_core_on_directory_page_delete()

Remove the entry from bp_pages when the corresponding WP page is deleted.
bp-core/bp-core-functions.php: bp_core_create_root_component_page()

Create WordPress pages to be used as BP component directories.
bp-core/bp-core-cache.php: bp_core_clear_directory_pages_cache_page_edit()

Clear the directory_pages cache when one of the pages is updated.
bp-core/bp-core-catchuri.php: bp_core_profile_dashboard_non_logged_redirect()

Redirect user to profile dashboard if not logged in.
bp-core/bp-core-catchuri.php: bp_get_canonical_url()

Get the canonical URL of the current page.
bp-core/bp-core-catchuri.php: bp_private_network_template_redirect()

Redirects users to login page if Private Network is enabled in BuddyBoss settings.
bp-core/bp-core-catchuri.php: bp_core_login_profile_dashboard_redirect()

Redirect member to profile dashboard.
Show 24 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.