Contents

Code Reference Classes BP_XProfile_Field BP_XProfile_Field::get_instance()

BP_XProfile_Field::get_instance( int $field_id, int|null $user_id = null, bool $get_data = true )

Retrieve a BP_XProfile_Field instance.

Description

Parameters

$field_id

(int) (Required) ID of the field.

$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|false) Field object if found, otherwise false.

Source

File: bp-xprofile/classes/class-bp-xprofile-field.php 

	public static function get_instance( $field_id, $user_id = null, $get_data = true ) {
		global $wpdb;

		$field_id = (int) $field_id;
		if ( ! $field_id ) {
			return false;
		}

		return new self( $field_id, $user_id, $get_data );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.4.0 Introduced.
Used By
Used By Description
bp-xprofile/bp-xprofile-functions.php: xprofile_get_field()

Get a profile field object.

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.