bp_xprofile_get_member_display_name( int $user_id = null )

Get the display_name for member based on user_id

Description

Parameters

$display_name

(Required)

$user_id

(Optional)

Default value: null

Return

(string)

Source

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

function bp_xprofile_get_member_display_name( $user_id = null ) {
    // some cases it calls the filter directly, therefore no user id is passed
    if ( ! $user_id ) {
        return false;
    }
 
    $format = bp_get_option( 'bp-display-name-format' );
 
    switch ( $format ) {
        case 'first_name':
 
            // Get First Name Field Id.
            $first_name_id = (int) bp_get_option( 'bp-xprofile-firstname-field-id' );
 
            $display_name = xprofile_get_field_data( $first_name_id, $user_id );
 
            if ( '' === $display_name ) {
                $display_name = get_user_meta( $user_id, 'first_name', true );
                if ( empty( $display_name ) ) {
                    $display_name = get_user_meta( $user_id, 'nickname', true );
                }
                xprofile_set_field_data( $first_name_id, $user_id, $display_name );
            }
 
            // Get Nick Name Field Id.
            $nickname_id = (int) bp_get_option( 'bp-xprofile-nickname-field-id' );
            $nick_name   = xprofile_get_field_data( $nickname_id, $user_id );
 
            if ( '' === trim( $nick_name ) ) {
                $user = get_userdata( $user_id );
                // make sure nickname is valid
                $nickname = get_user_meta( $user_id, 'nickname', true );
                $nickname = sanitize_title( $nickname );
                $invalid  = bp_xprofile_validate_nickname_value( '', $nickname_id, $nickname, $user_id );
 
                // or use the user_nicename
                if ( ! $nickname || $invalid ) {
                    $nickname = $user->user_nicename;
                }
                xprofile_set_field_data( $nickname_id, $user_id, $nickname );
            }
 
            break;
        case 'first_last_name':
 
            // Get First Name Field Id.
            $first_name_id = (int) bp_get_option( 'bp-xprofile-firstname-field-id' );
            // Get Last Name Field Id.
            $last_name_id      = (int) bp_get_option( 'bp-xprofile-lastname-field-id' );
            $result_first_name = xprofile_get_field_data( $first_name_id, $user_id );
            $result_last_name  = xprofile_get_field_data( $last_name_id, $user_id );
 
            if ( '' === $result_first_name ) {
                $result_first_name = get_user_meta( $user_id, 'first_name', true );
                if ( empty( $result_first_name ) ) {
                    $result_first_name = get_user_meta( $user_id, 'nickname', true );
                }
                xprofile_set_field_data( $first_name_id, $user_id, $result_first_name );
            }
 
            if ( '' === $result_last_name ) {
                $result_last_name = get_user_meta( $user_id, 'last_name', true );
                xprofile_set_field_data( $last_name_id, $user_id, $result_last_name );
            }
 
            $display_name = implode( ' ',
                array_filter( [
                    isset( $result_first_name ) ? $result_first_name : '',
                    isset( $result_last_name ) ? $result_last_name : '',
                ] ) );
 
            // Get Nick Name Field Id.
            $nickname_id = (int) bp_get_option( 'bp-xprofile-nickname-field-id' );
            $nick_name   = xprofile_get_field_data( $nickname_id, $user_id );
 
            if ( '' === trim( $nick_name ) ) {
                $user = get_userdata( $user_id );
                // make sure nickname is valid
                $nickname = get_user_meta( $user_id, 'nickname', true );
                $nickname = sanitize_title( $nickname );
                $invalid  = bp_xprofile_validate_nickname_value( '', $nickname_id, $nickname, $user_id );
 
                // or use the user_nicename
                if ( ! $nickname || $invalid ) {
                    $nickname = $user->user_nicename;
                }
                xprofile_set_field_data( $nickname_id, $user_id, $nickname );
            }
 
            break;
        case 'nickname':
 
            // Get Nick Name Field Id.
            $nickname_id  = (int) bp_get_option( 'bp-xprofile-nickname-field-id' );
            $display_name = xprofile_get_field_data( $nickname_id, $user_id );
 
            if ( '' === trim( $display_name ) ) {
                $user = get_userdata( $user_id );
                // make sure nickname is valid
                $nickname = get_user_meta( $user_id, 'nickname', true );
                $nickname = sanitize_title( $nickname );
                $invalid  = bp_xprofile_validate_nickname_value( '', $nickname_id, $nickname, $user_id );
 
                // or use the user_nicename
                if ( ! $nickname || $invalid ) {
                    $nickname = $user->user_nicename;
                }
                xprofile_set_field_data( $nickname_id, $user_id, $nickname );
                $display_name = $nickname;
 
            }
            break;
    }
 
    return apply_filters( 'bp_xprofile_get_member_display_name', trim( $display_name ), $user_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.0.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-filters.php: bp_xprofile_validate_nickname_value()	Validate nickname approved characters and format.
bp-xprofile/bp-xprofile-functions.php: xprofile_get_field_data()	Fetches profile data for a specific field for the user.
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-core/bp-core-options.php: bp_get_option()	Retrieve an option.

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-core/deprecated/buddyboss/1.2.2.php: bp_core_get_member_display_name()	Get the display_name for member based on user_id

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