[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress XProfile Classes.

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

Defines 1 class

BP_XProfile_Group:: (13 methods):
  __construct()
  populate()
  save()
  delete()
  get()
  get_group_ids()
  get_group_field_ids()
  get_group_data()
  admin_validate()
  update_position()
  fetch_visibility_level()
  fetch_default_visibility_levels()
  render_admin_form()


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.

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

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

return: boolean
since: 1.1.0

delete()   X-Ref
Delete a profile field group

return: boolean
since: 1.1.0

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

return: array $groups
param: array $args {
since: 1.2.0

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

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

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

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

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

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

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

return: boolean
since: 1.0.0

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

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

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

return: array $fields The database results, with field_visibility added
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

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

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

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

since: 1.0.0



Generated: Wed Jul 17 01:01:40 2019 Cross-referenced by PHPXref 0.7.1