Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-23 09:37:42 +01:00
Code Issues Projects Releases Wiki Activity

Improve the @param docs for src/wp-includes/pluggable*.

Browse Source 
See #30224.

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


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

8
wp-includes/pluggable-deprecated.php
View File

@ -28,7 +28,7 @@ if ( !function_exists('set_current_user') ) :
* *
* @param int|null $id User ID. * @param int|null $id User ID.
* @param string $name Optional. The user's username * @param string $name Optional. The user's username
* @return object returns wp_set_current_user() * @return WP_User returns wp_set_current_user()
*/ */
function set_current_user($id, $name = '') { function set_current_user($id, $name = '') {
_deprecated_function( __FUNCTION__, '3.0', 'wp_set_current_user()' ); _deprecated_function( __FUNCTION__, '3.0', 'wp_set_current_user()' );
@ -148,9 +148,9 @@ if ( !function_exists('wp_login') ) :
* @deprecated Use wp_signon() * @deprecated Use wp_signon()
* @global string $error Error when false is returned * @global string $error Error when false is returned
* *
* @param string $username User's username * @param string $username User's username
* @param string $password User's password * @param string $password User's password
* @param bool $deprecated Not used * @param string $deprecated Not used
* @return bool False on login failure, true on successful check * @return bool False on login failure, true on successful check
*/ */
function wp_login($username, $password, $deprecated = '') { function wp_login($username, $password, $deprecated = '') {

18
wp-includes/pluggable.php
View File

@ -73,7 +73,7 @@ if ( !function_exists('get_currentuserinfo') ) :
* *
* @uses $current_user Checks if the current user is set * @uses $current_user Checks if the current user is set
* *
* @return bool|null False on XML-RPC Request and invalid auth cookie. Null when current user set. * @return null|false False on XML-RPC Request and invalid auth cookie. Null when current user set.
*/ */
function get_currentuserinfo() { function get_currentuserinfo() {
global $current_user; global $current_user;
@ -1064,8 +1064,8 @@ if ( !function_exists('check_admin_referer') ) :
* *
* @since 1.2.0 * @since 1.2.0
* *
* @param string $action Action nonce * @param int|string $action Action nonce
* @param string $query_arg where to look for nonce in $_REQUEST (since 2.5) * @param string $query_arg Where to look for nonce in $_REQUEST (since 2.5)
*/ */
function check_admin_referer($action = -1, $query_arg = '_wpnonce') { function check_admin_referer($action = -1, $query_arg = '_wpnonce') {
if ( -1 == $action ) if ( -1 == $action )
@ -1098,8 +1098,8 @@ if ( !function_exists('check_ajax_referer') ) :
* *
* @since 2.0.3 * @since 2.0.3
* *
* @param string $action Action nonce * @param int|string $action Action nonce
* @param string $query_arg where to look for nonce in $_REQUEST (since 2.5) * @param string $query_arg Where to look for nonce in $_REQUEST (since 2.5)
*/ */
function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) { function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
$nonce = ''; $nonce = '';
@ -1666,7 +1666,7 @@ if ( !function_exists('wp_nonce_tick') ) :
* *
* @since 2.5.0 * @since 2.5.0
* *
* @return int * @return float Float value rounded up to the next highest integer.
*/ */
function wp_nonce_tick() { function wp_nonce_tick() {
/** /**
@ -1691,7 +1691,7 @@ if ( !function_exists('wp_verify_nonce') ) :
* *
* @since 2.0.3 * @since 2.0.3
* *
* @param string $nonce Nonce that was used in the form to verify * @param string $nonce Nonce that was used in the form to verify
* @param string|int $action Should give context to what is taking place and be the same when nonce was created. * @param string|int $action Should give context to what is taking place and be the same when nonce was created.
* @return bool Whether the nonce check passed or failed. * @return bool Whether the nonce check passed or failed.
*/ */
@ -1741,7 +1741,7 @@ if ( !function_exists('wp_create_nonce') ) :
* *
* @since 2.0.3 * @since 2.0.3
* *
* @param string $action Scalar value to add context to the nonce. * @param string|int $action Scalar value to add context to the nonce.
* @return string The token. * @return string The token.
*/ */
function wp_create_nonce($action = -1) { function wp_create_nonce($action = -1) {
@ -2090,7 +2090,7 @@ if ( !function_exists( 'get_avatar' ) ) :
* @param int $size Size of the avatar image * @param int $size Size of the avatar image
* @param string $default URL to a default image to use if no avatar is available * @param string $default URL to a default image to use if no avatar is available
* @param string $alt Alternative text to use in image tag. Defaults to blank * @param string $alt Alternative text to use in image tag. Defaults to blank
* @return string `<img>` tag for the user's avatar. * @return false|string `<img>` tag for the user's avatar.
*/ */
function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) { function get_avatar( $id_or_email, $size = '96', $default = '', $alt = false ) {
if ( ! get_option('show_avatars') ) if ( ! get_option('show_avatars') )

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30666'; $wp_version = '4.1-beta2-30667';
/** /**
* 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.