Apply suggestions from code review

Co-authored-by: Juliette <[email protected]>

Author: rodrigoprimo

WordPress/Docs/WP/OptionAutoloadStandard.xml

@@ -7,7 +7,7 @@
     <![CDATA[
     When using `add_option()`, `update_option()`, `wp_set_options_autoload()`,
     `wp_set_option_autoload()`, or `wp_set_option_autoload_values()`, it is recommended to
-    explicitly set the autoload value to ensure predictable behavior. This value determines whether
+    explicitly set the autoload parameter to ensure predictable behavior. This paremeter determines whether
     the option is automatically loaded on every page load, which can impact site performance.
 
     Check https://felix-arntz.me/blog/autoloading-wordpress-options-efficiently-and-responsibly/ for
@@ -49,7 +49,7 @@ add_option(
     ]]>
     </standard>
     <code_comparison>
-        <code title="Valid: Using boolean values.">
+        <code title="Valid: Using a boolean value.">
         <![CDATA[
 update_option(
     'my_option',
@@ -58,7 +58,7 @@ update_option(
 );
         ]]>
         </code>
-        <code title="Invalid: Using deprecated values.">
+        <code title="Invalid: Using a deprecated value.">
         <![CDATA[
 update_option(
     'my_option',
@@ -114,7 +114,7 @@ wp_set_options_autoload(
 
 wp_set_option_autoload(
     'my_option',
-    <em>false</em>
+    <em>true</em>
 );
         ]]>
         </code>

WordPress/Sniffs/WP/OptionAutoloadSniff.php

@@ -86,7 +86,7 @@ final class OptionAutoloadSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @since 3.2.0
 	 *
-	 * @var string[]
+	 * @var array<string, string>
 	 */
 	protected static $fixable_values = array(
 		'yes' => 'true',
@@ -266,7 +266,8 @@ protected function handle_wp_set_option_autoload_values( array $options_param, $
 	 * @since 3.2.0
 	 *
 	 * @param int    $stackPtr      The position of the current token in the stack.
-	 * @param string $function_name The name of the function being checked.
+	 * @param string $function_name The token content (function name) which was matched
+	 *                              in lowercase.
 	 *
 	 * @return void
 	 */
@@ -290,8 +291,9 @@ protected function maybe_display_missing_autoload_warning( $stackPtr, $function_
 	 * @since 3.2.0
 	 *
 	 * @param array  $autoload_info Information about the autoload value (start and end tokens and
-	 *                              the clean and raw value).
-	 * @param string $function_name The name of the function being checked.
+	 *                              the clean value).
+	 * @param string $function_name The token content (function name) which was matched
+	 *                              in lowercase.
 	 *
 	 * @return void
 	 */
@@ -312,7 +314,7 @@ protected function check_autoload_value( array $autoload_info, $function_name )
 
 		$normalized_value = strtolower( $autoload_info['clean'] );
 
-		if ( T_NS_SEPARATOR === $this->tokens[ $param_first_token ]['code']
+		if ( \T_NS_SEPARATOR === $this->tokens[ $param_first_token ]['code']
 			&& $param_second_token
 			&& in_array( strtolower( $this->tokens[ $param_second_token ]['content'] ), self::$valid_values_add_and_update, true )
 		) {
@@ -334,7 +336,7 @@ protected function check_autoload_value( array $autoload_info, $function_name )
 			return;
 		}
 
-		if ( in_array( $this->tokens[ $param_first_token ]['code'], array( T_VARIABLE, T_STRING ), true )
+		if ( in_array( $this->tokens[ $param_first_token ]['code'], array( \T_VARIABLE, \T_STRING ), true )
 			&& 'null' !== strtolower( $this->tokens[ $param_first_token ]['content'] )
 		) {
 			// Bail early if the first non-empty token in the parameter is T_VARIABLE or T_STRING as

WordPress/Tests/WP/OptionAutoloadUnitTest.inc.fixed

@@ -45,8 +45,7 @@ $ok = wp_set_option_autoload_values(
 );
 
 /*
- * These should all be ignored by the sniff as the autoload value is undetermined or not easy to
- * determine.
+ * These should all be ignored by the sniff as the autoload value can't be reliably determined.
  */
 $ignored = add_option( 'my_option', 'my_value', '', $some_variable );
 $ignored = add_option( 'my_option', 'my_value', '', $obj->yes );
@@ -82,7 +81,7 @@ $ignored = wp_set_option_autoload_values(options: array());
 $ignored = wp_set_option_autoload_values(options: []);
 
 /*
- * Invalid function calls that are ignored by the sniff as a mandatory parameter is missing
+ * Invalid function calls that are ignored by the sniff as a mandatory parameter is missing.
  */
 $ignored = wp_set_option_autoload_values();
 $ignored = wp_set_options_autoload();