IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: http://svn.automattic.com/wordpress/trunk@8782 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi
2008-08-30 21:23:43 +00:00
parent 2f39e6219d
commit 9e89b4a99e
7 changed files with 235 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
wp-includes/registration.php
View File

@@ -6,7 +6,7 @@
*/
/**
* username_exists() - Checks whether the given username exists.
* Checks whether the given username exists.
*
* @since 2.0.0
*
@@ -22,7 +22,7 @@ function username_exists( $username ) {
}
/**
* email_exists() - Checks whether the given email exists.
* Checks whether the given email exists.
*
* @since 2.1.0
* @uses $wpdb
@@ -38,7 +38,7 @@ function email_exists( $email ) {
}
/**
* validate_username() - Checks whether an username is valid.
* Checks whether an username is valid.
*
* @since 2.0.1
* @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters
@@ -53,21 +53,19 @@ function validate_username( $username ) {
}
/**
* wp_insert_user() - Insert an user into the database.
* 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 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.
* 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.
* 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:
* 'ID' - An integer that will be used for updating an existing user.
@@ -77,15 +75,16 @@ function validate_username( $username ) {
* The default is the user's username.
* '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.
* 'jabber' - User's Jabber account.
@@ -208,16 +207,16 @@ function wp_insert_user($userdata) {
}
/**
* wp_update_user() - Update an user in the database
* 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.
* 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 $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.
* If current user's password is being updated, then the cookies will be
* cleared.
*
* @since 2.0.0
* @see wp_insert_user() For what fields can be set in $userdata
@@ -258,7 +257,7 @@ function wp_update_user($userdata) {
}
/**
* 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
* detail creation of a user, use wp_insert_user() to specify more infomation.