xprofile_get_field_data( mixed $field, int $user_id, string $multi_format = 'array' )

Fetches profile data for a specific field for the user.

Description

When the field value is serialized, this function unserializes and filters each item in the array.

Parameters

$field

(Required) The ID of the field, or the $name of the field.

$user_id

(Required) The ID of the user.

$multi_format

(Optional) How should array data be returned? 'comma' if you want a comma-separated string; 'array' if you want an array.

Default value: 'array'

Return

(mixed) The profile field data.

Source

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

function xprofile_get_field_data( $field, $user_id = 0, $multi_format = 'array' ) {
 
    if ( empty( $user_id ) ) {
        $user_id = bp_displayed_user_id();
    }
 
    if ( empty( $user_id ) ) {
        return false;
    }
 
    if ( is_numeric( $field ) ) {
        $field_id = $field;
    } else {
        $field_id = xprofile_get_field_id_from_name( $field );
    }
 
    if ( empty( $field_id ) ) {
        return false;
    }
 
    $values = maybe_unserialize( BP_XProfile_ProfileData::get_value_byid( $field_id, $user_id ) );
 
    if ( is_array( $values ) ) {
        $data = array();
        foreach( (array) $values as $value ) {
 
            /**
             * Filters the field data value for a specific field for the user.
             *
             * @since BuddyPress 1.0.0
             *
             * @param string $value    Value saved for the field.
             * @param int    $field_id ID of the field being displayed.
             * @param int    $user_id  ID of the user being displayed.
             */
            $data[] = apply_filters( 'xprofile_get_field_data', $value, $field_id, $user_id );
        }
 
        if ( 'comma' == $multi_format ) {
            $data = implode( ', ', $data );
        }
    } else {
        /** This filter is documented in bp-xprofile/bp-xprofile-functions.php */
        $data = apply_filters( 'xprofile_get_field_data', $values, $field_id, $user_id );
    }
 
    return $data;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-xprofile/bp-xprofile-functions.php: xprofile_get_field_id_from_name()	Returns the ID for the field based on the field name.
bp-xprofile/bp-xprofile-functions.php: xprofile_get_field_data	Filters the field data value for a specific field for the user.
bp-xprofile/classes/class-bp-xprofile-profiledata.php: BP_XProfile_ProfileData::get_value_byid()	Get profile field values by field ID and user IDs.
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.

Used By
Used By	Description
bp-xprofile/bp-xprofile-filters.php: xprofile_filter_get_user_display_name()	Conditionally filters ‘bp_core_get_user_displayname’ to return user diaplay name from xprofile.
bp-xprofile/classes/class-bp-rest-xprofile-repeater-endpoint.php: BP_REST_XProfile_Repeater_Endpoint::bp_profile_repeaters_update_field_data()	Update Field data with delete.
bp-friends/classes/class-bp-core-friends-widget.php: BP_Core_Friends_Widget::get_user_display_name()	Display user name to ‘First Name’ when they have selected ‘First Name & Last Name’ in display format.
bp-core/classes/class-bp-core-follow-follower-widget.php: BP_Core_Follow_Follower_Widget::get_user_display_name()	Display user name to ‘First Name’ when they have selected ‘First Name & Last Name’ in display format.
bp-core/classes/class-bp-core-follow-following-widget.php: BP_Core_Follow_Following_Widget::get_user_display_name()	Display user name to ‘First Name’ when they have selected ‘First Name & Last Name’ in display format.
bp-core/admin/bp-core-admin-tools.php: bp_admin_repair_nickname_value()
bp-members/bp-members-functions.php: bp_infusion_soft_sync_bp_data()	Sync the BP data based on the WP data via infusion soft API.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_get_member_display_name()	Get the display_name for member based on user_id
bp-xprofile/bp-xprofile-functions.php: xprofile_sync_wp_profile()	Sync xprofile data to the standard built in WordPress profile data.
bp-xprofile/bp-xprofile-template.php: bp_get_profile_field_data()	Return XProfile field data.
bp-xprofile/screens/edit.php: xprofile_screen_edit_profile()	Handles the display of the profile edit page by loading the correct template file.
bp-xprofile/classes/class-bp-xprofile-user-admin.php: BP_XProfile_User_Admin::user_admin_load()	Save the profile fields in Members community profile page.
bp-xprofile/classes/class-bp-xprofile-profiledata.php: BP_XProfile_ProfileData::get_fullname()	Get fullname for provided user ID.
bp-members/bp-members-functions.php: bp_get_user_gender_pronoun_type()	Return “his”, “her” or “their” based on member selected gender, used in activity feeds.
bp-members/bp-members-functions.php: bp_core_get_user_displayname()	Fetch the display name for a user.
bp-core/gdpr/class-bp-xprofile-export.php: BP_Xprofile_Export::get_data()	Returns the data & count of activities by page and user.

Show 11 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.

Contents