Changeset 34389 for trunk/src/wp-includes/class-wp-user.php

Timestamp:

09/22/2015 10:01:01 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Fix some syntactical issues and add missing parameter and return descriptions to the DocBlock for the WP_User::__get() magic method.

See #32246.

File:

• trunk/src/wp-includes/class-wp-user.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-user.php

@@ -284 +284 @@
 
     /**
-     * Magic method for accessing custom fields
+     * Magic method for accessing custom fields.
      *
      * @since 3.3.0
-     * @param string $key
-     * @return mixed
+     * @access public
+     *
+     * @param string $key User meta key to retrieve.
+     * @return mixed Value of the given user meta key (if set). If `$key` is 'id', the user ID.
      */
     public function __get( $key ) {