Merge pull request #1548 from WordPress-Coding-Standards/develop

Release version 1.2.1

Author: jrfnl

CHANGELOG.md

@@ -8,6 +8,22 @@ This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a
 
 _No documentation available about unreleased changes as of yet._
 
+## [1.2.1] - 2018-12-18
+
+Note: This will be the last release supporting PHP_CodeSniffer 2.x.
+
+### Changed
+- The default value for `minimum_supported_wp_version`, as used by a [number of sniffs detecting usage of deprecated WP features](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#minimum-wp-version-to-check-for-usage-of-deprecated-functions-classes-and-function-parameters), has been updated to `4.7`.
+- The `WordPress.NamingConventions.PrefixAllGlobals` sniff will now report the error for hook names and constant names declared with `define()` on the line containing the parameter for the hook/constant name. Previously, it would report the error on the line containing the function call.
+- Various minor housekeeping fixes to inline documentation, rulesets, code.
+
+### Removed
+- `comment_author_email_link()`, `comment_author_email()`, `comment_author_IP()`, `comment_author_link()`, `comment_author_rss()`, `comment_author_url_link()`, `comment_author_url()`, `comment_author()`, `comment_date()`, `comment_excerpt()`, `comment_form_title()`, `comment_form()`, `comment_id_fields()`, `comment_ID()`, `comment_reply_link()`, `comment_text_rss()`, `comment_text()`, `comment_time()`, `comment_type()`, `comments_link()`, `comments_number()`, `comments_popup_link()`, `comments_popup_script()`, `comments_rss_link()`, `delete_get_calendar_cache()`, `edit_bookmark_link()`, `edit_comment_link()`, `edit_post_link()`, `edit_tag_link()`, `get_footer()`, `get_header()`, `get_sidebar()`, `get_the_title()`, `next_comments_link()`, `next_image_link()`, `next_post_link()`, `next_posts_link()`, `permalink_anchor()`, `posts_nav_link()`, `previous_comments_link()`, `previous_image_link()`, `previous_post_link()`, `previous_posts_link()`, `sticky_class()`, `the_attachment_link()`, `the_author_link()`, `the_author_meta()`, `the_author_posts_link()`, `the_author_posts()`, `the_category_rss()`, `the_category()`, `the_content_rss()`, `the_content()`, `the_date_xml()`, `the_excerpt_rss()`, `the_excerpt()`, `the_feed_link()`, `the_ID()`, `the_meta()`, `the_modified_author()`, `the_modified_date()`, `the_modified_time()`, `the_permalink()`, `the_post_thumbnail()`, `the_search_query()`, `the_shortlink()`, `the_tags()`, `the_taxonomies()`, `the_terms()`, `the_time()`, `the_title_rss()`, `the_title()`, `wp_enqueue_script()`, `wp_meta()`, `wp_shortlink_header()` and `wp_shortlink_wp_head()` from the list of auto-escaped functions `Sniff::$autoEscapedFunctions`. This affects the `WordPress.Security.EscapeOutput` sniff.
+
+### Fixed
+- The `WordPress.WhiteSpace.PrecisionAlignment` sniff would loose the value of a custom set `ignoreAlignmentTokens` property when scanning more than one file.
+
+
 ## [1.2.0] - 2018-11-12
 
 ### Added
@@ -810,6 +826,7 @@ See the comparison for full list.
 Initial tagged release.
 
 [Unreleased]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/compare/master...HEAD
+[1.2.1]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/compare/1.2.0...1.2.1
 [1.2.0]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/compare/0.14.1...1.0.0

WordPress-Docs/ruleset.xml

@@ -61,6 +61,8 @@
 		<exclude name="Squiz.Commenting.FunctionComment.ParamCommentNotCapital"/>
 		<!-- Excluded to allow param documentation for arrays  -->
 		<exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamName"/>
+		<!-- It is too early for PHP7 features to be required -->
+		<exclude name="Squiz.Commenting.FunctionComment.ScalarTypeHintMissing"/>
 		<!-- WP doesn't require type hints -->
 		<exclude name="Squiz.Commenting.FunctionComment.TypeHintMissing"/>
 
@@ -81,9 +83,6 @@
 		<exclude name="Squiz.Commenting.VariableComment.TagNotAllowed"/>
 		<!-- WP prefers @since first -->
 		<exclude name="Squiz.Commenting.VariableComment.VarOrder"/>
-
-		<!-- It is too early for PHP7 features to be required -->
-		<exclude name="Squiz.Commenting.FunctionComment.ScalarTypeHintMissing"/>
 	</rule>
 
 	<rule ref="Generic.Commenting">
@@ -105,8 +104,6 @@
 		<exclude name="Generic.Commenting.DocComment.ContentBeforeClose"/>
 
 		<!-- WP allows @todo's in comments -->
-		<exclude name="Generic.Commenting.Todo.CommentFound"/>
-		<!-- WP allows @todo's in comments -->
-		<exclude name="Generic.Commenting.Todo.TaskFound"/>
+		<exclude name="Generic.Commenting.Todo"/>
 	</rule>
 </ruleset>

WordPress/Sniff.php

@@ -82,7 +82,7 @@ abstract class Sniff implements PHPCS_Sniff {
 	 *
 	 * @var string WordPress version.
 	 */
-	public $minimum_supported_version = '4.6';
+	public $minimum_supported_version = '4.7';
 
 	/**
 	 * Custom list of classes which test classes can extend.
@@ -178,40 +178,11 @@ abstract class Sniff implements PHPCS_Sniff {
 		'calendar_week_mod'         => true,
 		'category_description'      => true,
 		'checked'                   => true,
-		'comment_author_email_link' => true,
-		'comment_author_email'      => true,
-		'comment_author_IP'         => true,
-		'comment_author_link'       => true,
-		'comment_author_rss'        => true,
-		'comment_author_url_link'   => true,
-		'comment_author_url'        => true,
-		'comment_author'            => true,
 		'comment_class'             => true,
-		'comment_date'              => true,
-		'comment_excerpt'           => true,
-		'comment_form_title'        => true,
-		'comment_form'              => true,
-		'comment_id_fields'         => true,
-		'comment_ID'                => true,
-		'comment_reply_link'        => true,
-		'comment_text_rss'          => true,
-		'comment_text'              => true,
-		'comment_time'              => true,
-		'comment_type'              => true,
-		'comments_link'             => true,
-		'comments_number'           => true,
-		'comments_popup_link'       => true,
-		'comments_popup_script'     => true,
-		'comments_rss_link'         => true,
 		'count'                     => true,
-		'delete_get_calendar_cache' => true,
 		'disabled'                  => true,
 		'do_shortcode'              => true,
 		'do_shortcode_tag'          => true,
-		'edit_bookmark_link'        => true,
-		'edit_comment_link'         => true,
-		'edit_post_link'            => true,
-		'edit_tag_link'             => true,
 		'get_archives_link'         => true,
 		'get_attachment_link'       => true,
 		'get_avatar'                => true,
@@ -220,76 +191,32 @@ abstract class Sniff implements PHPCS_Sniff {
 		'get_comment_author_link'   => true,
 		'get_current_blog_id'       => true,
 		'get_delete_post_link'      => true,
-		'get_footer'                => true,
-		'get_header'                => true,
 		'get_search_form'           => true,
 		'get_search_query'          => true,
-		'get_sidebar'               => true,
 		'get_the_author_link'       => true,
 		'get_the_author'            => true,
 		'get_the_date'              => true,
 		'get_the_ID'                => true,
 		'get_the_post_thumbnail'    => true,
 		'get_the_term_list'         => true,
-		'get_the_title'             => true,
-		'next_comments_link'        => true,
-		'next_image_link'           => true,
-		'next_post_link'            => true,
-		'next_posts_link'           => true,
 		'paginate_comments_links'   => true,
-		'permalink_anchor'          => true,
 		'post_type_archive_title'   => true,
-		'posts_nav_link'            => true,
-		'previous_comments_link'    => true,
-		'previous_image_link'       => true,
-		'previous_post_link'        => true,
-		'previous_posts_link'       => true,
 		'readonly'                  => true,
 		'selected'                  => true,
 		'single_cat_title'          => true,
 		'single_month_title'        => true,
 		'single_post_title'         => true,
 		'single_tag_title'          => true,
 		'single_term_title'         => true,
-		'sticky_class'              => true,
 		'tag_description'           => true,
 		'term_description'          => true,
-		'the_attachment_link'       => true,
-		'the_author_link'           => true,
-		'the_author_meta'           => true,
-		'the_author_posts_link'     => true,
-		'the_author_posts'          => true,
 		'the_author'                => true,
-		'the_category_rss'          => true,
-		'the_category'              => true,
-		'the_content_rss'           => true,
-		'the_content'               => true,
-		'the_date_xml'              => true,
 		'the_date'                  => true,
-		'the_excerpt_rss'           => true,
-		'the_excerpt'               => true,
-		'the_feed_link'             => true,
-		'the_ID'                    => true,
-		'the_meta'                  => true,
-		'the_modified_author'       => true,
-		'the_modified_date'         => true,
-		'the_modified_time'         => true,
-		'the_permalink'             => true,
-		'the_post_thumbnail'        => true,
-		'the_search_query'          => true,
-		'the_shortlink'             => true,
-		'the_tags'                  => true,
-		'the_taxonomies'            => true,
-		'the_terms'                 => true,
-		'the_time'                  => true,
 		'the_title_attribute'       => true,
-		'the_title_rss'             => true,
-		'the_title'                 => true,
 		'vip_powered_wpcom'         => true,
 		'walk_nav_menu_tree'        => true,
 		'wp_dropdown_categories'    => true,
 		'wp_dropdown_users'         => true,
-		'wp_enqueue_script'         => true,
 		'wp_generate_tag_cloud'     => true,
 		'wp_get_archives'           => true,
 		'wp_get_attachment_image'   => true,
@@ -301,11 +228,8 @@ abstract class Sniff implements PHPCS_Sniff {
 		'wp_list_comments'          => true,
 		'wp_login_form'             => true,
 		'wp_loginout'               => true,
-		'wp_meta'                   => true,
 		'wp_nav_menu'               => true,
 		'wp_register'               => true,
-		'wp_shortlink_header'       => true,
-		'wp_shortlink_wp_head'      => true,
 		'wp_tag_cloud'              => true,
 		'wp_title'                  => true,
 	);
@@ -2390,7 +2314,7 @@ public function get_declared_namespace_name( $stackPtr ) {
 			\T_STRING       => true,
 			\T_NS_SEPARATOR => true,
 		);
-		$validTokens = $acceptedTokens + Tokens::$emptyTokens;
+		$validTokens    = $acceptedTokens + Tokens::$emptyTokens;
 
 		$namespaceName = '';
 		while ( isset( $validTokens[ $this->tokens[ $nextToken ]['code'] ] ) ) {
@@ -2493,7 +2417,7 @@ public function is_class_property( $stackPtr ) {
 				$deepest_open = array_pop( $parenthesis );
 				if ( $deepest_open < $scopePtr
 					|| isset( $this->tokens[ $deepest_open ]['parenthesis_owner'] ) === false
-					|| T_FUNCTION !== $this->tokens[ $this->tokens[ $deepest_open ]['parenthesis_owner'] ]['code']
+					|| \T_FUNCTION !== $this->tokens[ $this->tokens[ $deepest_open ]['parenthesis_owner'] ]['code']
 				) {
 					return true;
 				}

WordPress/Sniffs/NamingConventions/PrefixAllGlobalsSniff.php

@@ -801,7 +801,7 @@ public function process_parameters( $stackPtr, $group_name, $matched_content, $p
 
 		$data[] = $raw_content;
 
-		$recorded = $this->addMessage( self::ERROR_MSG, $parameters[1]['start'], $is_error, $error_code, $data );
+		$recorded = $this->addMessage( self::ERROR_MSG, $first_non_empty, $is_error, $error_code, $data );
 
 		if ( true === $recorded ) {
 			$this->record_potential_prefix_metric( $stackPtr, $raw_content );

WordPress/Sniffs/Utils/I18nTextDomainFixerSniff.php

@@ -121,7 +121,7 @@ class I18nTextDomainFixerSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @since 1.2.0
 	 *
-	 * @var string
+	 * @var bool
 	 */
 	private $is_valid = false;
 
@@ -139,7 +139,7 @@ class I18nTextDomainFixerSniff extends AbstractFunctionParameterSniff {
 	 *
 	 * @since 1.2.0
 	 *
-	 * @var string
+	 * @var bool
 	 */
 	private $header_found = false;
 

WordPress/Sniffs/WhiteSpace/PrecisionAlignmentSniff.php

@@ -91,7 +91,7 @@ public function process_token( $stackPtr ) {
 		}
 
 		// Handle any custom ignore tokens received from a ruleset.
-		$this->ignoreAlignmentTokens = $this->merge_custom_array( $this->ignoreAlignmentTokens );
+		$ignoreAlignmentTokens = $this->merge_custom_array( $this->ignoreAlignmentTokens );
 
 		$check_tokens  = array(
 			'T_WHITESPACE'             => true,
@@ -109,9 +109,9 @@ public function process_token( $stackPtr ) {
 				|| ( isset( $this->tokens[ ( $i + 1 ) ] )
 					&& \T_WHITESPACE === $this->tokens[ ( $i + 1 ) ]['code'] )
 				|| $this->tokens[ $i ]['content'] === $this->phpcsFile->eolChar
-				|| isset( $this->ignoreAlignmentTokens[ $this->tokens[ $i ]['type'] ] )
+				|| isset( $ignoreAlignmentTokens[ $this->tokens[ $i ]['type'] ] )
 				|| ( isset( $this->tokens[ ( $i + 1 ) ] )
-					&& isset( $this->ignoreAlignmentTokens[ $this->tokens[ ( $i + 1 ) ]['type'] ] ) )
+					&& isset( $ignoreAlignmentTokens[ $this->tokens[ ( $i + 1 ) ]['type'] ] ) )
 			) {
 				continue;
 			}

WordPress/Tests/NamingConventions/PrefixAllGlobalsUnitTest.1.inc

@@ -409,4 +409,19 @@ apply_filters( 'my_wordpress_plugin_filtername', $var ); // OK.
 // @codingStandardsChangeSetting WordPress.NamingConventions.PrefixAllGlobals prefixes test-this
 do_action( 'Test-THIS-hookname' ); // OK.
 
+// @codingStandardsChangeSetting WordPress.NamingConventions.PrefixAllGlobals prefixes acronym,tgmpa
+// Issue #1495 - throw the error on the line with the non-prefixed name.
+$acronym = apply_filters(
+	'content-types-post-types', // Bad.
+	[
+		PostType\Post::NAME => PostType\Post::class,
+	]
+);
+
+define(
+	/* comment */
+	'SOME_GLOBAL', // Bad.
+	[ 1, 2, 3 ]
+);
+
 // @codingStandardsChangeSetting WordPress.NamingConventions.PrefixAllGlobals prefixes false

WordPress/Tests/NamingConventions/PrefixAllGlobalsUnitTest.php

@@ -68,6 +68,8 @@ public function getErrorList( $testFile = 'PrefixAllGlobalsUnitTest.1.inc' ) {
 					387 => 1,
 					389 => 1,
 					403 => 1,
+					415 => 1,
+					423 => 1,
 				);
 
 			case 'PrefixAllGlobalsUnitTest.4.inc':

WordPress/Tests/Security/EscapeOutputUnitTest.inc

@@ -285,3 +285,7 @@ echo  // phpcs:ignore WP.Secur1ty.EscapeOutput -- WPCS: XSS ok. (sniff name mang
 echo esc_html( $something ),
 	$something_else,
 	esc_html( $something_more ); // phpcs:ignore WP.Secur1ty.EscapeOutput -- WPCS: XSS ok. (sniff name mangled on purpose).
+
+echo get_the_title(); // Bad.
+echo wp_kses_post( get_the_title() ); // Ok.
+echo esc_html( get_the_title() ); // Ok.

WordPress/Tests/Security/EscapeOutputUnitTest.php

@@ -78,6 +78,7 @@ public function getErrorList() {
 			263 => 1,
 			264 => 1,
 			266 => 1,
+			289 => 1,
 		);
 	}
 

WordPress/Tests/WP/DeprecatedFunctionsUnitTest.inc

@@ -315,14 +315,14 @@ get_comments_popup_template();
 get_currentuserinfo();
 is_comments_popup();
 use function popuplinks as something_else; // Related to issue #1306.
-
-/*
- * Warning.
- */
 /* ============ WP 4.6 ============ */
 post_form_autocomplete_off();
 wp_embed_handler_googlevideo();
 wp_get_sites();
+
+/*
+ * Warning.
+ */
 /* ============ WP 4.7 ============ */
 _sort_nav_menu_items();
 _usort_terms_by_ID();

WordPress/Tests/WP/DeprecatedFunctionsUnitTest.php

@@ -28,7 +28,7 @@ class DeprecatedFunctionsUnitTest extends AbstractSniffUnitTest {
 	 */
 	public function getErrorList() {
 
-		$errors = array_fill( 8, 310, 1 );
+		$errors = array_fill( 8, 314, 1 );
 
 		// Unset the lines related to version comments.
 		unset(
@@ -59,7 +59,8 @@ public function getErrorList() {
 			$errors[290],
 			$errors[295],
 			$errors[303],
-			$errors[310]
+			$errors[310],
+			$errors[318]
 		);
 
 		return $errors;
@@ -72,7 +73,7 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 
-		$warnings = array_fill( 323, 17, 1 );
+		$warnings = array_fill( 326, 14, 1 );
 
 		// Unset the lines related to version comments.
 		unset( $warnings[326], $warnings[333], $warnings[335] );

WordPress/Tests/WP/DeprecatedParametersUnitTest.inc

@@ -60,7 +60,7 @@ wp_title_rss( 'deprecated' );
 wp_upload_bits( '', 'deprecated' );
 xfn_check( '', '', 'deprecated' );
 
-// All will give an WARNING as they have been deprecated after WP 4.5.
+// All will give an WARNING as they have been deprecated after WP 4.7.
 
 get_category_parents( '', '', '', '', array( 'deprecated') );
 unregister_setting( '', '', '', 'deprecated' );

WordPress/Tests/WhiteSpace/PrecisionAlignmentUnitTest.2.inc

@@ -19,24 +19,24 @@
 	/**
 	 * OK: Doc comments are indented with tabs and one space.
 	 *
-	  * @var string  <= Bad.
+	  * @var string  <= Bad, but not reported as token type is whitelisted.
 	 * @access private
 	 */
 
 	/*
 	 * OK: Multi-line comments are indented with tabs and one space.
 	 *
-	   * <= Bad.
+	   * <= Bad, but not reported as token type is whitelisted
 	 */
 
-	 function exampleFunctionD() {} // Bad: [tab][space].
-	  function exampleFunctionE() {} // Bad: [tab][space][space].
-	   function exampleFunctionF() {} // Bad: [tab][space][space][space].
+	 function exampleFunctionD() {} // Bad, but not reported as token type is whitelisted.
+	  function exampleFunctionE() {} // Bad, but not reported as token type is whitelisted.
+	   function exampleFunctionF() {} // Bad, but not reported as token type is whitelisted.
 
 ?>
 
 	<p>
-	  Bad: Some text with precision alignment.
+	  Bad: Some text with precision alignment, but not reported as token type is whitelisted.
 	</p>
 
 <?php