Changeset 30667

Timestamp:

11/30/2014 10:18:33 PM (10 years ago)

Author:

wonderboymusic

Message:

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

See #30224.

Location:

trunk/src/wp-includes

Files:

• pluggable-deprecated.php (modified) (2 diffs)
• pluggable.php (modified) (7 diffs)

trunk/src/wp-includes/pluggable-deprecated.php

@@ -29 +29 @@
  * @param int|null $id User ID.
  * @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 = '') {
@@ -149 +149 @@
  * @global string $error Error when false is returned
  *
- * @param string $username User's username
- * @param string $password User's password
- * @param bool $deprecated Not used
+ * @param string $username   User's username
+ * @param string $password   User's password
+ * @param string $deprecated Not used
  * @return bool False on login failure, true on successful check
  */

trunk/src/wp-includes/pluggable.php

@@ -74 +74 @@
  * @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() {
@@ -1065 +1065 @@
  * @since 1.2.0
  *
- * @param string $action Action nonce
- * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
+ * @param int|string $action    Action nonce
+ * @param string     $query_arg Where to look for nonce in $_REQUEST (since 2.5)
  */
 function check_admin_referer($action = -1, $query_arg = '_wpnonce') {
@@ -1099 +1099 @@
  * @since 2.0.3
  *
- * @param string $action Action nonce
- * @param string $query_arg where to look for nonce in $_REQUEST (since 2.5)
+ * @param int|string $action    Action nonce
+ * @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 ) {
@@ -1667 +1667 @@
  * @since 2.5.0
  *
- * @return int
+ * @return float Float value rounded up to the next highest integer.
  */
 function wp_nonce_tick() {
@@ -1692 +1692 @@
  * @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.
  * @return bool Whether the nonce check passed or failed.
@@ -1742 +1742 @@
  * @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.
  */
@@ -2091 +2091 @@
  * @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
- * @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 ) {