WP_User::__get( string $key ): mixed

Magic method for accessing custom fields.


Parameters

$key string Required
User meta key to retrieve.

Top ↑

Return

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


Top ↑

Source

File: wp-includes/class-wp-user.php. View all references

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;
}


Top ↑

Changelog

Changelog
Version Description
3.3.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.