Changeset 8782 for trunk/wp-includes/registration.php

Timestamp:

08/30/2008 09:23:43 PM (15 years ago)

Author:

westi

Message:

phpDoc corrections for wp-includes. See #7550 props jacobsantos.

File:

• trunk/wp-includes/registration.php (modified) (7 diffs)

trunk/wp-includes/registration.php

@@ -7 +7 @@
 
 /**
- * username_exists() - Checks whether the given username exists.
+ * Checks whether the given username exists.
  *
  * @since 2.0.0
@@ -23 +23 @@
 
 /**
- * email_exists() - Checks whether the given email exists.
+ * Checks whether the given email exists.
  *
  * @since 2.1.0
@@ -39 +39 @@
 
 /**
- * validate_username() - Checks whether an username is valid.
+ * Checks whether an username is valid.
  *
  * @since 2.0.1
@@ -54 +54 @@
 
 /**
- * wp_insert_user() - Insert an user into the database.
- *
- * Can update a current user or insert a new user based on whether
- * the user's ID is present.
- *
- * Can be used to update the user's info (see below), set the user's
- * role, and set the user's preference on whether they want the rich
- * editor on.
- *
- * Most of the $userdata array fields have filters associated with
- * the values. The exceptions are 'rich_editing', 'role', 'jabber',
- * 'aim', 'yim', 'user_registered', and 'ID'. The filters have the
- * prefix 'pre_user_' followed by the field name. An example using
- * 'description' would have the filter called, 'pre_user_description'
- * that can be hooked into.
+ * Insert an user into the database.
+ *
+ * Can update a current user or insert a new user based on whether the user's ID
+ * is present.
+ *
+ * Can be used to update the user's info (see below), set the user's role, and
+ * set the user's preference on whether they want the rich editor on.
+ *
+ * Most of the $userdata array fields have filters associated with the values.
+ * The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim',
+ * 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed
+ * by the field name. An example using 'description' would have the filter
+ * called, 'pre_user_description' that can be hooked into.
  *
  * The $userdata array can contain the following fields:
@@ -78 +76 @@
  * 'user_url' - A string containing the user's URL for the user's web site.
  * 'user_email' - A string containing the user's email address.
- * 'display_name' - A string that will be shown on the site. Defaults to user's username.
- *      It is likely that you will want to change this, for both appearance and security
- *      through obscurity (that is if you don't use and delete the default 'admin' user).
+ * 'display_name' - A string that will be shown on the site. Defaults to user's
+ *      username. It is likely that you will want to change this, for both
+ *      appearance and security through obscurity (that is if you don't use and
+ *      delete the default 'admin' user).
  * 'nickname' - The user's nickname, defaults to the user's username.
  * 'first_name' - The user's first name.
  * 'last_name' - The user's last name.
  * 'description' - A string containing content about the user.
- * 'rich_editing' - A string for whether to enable the rich editor or not. False if not
- *      empty.
+ * 'rich_editing' - A string for whether to enable the rich editor or not. False
+ *      if not empty.
  * 'user_registered' - The date the user registered. Format is 'Y-m-d H:i:s'.
  * 'role' - A string used to set the user's role.
@@ -209 +208 @@
 
 /**
- * wp_update_user() - Update an user in the database
- *
- * It is possible to update a user's password by specifying the
- * 'user_pass' value in the $userdata parameter array.
- *
- * If $userdata does not contain an 'ID' key, then a new user
- * will be created and the new user's ID will be returned.
- *
- * If current user's password is being updated, then the cookies
- * will be cleared.
+ * Update an user in the database.
+ *
+ * It is possible to update a user's password by specifying the 'user_pass'
+ * value in the $userdata parameter array.
+ *
+ * If $userdata does not contain an 'ID' key, then a new user will be created
+ * and the new user's ID will be returned.
+ *
+ * If current user's password is being updated, then the cookies will be
+ * cleared.
  *
  * @since 2.0.0
@@ -259 +258 @@
 
 /**
- * wp_create_user() - A simpler way of inserting an user into the database.
+ * A simpler way of inserting an user into the database.
  *
  * Creates a new user with just the username, password, and email. For a more