Changeset 48184 for trunk/src/wp-includes/canonical.php

Timestamp:

06/26/2020 06:38:51 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock improvements.

See #49572.

File:

• trunk/src/wp-includes/canonical.php (modified) (5 diffs)

trunk/src/wp-includes/canonical.php

@@ -851 +851 @@
      *
      * Passing a false value to the filter will disable the URL guessing
-     * and return early.
+     * and return early without performing a redirect.
      *
      * @since 5.5.0
@@ -863 +863 @@
 
     /**
-     * Filters whether to short-circuit redirect URL guessing for 404 requests.
+     * Short-circuits the redirect URL guessing for 404 requests.
      *
      * Passing a non-null value to the filter will effectively short-circuit
@@ -870 +870 @@
      * @since 5.5.0
      *
-     * @param null|string $pre Whether to short-circuit redirect guess 404 permalink.
-     *                         Default null to continue with the URL guessing.
+     * @param null|string|false $pre Whether to short-circuit guessing the redirect for a 404.
+     *                               Default null to continue with the URL guessing.
      */
     $pre = apply_filters( 'pre_redirect_guess_404_permalink', null );
@@ -880 +880 @@
     if ( get_query_var( 'name' ) ) {
         /**
-         * Filters whether to perform a strict or loose guess.
+         * Filters whether to perform a strict guess for a 404 redirect.
          *
          * Passing a truthy value to the filter will redirect only exact post_name matches.
@@ -886 +886 @@
          * @since 5.5.0
          *
-         * @param bool $strict_guess Whether to perform a strict/exact guess. Default false (loose guess).
+         * @param bool $strict_guess Whether to perform a strict guess. Default false (loose guess).
          */
         $strict_guess = apply_filters( 'strict_redirect_guess_404_permalink', false );