| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
BuddyPress Groups Functions. Functions are where all the magic happens in BuddyPress. They will handle the actual saving or manipulation of information. Usually they will hand off to a database class for data access, then return true or false on success or failure.
| File Size: | 3680 lines (113 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| bp_groups_has_directory() X-Ref |
| Check whether there is a Groups directory page in the $bp global. since: 1.5.0 return: bool True if set, False if empty. |
| groups_get_group( $group_id ) X-Ref |
| Fetch a single group object. When calling up a group object, you should always use this function instead of instantiating BP_Groups_Group directly, so that you will inherit cache support and pass through the groups_get_group filter. param: int $group_id ID of the group. since: 1.2.0 since: 2.7.0 The function signature was changed to accept a group ID only, return: BP_Groups_Group $group The group object. |
| bp_get_group_by( $field, $value ) X-Ref |
| Retrieve group by a given field. param: string $field (Required) The field to use to retrieve the group. param: string|int $value (Required) A value for the $field. A Group ID or slug. since: 10.0.0 return: BP_Groups_Group|bool The Group object if found, false otherwise. |
| bp_get_group( $group = false ) X-Ref |
| Retrieve a Group. When used into the context of a Groups loop built by the `BP_Groups_Template` class, it defaults to the Group being iterated on. param: false|int|string|object|BP_Groups_Group $group (Optional) The Group ID, the Group Slug or the Group object. since: 10.0.0 return: BP_Groups_Group|bool The Group object if found, false otherwise. |
| groups_create_group( $args = '' ) X-Ref |
| Create a group. param: array|string $args { since: 1.0.0 return: int|bool The ID of the group on success. False on error. |
| groups_edit_base_group_details( $args = array() X-Ref |
| Edit the base details for a group. These are the settings that appear on the first page of the group's Admin section (Name, Description, and "Notify members..."). param: array $args { since: 1.0.0 return: bool True on success, false on failure. |
| groups_edit_group_settings( $group_id, $enable_forum, $status, $invite_status = false, $parent_id = false ) X-Ref |
| Edit the base details for a group. These are the settings that appear on the Settings page of the group's Admin section (privacy settings, "enable forum", invitation status). param: int $group_id ID of the group. param: bool $enable_forum Whether to enable a forum for the group. param: string $status Group status. 'public', 'private', 'hidden'. param: string|bool $invite_status Optional. Who is allowed to send invitations param: int|bool $parent_id Parent group ID. since: 1.0.0 return: bool True on success, false on failure. |
| groups_delete_group( $group_id ) X-Ref |
| Delete a group and all of its associated metadata. param: int $group_id ID of the group to delete. since: 1.0.0 return: bool True on success, false on failure. |
| groups_is_valid_status( $status ) X-Ref |
| Check a group status (eg 'private') against the list of registered statuses. param: string $status Status to check. since: 1.1.0 return: bool True if status is allowed, otherwise false. |
| groups_check_slug( $slug ) X-Ref |
| Provide a unique, sanitized version of a group slug. param: string $slug Group slug to check. since: 1.0.0 return: string $slug A unique and sanitized slug. |
| groups_get_slug( $group ) X-Ref |
| Get slug from a group. param: int|string|BP_Groups_Group $group The Group ID, the Group Slug or the Group object. since: 1.0.0 since: 10.0.0 Updated to use `bp_get_group`. return: bool|string The group's slug. False if group doesn't exist. |
| groups_get_id( $group_slug ) X-Ref |
| Get a group ID by its slug. param: string $group_slug The group's slug. since: 1.6.0 return: int|null The group ID on success, null on failure. |
| groups_get_id_by_previous_slug( $group_slug ) X-Ref |
| Get a group ID by checking against old (not currently active) slugs. param: string $group_slug The group's slug. since: 2.9.0 return: int|null The group ID on success, null on failure. |
| groups_leave_group( $group, $user_id = 0 ) X-Ref |
| Remove a user from a group. param: int|string|BP_Groups_Group $group The Group ID, the Group Slug or the Group object. param: int $user_id Optional. ID of the user. Defaults to the currently since: 1.0.0 since: 10.0.0 Updated to use `bp_get_group`. return: bool True on success, false on failure. |
| groups_join_group( $group, $user_id = 0 ) X-Ref |
| Add a user to a group. param: int|string|BP_Groups_Group $group The Group ID, the Group Slug or the Group object. param: int $user_id Optional. ID of the user. Defaults to the currently since: 1.0.0 since: 10.0.0 Updated to use `bp_get_group`. return: bool True on success, false on failure. |
| groups_update_last_activity( $group = 0 ) X-Ref |
| Update the last_activity meta value for a given group. param: int|string|BP_Groups_Group $group The Group ID, the Group Slug or the Group object. since: 1.0.0 since: 10.0.0 Updated to use `bp_get_group`. return: bool False on failure. |
| groups_get_group_admins( $group_id ) X-Ref |
| Get a list of group administrators. param: int $group_id ID of the group. since: 1.0.0 return: array Info about group admins (user_id + date_modified). |
| groups_get_group_mods( $group_id ) X-Ref |
| Get a list of group moderators. param: int $group_id ID of the group. since: 1.0.0 return: array Info about group admins (user_id + date_modified). |
| groups_get_group_members( $args = array() X-Ref |
| Fetch the members of a group. Since BuddyPress 1.8, a procedural wrapper for BP_Group_Member_Query. Previously called BP_Groups_Member::get_all_for_group(). To use the legacy query, filter 'bp_use_legacy_group_member_query', returning true. param: array $args { since: 1.0.0 since: 3.0.0 $group_id now supports multiple values. Only works if legacy query is not return: false|array Multi-d array of 'members' list and 'count'. |
| groups_get_total_member_count( $group, $skip_cache = false ) X-Ref |
| Get the member count for a group. param: int|string|BP_Groups_Group $group The Group ID, the Group Slug or the Group object. param: bool $skip_cache Optional. Skip grabbing from cache. Defaults to false. since: 1.2.3 since: 10.0.0 Updated to use `bp_get_group`. return: int|bool Count of confirmed members for the group. False if group doesn't exist. |
| groups_get_groups( $args = '' ) X-Ref |
| Get a collection of groups, based on the parameters passed. param: array|string $args { since: 1.2.0 since: 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters. since: 2.7.0 Added `$update_admin_cache` and `$parent_id` parameters. since: 10.0.0 Added `$date_query` parameter. return: array See {@link BP_Groups_Group::get()}. |
| groups_get_total_group_count( $skip_cache = false ) X-Ref |
| Get the total group count for the site. param: bool $skip_cache Optional. Skip getting count from cache. since: 1.2.0 since: 10.0.0 Added the `$skip_cache` parameter. return: int |
| groups_get_user_groups( $user_id = 0, $pag_num = 0, $pag_page = 0 ) X-Ref |
| Get the IDs of the groups of which a specified user is a member. param: int $user_id ID of the user. param: int $pag_num Optional. Max number of results to return. param: int $pag_page Optional. Page offset of results to return. since: 1.0.0 return: array { |
| bp_get_user_groups( $user_id, $args = array() X-Ref |
| Get a list of groups of which the specified user is a member. Get a list of the groups to which this member belongs, filtered by group membership status and role. Usage examples: Used with no arguments specified, bp_get_user_groups( bp_loggedin_user_id() ); returns an array of the groups in which the logged-in user is an unpromoted member. To fetch an array of all groups that the current user belongs to, in any membership role, member, moderator or administrator, use bp_get_user_groups( $user_id, array( 'is_admin' => null, 'is_mod' => null, ) ); param: int $user_id ID of the user. param: array $args { param: bool|null $is_confirmed Whether to return only confirmed memberships. Pass `null` to disable this param: bool|null $is_banned Whether to return only banned memberships. Pass `null` to disable this filter. param: bool|null $is_admin Whether to return only admin memberships. Pass `null` to disable this filter. param: bool|null $is_mod Whether to return only mod memberships. Pass `null` to disable this filter. param: bool|null $invite_sent Whether to return only memberships with 'invite_sent'. Pass `null` to disable param: string $orderby Field to order by. Accepts 'id' (membership ID), 'group_id', 'date_modified'. param: string $order Sort order. Accepts 'ASC' or 'DESC'. Default: 'ASC'. since: 2.6.0 return: array Array of matching group memberships, keyed by group ID. |
| groups_total_groups_for_user( $user_id = 0 ) X-Ref |
| Get the count of groups of which the specified user is a member. param: int $user_id Optional. Default: ID of the displayed user. since: 1.0.0 return: int Group count. |
| groups_get_current_group() X-Ref |
| Get the BP_Groups_Group object corresponding to the current group. since: 1.5.0 return: BP_Groups_Group|bool The current group object or false. |
| groups_avatar_upload_dir( $group_id = 0 ) X-Ref |
| Generate the avatar upload directory path for a given group. param: int $group_id Optional. ID of the group. Default: ID of the current group. since: 1.1.0 return: string |
| bp_groups_get_group_roles() X-Ref |
| Get the Group roles. since: 5.0.0 return: array The list of Group role objects. |
| groups_is_user_admin( $user_id, $group_id ) X-Ref |
| Check whether a user is an admin of a given group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: int|bool ID of the membership if the user is admin, otherwise false. |
| groups_is_user_mod( $user_id, $group_id ) X-Ref |
| Check whether a user is a mod of a given group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: int|bool ID of the membership if the user is mod, otherwise false. |
| groups_is_user_member( $user_id, $group_id ) X-Ref |
| Check whether a user is a member of a given group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: int|bool ID of the membership if the user is member, otherwise false. |
| groups_is_user_banned( $user_id, $group_id ) X-Ref |
| Check whether a user is banned from a given group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: int|bool ID of the membership if the user is banned, otherwise false. |
| groups_is_user_invited( $user_id, $group_id, $type = 'sent' ) X-Ref |
| Check whether a user has an outstanding invitation to a group. param: int $user_id ID of the user. param: int $group_id ID of the group. param: string $type If 'sent', results are limited to those invitations since: 2.6.0 since: 5.0.0 Added $type parameter. return: int|bool ID of the membership if the user is invited, otherwise false. |
| groups_is_user_pending( $user_id, $group_id ) X-Ref |
| Check whether a user has a pending membership request for a group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 2.6.0 return: int|bool ID of the membership if the user is pending, otherwise false. |
| groups_is_user_creator( $user_id, $group_id ) X-Ref |
| Is the specified user the creator of the group? param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.2.6 return: int|null |
| groups_get_invites_for_user( $user_id = 0, $limit = false, $page = false, $exclude = false ) X-Ref |
| Get group objects for groups that a user is currently invited to. param: int $user_id ID of the invited user. param: int|bool $limit Limit to restrict to. param: int|bool $page Optional. Page offset of results to return. param: string|array|bool $exclude Array of comma-separated list of group IDs since: 1.0.0 return: array { |
| groups_get_invite_count_for_user( $user_id = 0 ) X-Ref |
| Get the total group invite count for a user. param: int $user_id The user ID. since: 2.0.0 return: int |
| groups_get_invited_to_group_ids( $user_id = 0 ) X-Ref |
| Get an array of group IDs to which a user is invited. param: int $user_id The user ID. since: 5.0.0 return: array Array of group IDs. |
| groups_invite_user( $args = '' ) X-Ref |
| Invite a user to a group. param: array|string $args { since: 1.0.0 return: bool True on success, false on failure. |
| groups_uninvite_user( $user_id, $group_id, $inviter_id = false ) X-Ref |
| Uninvite a user from a group. param: int $user_id ID of the user. param: int $group_id ID of the group. param: int $inviter_id ID of the inviter. since: 1.0.0 return: bool True on success, false on failure. |
| groups_accept_invite( $user_id, $group_id ) X-Ref |
| Process the acceptance of a group invitation. Returns true if a user is already a member of the group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: bool True when the user is a member of the group, otherwise false. |
| groups_reject_invite( $user_id, $group_id, $inviter_id = false ) X-Ref |
| Reject a group invitation. param: int $user_id ID of the user. param: int $group_id ID of the group. param: int $inviter_id ID of the inviter. since: 1.0.0 since: 5.0.0 The $inviter_id arg was added. return: bool True on success, false on failure. |
| groups_delete_invite( $user_id, $group_id, $inviter_id = false ) X-Ref |
| Delete a group invitation. param: int $user_id ID of the invited user. param: int $group_id ID of the group. param: int $inviter_id ID of the inviter. since: 1.0.0 since: 5.0.0 The $inviter_id arg was added. return: bool True on success, false on failure. |
| groups_send_invites( ...$args ) X-Ref |
| Send some or all pending invites by a single user to a specific group. param: array $args { since: 1.0.0 since: 5.0.0 Parameters changed to associative array. |
| groups_get_invites_for_group( $user_id, $group_id, $sent = null ) X-Ref |
| Get IDs of users with outstanding invites to a given group. param: int $user_id ID of the inviting user. param: int $group_id ID of the group. param: int|null $sent Query for a specific invite sent status. If 0, this will query for users since: 1.0.0 since: 2.9.0 Added $sent as a parameter. return: array IDs of users who have been invited to the group by the user but have not |
| groups_get_invites( $args = array() X-Ref |
| Get invitations to a given group filtered by arguments. param: int $group_id ID of the group. param: array $args Invitation arguments. since: 5.0.0 return: array $invites Matching BP_Invitation objects. |
| groups_check_user_has_invite( $user_id, $group_id, $type = 'sent' ) X-Ref |
| Check to see whether a user has already been invited to a group. By default, the function checks for invitations that have been sent. Entering 'all' as the $type parameter will return unsent invitations as well (useful to make sure AJAX requests are not duplicated). param: int $user_id ID of potential group member. param: int $group_id ID of potential group. param: string $type Optional. Use 'sent' to check for sent invites, since: 1.0.0 return: int|bool ID of the first found membership if found, otherwise false. |
| groups_check_has_invite_from_user( $user_id, $group_id, $inviter_id = false, $type = 'sent' ) X-Ref |
| Check to see whether a user has already been invited to a group by a particular user. By default, the function checks for invitations that have been sent. Entering 'all' as the $type parameter will return unsent invitations as well (useful to make sure AJAX requests are not duplicated). param: int $user_id ID of potential group member. param: int $group_id ID of potential group. param: string $inviter_id Optional. Use 'sent' to check for sent invites, param: string $type Optional. Specify a user ID to limit to only invited from that user. since: 5.0.0 return: int|bool ID of the first found membership if found, otherwise false. |
| groups_delete_all_group_invites( $group_id ) X-Ref |
| Delete all invitations to a given group. param: int $group_id ID of the group whose invitations are being deleted. since: 1.0.0 return: int|null Number of rows records deleted on success, null on failure. |
| groups_promote_member( $user_id, $group_id, $status ) X-Ref |
| Promote a member to a new status within a group. param: int $user_id ID of the user. param: int $group_id ID of the group. param: string $status The new status. 'mod' or 'admin'. since: 1.0.0 return: bool True on success, false on failure. |
| groups_demote_member( $user_id, $group_id ) X-Ref |
| Demote a user to 'member' status within a group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: bool True on success, false on failure. |
| groups_ban_member( $user_id, $group_id ) X-Ref |
| Ban a member from a group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: bool True on success, false on failure. |
| groups_unban_member( $user_id, $group_id ) X-Ref |
| Unban a member from a group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: bool True on success, false on failure. |
| groups_remove_member( $user_id, $group_id ) X-Ref |
| Remove a member from a group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.2.6 return: bool True on success, false on failure. |
| groups_send_membership_request( ...$args ) X-Ref |
| Create a group membership request. param: array|string $args { since: 1.0.0 return: bool True on success, false on failure. |
| groups_accept_membership_request( $membership_id, $user_id = 0, $group_id = 0 ) X-Ref |
| Accept a pending group membership request. param: int $membership_id Deprecated 5.0.0. param: int $user_id Required. ID of the user who requested membership. param: int $group_id Required. ID of the group to which membership is being since: 1.0.0 since: 5.0.0 Deprecated $membership_id argument. return: bool True on success, false on failure. |
| groups_reject_membership_request( $membership_id, $user_id = 0, $group_id = 0 ) X-Ref |
| Reject a pending group membership request. param: int $membership_id Deprecated 5.0.0. param: int $user_id Optional. ID of the user who requested membership. param: int $group_id Optional. ID of the group to which membership is being since: 1.0.0 return: bool True on success, false on failure. |
| groups_delete_membership_request( $membership_id, $user_id = 0, $group_id = 0 ) X-Ref |
| Delete a pending group membership request. param: int $membership_id Deprecated 5.0.0. param: int $user_id Optional. ID of the user who requested membership. param: int $group_id Optional. ID of the group to which membership is being since: 1.2.0 return: false|BP_Groups_Member True on success, false on failure. |
| groups_get_requests( $args = array() X-Ref |
| Get group membership requests filtered by arguments. param: int $group_id ID of the group. param: array $args Invitation arguments. since: 5.0.0 return: array $requests Matching BP_Invitation objects. |
| groups_check_for_membership_request( $user_id, $group_id ) X-Ref |
| Check whether a user has an outstanding membership request for a given group. param: int $user_id ID of the user. param: int $group_id ID of the group. since: 1.0.0 return: int|bool ID of the request if found, otherwise false. |
| groups_get_membership_requested_group_ids( $user_id = 0 ) X-Ref |
| Get an array of group IDs to which a user has requested membership. param: int $user_id The user ID. since: 5.0.0 return: array Array of group IDs. |
| groups_get_membership_requested_user_ids( $group_id = 0 ) X-Ref |
| Get an array of group IDs to which a user has requested membership. param: int $user_id The user ID. since: 5.0.0 return: array Array of group IDs. |
| groups_accept_all_pending_membership_requests( $group_id = 0 ) X-Ref |
| Accept all pending membership requests to a group. param: int $group_id ID of the group. since: 1.0.2 return: bool True on success, false on failure. |
| groups_delete_groupmeta( $group_id, $meta_key = false, $meta_value = false, $delete_all = false ) X-Ref |
| Delete metadata for a group. param: int $group_id ID of the group. param: string|bool $meta_key The key of the row to delete. param: string|bool $meta_value Optional. Metadata value. If specified, only delete param: bool $delete_all Optional. If true, delete matching metadata entries since: 1.0.0 return: bool True on success, false on failure. |
| groups_get_groupmeta( $group_id, $meta_key = '', $single = true ) X-Ref |
| Get a piece of group metadata. param: int $group_id ID of the group. param: string $meta_key Metadata key. param: bool $single Optional. If true, return only the first value of the since: 1.0.0 return: mixed Metadata value. |
| groups_update_groupmeta( $group_id, $meta_key, $meta_value, $prev_value = '' ) X-Ref |
| Update a piece of group metadata. param: int $group_id ID of the group. param: string $meta_key Metadata key. param: mixed $meta_value Value to store. param: mixed $prev_value Optional. If specified, only update existing since: 1.0.0 return: bool|int $retval Returns false on failure. On successful update of existing |
| groups_add_groupmeta( $group_id, $meta_key, $meta_value, $unique = false ) X-Ref |
| Add a piece of group metadata. param: int $group_id ID of the group. param: string $meta_key Metadata key. param: mixed $meta_value Metadata value. param: bool $unique Optional. Whether to enforce a single metadata value since: 2.0.0 return: int|bool The meta ID on successful update, false on failure. |
| groups_remove_data_for_user( $user_id ) X-Ref |
| Delete all group membership information for the specified user. param: int $user_id ID of the user. since: 1.0.0 |
| bp_groups_remove_data_for_user_on_delete_user( $user_id ) X-Ref |
| Deletes user group data on the 'delete_user' hook. param: int $user_id The ID of the deleted user. since: 6.0.0 |
| bp_groups_update_orphaned_groups_on_group_delete( $group ) X-Ref |
| Update orphaned child groups when the parent is deleted. param: BP_Groups_Group $group Instance of the group item being deleted. since: 2.7.0 |
| bp_group_type_tax_name() X-Ref |
| Output the slug of the Group type taxonomy. since: 7.0.0 |
| bp_get_group_type_tax_name() X-Ref |
| Return the slug of the Group type taxonomy. since: 7.0.0 return: string The unique Group taxonomy slug. |
| bp_get_group_type_tax_labels() X-Ref |
| Returns labels used by the Group type taxonomy. since: 7.0.0 return: array |
| bp_get_group_type_tax_args() X-Ref |
| Returns arguments used by the Group type taxonomy. since: 7.0.0 return: array |
| bp_groups_register_group_type_taxonomy( $taxonomies = array() X-Ref |
| Register the Group Types taxonomy. param: array $taxonomies BuddyPress default taxonomies. since: 7.0.0 return: array BuddyPress default taxonomies. |
| bp_groups_register_group_types() X-Ref |
| Fire the 'bp_groups_register_group_types' action. since: 2.6.0 |
| bp_get_group_type_metadata_schema( $schema = array() X-Ref |
| Extend generic Type metadata schema to match Group Type needs. param: array $schema The generic Type metadata schema. param: string $taxonomy The taxonomy name the schema applies to. since: 7.0.0 return: array The Group Type metadata schema. |
| bp_register_group_type_metadata() X-Ref |
| Registers the Group type metadata. since: 7.0.0 |
| bp_groups_register_group_type( $group_type, $args = array() X-Ref |
| Register a group type. param: string $group_type Unique string identifier for the group type. param: array $args { since: 2.6.0 since: 2.7.0 Introduce $has_directory, $show_in_create_screen, $show_in_list, and return: object|WP_Error Group type object on success, WP_Error object on failure. |
| bp_groups_get_group_types( $args = array() X-Ref |
| Get a list of all registered group type objects. param: array|string $args Optional. An array of key => value arguments to match against param: string $output Optional. The type of output to return. Accepts 'names' param: string $operator Optional. The logical operation to perform. 'or' means only one since: 2.6.0 return: array $types A list of groups type names or objects. |
| bp_groups_get_group_type_object( $group_type ) X-Ref |
| Retrieve a group type object by name. param: string $group_type The name of the group type. since: 2.6.0 return: object A group type object. |
| bp_get_group_types_registered_by_code() X-Ref |
| Only gets the group types registered by code. since: 7.0.0 return: array The group types registered by code. |
| bp_set_registered_by_code_group_type_metadata( $metadata = array() X-Ref |
| Generates missing metadata for a type registered by code. since: 7.0.0 return: array The group type metadata. |
| bp_insert_group_types_registered_by_code() X-Ref |
| Insert group types registered by code not yet saved into the database as WP Terms. since: 7.0.0 |
| bp_groups_set_group_type( $group_id, $group_type, $append = false ) X-Ref |
| Set type for a group. param: int $group_id ID of the group. param: string|array $group_type Group type or array of group types to set. param: bool $append Optional. True to append this to existing types for group, since: 2.6.0 since: 2.7.0 $group_type parameter also accepts an array of group types now. return: false|array $retval See bp_set_object_terms(). |
| bp_groups_get_group_type( $group_id, $single = true, $use_db = true ) X-Ref |
| Get type for a group. param: int $group_id ID of the group. param: bool $single Optional. Whether to return a single type string. If multiple types are found param: bool $use_db Optional. Whether to request all group types or only the ones registered by code. since: 2.6.0 since: 7.0.0 Adds the `$use_db` parameter. return: string|array|bool On success, returns a single group type (if `$single` is true) or an array of group |
| bp_groups_remove_group_type( $group_id, $group_type ) X-Ref |
| Remove type for a group. param: int $group_id ID of the user. param: string $group_type Group type. since: 2.6.0 return: bool|WP_Error $deleted True on success. False or WP_Error on failure. |
| bp_groups_has_group_type( $group_id, $group_type ) X-Ref |
| Check whether the given group has a certain group type. param: int $group_id ID of the group. param: string $group_type Group type. since: 2.6.0 return: bool Whether the group has the give group type. |
| bp_get_current_group_directory_type() X-Ref |
| Get the "current" group type, if one is provided, in group directories. since: 2.7.0 return: string |
| bp_remove_group_type_on_group_delete( $group_id = 0 ) X-Ref |
| Delete a group's type when the group is deleted. param: int $group_id ID of the group. since: 2.6.0 return: array|null $value See {@see bp_groups_set_group_type()}. |
| bp_groups_memberships_personal_data_exporter( $email_address, $page ) X-Ref |
| Finds and exports group membership data associated with an email address. param: string $email_address The user's email address. param: int $page Batch number. since: 4.0.0 return: array An array of personal data. |
| bp_groups_pending_requests_personal_data_exporter( $email_address, $page ) X-Ref |
| Finds and exports data on pending group membership requests associated with an email address. param: string $email_address The user's email address. param: int $page Batch number. since: 4.0.0 return: array An array of personal data. |
| bp_groups_pending_sent_invitations_personal_data_exporter( $email_address, $page ) X-Ref |
| Finds and exports data on pending group invitations sent by a user associated with an email address. param: string $email_address The user's email address. param: int $page Batch number. since: 4.0.0 return: array An array of personal data. |
| bp_groups_pending_received_invitations_personal_data_exporter( $email_address, $page ) X-Ref |
| Finds and exports data on pending group invitations received by a user associated with an email address. param: string $email_address The user's email address. param: int $page Batch number. since: 4.0.0 return: array An array of personal data. |
| bp_groups_migrate_invitations() X-Ref |
| Migrate invitations and requests from pre-5.0 group_members table to invitations table. since: 5.0.0 |
| bp_register_group_extension( $group_extension_class = '' ) X-Ref |
| Register a new Group Extension. param: string $group_extension_class Name of the Extension class. since: 1.1.0 since: 10.0.0 The function was moved from the `/bp-groups/classes/class-bp-group-extension.php` file. return: bool Returns true on success, otherwise false. |
| bp_init_group_extensions() X-Ref |
| Init Registered Group Extensions. since: 10.0.0 |
| Generated: Sat Apr 27 01:00:55 2024 | Cross-referenced by PHPXref 0.7.1 |