enmi-conf.org: comparison wp/wp-includes/class-wp-user.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 * @property string $spam
 * @property string $deleted
 * @property string $locale
 * @property string $rich_editing
 * @property string $syntax_highlighting
+* @property string $use_ssl
 */
 class WP_User {
 	/**
 	 * User data container.
 	 *
 		$this->for_site( $site_id );
 	}
 	/**
-	 * Return only the main user fields
+	 * Returns 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
+	 * @param string|int $value The field value.
-	 * @return object|false Raw user object
+	 * @return object|false Raw user object.
 	 */
 	public static function get_data_by( $field, $value ) {
 		global $wpdb;
 		// 'ID' is an alias of 'id'.
 			unset( self::$back_compat_keys[ $key ] );
 		}
 	}
 	/**
-	 * Determine whether the user exists in the database.
+	 * Determines 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 the value of a property or meta key.
 	 *
 	 * Retrieves from the users and usermeta table.
 	 *
 	 * @since 3.3.0
 	 *
 	public function get( $key ) {
 		return $this->__get( $key );
 	}
 	/**
-	 * Determine whether a property or meta key is set
+	 * Determines whether a property or meta key is set.
 	 *
 	 * Consults the users and usermeta tables.
 	 *
 	 * @since 3.3.0
 	 *
-	 * @param string $key Property
+	 * @param string $key Property.
 	 * @return bool
 	 */
 	public function has_prop( $key ) {
 		return $this->__isset( $key );
 	}
 	/**
-	 * Return an array representation.
+	 * Returns an array representation.
 	 *
 	 * @since 3.5.0
 	 *
 	 * @return array Array representation.
 	 */
 		}
 		return false;
 	}
 	/**
-	 * Set up capability object properties.
+	 * Sets up capability object properties.
 	 *
 	 * Will set the value for the 'cap_key' property to current database table
 	 * prefix, followed by 'capabilities'. Will then check to see if the
 	 * property matching the 'cap_key' exists and is an array. If so, it will be
 	 * used.
 		return $this->allcaps;
 	}
 	/**
-	 * Add role to user.
+	 * Adds role to user.
 	 *
 	 * Updates the user's meta data option with capabilities and roles.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name.
 	 */
 	public function add_role( $role ) {
 		if ( empty( $role ) ) {
+			return;
+		}
+		if ( in_array( $role, $this->roles, true ) ) {
 			return;
 		}
 		$this->caps[ $role ] = true;
 		update_user_meta( $this->ID, $this->cap_key, $this->caps );
 		 */
 		do_action( 'add_user_role', $this->ID, $role );
 	}
 	/**
-	 * Remove role from user.
+	 * Removes role from user.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name.
 	 */
 	public function remove_role( $role ) {
 		if ( ! in_array( $role, $this->roles, true ) ) {
 			return;
 		}
 		unset( $this->caps[ $role ] );
 		update_user_meta( $this->ID, $this->cap_key, $this->caps );
 		$this->get_role_caps();
 		$this->update_user_level_from_caps();
 		 */
 		do_action( 'remove_user_role', $this->ID, $role );
 	}
 	/**
-	 * Set the role of the user.
+	 * Sets the role of the user.
 	 *
 	 * This will remove the previous roles of the user and assign the user the
 	 * new one. You can set the role to an empty string and it will remove all
 	 * of the roles from the user.
 	 *
 		foreach ( (array) $this->roles as $oldrole ) {
 			unset( $this->caps[ $oldrole ] );
 		}
 		$old_roles = $this->roles;
 		if ( ! empty( $role ) ) {
 			$this->caps[ $role ] = true;
 			$this->roles         = array( $role => true );
 		} else {
-			$this->roles = false;
+			$this->roles = array();
 		}
 		update_user_meta( $this->ID, $this->cap_key, $this->caps );
 		$this->get_role_caps();
 		$this->update_user_level_from_caps();
+		foreach ( $old_roles as $old_role ) {
+			if ( ! $old_role || $old_role === $role ) {
+				continue;
+			}
+			/** This action is documented in wp-includes/class-wp-user.php */
+			do_action( 'remove_user_role', $this->ID, $old_role );
+		}
+		if ( $role && ! in_array( $role, $old_roles, true ) ) {
+			/** This action is documented in wp-includes/class-wp-user.php */
+			do_action( 'add_user_role', $this->ID, $role );
+		}
 		/**
 		 * Fires after the user's role has changed.
 		 *
 		 * @since 2.9.0
 		 */
 		do_action( 'set_user_role', $this->ID, $role, $old_roles );
 	}
 	/**
-	 * Choose the maximum level the user has.
+	 * Chooses the maximum level the user has.
 	 *
 	 * Will compare the level from the $item parameter against the $max
 	 * parameter. If the item is incorrect, then just the $max parameter value
 	 * will be returned.
 	 *
 			return $max;
 		}
 	}
 	/**
-	 * Update the maximum user level for the user.
+	 * Updates the maximum user level for the user.
 	 *
 	 * Updates the 'user_level' user metadata (includes prefix that is the
 	 * database table prefix) with the maximum user level. Gets the value from
 	 * the all of the capabilities that the user has.
 	 *
 		$this->user_level = array_reduce( array_keys( $this->allcaps ), array( $this, 'level_reduction' ), 0 );
 		update_user_meta( $this->ID, $wpdb->get_blog_prefix() . 'user_level', $this->user_level );
 	}
 	/**
-	 * Add capability and grant or deny access to capability.
+	 * Adds capability and grant or deny access to capability.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $cap   Capability name.
 	 * @param bool   $grant Whether to grant capability to user.
 		$this->get_role_caps();
 		$this->update_user_level_from_caps();
 	}
 	/**
-	 * Remove capability from user.
+	 * Removes capability from user.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $cap Capability name.
 	 */
 		$this->get_role_caps();
 		$this->update_user_level_from_caps();
 	}
 	/**
-	 * Remove all of the capabilities of the user.
+	 * Removes all of the capabilities of the user.
 	 *
 	 * @since 2.1.0
 	 *
 	 * @global wpdb $wpdb WordPress database abstraction object.
 	 */
 		return true;
 	}
 	/**
-	 * Convert numeric level to level capability name.
+	 * Converts numeric level to level capability name.
 	 *
 	 * Prepends 'level_' to level number.
 	 *
 	 * @since 2.0.0
 	 *
 	public function translate_level_to_cap( $level ) {
 		return 'level_' . $level;
 	}
 	/**
-	 * Set the site to operate on. Defaults to the current site.
+	 * Sets the site to operate on. Defaults to the current site.
 	 *
 	 * @since 3.0.0
 	 * @deprecated 4.9.0 Use WP_User::for_site()
 	 *
 	 * @param int $blog_id Optional. Site ID, defaults to current site.

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6