Contents

Code Reference Functions bp_xprofile_get_meta()

bp_xprofile_get_meta( int $object_id, string $object_type, string $meta_key = '', bool $single = true )

Get a piece of xprofile metadata.

Description

Note that the default value of $single is true, unlike in the case of the underlying get_metadata() function. This is for backward compatibility.

Parameters

$object_id

(Required) ID of the object the metadata belongs to.

$object_type

(Required) Type of object. 'group', 'field', or 'data'.

$meta_key

(Optional) Key of the metadata being fetched. If omitted, all metadata for the object will be retrieved.

Default value: ''

$single

(Optional) If true, return only the first value of the specified meta_key. This parameter has no effect if meta_key is not specified. Default: true.

Default value: true

Return

(mixed) Meta value if found. False on failure.

Source

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

1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
function bp_xprofile_get_meta( $object_id, $object_type, $meta_key = '', $single = true ) {
    // Sanitize object type.
    if ( ! in_array( $object_type, array( 'group', 'field', 'data' ) ) ) {
        return false;
    }
 
    add_filter( 'query', 'bp_filter_metaid_column_name' );
    add_filter( 'query', 'bp_xprofile_filter_meta_query' );
    $retval = get_metadata( 'xprofile_' . $object_type, $object_id, $meta_key, $single );
    remove_filter( 'query', 'bp_filter_metaid_column_name' );
    remove_filter( 'query', 'bp_xprofile_filter_meta_query' );
 
    return $retval;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.5.0 Introduced.
Used By
Used By Description
bp-xprofile/classes/class-bp-rest-xprofile-repeater-endpoint.php: BP_REST_XProfile_Repeater_Endpoint::update_item_permissions_check()

Check if a given request has access to update a Repeater Group.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_get_user_progress()

Function returns logged in user progress based on options selected in the widget form.
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-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::assemble_response_data()

Assembles single XProfile field data for return as an object.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_gender_type_options()

Get Gender field options
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_repeater_fields_data()

Get Repeater field data.
bp-xprofile/classes/class-bp-rest-xprofile-repeater-endpoint.php: BP_REST_XProfile_Repeater_Endpoint::create_item_permissions_check()

Check if a given request has access to create a new Repeater Group.
bp-xprofile/classes/class-bp-rest-xprofile-repeater-endpoint.php: BP_REST_XProfile_Repeater_Endpoint::delete_item_permissions_check()

Check if a given request has access to delete a XProfile Repeater field.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::update_item()

Update a XProfile field group.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::prepare_item_for_response()

Prepares single XProfile field group data for return as an object.
bp-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::signup_form_items()

Retrieve Signup Form Fields.
bp-xprofile/classes/class-bp-xprofile-field-type-member-types.php: BP_XProfile_Field_Type_Member_Types::get_selected_post_type()

Get the terms content.
bp-xprofile/bp-xprofile-filters.php: bp_xprofile_validate_phone_value()

Validate phone number format.
bp-xprofile/classes/class-bp-xprofile-group.php: BP_XProfile_Group::fetch_visibility_level()

Fetch the field visibility level for the fields returned by the query.
bp-xprofile/classes/class-bp-xprofile-group.php: BP_XProfile_Group::get_group_meta()
bp-xprofile/classes/class-bp-xprofile-field-type-telephone.php: BP_XProfile_Field_Type_Telephone::edit_field_html()

Output the edit field HTML for this field type.
bp-xprofile/classes/class-bp-xprofile-field-type-telephone.php: BP_XProfile_Field_Type_Telephone::get_field_settings()

Get all settings for field.
bp-xprofile/classes/class-bp-xprofile-field-type-telephone.php: BP_XProfile_Field_Type_Telephone::input_mask_script()

Prints the jquery input mask script
bp-xprofile/classes/class-bp-xprofile-field-type-gender.php: BP_XProfile_Field_Type_Gender::admin_new_field_html()

Output HTML for this field type’s children options on the wp-admin Profile Fields “Add Field” and “Edit Field” screens.
bp-xprofile/classes/class-bp-xprofile-field-type-gender.php: BP_XProfile_Field_Type_Gender::edit_field_options_html()

Output the edit field options HTML for this field type.
bp-xprofile/classes/class-bp-xprofile-field-type-datebox.php: BP_XProfile_Field_Type_Datebox::get_field_settings()

Get settings for a given date field.
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::get_member_types()

Gets the profile types to which this field should be available.
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::get_default_visibility()

Get the field’s default visibility setting.
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::get_allow_custom_visibility()

Get whether the field’s default visibility can be overridden by users.
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::get_alternate_name()

Get alternate name of the field.
bp-xprofile/bp-xprofile-repeaters.php: bp_profile_repeaters_search_change_filter()

If the field is a main/template field for a repeater set, search should have a like ‘%s keyword %s’ query.
bp-xprofile/bp-xprofile-repeaters.php: xprofile_update_clone_positions_on_template_position_update()

Update position and group_id for all clone fields when a template/main field’s order is changed.
bp-xprofile/bp-xprofile-repeaters.php: bp_xprofile_repeater_field_get_children()

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

Open wrapper of repeater set – on edit profile screen
bp-xprofile/bp-xprofile-repeaters.php: bp_view_profile_repeaters_print_group_html_start()

Open wrapper of repeater set – on View profile screen
bp-xprofile/bp-xprofile-repeaters.php: bp_profile_repeater_is_data_valid_for_template_fields()
bp-xprofile/bp-xprofile-admin.php: xprofile_admin_field()

Handles the WYSIWYG display of each profile field on the edit screen.
bp-xprofile/bp-xprofile-caps.php: bp_xprofile_map_meta_caps()

Maps XProfile caps to built in WordPress caps.
bp-search/classes/class-bp-search-members.php: Bp_Search_Members::sql()

Generates sql for members search.
bp-core/profile-search/bps-admin.php: bp_search_ajax_option()

BuddyBoss Profile Search Admin
bp-core/profile-search/bps-admin.php: bp_ps_fields_box()

Output BuddyBoss profile search admin settings.
Show 31 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.