| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
BuddyPress Capabilities.
| File Size: | 489 lines (14 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| bp_get_current_blog_roles() X-Ref |
| Return an array of roles from the currently loaded blog. WordPress roles are dynamically flipped when calls to switch_to_blog() and restore_current_blog() are made, so we use and trust WordPress core to have loaded the correct results for us here. As enhancements are made to WordPress's RBAC, so should our capability functions here. since: 2.1.0 return: object |
| bp_add_caps() X-Ref |
| Add capabilities to WordPress user roles. This is called on plugin activation. since: 1.6.0 |
| bp_remove_caps() X-Ref |
| Remove capabilities from WordPress user roles. This is called on plugin deactivation. since: 1.6.0 |
| bp_map_meta_caps( $caps, $cap, $user_id, $args ) X-Ref |
| Map community caps to built in WordPress caps. param: array $caps See {@link WP_User::has_cap()}. param: string $cap See {@link WP_User::has_cap()}. param: int $user_id See {@link WP_User::has_cap()}. param: mixed $args See {@link WP_User::has_cap()}. since: 1.6.0 return: array Actual capabilities for meta capability. See {@link WP_User::has_cap()}. |
| bp_get_community_caps() X-Ref |
| Return community capabilities. since: 1.6.0 return: array Community capabilities. |
| bp_get_caps_for_role( $role = '' ) X-Ref |
| Return an array of capabilities based on the role that is being requested. param: string $role The role for which you're loading caps. since: 1.6.0 return: array Capabilities for $role. |
| bp_set_current_user_default_role() X-Ref |
| Set a default role for the current user. Give a user the default role when creating content on a site they do not already have a role or capability on. since: 1.6.0 |
| bp_current_user_can( $capability, $args = array() X-Ref |
| Check whether the current user has a given capability. param: string $capability Capability or role name. param: array|int $args { since: 1.6.0 since: 2.4.0 Second argument modified to accept an array, rather than `$blog_id`. since: 2.7.0 Deprecated $args['blog_id'] in favor of $args['site_id']. return: bool True if the user has the cap for the given parameters. |
| bp_user_can( $user_id, $capability, $args = array() X-Ref |
| Check whether the specified user has a given capability on a given site. param: int $user_id param: string $capability Capability or role name. param: array|int $args { since: 2.7.0 return: bool True if the user has the cap for the given parameters. |
| _bp_roles_init( WP_Roles $wp_roles ) X-Ref |
| Adds the `bp_moderate` cap to Roles having the `manage_options` cap when BuddyPress is not active on the network. param: WP_Roles $wp_roles The WordPress roles object. since: 7.0.0 |
| _bp_enforce_bp_moderate_cap_for_admins( $caps = array() X-Ref |
| Temporary implementation of 'bp_moderate' cap. In BuddyPress 1.6, the 'bp_moderate' cap was introduced. In order to enforce that bp_current_user_can( 'bp_moderate' ) always returns true for Administrators, we must manually add the 'bp_moderate' cap to the list of user caps for Admins. Note that this level of enforcement is only necessary in the case of non-Multisite. This is because WordPress automatically assigns every capability - and thus 'bp_moderate' - to Super Admins on a Multisite installation. See {@link WP_User::has_cap()}. This implementation of 'bp_moderate' is temporary, until BuddyPress properly matches caps to roles and stores them in the database. Plugin authors: Please do not use this function; thank you. :) param: array $caps The caps that WP associates with the given role. param: string $cap The caps being tested for in WP_User::has_cap(). param: int $user_id ID of the user being checked against. param: array $args Miscellaneous arguments passed to the user_has_cap filter. since: 1.6.0 return: array $allcaps The user's cap list, with 'bp_moderate' appended, if relevant. |
| bp_add_roles() X-Ref |
| Adds BuddyPress-specific user roles. This is called on plugin activation. since: 1.6.0 |
| bp_remove_roles() X-Ref |
| Removes BuddyPress-specific user roles. This is called on plugin deactivation. since: 1.6.0 |
| bp_get_participant_role() X-Ref |
| The participant role for registered users without roles. This is primarily for multisite compatibility when users without roles on sites that have global communities enabled. since: 1.6.0 |
| bp_get_moderator_role() X-Ref |
| The moderator role for BuddyPress users. since: 1.6.0 |
| Generated: Fri Apr 19 01:01:08 2024 | Cross-referenced by PHPXref 0.7.1 |