bp_get_root_blog_id
Filters the ID for the root blog.
Description
Parameters (1)
- 0. $bp_root_blog (unknown) =>
BP_ROOT_BLOG
- The bp root blog.
Usage
- To run the hook, copy the example below.
- $bp_root_blog = apply_filters( 'bp_get_root_blog_id', $bp_root_blog );
- if ( !empty( $bp_root_blog ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_get_root_blog_id callback
- function filter_bp_get_root_blog_id( $bp_root_blog ) {
- // make filter magic happen here...
- return $bp_root_blog;
- };
- // add the filter
- add_filter( 'bp_get_root_blog_id', 'filter_bp_get_root_blog_id', 10, 1 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'bp_get_root_blog_id', 'filter_bp_get_root_blog_id', 10, 1 );
Defined (2)
The filter is defined in the following location(s).
- /class-buddypress.php
- $this->root_blog_id = (int) apply_filters( 'bp_get_root_blog_id', BP_ROOT_BLOG );
- /bp-core/bp-core-functions.php
- return (int) apply_filters( 'bp_get_root_blog_id', (int) buddypress()->root_blog_id );