[ Index ]

PHP Cross Reference of BuddyPress




/src/bp-xprofile/classes/ -> class-bp-xprofile-group.php (summary)

BuddyPress XProfile Classes.

File Size: 981 lines (30 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_XProfile_Group:: (13 methods):

Class: BP_XProfile_Group  - X-Ref

Class to help set up XProfile Groups.

__construct( $id = null )   X-Ref
Initialize and/or populate profile field group.

param: int|null $id Field group ID.
since: 1.1.0

populate( $id )   X-Ref
Populate a profile field group.

param: int $id Field group ID.
since: 1.0.0
return: boolean

save()   X-Ref
Save a profile field group.

since: 1.1.0
return: boolean

delete()   X-Ref
Delete a profile field group

since: 1.1.0
return: boolean

get( $args = array()   X-Ref
Populates the BP_XProfile_Group object with profile field groups, fields,
and field data.

param: array $args {
since: 1.2.0
since: 2.4.0 Introduced `$member_type` argument.
since: 8.0.0 Introduced `$hide_field_types` & `$signup_fields_only` arguments.
return: array $groups

get_group_ids( $args = array()   X-Ref
Gets group IDs, based on passed parameters.

param: array $args {
since: 5.0.0
return: array

get_group_field_ids( $group_ids, $args = array()   X-Ref
Gets group field IDs, based on passed parameters.

param: array $group_ids Array of group IDs.
param: array $args {
since: 5.0.0
return: array

get_group_data( $group_ids )   X-Ref
Get data about a set of groups, based on IDs.

param: array $group_ids Array of IDs.
since: 2.0.0
return: array

admin_validate()   X-Ref
Validate field group when form submitted.

since: 1.0.0
return: boolean

update_position( $field_group_id, $position )   X-Ref
Update field group position.

param: int $field_group_id ID of the group the field belongs to.
param: int $position       Field group position.
since: 1.5.0
return: boolean

fetch_visibility_level( $user_id = 0, $fields = array()   X-Ref
Fetch the field visibility level for the fields returned by the query.

param: int   $user_id The profile owner's user_id.
param: array $fields  The database results returned by the get() query.
since: 1.6.0
return: array $fields The database results, with field_visibility added

fetch_default_visibility_levels()   X-Ref
Fetch the admin-set preferences for all fields.

since: 1.6.0
return: array $default_visibility_levels An array, keyed by field_id, of default

render_admin_form()   X-Ref
Output the admin area field group form.

since: 1.0.0

Generated: Wed Jun 29 01:00:59 2022 Cross-referenced by PHPXref 0.7.1