Changeset 33687

Timestamp:

08/21/2015 05:32:53 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify the DocBlock summary and add a description and return description for _get_additional_user_keys().

As noted in the description, returned keys being set is dependent on the existence of those keys in user meta at the point where _get_additional_user_keys() is called in wp_update_user().

Fixes #29120.

File:

• trunk/src/wp-includes/user.php (modified) (2 diffs)

trunk/src/wp-includes/user.php

@@ -2352 +2352 @@
 
 /**
- * Return a list of meta keys that wp_insert_user() is supposed to set.
+ * Returns a list of meta keys to be (maybe) populated in wp_update_user().
+ *
+ * Values actually keys returned via this function are dependent on the presence
+ * of those keys in the user meta data.
  *
  * @since 3.3.0
@@ -2358 +2361 @@
  *
  * @param WP_User $user WP_User instance.
- * @return array
+ * @return array List of user keys to be populated in wp_update_user().
  */
 function _get_additional_user_keys( $user ) {