Release v1.13.0

.github/workflows/deploy-on-release-to-dot-org.yml

@@ -39,8 +39,6 @@ jobs:
       - name: WordPress plugin deploy
         id: deploy
         uses: 10up/action-wordpress-plugin-deploy@stable
-        with:
-          dry-run: true # exists to prevent accidental deploys during testing
         env:
           SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
           SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}

accessibility-checker.php

@@ -10,7 +10,7 @@
  * Plugin Name:       Accessibility Checker
  * Plugin URI:        https://a11ychecker.com
  * Description:       Audit and check your website for accessibility before you hit publish. In-post accessibility scanner and guidance.
- * Version:           1.12.0
+ * Version:           1.13.0
  * Author:            Equalize Digital
  * Author URI:        https://equalizedigital.com
  * License:           GPL-2.0+
@@ -35,7 +35,7 @@
 
 // Current plugin version.
 if ( ! defined( 'EDAC_VERSION' ) ) {
-	define( 'EDAC_VERSION', '1.12.0' );
+	define( 'EDAC_VERSION', '1.13.0' );
 }
 
 // Current database version.

admin/class-ajax.php

@@ -415,7 +415,7 @@ function ( $a, $b ) {
 
 						$html .= '<button class="edac-details-rule-records-record-actions-ignore' . $ignore_class . '" aria-expanded="false" aria-controls="edac-details-rule-records-record-ignore-' . $row['id'] . '">' . EDAC_SVG_IGNORE_ICON . '<span class="edac-details-rule-records-record-actions-ignore-label">' . $ignore_label . '</span></button>';
 
-						if ( 'missing_headings' !== $rule['slug'] ) {
+						if ( ! isset( $rule['viewable'] ) || $rule['viewable'] ) {
 
 							$url = add_query_arg(
 								[

admin/class-enqueue-admin.php

@@ -122,6 +122,7 @@ public static function maybe_enqueue_admin_and_editor_app_scripts() {
 							$post_id,
 							[ 'edac_pageScanner' => 1 ]
 						),
+						'version'    => EDAC_VERSION,
 					]
 				);
 

includes/classes/class-rest-api.php

@@ -32,6 +32,7 @@ public function __construct() {
 	 */
 	public function init_hooks() {
 		add_action( 'init', [ $this, 'init_rest_routes' ] );
+		add_filter( 'edac_filter_js_violation_html', [ $this, 'filter_js_validation_html' ], 10, 3 );
 	}
 
 
@@ -161,7 +162,28 @@ function () use ( $ns, $version ) {
 		);
 	}
 
-
+	/**
+	 * Filter the html of the js validation violation.
+	 *
+	 * This can be used to store additional data in the html of the violation.
+	 *
+	 * @since 1.13.0
+	 * @param string $html      The html of the violation.
+	 * @param string $rule_id   The id of the rule.
+	 * @param array  $violation The violation data.
+	 *
+	 * @return string
+	 */
+	public function filter_js_validation_html( string $html, string $rule_id, array $violation ): string {
+		// Add the selector to the violation message as empty paragraphs are almost always
+		// duplicate html fragments. Adding the selector makes it unique, so it can be saved.
+		if ( 'empty_paragraph_tag' === $rule_id ) {
+			$html .= $violation['selector'][0]
+				? '// {{ ' . $violation['selector'][0] . ' }}'
+				: '';
+		}
+		return $html;
+	}
 
 	/**
 	 * REST handler that saves to the DB a list of js rule violations for a post.
@@ -194,11 +216,19 @@ public function set_post_scan_results( $request ) {
 
 		//phpcs:ignore Generic.Commenting.Todo.TaskFound
 		// TODO: setup a rules class for loading/filtering rules.
-		$rules       = edac_register_rules();
-		$js_rule_ids = [];
+		$rules             = edac_register_rules();
+		$js_rule_ids       = [];
+		$combined_rule_ids = [];
 		foreach ( $rules as $rule ) {
 			if ( array_key_exists( 'ruleset', $rule ) && 'js' === $rule['ruleset'] ) {
 				$js_rule_ids[] = $rule['slug'];
+
+				// Some rules can be a grouping of other checks with different ids. This tracks those combined check IDs for later mapping.
+				if ( array_key_exists( 'combines', $rule ) && ! empty( $rule['combines'] ) ) {
+					foreach ( $rule['combines'] as $combine_rule_id ) {
+						$combined_rule_ids[ $combine_rule_id ] = $rule['slug'];
+					}
+				}
 			}
 		}
 
@@ -226,17 +256,20 @@ public function set_post_scan_results( $request ) {
 				foreach ( $violations as $violation ) {
 					$rule_id = $violation['ruleId'];
 
-					if ( in_array( $rule_id, $js_rule_ids, true ) ) {
+					// If this rule is a combined rule then map it to the actual reporting rule ID.
+					$actual_rule_id = array_key_exists( $rule_id, $combined_rule_ids ) ? $combined_rule_ids[ $rule_id ] : $rule_id;
+
+					if ( in_array( $actual_rule_id, $js_rule_ids, true ) ) {
 
 						// This rule is one that we've included in our js ruleset.
 
-						$html   = $violation['html'];
+						$html   = apply_filters( 'edac_filter_js_violation_html', $violation['html'], $rule_id, $violation );
 						$impact = $violation['impact']; // by default, use the impact setting from the js rule.
 
 						//phpcs:ignore Generic.Commenting.Todo.TaskFound
 						// TODO: setup a rules class for loading/filtering rules.
 						foreach ( $rules as $rule ) {
-							if ( $rule['slug'] === $rule_id ) {
+							if ( $rule['slug'] === $actual_rule_id ) {
 								$impact = $rule['rule_type']; // if we are defining the rule_type in php rules config, use that instead of the js rule's impact setting.
 							}
 						}
@@ -255,9 +288,9 @@ public function set_post_scan_results( $request ) {
 						 * @param string $rule_id The rule ID.
 						 * @param string $type    The type of validation which is always 'js' in this path.
 						 */
-						do_action( 'edac_before_rule', $post_id, $rule_id, 'js' );
+						do_action( 'edac_before_rule', $post_id, $actual_rule_id, 'js' );
 
-						( new Insert_Rule_Data() )->insert( $post, $rule_id, $impact, $html );
+						( new Insert_Rule_Data() )->insert( $post, $actual_rule_id, $impact, $html );
 
 						/**
 						 * Fires after a rule is run against the content.
@@ -270,7 +303,7 @@ public function set_post_scan_results( $request ) {
 						 * @param string $rule_id The rule ID.
 						 * @param string $type    The type of validation which is always 'js' in this path.
 						 */
-						do_action( 'edac_after_rule', $post_id, $rule_id, 'js' );
+						do_action( 'edac_after_rule', $post_id, $actual_rule_id, 'js' );
 
 					}
 				}
@@ -297,6 +330,10 @@ public function set_post_scan_results( $request ) {
 			// store a record of this scan in the post's meta.
 			update_post_meta( $post_id, '_edac_post_checked_js', time() );
 
+			if ( true === $request['isFailure'] ) {
+				update_post_meta( $post_id, '_edac_post_checked_js_failure', time() );
+			}
+
 			return new \WP_REST_Response(
 				[
 					'success'   => true,

includes/rules.php

@@ -74,6 +74,14 @@
 			'<code>&lt;h2&gt;</code>'
 		),
 	],
+	[
+		'title'     => esc_html__( 'Empty Paragraph Tag', 'accessibility-checker' ),
+		'info_url'  => 'https://a11ychecker.com/help7870',
+		'slug'      => 'empty_paragraph_tag',
+		'rule_type' => 'warning',
+		'summary'   => esc_html__( 'An Empty Paragraph Tag warning means there is a paragraph tag present that does not contain content. These may be announced by screen readers or create confusion for users. To fix this warning, remove the empty paragraphs from the page. If you need to add spacing between sections, this should be done with padding, margins, or a spacer block.', 'accessibility-checker' ),
+		'ruleset'   => 'js',
+	],
 	[
 		'title'     => esc_html__( 'iFrame Missing Title', 'accessibility-checker' ),
 		'info_url'  => 'https://a11ychecker.com/help1953',
@@ -98,19 +106,15 @@
 			'<code>&lt;h1&gt;</code>',
 			'<code>&lt;h6&gt;</code>'
 		),
+		'viewable'  => false,
 	],
 	[
 		'title'     => esc_html__( 'Text Justified', 'accessibility-checker' ),
 		'info_url'  => 'https://a11ychecker.com/help1980',
 		'slug'      => 'text_justified',
 		'rule_type' => 'warning',
-		'summary'   => sprintf(
-			// translators: %s is <code>&lt;p&gt;</code>, %s is <code>&lt;div&gt;</code>, %s is <code>&lt;td&gt;</code>.
-			esc_html__( 'A Text Justified warning shows up in Accessibility Checker when the text on your post or page, either a %1$s, %2$s, or %3$s element, with more than 500 characters has been styled with a justified alignment (text-align:justify). To fix this warning, you will need to remove the justified styling from the specified text elements.', 'accessibility-checker' ),
-			'<code>&lt;p&gt;</code>',
-			'<code>&lt;div&gt;</code>',
-			'<code>&lt;td&gt;</code>'
-		),
+		'summary'   => esc_html__( 'A Text Justified warning appears in Accessibility Checker when text with more than 200 characters on your post or page is styled with justified alignment (text-align:justify). To fix this warning, remove the justified styling from the specified text elements.', 'accessibility-checker' ),
+		'ruleset'   => 'js',
 	],
 	[
 		'title'     => esc_html__( 'Link Opens New Window or Tab', 'accessibility-checker' ),
@@ -315,13 +319,15 @@
 		'slug'      => 'text_small',
 		'rule_type' => 'warning',
 		'summary'   => esc_html__( 'A Text Too Small warning occurs when there is text on your website that is less than 10px in size. The warning is an indication that you may want to rethink the font size and make it larger so that it can be more easily read without a user needing zoom in on their browser. To fix text that is too small, you will need to ensure that all text elements on your website are at least 10 points.', 'accessibility-checker' ),
+		'ruleset'   => 'js',
 	],
 	[
 		'title'     => esc_html__( 'Possible Heading', 'accessibility-checker' ),
 		'info_url'  => 'https://a11ychecker.com/help1969',
 		'slug'      => 'possible_heading',
 		'rule_type' => 'warning',
 		'summary'   => esc_html__( 'A Possible Heading warning occurs when there is text on a page that appears to be a heading, but has not been coded with proper heading tags. This warning is appears if there are short phrases or strings of text less than 50 characters in length that are formatted in a way which suggests they might be being used as headers (they are 20 pixels or bigger, or are 16 pixels or bigger and bold and/or italicized). To fix a Possible Heading warning, you will need to determine if the flagged text is indeed intended to be a heading. If so, you need to change it from a paragraph to a heading at the proper level. If it is not supposed to be a heading then you can safely “Ignore” the warning.', 'accessibility-checker' ),
+		'ruleset'   => 'js',
 	],
 	[
 		'title'     => esc_html__( 'Blinking or Scrolling Content', 'accessibility-checker' ),
@@ -335,6 +341,8 @@
 			'<code>&lt;marquee&gt;</code>',
 			'<code>text-decoration: blink</code>'
 		),
+		'ruleset'   => 'js',
+		'combines'  => [ 'blink', 'marquee' ],
 	],
 	[
 		'title'     => esc_html__( 'Insufficient Color Contrast', 'accessibility-checker' ),
@@ -420,4 +428,14 @@
 			'<code>&lt;a&gt;</code>'
 		),
 	],
