WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve the `@param` docs for `src/wp-includes/user.php`. 

See #30224.

Built from https://develop.svn.wordpress.org/trunk@30666


git-svn-id: http://core.svn.wordpress.org/trunk@30656 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2014-11-30 22:11:23 +00:00
parent 5d75282328
commit 04a4cf6156
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
wp-includes/user.php
View File

@ -20,7 +20,7 @@
* @since 2.5.0 * @since 2.5.0
* *
* @param array $credentials Optional. User info in order to sign on. * @param array $credentials Optional. User info in order to sign on.
* @param bool $secure_cookie Optional. Whether to use secure cookie. * @param string|bool $secure_cookie Optional. Whether to use secure cookie.
* @return WP_User|WP_Error WP_User on success, WP_Error on failure. * @return WP_User|WP_Error WP_User on success, WP_Error on failure.
*/ */
function wp_signon( $credentials = array(), $secure_cookie = '' ) { function wp_signon( $credentials = array(), $secure_cookie = '' ) {
@ -229,7 +229,7 @@ function wp_authenticate_spam_check( $user ) {
* *
* @since 3.9.0 * @since 3.9.0
* *
* @param int|bool $user The user ID (or false) as received from the * @param int|bool $user_id The user ID (or false) as received from the
* determine_current_user filter. * determine_current_user filter.
* @return int|bool User ID if validated, false otherwise. If a user ID from * @return int|bool User ID if validated, false otherwise. If a user ID from
* an earlier filter callback is received, that value is returned. * an earlier filter callback is received, that value is returned.
@ -345,7 +345,7 @@ function get_current_user_id() {
* *
* @param string $option User option name. * @param string $option User option name.
* @param int $user Optional. User ID. * @param int $user Optional. User ID.
* @param bool $deprecated Use get_option() to check for an option in the options table. * @param string $deprecated Use get_option() to check for an option in the options table.
* @return mixed User option value on success, false on failure. * @return mixed User option value on success, false on failure.
*/ */
function get_user_option( $option, $user = 0, $deprecated = '' ) { function get_user_option( $option, $user = 0, $deprecated = '' ) {
@ -485,7 +485,7 @@ class WP_User_Query {
* *
* @since 3.1.0 * @since 3.1.0
* *
* @param string|array $args Optional. The query variables. * @param null|string|array $args Optional. The query variables.
* @return WP_User_Query * @return WP_User_Query
*/ */
public function __construct( $query = null ) { public function __construct( $query = null ) {
@ -2040,7 +2040,7 @@ function wp_create_user($username, $password, $email = '') {
* @since 3.3.0 * @since 3.3.0
* @access private * @access private
* *
* @param object $user WP_User instance. * @param WP_User $user WP_User instance.
* @return array * @return array
*/ */
function _get_additional_user_keys( $user ) { function _get_additional_user_keys( $user ) {

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30665'; $wp_version = '4.1-beta2-30666';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.