Changeset 48182

Timestamp:

06/26/2020 04:14:30 PM (6 years ago)

Author:

desrosj

Message:

Docs: Reword inline docs for better readability and clarity.

This improves the wording of the inline documentation for redirect_guess_404_permalink() and the related filters introduced in [47878].

Previously [47878,47885]
See #16557.

File:

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

trunk/src/wp-includes/canonical.php

@@ -836 +836 @@
 
 /**
- * Attempts to guess the correct URL based on query vars.
+ * Attempts to guess the correct URL for a 404 request based on query vars.
  *
  * @since 2.3.0
@@ -848 +848 @@
 
     /**
-     * Filters whether to do redirect guess of 404 requests.
+     * Filters whether to attempt to guess a redirect URL for a 404 request.
      *
      * Passing a false value to the filter will disable the URL guessing
@@ -855 +855 @@
      * @since 5.5.0
      *
-     * @param bool $do_redirect_guess Whether to do redirect guess 404 permalink.
-     *                                Default true.
+     * @param bool $do_redirect_guess Whether to attempt to guess a redirect URL
+     *                                for a 404 request. Default is true.
      */
     if ( false === apply_filters( 'do_redirect_guess_404_permalink', true ) ) {
@@ -863 +863 @@
 
     /**
-     * Filters whether to short-circuit redirect guess of 404 requests.
+     * Filters whether to short-circuit redirect URL guessing for 404 requests.
      *
      * Passing a non-null value to the filter will effectively short-circuit
@@ -879 +879 @@
 
     if ( get_query_var( 'name' ) ) {
-
         /**
-         * Filters whether to do a strict or loose guess.
+         * Filters whether to perform a strict or loose guess.
          *
          * Passing a truthy value to the filter will redirect only exact post_name matches.
@@ -887 +886 @@
          * @since 5.5.0
          *
-         * @param bool $strict_guess Whether to do a strict/exact guess. Default false.
+         * @param bool $strict_guess Whether to perform a strict/exact guess. Default false (loose guess).
          */
         $strict_guess = apply_filters( 'strict_redirect_guess_404_permalink', false );