+	[
+		'title'     => esc_html__( 'Zooming and Scaling Disabled', 'accessibility-checker' ),
+		'info_url'  => 'https://a11ychecker.com/help7947',
+		'slug'      => 'meta_viewport',
+		'rule_type' => 'error',
+		'summary'   => esc_html__( 'Zooming is disabled via viewport meta tag that includes `user-scalable=no` or a `maximum-scale` value of less than 2. This limits low-vision users that want to increase text sizes, zoom into the page or who use a magnifier.', 'accessibility-checker' ),
+		'ruleset'   => 'js',
+		'combines'  => [ 'meta-viewport' ],
+		'viewable'  => false,
+	],
 ];

includes/rules/iframe_missing_title.php

@@ -1,6 +1,6 @@
 <?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase -- underscore is for valid function name.
 /**
- * Accessibility Checker pluign file.
+ * Accessibility Checker plugin file.
  *
  * @package Accessibility_Checker
  */
@@ -21,6 +21,11 @@ function edac_rule_iframe_missing_title( $content, $post ) { // phpcs:ignore --
 	foreach ( $iframe_tags as $iframe ) {
 		if ( isset( $iframe ) && empty( $iframe->getAttribute( 'title' ) ) && empty( $iframe->getAttribute( 'aria-label' ) ) ) {
 
+			$display_none_and_visibility_hidden = preg_match( '/(?=.*display\s*:\s*none)(?=.*visibility\s*:\s*hidden)/is', $iframe->getAttribute( 'style' ) );
+			if ( $display_none_and_visibility_hidden ) {
+				continue;
+			}
+
 			$iframecode = htmlspecialchars( $iframe->outertext );
 
 			$errors[] = $iframecode;