Merge pull request #874 from WordPress/add-experimental-admin-option

Add include experimental option in admin

Author: ernilambar

assets/js/plugin-check-admin.js

@@ -22,6 +22,10 @@
 		return;
 	}
 
+	const includeExperimental = document.getElementById(
+		'plugin-check__include-experimental'
+	);
+
 	// Handle disabling the Check it button when a plugin is not selected.
 	function canRunChecks() {
 		if ( '' === pluginsList.value ) {
@@ -125,6 +129,10 @@
 			'action',
 			pluginCheck.actionSetUpRuntimeEnvironment
 		);
+		pluginCheckData.append(
+			'include-experimental',
+			includeExperimental && includeExperimental.checked ? 1 : 0
+		);
 
 		for ( let i = 0; i < data.checks.length; i++ ) {
 			pluginCheckData.append( 'checks[]', data.checks[ i ] );
@@ -193,6 +201,10 @@
 		pluginCheckData.append( 'nonce', pluginCheck.nonce );
 		pluginCheckData.append( 'plugin', pluginsList.value );
 		pluginCheckData.append( 'action', pluginCheck.actionGetChecksToRun );
+		pluginCheckData.append(
+			'include-experimental',
+			includeExperimental && includeExperimental.checked ? 1 : 0
+		);
 
 		for ( let i = 0; i < categoriesList.length; i++ ) {
 			if ( categoriesList[ i ].checked ) {
@@ -291,6 +303,10 @@
 		pluginCheckData.append( 'plugin', plugin );
 		pluginCheckData.append( 'checks[]', check );
 		pluginCheckData.append( 'action', pluginCheck.actionRunChecks );
+		pluginCheckData.append(
+			'include-experimental',
+			includeExperimental && includeExperimental.checked ? 1 : 0
+		);
 
 		return fetch( ajaxurl, {
 			method: 'POST',

includes/Admin/Admin_AJAX.php

@@ -112,7 +112,10 @@ public function set_up_environment() {
 		$checks = is_null( $checks ) ? array() : $checks;
 		$plugin = filter_input( INPUT_POST, 'plugin', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
 
+		$include_experimental = 1 === filter_input( INPUT_POST, 'include-experimental', FILTER_VALIDATE_INT );
+
 		try {
+			$runner->set_experimental_flag( $include_experimental );
 			$runner->set_check_slugs( $checks );
 			$runner->set_plugin( $plugin );
 
@@ -183,12 +186,13 @@ public function get_checks_to_run() {
 			wp_send_json_error( $valid_request, 403 );
 		}
 
-		$categories = filter_input( INPUT_POST, 'categories', FILTER_DEFAULT, FILTER_FORCE_ARRAY );
-		$categories = is_null( $categories ) ? array() : $categories;
-		$checks     = filter_input( INPUT_POST, 'checks', FILTER_DEFAULT, FILTER_FORCE_ARRAY );
-		$checks     = is_null( $checks ) ? array() : $checks;
-		$plugin     = filter_input( INPUT_POST, 'plugin', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
-		$runner     = Plugin_Request_Utility::get_runner();
+		$categories           = filter_input( INPUT_POST, 'categories', FILTER_DEFAULT, FILTER_FORCE_ARRAY );
+		$categories           = is_null( $categories ) ? array() : $categories;
+		$checks               = filter_input( INPUT_POST, 'checks', FILTER_DEFAULT, FILTER_FORCE_ARRAY );
+		$checks               = is_null( $checks ) ? array() : $checks;
+		$plugin               = filter_input( INPUT_POST, 'plugin', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
+		$include_experimental = 1 === filter_input( INPUT_POST, 'include-experimental', FILTER_VALIDATE_INT );
+		$runner               = Plugin_Request_Utility::get_runner();
 
 		if ( is_null( $runner ) ) {
 			$runner = new AJAX_Runner();
@@ -203,6 +207,7 @@ public function get_checks_to_run() {
 		}
 
 		try {
+			$runner->set_experimental_flag( $include_experimental );
 			$runner->set_check_slugs( $checks );
 			$runner->set_plugin( $plugin );
 			$runner->set_categories( $categories );
@@ -255,7 +260,10 @@ public function run_checks() {
 		$checks = is_null( $checks ) ? array() : $checks;
 		$plugin = filter_input( INPUT_POST, 'plugin', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
 
+		$include_experimental = 1 === filter_input( INPUT_POST, 'include-experimental', FILTER_VALIDATE_INT );
+
 		try {
+			$runner->set_experimental_flag( $include_experimental );
 			$runner->set_check_slugs( $checks );
 			$runner->set_plugin( $plugin );
 			$results = $runner->run();

includes/Admin/Admin_Page.php

@@ -284,6 +284,16 @@ public function render_page() {
 		$user_enabled_categories = get_user_setting( 'plugin_check_category_preferences', implode( '__', $this->get_default_check_categories_to_be_selected() ) );
 		$user_enabled_categories = explode( '__', $user_enabled_categories );
 
+		$check_repo = new Default_Check_Repository();
+
+		$collection = $check_repo->get_checks( Check_Repository::TYPE_ALL | Check_Repository::INCLUDE_EXPERIMENTAL )->filter(
+			static function ( Check $check ) {
+				return $check->get_stability() === Check::STABILITY_EXPERIMENTAL;
+			}
+		);
+
+		$has_experimental_checks = count( $collection ) > 0;
+
 		require WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'templates/admin-page.php';
 	}
 

includes/Checker/AJAX_Runner.php

@@ -104,7 +104,8 @@ protected function get_check_exclude_slugs_param() {
 	 * @return bool Returns true to include experimental checks else false.
 	 */
 	protected function get_include_experimental_param() {
-		return false;
+		$include_experimental = filter_input( INPUT_POST, 'include-experimental', FILTER_VALIDATE_INT );
+		return ( 1 === absint( $include_experimental ) );
 	}
 
 	/**

templates/admin-page.php

@@ -60,6 +60,14 @@
 				<?php } ?>
 				</table>
 				<?php } ?>
+
+				<?php if ( $has_experimental_checks ) { ?>
+					<h4><?php esc_attr_e( 'Other Options', 'plugin-check' ); ?></h4>
+					<p>
+						<label><input type="checkbox" value="include-experimental" id="plugin-check__include-experimental" /> <?php esc_html_e( 'Include Experimental Checks', 'plugin-check' ); ?></label>
+					</p>
+				<?php } ?>
+
 			</form>
 
 		<?php } else { ?>