Contents

Code Reference Functions xprofile_get_field()

xprofile_get_field( int|object $field, int|null $user_id = null, bool $get_data = true )

Get a profile field object.

Description

Parameters

$field

(int|object) (Required) ID of the field or object representing field data.

$user_id

(int|null) (Optional) ID of the user associated with the field. Ignored if $get_data is false. If $get_data is true, but no $user_id is provided, defaults to logged-in user ID.

Default value: null

$get_data

(bool) (Optional) Whether to fetch data for the specified $user_id.

Default value: true

Return

(BP_XProfile_Field|null) Field object if found, otherwise null.

Source

File: bp-xprofile/bp-xprofile-functions.php 

function xprofile_get_field( $field, $user_id = null, $get_data = true ) {
	if ( $field instanceof BP_XProfile_Field ) {
		$_field = $field;
	} elseif ( is_object( $field ) ) {
		$_field = new BP_XProfile_Field();
		$_field->fill_data( $field );
	} else {
		$_field = BP_XProfile_Field::get_instance( $field, $user_id, $get_data );
	}

	if ( ! $_field ) {
		return null;
	}

	return $_field;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.1.0 Introduced.
Used By
Used By Description
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_profile_field_raw_value()

Retrieve the field raw data.
bp-xprofile/classes/class-bp-rest-xprofile-repeater-endpoint.php: BP_REST_XProfile_Repeater_Endpoint::update_item()

Reorder a new Repeater Group.
bp-xprofile/classes/class-bp-rest-xprofile-update-endpoint.php: BP_REST_XProfile_Update_Endpoint::update_items()

Update XProfile.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_xprofile_field_object()

Get XProfile field object.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_profile_field_rendered_value()

Retrieve the rendered value of a profile field.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_profile_field_unserialized_value()

Retrieve the unserialized value of a profile field.
bp-templates/bp-nouveau/includes/xprofile/ajax.php: bp_nouveau_ajax_xprofile_get_field()

Ajax callback for get the conditional field based on the selected member type.
bp-xprofile/bp-xprofile-filters.php: bp_xprofile_validate_social_networks_value()

Validate social networks field values.
bp-xprofile/bp-xprofile-filters.php: bp_xprofile_validate_nickname_value()

Validate nickname approved characters and format.
bp-xprofile/bp-xprofile-filters.php: bp_xprofile_validate_phone_value()

Validate phone number format.
bp-xprofile/bp-xprofile-filters.php: xprofile_sanitize_data_value_before_save()

Safely runs profile field data through kses and force_balance_tags.
bp-xprofile/bp-xprofile-filters.php: xprofile_filter_format_field_value_by_field_id()

Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched by xprofile_get_field_data().
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_fullname_field_name()

Return the field name for the Full Name xprofile field.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_is_richtext_enabled_for_field()

Is rich text enabled for this profile field?
bp-xprofile/bp-xprofile-functions.php: xprofile_get_field_visibility_level()

Get the visibility level for a field.
bp-xprofile/bp-xprofile-functions.php: xprofile_set_field_data()

A simple function to set profile data for a specific field for a specific user.
bp-xprofile/bp-xprofile-functions.php: xprofile_insert_field()

Insert or update an xprofile field.
bp-xprofile/bp-xprofile-template.php: bp_get_the_profile_field_options()

Retrieves field options HTML for field types of ‘selectbox’, ‘multiselectbox’, ‘radio’, ‘checkbox’, and ‘datebox’.
bp-xprofile/classes/class-bp-xprofile-group.php: BP_XProfile_Group::get()

Populates the BP_XProfile_Group object with profile field groups, fields, and field data.
bp-xprofile/bp-xprofile-repeaters.php: bp_xprofile_repeater_field_get_children()

Return children of repeated field sets.
bp-xprofile/bp-xprofile-repeaters.php: xprofile_delete_clones_on_template_delete()

Delete repeater/clone fields when the main/template field is deleted.
bp-xprofile/bp-xprofile-admin.php: xprofile_admin_screen()

Output the main XProfile management screen.
bp-xprofile/bp-xprofile-admin.php: xprofile_admin_manage_field()

Handles the adding or editing of profile field data for a user.
bp-xprofile/bp-xprofile-admin.php: xprofile_admin_delete_field()

Handles the deletion of a profile field (or field option).
bp-xprofile/bp-xprofile-caps.php: bp_xprofile_grant_bp_xprofile_change_field_visibility_for_logged_out_users()

Grant the ‘bp_xprofile_change_field_visibility’ cap to logged-out users.
bp-members/bp-members-functions.php: bp_core_validate_user_signup()

Validate a user name and email address when creating a new user.
bp-members/bp-members-functions.php: bp_core_activate_signup()

Activate a signup, as identified by an activation key.
bp-members/classes/class-bp-signup.php: BP_Signup::add_backcompat()

Create a WP user at signup.
bp-core/admin/settings/bp-admin-setting-xprofile.php: BP_Admin_Setting_Xprofile::settings_save()
Show 24 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.