<?php

/**

 * User API: WP_User class

 *

 * @package WordPress

 * @subpackage Users

 * @since 4.4.0

 */

/**

 * Core class used to implement the WP_User object.

 *

 * @since 2.0.0

 *

 * @property string $nickname

 * @property string $description

 * @property string $user_description

 * @property string $first_name

 * @property string $user_firstname

 * @property string $last_name

 * @property string $user_lastname

 * @property string $user_login

 * @property string $user_pass

 * @property string $user_nicename

 * @property string $user_email

 * @property string $user_url

 * @property string $user_registered

 * @property string $user_activation_key

 * @property string $user_status

 * @property int    $user_level

 * @property string $display_name

 * @property string $spam

 * @property string $deleted

 * @property string $locale

 * @property string $rich_editing

 * @property string $syntax_highlighting

 */

class WP_User {

	/**

	 * User data container.

	 *

	 * @since 2.0.0

	 */

	public $data;

	/**

	 * The user's ID.

	 *

	 * @since 2.1.0

	 * @var int

	 */

	public $ID = 0;

	/**

	 * Capabilities that the individual user has been granted outside of those inherited from their role.

	 *

	 * @since 2.0.0

	 * @var bool[] Array of key/value pairs where keys represent a capability name

	 *             and boolean values represent whether the user has that capability.

	 */

	public $caps = array();

	/**

	 * User metadata option name.

	 *

	 * @since 2.0.0

	 * @var string

	 */

	public $cap_key;

	/**

	 * The roles the user is part of.

	 *

	 * @since 2.0.0

	 * @var string[]

	 */

	public $roles = array();

	/**

	 * All capabilities the user has, including individual and role based.

	 *

	 * @since 2.0.0

	 * @var bool[] Array of key/value pairs where keys represent a capability name

	 *             and boolean values represent whether the user has that capability.

	 */

	public $allcaps = array();

	/**

	 * The filter context applied to user data fields.

	 *

	 * @since 2.9.0

	 * @var string

	 */

	public $filter = null;

	/**

	 * The site ID the capabilities of this user are initialized for.

	 *

	 * @since 4.9.0

	 * @var int

	 */

	private $site_id = 0;

	/**

	 * @since 3.3.0

	 * @var array

	 */

	private static $back_compat_keys;

	/**

	 * Constructor.

	 *

	 * Retrieves the userdata and passes it to WP_User::init().

	 *

	 * @since 2.0.0

	 *

	 * @param int|string|stdClass|WP_User $id      User's ID, a WP_User object, or a user object from the DB.

	 * @param string                      $name    Optional. User's username

	 * @param int                         $site_id Optional Site ID, defaults to current site.

	 */

	public function __construct( $id = 0, $name = '', $site_id = '' ) {

		if ( ! isset( self::$back_compat_keys ) ) {

			$prefix                 = $GLOBALS['wpdb']->prefix;

			self::$back_compat_keys = array(

				'user_firstname'             => 'first_name',

				'user_lastname'              => 'last_name',

				'user_description'           => 'description',

				'user_level'                 => $prefix . 'user_level',

				$prefix . 'usersettings'     => $prefix . 'user-settings',

				$prefix . 'usersettingstime' => $prefix . 'user-settings-time',

			);

		}

		if ( $id instanceof WP_User ) {

			$this->init( $id->data, $site_id );

			return;

		} elseif ( is_object( $id ) ) {

			$this->init( $id, $site_id );

			return;

		}

		if ( ! empty( $id ) && ! is_numeric( $id ) ) {

			$name = $id;

			$id   = 0;

		}

		if ( $id ) {

			$data = self::get_data_by( 'id', $id );

		} else {

			$data = self::get_data_by( 'login', $name );

		}

		if ( $data ) {

			$this->init( $data, $site_id );

		} else {

			$this->data = new stdClass;

		}

	}

	/**

	 * Sets up object properties, including capabilities.

	 *

	 * @since 3.3.0

	 *

	 * @param object $data    User DB row object.

	 * @param int    $site_id Optional. The site ID to initialize for.

	 */

	public function init( $data, $site_id = '' ) {

		$this->data = $data;

		$this->ID   = (int) $data->ID;

		$this->for_site( $site_id );

	}

	/**

	 * Return only the main user fields

	 *

	 * @since 3.3.0

	 * @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.

	 *

	 * @global wpdb $wpdb WordPress database abstraction object.

	 *

	 * @param string     $field The field to query against: 'id', 'ID', 'slug', 'email' or 'login'.

	 * @param string|int $value The field value

	 * @return object|false Raw user object

	 */

