Title: WP_User::__get
Published: April 25, 2014
Last modified: April 28, 2025

---

# WP_User::__get( string $key ): mixed

## In this article

 * [Parameters](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#changelog)
 * [User Contributed Notes](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#user-contributed-notes)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#wp--skip-link--target)

Magic method for accessing custom fields.

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#parameters)󠁿

 `$key`stringrequired

User meta key to retrieve.

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#return)󠁿

 mixed Value of the given user meta key (if set). If `$key` is `'id'`, the user 
ID.

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#source)󠁿

    ```php
    public function __get( $key ) {
    	if ( 'id' === $key ) {
    		_deprecated_argument(
    			'WP_User->id',
    			'2.1.0',
    			sprintf(
    				/* translators: %s: WP_User->ID */
    				__( 'Use %s instead.' ),
    				'<code>WP_User->ID</code>'
    			)
    		);
    		return $this->ID;
    	}

    	if ( isset( $this->data->$key ) ) {
    		$value = $this->data->$key;
    	} else {
    		if ( isset( self::$back_compat_keys[ $key ] ) ) {
    			$key = self::$back_compat_keys[ $key ];
    		}
    		$value = get_user_meta( $this->ID, $key, true );
    	}

    	if ( $this->filter ) {
    		$value = sanitize_user_field( $key, $value, $this->ID, $this->filter );
    	}

    	return $value;
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/class-wp-user.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/class-wp-user.php#L310)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/class-wp-user.php#L310-L338)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#related)󠁿

| Uses | Description | 
| [get_user_meta()](https://developer.wordpress.org/reference/functions/get_user_meta/)`wp-includes/user.php` |

Retrieves user meta field for a user.

  | 
| [sanitize_user_field()](https://developer.wordpress.org/reference/functions/sanitize_user_field/)`wp-includes/user.php` |

Sanitizes user field based on context.

  | 
| [__()](https://developer.wordpress.org/reference/functions/__/)`wp-includes/l10n.php` |

Retrieves the translation of $text.

  | 
| [_deprecated_argument()](https://developer.wordpress.org/reference/functions/_deprecated_argument/)`wp-includes/functions.php` |

Marks a function argument as deprecated and inform when it has been used.

  |

[Show 2 more](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#)

| Used by | Description | 
| [WP_User::get()](https://developer.wordpress.org/reference/classes/wp_user/get/)`wp-includes/class-wp-user.php` |

Retrieves the value of a property or meta key.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#changelog)󠁿

| Version | Description | 
| [3.3.0](https://developer.wordpress.org/reference/since/3.3.0/) | Introduced. |

## 󠀁[User Contributed Notes](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#user-contributed-notes)󠁿

 1.  [Skip to note 2 content](https://developer.wordpress.org/reference/classes/wp_user/__get/?output_format=md#comment-content-5566)
 2.   [Mahdi](https://profiles.wordpress.org/mahdisarani/)  [  4 years ago  ](https://developer.wordpress.org/reference/classes/wp_user/__get/#comment-5566)
 3. [You must log in to vote on the helpfulness of this note](https://login.wordpress.org?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_user%2F__get%2F%23comment-5566)
    Vote results for this note: 0[You must log in to vote on the helpfulness of this note](https://login.wordpress.org?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_user%2F__get%2F%23comment-5566)
 4. **// Example Code Display user_firstname**
 5.     ```php
        $user = wp_get_current_user();
        if( $user->has_prop('user_firstname') ){
        	echo $user->__get('user_firstname');
        }
        ```
    
 6.  [Log in to add feedback](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_user%2F__get%2F%3Freplytocom%3D5566%23feedback-editor-5566)

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_user%2F__get%2F)
before being able to contribute a note or feedback.