This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

BP_XProfile_Field::is_default_field( int $field_id )

Return if a field ID is the default field.

Description

Parameters

$field_id: (Required) ID of field to check.

Return

(bool)

Source

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

private function is_default_field( $field_id = 0 ) {
 
    // Fallback to current field ID if none passed.
    if ( empty( $field_id ) ) {
        $field_id = $this->id;
    }
 
    $synced_fields = [
        bp_xprofile_firstname_field_id(),
        bp_xprofile_nickname_field_id(),
        bp_xprofile_lastname_field_id()
    ];
 
    if ( bp_get_option( 'bp-display-name-format' ) == 'first_last_name' ) {
        $synced_fields[] = bp_xprofile_lastname_field_id();
    }
 
    // Compare & return.
    return in_array( $field_id, array_filter( $synced_fields ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.3.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-options.php: bp_core_display_name_format()	Default display name format.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_nickname_field_id()	Get the field id of the nick name field, fallback to default fullname field
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_firstname_field_id()	Get the field id of the first name field

Used By
Used By	Description
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::required_metabox()	Output the metabox for setting if field is required or not.
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::type_metabox()	Output the metabox for setting what type of field this is.
bp-xprofile/classes/class-bp-xprofile-field.php: BP_XProfile_Field::default_field_hidden_inputs()	Output hidden fields used by default field.

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