Changeset 57120 for trunk/src/wp-admin/includes/user.php

Timestamp:

11/17/2023 01:27:23 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve some DocBlocks and inline comments per the documentation standards.

Follow-up to [56834], [56836], [56837], [56838].

Props kebbet, costdev, mukesh27, SergeyBiryukov.
See #59651.

File:

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

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

@@ -639 +639 @@
  * @since 5.6.0
  * @since 6.2.0 Allow insecure HTTP connections for the local environment.
- * @since 6.3.2 Validates the success and reject URLs to prevent javascript pseudo protocol being executed.
+ * @since 6.3.2 Validates the success and reject URLs to prevent `javascript` pseudo protocol from being executed.
  *
  * @param array   $request {
@@ -701 +701 @@
 
 /**
- * Validates the redirect URL protocol scheme. The protocol can be anything except http and javascript.
+ * Validates the redirect URL protocol scheme. The protocol can be anything except `http` and `javascript`.
  *
  * @since 6.3.2
  *
- * @param string $url - The redirect URL to be validated.
- *
+ * @param string $url The redirect URL to be validated.
  * @return true|WP_Error True if the redirect URL is valid, a WP_Error object otherwise.
  */
@@ -729 +728 @@
      * @since 6.3.2
      *
-     * @param string[]  $bad_protocols Array of invalid protocols.
-     * @param string    $url The redirect URL to be validated.
+     * @param string[] $bad_protocols Array of invalid protocols.
+     * @param string   $url The redirect URL to be validated.
      */
-    $invalid_protocols = array_map( 'strtolower', apply_filters( 'wp_authorize_application_redirect_url_invalid_protocols', $bad_protocols, $url ) );
+    $invalid_protocols = apply_filters( 'wp_authorize_application_redirect_url_invalid_protocols', $bad_protocols, $url );
+    $invalid_protocols = array_map( 'strtolower', $invalid_protocols );
 
     $scheme   = wp_parse_url( $url, PHP_URL_SCHEME );
@@ -738 +738 @@
     $is_local = 'local' === wp_get_environment_type();
 
-    // validates if the proper URI format is applied to the $url
+    // Validates if the proper URI format is applied to the URL.
     if ( empty( $host ) || empty( $scheme ) || in_array( strtolower( $scheme ), $invalid_protocols, true ) ) {
         return new WP_Error(