| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
Core BuddyPress Navigational Functions.
| File Size: | 984 lines (40 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| bp_core_new_nav_item( $args, $component = 'members' ) X-Ref |
| Add an item to the primary navigation of the specified component. return: null|false Returns false on failure. param: array|string $args { param: string $component The component the navigation is attached to. Defaults to 'members'. since: 1.1.0 since: 2.6.0 Introduced the `$component` parameter. since: 4.0.0 Introduced the `$component_id` argument. |
| bp_core_create_nav_link( $args = '', $component = 'members' ) X-Ref |
| Add a link to the main BuddyPress navigation. return: false|array Returns false on failure, new nav item on success. param: array|string $args { param: string $component Optional. Component that the nav belongs to. since: 2.4.0 since: 2.6.0 Introduced the `$component` parameter. Began returning a BP_Core_Nav_Item since: 4.0.0 Introduced `$component_id` argument. |
| bp_core_register_nav_screen_function( $args = '' ) X-Ref |
| Register a screen function for an item in the main nav array. return: false|null Returns false on failure. param: array|string $args { since: 2.4.0 |
| bp_core_new_nav_default( $args = '' ) X-Ref |
| Modify the default subnav item that loads when a top level nav item is clicked. param: array|string $args { since: 1.1.0 |
| bp_core_new_subnav_item( $args, $component = null ) X-Ref |
| Add an item to secondary navigation of the specified component. return: null|false Returns false on failure. param: array|string $args { param: string|null $component The component the navigation is attached to. Defaults to 'members'. since: 1.1.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_core_create_subnav_link( $args = '', $component = 'members' ) X-Ref |
| Add a subnav link to the BuddyPress navigation. return: false|array Returns false on failure, new BP_Core_Nav_Item instance on success. param: array|string $args { param: string $component The component the navigation is attached to. Defaults to 'members'. since: 2.4.0 since: 2.6.0 Introduced the `$component` parameter. Began returning a BP_Core_Nav_Item object on success. |
| bp_core_register_subnav_screen_function( $args = '', $component = 'members' ) X-Ref |
| Register a screen function, whether or not a related subnav link exists. return: null|false Returns false on failure. param: array|string $args { param: string $component The component the navigation is attached to. Defaults to 'members'. since: 2.4.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_core_maybe_hook_new_subnav_screen_function( $subnav_item, $component = 'members' ) X-Ref |
| For a given subnav item, either hook the screen function or generate redirect arguments, as necessary. return: array param: array $subnav_item The subnav array added to the secondary navigation of param: string $component The component the navigation is attached to. Defaults to 'members'. since: 2.1.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_nav_item_has_subnav( $nav_item = '', $component = 'members' ) X-Ref |
| Check whether a given nav item has subnav items. return: bool $has_subnav True if the nav item is found and has subnav items; false otherwise. param: string $nav_item The slug of the top-level nav item whose subnav items you're checking. param: string $component The component the navigation is attached to. Defaults to 'members'. since: 1.5.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_core_remove_nav_item( $slug, $component = null ) X-Ref |
| Deletes an item from the primary navigation of the specified component. return: bool Returns false on failure, True on success. param: string $slug The slug of the primary navigation item. param: string|null $component The component the navigation is attached to. Defaults to 'members'. since: 1.0.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_core_remove_subnav_item( $parent_slug, $slug, $component = null ) X-Ref |
| Deletes an item from the secondary navigation of the specified component. return: bool Returns false on failure, True on success. param: string $parent_slug The slug of the primary navigation item. param: string $slug The slug of the secondary item to be removed. param: string|null $component The component the navigation is attached to. Defaults to 'members'. since: 1.0.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_core_reset_subnav_items( $parent_slug, $component = 'members' ) X-Ref |
| Clear all subnav items from a specific nav item. param: string $parent_slug The slug of the parent navigation item. param: string $component The component the navigation is attached to. Defaults to 'members'. since: 1.0.0 since: 2.6.0 Introduced the `$component` parameter. |
| bp_get_admin_bar_pref( $context, $user = 0 ) X-Ref |
| Retrieve the Toolbar display preference of a user based on context. This is a direct copy of WP's private _get_admin_bar_pref() return: bool True if the toolbar should be showing for this user. param: string $context Context of this preference check. 'admin' or 'front'. param: int $user Optional. ID of the user to check. Default: 0 (which falls back to the logged-in user's ID). since: 1.5.0 |
| Generated: Thu Nov 21 01:00:57 2024 | Cross-referenced by PHPXref 0.7.1 |