Changeset 43256 for trunk/src/wp-includes/user.php

Timestamp:

05/14/2018 02:52:49 PM (7 years ago)

Author:

azaozz

Message:

Privacy: improve inline documentation.

Props desrosj.
Fixes #44075.

File:

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

trunk/src/wp-includes/user.php

@@ -2817 +2817 @@
  * @access private
  *
- * @return array
+ * @return array List of core privacy action types.
  */
 function _wp_privacy_action_request_types() {
@@ -3282 +3282 @@
  *
  * @param string $action_name Action name of the request.
- * @return string
+ * @return string Human readable action name.
  */
 function wp_user_request_action_description( $action_name ) {
@@ -3408 +3408 @@
      *     Data relating to the account action email.
      *
-     *     @type WP_User_Request $request User request object.
+     *     @type WP_User_Request $request     User request object.
      *     @type string          $email       The email address this is being sent to.
      *     @type string          $description Description of the action being performed so the user knows what the email is for.
@@ -3453 +3453 @@
 
 /**
- * Valdate a user request by comparing the key with the request's key.
+ * Validate a user request by comparing the key with the request's key.
  *
  * @since 4.9.6