	public static function get_data_by( $field, $value ) {

		global $wpdb;

		// 'ID' is an alias of 'id'.

		if ( 'ID' === $field ) {

			$field = 'id';

		}

		if ( 'id' === $field ) {

			// Make sure the value is numeric to avoid casting objects, for example,

			// to int 1.

			if ( ! is_numeric( $value ) ) {

				return false;

			}

			if ( $value < 1 ) {

				return false;

			}

		} else {

			$value = trim( $value );

		}

		if ( ! $value ) {

			return false;

		}

		switch ( $field ) {

			case 'id':

				$user_id  = $value;

				$db_field = 'ID';

				break;

			case 'slug':

				$user_id  = wp_cache_get( $value, 'userslugs' );

				$db_field = 'user_nicename';

				break;

			case 'email':

				$user_id  = wp_cache_get( $value, 'useremail' );

				$db_field = 'user_email';

				break;

			case 'login':

				$value    = sanitize_user( $value );

				$user_id  = wp_cache_get( $value, 'userlogins' );

				$db_field = 'user_login';

				break;

			default:

				return false;

		}

		if ( false !== $user_id ) {

			$user = wp_cache_get( $user_id, 'users' );

			if ( $user ) {

				return $user;

			}

		}

		$user = $wpdb->get_row(

			$wpdb->prepare(

				"SELECT * FROM $wpdb->users WHERE $db_field = %s LIMIT 1",

				$value

			)

		);

		if ( ! $user ) {

			return false;

		}

		update_user_caches( $user );

		return $user;

	}

	/**

	 * Magic method for checking the existence of a certain custom field.

	 *

	 * @since 3.3.0

	 *

	 * @param string $key User meta key to check if set.

	 * @return bool Whether the given user meta key is set.

	 */

	public function __isset( $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>'

				)

			);

			$key = 'ID';

		}

		if ( isset( $this->data->$key ) ) {

			return true;

		}

		if ( isset( self::$back_compat_keys[ $key ] ) ) {

			$key = self::$back_compat_keys[ $key ];

		}

		return metadata_exists( 'user', $this->ID, $key );

	}

	/**

	 * Magic method for accessing custom fields.

	 *

	 * @since 3.3.0

	 *

	 * @param string $key User meta key to retrieve.

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

	 */

	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;

	}

	/**

	 * Magic method for setting custom user fields.

	 *

	 * This method does not update custom fields in the database. It only stores

	 * the value on the WP_User instance.

	 *

	 * @since 3.3.0

	 *

	 * @param string $key   User meta key.

	 * @param mixed  $value User meta value.

	 */

	public function __set( $key, $value ) {

		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>'

				)

			);

			$this->ID = $value;

			return;

		}

		$this->data->$key = $value;

	}

	/**

	 * Magic method for unsetting a certain custom field.

	 *

	 * @since 4.4.0

	 *

	 * @param string $key User meta key to unset.

	 */

	public function __unset( $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>'

				)

			);

		}

		if ( isset( $this->data->$key ) ) {

			unset( $this->data->$key );

		}

		if ( isset( self::$back_compat_keys[ $key ] ) ) {

			unset( self::$back_compat_keys[ $key ] );

		}

	}

	/**

	 * Determine whether the user exists in the database.

	 *

	 * @since 3.4.0

	 *

	 * @return bool True if user exists in the database, false if not.

	 */

	public function exists() {

		return ! empty( $this->ID );

	}

	/**

	 * Retrieve the value of a property or meta key.

	 *

	 * Retrieves from the users and usermeta table.

	 *

	 * @since 3.3.0

	 *

	 * @param string $key Property

	 * @return mixed

	 */

	public function get( $key ) {

		return $this->__get( $key );

	}

	/**

	 * Determine whether a property or meta key is set

	 *

	 * Consults the users and usermeta tables.

	 *

	 * @since 3.3.0

	 *

	 * @param string $key Property

	 * @return bool

	 */

	public function has_prop( $key ) {

		return $this->__isset( $key );

	}

	/**

	 * Return an array representation.

	 *

	 * @since 3.5.0

	 *

	 * @return array Array representation.

	 */

	public function to_array() {

		return get_object_vars( $this->data );

	}

	/**

	 * Makes private/protected methods readable for backward compatibility.

	 *

	 * @since 4.3.0

	 *

	 * @param string $name      Method to call.