53 |

54 |

55 | -------------------------------------------------------------------------------- /includes/Traits/Find_Readme.php: -------------------------------------------------------------------------------- 1 | add_result_error_for_file( 51 | $result, 52 | __( 'Do not use Localhost/127.0.0.1 in your code.', 'plugin-check' ), 53 | 'localhost_code_detected', 54 | $file 55 | ); 56 | } 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /phpmd.xml: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | */assets/* 47 | */node_modules/* 48 | */tests/* 49 | */vendor/* 50 | 51 | -------------------------------------------------------------------------------- /cli.php: -------------------------------------------------------------------------------- 1 | posts = $posts; 37 | } 38 | 39 | /** 40 | * Creates the demo posts in the database to be us 41 | * 42 | * @since n.e.x.t 43 | * 44 | * @return callable Cleanup function to revert changes made by theme and plugin preparation classes. 45 | * 46 | * @throws Exception Thrown when preparation fails. 47 | */ 48 | public function prepare() { 49 | $post_ids = array(); 50 | 51 | foreach ( $this->posts as $postarr ) { 52 | $post_id = wp_insert_post( $postarr, true ); 53 | 54 | if ( is_wp_error( $post_id ) ) { 55 | throw new Exception( $post_id->get_error_message() ); 56 | } 57 | 58 | $post_ids[] = $post_id; 59 | } 60 | 61 | // Return the cleanup function. 62 | return function () use ( $post_ids ) { 63 | foreach ( $post_ids as $post_id ) { 64 | wp_delete_post( $post_id, true ); 65 | } 66 | }; 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /includes/Checker/Checks/No_Unfiltered_Uploads_Check.php: -------------------------------------------------------------------------------- 1 | add_result_error_for_file( 51 | $result, 52 | __( 'ALLOW_UNFILTERED_UPLOADS is not permitted.', 'plugin-check' ), 53 | 'allow_unfiltered_uploads_detected', 54 | $file 55 | ); 56 | } 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /drop-ins/object-cache.copy.php: -------------------------------------------------------------------------------- 1 | getConstants(); 35 | 36 | /** 37 | * List of categories. 38 | * 39 | * @var string[] $categories 40 | */ 41 | $categories = array_values( 42 | array_filter( 43 | $constants, 44 | static function ( $key ) { 45 | return strpos( $key, 'CATEGORY_' ) === 0; 46 | }, 47 | ARRAY_FILTER_USE_KEY 48 | ) 49 | ); 50 | } 51 | 52 | return $categories; 53 | } 54 | 55 | /** 56 | * Returns an array of checks. 57 | * 58 | * @since n.e.x.t 59 | * 60 | * @param Check_Collection $collection Check collection. 61 | * @param array $categories An array of categories to filter by. 62 | * @return Check_Collection Filtered check collection. 63 | */ 64 | public static function filter_checks_by_categories( Check_Collection $collection, array $categories ): Check_Collection { 65 | return $collection->filter( 66 | static function ( $check ) use ( $categories ) { 67 | // Return true if at least one of the check categories is among the filter categories. 68 | return (bool) array_intersect( $check->get_categories(), $categories ); 69 | } 70 | ); 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /test-content/themes/wp-empty-theme/inc/template-functions.php: -------------------------------------------------------------------------------- 1 | '; 27 | } 28 | } 29 | add_action( 'wp_head', 'wp_empty_theme_pingback_header' ); 30 | 31 | /** 32 | * Creates continue reading text. 33 | */ 34 | function wp_empty_theme_continue_reading_text() { 35 | $continue_reading = sprintf( 36 | /* translators: %s: Name of current post. */ 37 | esc_html__( 'Continue reading %s', 'wp-empty-theme' ), 38 | the_title( '', false ) 39 | ); 40 | 41 | return $continue_reading; 42 | } 43 | 44 | /** 45 | * Creates the continue reading link for excerpt. 46 | */ 47 | function wp_empty_theme_continue_reading_link_excerpt() { 48 | if ( ! is_admin() ) { 49 | return '… ' . wp_empty_theme_continue_reading_text() . ''; 50 | } 51 | } 52 | add_filter( 'excerpt_more', 'wp_empty_theme_continue_reading_link_excerpt' ); 53 | 54 | /** 55 | * Creates the continue reading link. 56 | */ 57 | function wp_empty_theme_continue_reading_link() { 58 | if ( ! is_admin() ) { 59 | return '

' . wp_empty_theme_continue_reading_text() . '

'; 60 | } 61 | } 62 | add_filter( 'the_content_more_link', 'wp_empty_theme_continue_reading_link' ); 63 | -------------------------------------------------------------------------------- /includes/Checker/Checks.php: -------------------------------------------------------------------------------- 1 | run_check_with_result( $check, $result ); 46 | } 47 | ); 48 | 49 | return $result; 50 | } 51 | 52 | /** 53 | * Runs a given check with the given result object to amend. 54 | * 55 | * @since n.e.x.t 56 | * 57 | * @param Check $check The check to run. 58 | * @param Check_Result $result The result object to amend. 59 | * 60 | * @throws Exception Thrown when check fails with critical error. 61 | */ 62 | private function run_check_with_result( Check $check, Check_Result $result ) { 63 | // If $check implements Preparation interface, ensure the preparation and clean up is run. 64 | if ( $check instanceof Preparation ) { 65 | $cleanup = $check->prepare(); 66 | 67 | try { 68 | $check->run( $result ); 69 | } catch ( Exception $e ) { 70 | // Run clean up in case of any exception thrown from check. 71 | $cleanup(); 72 | throw $e; 73 | } 74 | 75 | $cleanup(); 76 | return; 77 | } 78 | 79 | // Otherwise, just run the check. 80 | $check->run( $result ); 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /test-content/themes/wp-empty-theme/comments.php: -------------------------------------------------------------------------------- 1 | 14 | 15 |

16 | 19 |

20 | 31 |

32 | 33 |

34 | 60, 38 | 'style' => 'ol', 39 | 'short_ping' => true, 40 | ) 41 | ); 42 | ?> 43 | 44 | 45 | esc_html__( 'Page', 'wp-empty-theme' ) . ' ', 49 | 'mid_size' => 0, 50 | 'prev_text' => sprintf( 51 | '%s', 52 | esc_html__( 'Older comments', 'wp-empty-theme' ) 53 | ), 54 | 'next_text' => sprintf( 55 | '%s', 56 | esc_html__( 'Newer comments', 'wp-empty-theme' ) 57 | ), 58 | ) 59 | ); 60 | 61 | if ( ! comments_open() ) { 62 | ?> 63 |

64 | null, 71 | 'title_reply' => esc_html__( 'Leave a comment', 'wp-empty-theme' ), 72 | 'title_reply_before' => '

', 73 | 'title_reply_after' => '

', 74 | ) 75 | ); 76 | ?> 77 |

78 | -------------------------------------------------------------------------------- /templates/admin-page.php: -------------------------------------------------------------------------------- 1 | 9 | 10 |

11 | 12 |

13 | 14 |

15 | 16 | 17 | 18 | 58 | 59 | 60 | 61 |

62 | 63 | 64 |

65 | 66 |

67 | 68 |

69 | -------------------------------------------------------------------------------- /test-content/themes/wp-empty-theme/inc/back-compat.php: -------------------------------------------------------------------------------- 1 |

'; 30 | printf( 31 | /* translators: %s: WordPress Version. */ 32 | esc_html__( 'This theme requires WordPress 5.3 or newer. You are running version %s. Please upgrade.', 'wp-empty-theme' ), 33 | esc_html( $GLOBALS['wp_version'] ) 34 | ); 35 | echo '

'; 36 | } 37 | 38 | /** 39 | * Prevents the Customizer from being loaded on WordPress versions prior to 5.3. 40 | * 41 | * @global string $wp_version WordPress version. 42 | */ 43 | function wp_empty_theme_customize() { 44 | wp_die( 45 | sprintf( 46 | /* translators: %s: WordPress Version. */ 47 | esc_html__( 'This theme requires WordPress 5.3 or newer. You are running version %s. Please upgrade.', 'wp-empty-theme' ), 48 | esc_html( $GLOBALS['wp_version'] ) 49 | ), 50 | '', 51 | array( 52 | 'back_link' => true, 53 | ) 54 | ); 55 | } 56 | add_action( 'load-customize.php', 'wp_empty_theme_customize' ); 57 | 58 | /** 59 | * Prevents the Theme Preview from being loaded on WordPress versions prior to 5.3. 60 | * 61 | * @global string $wp_version WordPress version. 62 | */ 63 | function wp_empty_theme_preview() { 64 | if ( isset( $_GET['preview'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification 65 | wp_die( 66 | sprintf( 67 | /* translators: %s: WordPress Version. */ 68 | esc_html__( 'This theme requires WordPress 5.3 or newer. You are running version %s. Please upgrade.', 'wp-empty-theme' ), 69 | esc_html( $GLOBALS['wp_version'] ) 70 | ) 71 | ); 72 | } 73 | } 74 | add_action( 'template_redirect', 'wp_empty_theme_preview' ); 75 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Plugin_Header_Text_Domain_Check.php: -------------------------------------------------------------------------------- 1 | plugin()->basename(); 57 | $plugin_header = get_plugin_data( $plugin_main_file ); 58 | $plugin_slug = basename( $result->plugin()->path() ); 59 | 60 | if ( 61 | ! empty( $plugin_slug ) && 62 | ! empty( $plugin_header['TextDomain'] ) && 63 | $plugin_slug !== $plugin_header['TextDomain'] 64 | ) { 65 | $this->add_result_warning_for_file( 66 | $result, 67 | sprintf( 68 | /* translators: 1: plugin header text domain, 2: plugin slug */ 69 | __( 'The TextDomain header in the plugin file does not match the slug. Found "%1$s", expected "%2$s".', 'plugin-check' ), 70 | esc_html( $plugin_header['TextDomain'] ), 71 | esc_html( $plugin_slug ) 72 | ), 73 | 'textdomain_mismatch', 74 | $plugin_main_file 75 | ); 76 | } 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /includes/Checker/Preparations/Universal_Runtime_Preparation.php: -------------------------------------------------------------------------------- 1 | check_context = $check_context; 38 | } 39 | 40 | /** 41 | * Runs preparation step for the environment by modifying the plugins and theme to use, 42 | * and returns a closure as a cleanup function. 43 | * 44 | * This preparation needs to be called very early in the WordPress lifecycle, before 45 | * plugins are loaded, e.g. from a drop-in like `object-cache.php`. 46 | * 47 | * @since n.e.x.t 48 | * 49 | * @return callable Cleanup function to revert changes made by theme and plugin preparation classes. 50 | * 51 | * @throws Exception Thrown when preparation fails. 52 | */ 53 | public function prepare() { 54 | 55 | $cleanup_functions = array(); 56 | 57 | if ( ! defined( 'WP_PLUGIN_CHECK_PLUGIN_DIR_PATH' ) ) { 58 | $plugins_dir = defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins'; 59 | $theme_folder = $plugins_dir . '/plugin-check/test-content/themes'; 60 | } else { 61 | $theme_folder = WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'test-content/themes'; 62 | } 63 | 64 | $use_minimal_theme_preparation = new Use_Minimal_Theme_Preparation( 'wp-empty-theme', $theme_folder ); 65 | $cleanup_functions[] = $use_minimal_theme_preparation->prepare(); 66 | 67 | $force_single_plugin_preparation = new Force_Single_Plugin_Preparation( $this->check_context->basename() ); 68 | $cleanup_functions[] = $force_single_plugin_preparation->prepare(); 69 | 70 | // Return the cleanup function. 71 | return function () use ( $cleanup_functions ) { 72 | 73 | foreach ( $cleanup_functions as $cleanup_function ) { 74 | $cleanup_function(); 75 | } 76 | }; 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /includes/Plugin_Context.php: -------------------------------------------------------------------------------- 1 | main_file = $main_file; 34 | } 35 | 36 | /** 37 | * Returns the plugin basename. 38 | * 39 | * @since n.e.x.t 40 | * 41 | * @return string Plugin basename. 42 | */ 43 | public function basename() { 44 | return plugin_basename( $this->main_file ); 45 | } 46 | 47 | /** 48 | * Returns the absolute path for a relative path to the plugin directory. 49 | * 50 | * @since n.e.x.t 51 | * 52 | * @param string $relative_path Optional. Relative path. Default '/'. 53 | * @return string Absolute path. 54 | */ 55 | public function path( $relative_path = '/' ) { 56 | return plugin_dir_path( $this->main_file ) . ltrim( $relative_path, '/' ); 57 | } 58 | 59 | /** 60 | * Returns the full URL for a path relative to the plugin directory. 61 | * 62 | * @since n.e.x.t 63 | * 64 | * @param string $relative_path Optional. Relative path. Default '/'. 65 | * @return string Full URL. 66 | */ 67 | public function url( $relative_path = '/' ) { 68 | return plugin_dir_url( $this->main_file ) . ltrim( $relative_path, '/' ); 69 | } 70 | 71 | /** 72 | * Returns the plugin location. 73 | * 74 | * @since n.e.x.t 75 | * 76 | * @return string The plugin file if single file plugin. Or the plugin folder. 77 | */ 78 | public function location() { 79 | $path = $this->path(); 80 | 81 | // Return the plugin path and basename if the path matches the plugin directory. 82 | if ( WP_PLUGIN_DIR . '/' === $path ) { 83 | return $path . $this->basename(); 84 | } 85 | 86 | return $path; 87 | } 88 | 89 | /** 90 | * Checks if the plugin is a single file plugin without a dedicated directory. 91 | * 92 | * This is the case when the single file is directly placed within `wp-content/plugins`. 93 | * 94 | * @since n.e.x.t 95 | * 96 | * @return bool true if the single file plugin, otherwise false. 97 | */ 98 | public function is_single_file_plugin() { 99 | return $this->path() !== $this->location(); 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /plugin-check.php: -------------------------------------------------------------------------------- 1 | add_hooks(); 50 | } 51 | 52 | /** 53 | * Displays admin notice about unmet PHP version requirement. 54 | * 55 | * @since n.e.x.t 56 | */ 57 | function wp_plugin_check_display_php_version_notice() { 58 | echo '

'; 59 | printf( 60 | /* translators: 1: required version, 2: currently used version */ 61 | esc_html__( 'Plugin Check requires at least PHP version %1$s. Your site is currently running on PHP %2$s.', 'plugin-check' ), 62 | esc_html( WP_PLUGIN_CHECK_MINIMUM_PHP ), 63 | esc_html( phpversion() ) 64 | ); 65 | echo '

'; 66 | } 67 | 68 | /** 69 | * Displays admin notice about missing Composer autoload files. 70 | * 71 | * @since n.e.x.t 72 | */ 73 | function wp_plugin_check_display_composer_autoload_notice() { 74 | echo '

'; 75 | printf( 76 | /* translators: composer command. */ 77 | esc_html__( 'Your installation of the Plugin Check plugin is incomplete. Please run %s.', 'plugin-check' ), 78 | 'composer install' 79 | ); 80 | echo '

'; 81 | } 82 | 83 | wp_plugin_check_load(); 84 | -------------------------------------------------------------------------------- /includes/Checker/Check_Collection.php: -------------------------------------------------------------------------------- 1 | $check_obj` pairs. 37 | */ 38 | public function to_map(): array; 39 | 40 | /** 41 | * Returns a new check collection containing the subset of checks based on the given check filter function. 42 | * 43 | * @since n.e.x.t 44 | * 45 | * @phpstan-param callable(Check,string): bool $filter_fn 46 | * 47 | * @param callable $filter_fn Filter function that accepts a Check object and a Check slug and 48 | * should return a boolean for whether to include the check in the new collection. 49 | * @return Check_Collection New check collection, effectively a subset of this one. 50 | */ 51 | public function filter( callable $filter_fn ): Check_Collection; 52 | 53 | /** 54 | * Returns a new check collection containing the subset of checks based on the given check slugs. 55 | * 56 | * If the given list is empty, the same collection will be returned without any change. 57 | * 58 | * @since n.e.x.t 59 | * 60 | * @param array $check_slugs List of slugs to limit to only those. If empty, the same collection is returned. 61 | * @return Check_Collection New check collection, effectively a subset of this one. 62 | */ 63 | public function include( array $check_slugs ): Check_Collection; 64 | 65 | /** 66 | * Returns a new check collection excluding the provided checks. 67 | * 68 | * If the given list is empty, the same collection will be returned without any change. 69 | * 70 | * @since n.e.x.t 71 | * 72 | * @param array $check_slugs List of slugs to exclude. If empty, the same collection is returned. 73 | * @return Check_Collection New check collection, effectively a subset of this one. 74 | */ 75 | public function exclude( array $check_slugs ): Check_Collection; 76 | 77 | /** 78 | * Throws an exception if any of the given check slugs are not present, or returns the same collection otherwise. 79 | * 80 | * @since n.e.x.t 81 | * 82 | * @param array $check_slugs List of slugs to limit to only those. If empty, the same collection is returned. 83 | * @return Check_Collection The unchanged check collection. 84 | * 85 | * @throws Exception Thrown when any of the given check slugs is not present in the collection. 86 | */ 87 | public function require( array $check_slugs ): Check_Collection; 88 | } 89 | -------------------------------------------------------------------------------- /includes/Checker/Default_Check_Repository.php: -------------------------------------------------------------------------------- 1 | runtime_checks[ $slug ] ) || isset( $this->static_checks[ $slug ] ) ) { 57 | throw new Exception( 58 | sprintf( 59 | /* translators: %s: The Check slug. */ 60 | __( 'Check slug "%s" is already in use.', 'plugin-check' ), 61 | $slug 62 | ) 63 | ); 64 | } 65 | 66 | if ( ! $check->get_categories() ) { 67 | throw new Exception( 68 | sprintf( 69 | /* translators: %s: The Check slug. */ 70 | __( 'Check with slug "%s" has no categories associated with it.', 'plugin-check' ), 71 | $slug 72 | ) 73 | ); 74 | } 75 | 76 | $check_array = $check instanceof Runtime_Check ? 'runtime_checks' : 'static_checks'; 77 | $this->{$check_array}[ $slug ] = $check; 78 | } 79 | 80 | /** 81 | * Returns an array of checks. 82 | * 83 | * @since n.e.x.t 84 | * 85 | * @param int $flags The check type flag. 86 | * @return Check_Collection Check collection providing an indexed array of check instances. 87 | */ 88 | public function get_checks( $flags = self::TYPE_ALL ) { 89 | $checks = array(); 90 | 91 | if ( $flags & self::TYPE_STATIC ) { 92 | $checks += $this->static_checks; 93 | } 94 | 95 | if ( $flags & self::TYPE_RUNTIME ) { 96 | $checks += $this->runtime_checks; 97 | } 98 | 99 | // Return all checks, including experimental if requested. 100 | if ( $flags & self::INCLUDE_EXPERIMENTAL ) { 101 | return new Default_Check_Collection( $checks ); 102 | } 103 | 104 | // Remove experimental checks before returning. 105 | return ( new Default_Check_Collection( $checks ) )->filter( 106 | static function ( Check $check ) { 107 | return $check->get_stability() !== Check::STABILITY_EXPERIMENTAL; 108 | } 109 | ); 110 | } 111 | } 112 | -------------------------------------------------------------------------------- /includes/Traits/Amend_Check_Result.php: -------------------------------------------------------------------------------- 1 | add_message( 36 | (bool) $error, 37 | $message, 38 | array( 39 | 'code' => $code, 40 | 'file' => str_replace( $result->plugin()->path(), '', $file ), 41 | 'line' => $line, 42 | 'column' => $column, 43 | 'link' => $this->get_file_editor_url( $result, $file, $line ), 44 | ) 45 | ); 46 | } 47 | 48 | /** 49 | * Amends the given result with an error message for the specified file. 50 | * 51 | * @since n.e.x.t 52 | * 53 | * @param Check_Result $result The check result to amend, including the plugin context to check. 54 | * @param string $message Error message. 55 | * @param string $code Error code. 56 | * @param string $file Absolute path to the file where the error was found. 57 | * @param int $line The line on which the error occurred. Default is 0 (unknown line). 58 | * @param int $column The column on which the error occurred. Default is 0 (unknown column). 59 | */ 60 | protected function add_result_error_for_file( Check_Result $result, $message, $code, $file, $line = 0, $column = 0 ) { 61 | $this->add_result_message_for_file( $result, true, $message, $code, $file, $line, $column ); 62 | } 63 | 64 | /** 65 | * Amends the given result with a warning message for the specified file. 66 | * 67 | * @since n.e.x.t 68 | * 69 | * @param Check_Result $result The check result to amend, including the plugin context to check. 70 | * @param string $message Error message. 71 | * @param string $code Error code. 72 | * @param string $file Absolute path to the file where the warning was found. 73 | * @param int $line The line on which the warning occurred. Default is 0 (unknown line). 74 | * @param int $column The column on which the warning occurred. Default is 0 (unknown column). 75 | */ 76 | protected function add_result_warning_for_file( Check_Result $result, $message, $code, $file, $line = 0, $column = 0 ) { 77 | $this->add_result_message_for_file( $result, false, $message, $code, $file, $line, $column ); 78 | } 79 | } 80 | -------------------------------------------------------------------------------- /includes/Checker/Preparations/Force_Single_Plugin_Preparation.php: -------------------------------------------------------------------------------- 1 | plugin_basename = $plugin_basename; 39 | } 40 | 41 | /** 42 | * Runs this preparation step for the environment and returns a cleanup function. 43 | * 44 | * @since n.e.x.t 45 | * 46 | * @return callable Cleanup function to revert any changes made here. 47 | * 48 | * @throws Exception Thrown when preparation fails. 49 | */ 50 | public function prepare() { 51 | $valid_plugin = validate_plugin( $this->plugin_basename ); 52 | 53 | // Check if the plugin exists. 54 | if ( is_wp_error( $valid_plugin ) ) { 55 | 56 | throw new Exception( 57 | sprintf( 58 | /* translators: 1: plugin basename, 2: error message */ 59 | __( 'Invalid plugin %1$s: %2$s', 'plugin-check' ), 60 | $this->plugin_basename, 61 | $valid_plugin->get_error_message() 62 | ) 63 | ); 64 | } 65 | 66 | add_filter( 'option_active_plugins', array( $this, 'filter_active_plugins' ) ); 67 | add_filter( 'default_option_active_plugins', array( $this, 'filter_active_plugins' ) ); 68 | 69 | // Return the cleanup function. 70 | return function () { 71 | remove_filter( 'option_active_plugins', array( $this, 'filter_active_plugins' ) ); 72 | remove_filter( 'default_option_active_plugins', array( $this, 'filter_active_plugins' ) ); 73 | }; 74 | } 75 | 76 | /** 77 | * Filter active plugins. 78 | * 79 | * @since n.e.x.t 80 | * 81 | * @param array $active_plugins List of active plugins. 82 | * @return array List of active plugins. 83 | */ 84 | public function filter_active_plugins( $active_plugins ) { 85 | if ( is_array( $active_plugins ) && in_array( $this->plugin_basename, $active_plugins, true ) ) { 86 | 87 | if ( defined( 'WP_PLUGIN_CHECK_MAIN_FILE' ) ) { 88 | $plugin_check_file = WP_PLUGIN_CHECK_MAIN_FILE; 89 | } else { 90 | $plugins_dir = defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins'; 91 | $plugin_check_file = $plugins_dir . '/plugin-check/plugin-check.php'; 92 | } 93 | 94 | $plugin_base_file = plugin_basename( $plugin_check_file ); 95 | 96 | // If the plugin-check is the only available plugin then return that one only. 97 | if ( $this->plugin_basename === $plugin_base_file ) { 98 | 99 | return array( 100 | $plugin_base_file, 101 | ); 102 | } 103 | 104 | return array( 105 | $this->plugin_basename, 106 | $plugin_base_file, 107 | ); 108 | } 109 | 110 | return $active_plugins; 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /includes/Checker/AJAX_Runner.php: -------------------------------------------------------------------------------- 1 | count( $_SERVER['argv'] ) ) { 36 | return false; 37 | } 38 | 39 | if ( 40 | 'wp' === substr( $_SERVER['argv'][0], -2 ) && 41 | 'plugin' === $_SERVER['argv'][1] && 42 | 'check' === $_SERVER['argv'][2] 43 | ) { 44 | return true; 45 | } 46 | 47 | return false; 48 | } 49 | 50 | /** 51 | * Returns the plugin parameter based on the request. 52 | * 53 | * @since n.e.x.t 54 | * 55 | * @return string The plugin parameter. 56 | * 57 | * @throws Exception Thrown if the plugin parameter is empty. 58 | */ 59 | protected function get_plugin_param() { 60 | // Get the plugin parameter from the command line arguments. 61 | $plugin = isset( $_SERVER['argv'][3] ) ? $_SERVER['argv'][3] : ''; 62 | 63 | if ( empty( $plugin ) ) { 64 | throw new Exception( 65 | __( 'Invalid plugin: Plugin parameter must not be empty.', 'plugin-check' ) 66 | ); 67 | } 68 | 69 | return $plugin; 70 | } 71 | 72 | /** 73 | * Returns an array of Check slugs to run based on the request. 74 | * 75 | * @since n.e.x.t 76 | * 77 | * @return array An array of Check slugs to run. 78 | */ 79 | protected function get_check_slugs_param() { 80 | $checks = array(); 81 | 82 | foreach ( $_SERVER['argv'] as $value ) { 83 | if ( false !== strpos( $value, '--checks=' ) ) { 84 | $checks = wp_parse_list( str_replace( '--checks=', '', $value ) ); 85 | break; 86 | } 87 | } 88 | 89 | return $checks; 90 | } 91 | 92 | /** 93 | * Returns an array of Check slugs to exclude based on the request. 94 | * 95 | * @since n.e.x.t 96 | * 97 | * @return array An array of Check slugs to run. 98 | */ 99 | protected function get_check_exclude_slugs_param() { 100 | $checks = array(); 101 | 102 | foreach ( $_SERVER['argv'] as $value ) { 103 | if ( false !== strpos( $value, '--exclude-checks=' ) ) { 104 | $checks = wp_parse_list( str_replace( '--exclude-checks=', '', $value ) ); 105 | break; 106 | } 107 | } 108 | 109 | return $checks; 110 | } 111 | 112 | /** 113 | * Returns the include experimental parameter based on the request. 114 | * 115 | * @since n.e.x.t 116 | * 117 | * @return bool Returns true to include experimental checks else false. 118 | */ 119 | protected function get_include_experimental_param() { 120 | if ( in_array( '--include-experimental', $_SERVER['argv'], true ) ) { 121 | return true; 122 | } 123 | 124 | return false; 125 | } 126 | 127 | /** 128 | * Returns an array of categories for filtering the checks. 129 | * 130 | * @since n.e.x.t 131 | * 132 | * @return array An array of categories. 133 | */ 134 | protected function get_categories_param() { 135 | $categories = array(); 136 | 137 | foreach ( $_SERVER['argv'] as $value ) { 138 | if ( false !== strpos( $value, '--categories=' ) ) { 139 | $categories = wp_parse_list( str_replace( '--categories=', '', $value ) ); 140 | break; 141 | } 142 | } 143 | 144 | return $categories; 145 | } 146 | } 147 | -------------------------------------------------------------------------------- /includes/Traits/File_Editor_URL.php: -------------------------------------------------------------------------------- 1 | plugin()->path( '/' ); 34 | $plugin_slug = basename( $plugin_path ); 35 | $filename = str_replace( $plugin_path, '', $filename ); 36 | /** 37 | * Filters the template for the URL for linking to an external editor to open a file for editing. 38 | * 39 | * Users of IDEs that support opening files in via web protocols can use this filter to override 40 | * the edit link to result in their editor opening rather than the plugin editor. 41 | * 42 | * The initial filtered value is null, requiring extension plugins to supply the URL template 43 | * string themselves. If no template string is provided, links to the plugin editors will 44 | * be provided if available. For example, for an extension plugin to cause file edit links to 45 | * open in an IDE, the following filters can be used: 46 | * 47 | * # PhpStorm 48 | * add_filter( 'wp_plugin_check_validation_error_source_file_editor_url_template', function () { 49 | * return 'phpstorm://open?file={{file}}&line={{line}}'; 50 | * } ); 51 | * 52 | * # VS Code 53 | * add_filter( 'wp_plugin_check_validation_error_source_file_editor_url_template', function () { 54 | * return 'vscode://file/{{file}}:{{line}}'; 55 | * } ); 56 | * 57 | * For a template to be considered, the string '{{file}}' must be present in the filtered value. 58 | * 59 | * @since n.e.x.t 60 | * 61 | * @param string|null $editor_url_template Editor URL template. default null. 62 | */ 63 | $editor_url_template = apply_filters( 'wp_plugin_check_validation_error_source_file_editor_url_template', null ); 64 | 65 | // Supply the file path to the editor template. 66 | if ( is_string( $editor_url_template ) && str_contains( $editor_url_template, '{{file}}' ) ) { 67 | $file_path = WP_PLUGIN_DIR . '/' . $plugin_slug; 68 | if ( $plugin_slug !== $filename ) { 69 | $file_path .= '/' . $filename; 70 | } 71 | 72 | if ( file_exists( $file_path ) ) { 73 | /** 74 | * Filters the file path to be opened in an external editor for a given PHPCS error source. 75 | * 76 | * This is useful to map the file path from inside of a Docker container or VM to the host machine. 77 | * 78 | * @since n.e.x.t 79 | * 80 | * @param string|null $editor_url_template Editor URL template. 81 | * @param array $source Source information. 82 | */ 83 | $file_path = apply_filters( 'wp_plugin_check_validation_error_source_file_path', $file_path, array( $plugin_slug, $filename, $line ) ); 84 | if ( $file_path ) { 85 | $edit_url = str_replace( 86 | array( 87 | '{{file}}', 88 | '{{line}}', 89 | ), 90 | array( 91 | rawurlencode( $file_path ), 92 | $line, 93 | ), 94 | $editor_url_template 95 | ); 96 | } 97 | } 98 | } 99 | 100 | // Fall back to using the plugin editor if no external editor is offered. 101 | if ( ! $edit_url && current_user_can( 'edit_plugins' ) ) { 102 | $query_args = array( 103 | 'plugin' => rawurlencode( $result->plugin()->basename() ), 104 | 'file' => rawurlencode( $plugin_slug . '/' . $filename ), 105 | ); 106 | if ( $line ) { 107 | $query_args['line'] = $line; 108 | } 109 | return add_query_arg( 110 | $query_args, 111 | admin_url( 'plugin-editor.php' ) 112 | ); 113 | } 114 | return $edit_url; 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /includes/Utilities/Plugin_Request_Utility.php: -------------------------------------------------------------------------------- 1 | is_plugin_check() ) { 98 | add_action( 99 | 'muplugins_loaded', 100 | function () use ( $runner ) { 101 | static::$cleanup = $runner->prepare(); 102 | static::$runner = $runner; 103 | } 104 | ); 105 | 106 | break; 107 | } 108 | } 109 | } 110 | 111 | /** 112 | * Get the Runner class for the current request. 113 | * 114 | * @since n.e.x.t 115 | * 116 | * @return Abstract_Check_Runner|null The Runner class for the request or null. 117 | */ 118 | public static function get_runner() { 119 | if ( null !== static::$runner ) { 120 | return static::$runner; 121 | } 122 | 123 | return null; 124 | } 125 | 126 | /** 127 | * Runs the cleanup functions and destroys the runner. 128 | * 129 | * @since n.e.x.t 130 | */ 131 | public static function destroy_runner() { 132 | // Run the cleanup functions. 133 | if ( null !== self::$cleanup ) { 134 | call_user_func( self::$cleanup ); 135 | } 136 | 137 | static::$runner = null; 138 | } 139 | 140 | /** 141 | * Gets the directories to ignore using the filter. 142 | * 143 | * @since n.e.x.t 144 | */ 145 | public static function get_directories_to_ignore() { 146 | // By default, ignore the '.git', 'vendor' and 'node_modules' directories. 147 | $default_ignore_directories = array( 148 | '.git', 149 | 'vendor', 150 | 'node_modules', 151 | ); 152 | 153 | /** 154 | * Filters the directories to ignore. 155 | * 156 | * @since n.e.x.t 157 | * 158 | * @param array $default_ignore_directories An array of directories to ignore. 159 | */ 160 | $directories_to_ignore = (array) apply_filters( 'wp_plugin_check_ignore_directories', $default_ignore_directories ); 161 | 162 | return $directories_to_ignore; 163 | } 164 | } 165 | -------------------------------------------------------------------------------- /test-content/themes/wp-empty-theme/min-style.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --global--spacing-horizontal: 25px; 3 | 4 | --responsive--spacing-horizontal: calc(2 * var(--global--spacing-horizontal) * 0.6); 5 | --responsive--aligndefault-width: calc(100vw - var(--responsive--spacing-horizontal)); 6 | --responsive--alignwide-width: calc(100vw - var(--responsive--spacing-horizontal)); 7 | --responsive--alignfull-width: 100%; 8 | --responsive--alignright-margin: var(--global--spacing-horizontal); 9 | --responsive--alignleft-margin: var(--global--spacing-horizontal); 10 | } 11 | 12 | @media only screen and (min-width: 482px) { 13 | 14 | :root { 15 | --responsive--aligndefault-width: min(calc(100vw - 4 * var(--global--spacing-horizontal)), 610px); 16 | --responsive--alignwide-width: calc(100vw - 4 * var(--global--spacing-horizontal)); 17 | --responsive--alignright-margin: calc(0.5 * (100vw - var(--responsive--aligndefault-width))); 18 | --responsive--alignleft-margin: calc(0.5 * (100vw - var(--responsive--aligndefault-width))); 19 | } 20 | } 21 | @media only screen and (min-width: 822px) { 22 | 23 | :root { 24 | --responsive--aligndefault-width: min(calc(100vw - 8 * var(--global--spacing-horizontal)), 610px); 25 | --responsive--alignwide-width: min(calc(100vw - 8 * var(--global--spacing-horizontal)), 1240px); 26 | } 27 | } 28 | 29 | img { 30 | height: auto; 31 | max-width: 100%; 32 | vertical-align: middle; 33 | } 34 | 35 | /** 36 | * Extends 37 | */ 38 | .post-thumbnail, 39 | .entry-content .wp-audio-shortcode, 40 | .entry-content > *:not(.alignwide):not(.alignfull):not(.alignleft):not(.alignright):not(.wp-block-separator):not(.woocommerce), 41 | *[class*=inner-container] > *:not(.entry-content):not(.alignwide):not(.alignfull):not(.alignleft):not(.alignright):not(.wp-block-separator):not(.woocommerce), 42 | .default-max-width { 43 | max-width: var(--responsive--aligndefault-width); 44 | margin-left: auto; 45 | margin-right: auto; 46 | } 47 | 48 | .widget-area, 49 | .pagination, 50 | .comments-pagination, 51 | .post-navigation, 52 | .site-footer, 53 | .site-header, 54 | .alignwide, 55 | .wide-max-width { 56 | max-width: var(--responsive--alignwide-width); 57 | margin-left: auto; 58 | margin-right: auto; 59 | } 60 | 61 | .alignfull, 62 | .wp-block-group .wp-block-group__inner-container > *.alignfull, 63 | .full-max-width { 64 | max-width: var(--responsive--alignfull-width); 65 | width: var(--responsive--alignfull-width); 66 | margin-left: auto; 67 | margin-right: auto; 68 | } 69 | 70 | @media only screen and (min-width: 482px) { 71 | 72 | .alignfull, 73 | .full-max-width { 74 | max-width: var(--responsive--alignfull-width); 75 | width: auto; 76 | margin-left: auto; 77 | margin-right: auto; 78 | } 79 | } 80 | 81 | .entry-header .post-thumbnail, 82 | .singular .post-thumbnail, 83 | .alignfull [class*=inner-container] > .alignwide, 84 | .alignwide [class*=inner-container] > .alignwide { 85 | margin-left: auto; 86 | margin-right: auto; 87 | width: var(--responsive--alignwide-width); 88 | max-width: var(--responsive--alignfull-width); 89 | } 90 | 91 | @media only screen and (min-width: 482px) { 92 | 93 | .entry-content > .alignleft { 94 | 95 | /*rtl:ignore*/ 96 | margin-left: var(--responsive--alignleft-margin); 97 | 98 | /*rtl:ignore*/ 99 | margin-right: var(--global--spacing-horizontal); 100 | } 101 | } 102 | @media only screen and (min-width: 482px) { 103 | 104 | .entry-content > .alignright { 105 | 106 | /*rtl:ignore*/ 107 | margin-left: var(--global--spacing-horizontal); 108 | 109 | /*rtl:ignore*/ 110 | margin-right: var(--responsive--alignright-margin); 111 | } 112 | } 113 | 114 | .screen-reader-text { 115 | border: 0; 116 | clip: rect(1px, 1px, 1px, 1px); 117 | -webkit-clip-path: inset(50%); 118 | clip-path: inset(50%); 119 | height: 1px; 120 | margin: -1px; 121 | overflow: hidden; 122 | padding: 0; 123 | position: absolute !important; 124 | width: 1px; 125 | word-wrap: normal !important; 126 | word-break: normal; 127 | } 128 | 129 | .skip-link:focus { 130 | background-color: #f1f1f1; 131 | border-radius: 3px; 132 | box-shadow: 0 0 2px 2px rgba(0, 0, 0, 0.6); 133 | clip: auto !important; 134 | -webkit-clip-path: none; 135 | clip-path: none; 136 | color: #21759b; 137 | display: block; 138 | font-size: 0.875rem; 139 | font-weight: 700; 140 | height: auto; 141 | left: 5px; 142 | line-height: normal; 143 | padding: 15px 23px 14px; 144 | text-decoration: none; 145 | top: 5px; 146 | width: auto; 147 | z-index: 100000; 148 | } 149 | -------------------------------------------------------------------------------- /test-content/themes/wp-empty-theme/index.php: -------------------------------------------------------------------------------- 1 | 11 | 12 | 15 | 18 | 21 | 32 | 35 | 39 | 42 | 45 | 48 | 49 | 57 |

> 58 | 59 |

60 | ', '' ); 63 | } else { 64 | the_title( sprintf( '

', esc_url( get_permalink() ) ), '

' ); 65 | } 66 | ?> 67 | 70 |

71 | 72 | 73 | 76 |

77 | 78 |

79 | '', 86 | /* translators: %: Page number. */ 87 | 'pagelink' => esc_html__( 'Page %', 'wp-empty-theme' ), 88 | ) 89 | ); 90 | ?> 91 |

92 | 93 | 96 | 97 |

98 | '

' . esc_html__( 'Next post', 'wp-empty-theme' ) . '

%title

', 109 | 'prev_text' => '

' . esc_html__( 'Previous post', 'wp-empty-theme' ) . '

%title

', 110 | ) 111 | ); 112 | } else { 113 | the_posts_pagination( 114 | array( 115 | 'before_page_number' => esc_html__( 'Page', 'wp-empty-theme' ) . ' ', 116 | 'mid_size' => 0, 117 | 'prev_text' => sprintf( 118 | '%s', 119 | wp_kses( 120 | __( 'Newer posts', 'wp-empty-theme' ), 121 | array( 122 | 'span' => array( 123 | 'class' => array(), 124 | ), 125 | ) 126 | ) 127 | ), 128 | 'next_text' => sprintf( 129 | '%s', 130 | wp_kses( 131 | __( 'Older posts', 'wp-empty-theme' ), 132 | array( 133 | 'span' => array( 134 | 'class' => array(), 135 | ), 136 | ) 137 | ) 138 | ), 139 | ) 140 | ); 141 | } 142 | } else { 143 | ?> 144 |

145 |

146 | 147 |

148 | 151 | 152 | 2 | 3 | 4 | 5 | Standards any plugin to be published on wordpress.org should comply with. 6 | 7 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | */tgm-plugin-activation/* 20 | */freemius/* 21 | */dompdf/* 22 | */cmb2/* 23 | */redux-framework/* 24 | */cherry-framework/* 25 | */titan-framework/* 26 | */vendor/* 27 | */guzzlehttp/* 28 | */vendors/* 29 | */plugin-update-checker/* 30 | */composer_directory/* 31 | */node_modules/* 32 | 33 | 34 | 35 | 36 | 37 | warning 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | warning 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | error 55 | The "goto" language construct should not be used. 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | error 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | error 100 | 101 | 102 | 103 | 104 | 105 | 106 | -------------------------------------------------------------------------------- /includes/Checker/Check_Result.php: -------------------------------------------------------------------------------- 1 | check_context = $check_context; 66 | } 67 | 68 | /** 69 | * Returns the context for the plugin to check. 70 | * 71 | * @since n.e.x.t 72 | * 73 | * @return Check_Context Plugin context instance. 74 | */ 75 | public function plugin() { 76 | return $this->check_context; 77 | } 78 | 79 | /** 80 | * Adds an error or warning to the respective stack. 81 | * 82 | * @since n.e.x.t 83 | * 84 | * @param bool $error Whether it is an error message. 85 | * @param string $message The message. 86 | * @param array $args { 87 | * Additional message arguments. 88 | * 89 | * @type string $code Violation code according to the message. Default empty string. 90 | * @type string $file The file in which the message occurred. Default empty string (unknown file). 91 | * @type int $line The line on which the message occurred. Default 0 (unknown line). 92 | * @type int $column The column on which the message occurred. Default 0 (unknown column). 93 | * @type string $link View in code editor link. Default empty string. 94 | * } 95 | */ 96 | public function add_message( $error, $message, $args = array() ) { 97 | $defaults = array( 98 | 'code' => '', 99 | 'file' => '', 100 | 'line' => 0, 101 | 'column' => 0, 102 | 'link' => '', 103 | ); 104 | 105 | $data = array_merge( 106 | array( 107 | 'message' => $message, 108 | ), 109 | $defaults, 110 | array_intersect_key( $args, $defaults ) 111 | ); 112 | 113 | $file = str_replace( $this->plugin()->path( '/' ), '', $data['file'] ); 114 | $line = $data['line']; 115 | $column = $data['column']; 116 | unset( $data['line'], $data['column'], $data['file'] ); 117 | 118 | if ( $error ) { 119 | if ( ! isset( $this->errors[ $file ] ) ) { 120 | $this->errors[ $file ] = array(); 121 | } 122 | if ( ! isset( $this->errors[ $file ][ $line ] ) ) { 123 | $this->errors[ $file ][ $line ] = array(); 124 | } 125 | if ( ! isset( $this->errors[ $file ][ $line ][ $column ] ) ) { 126 | $this->errors[ $file ][ $line ][ $column ] = array(); 127 | } 128 | $this->errors[ $file ][ $line ][ $column ][] = $data; 129 | ++$this->error_count; 130 | } else { 131 | if ( ! isset( $this->warnings[ $file ] ) ) { 132 | $this->warnings[ $file ] = array(); 133 | } 134 | if ( ! isset( $this->warnings[ $file ][ $line ] ) ) { 135 | $this->warnings[ $file ][ $line ] = array(); 136 | } 137 | if ( ! isset( $this->warnings[ $file ][ $line ][ $column ] ) ) { 138 | $this->warnings[ $file ][ $line ][ $column ] = array(); 139 | } 140 | $this->warnings[ $file ][ $line ][ $column ][] = $data; 141 | ++$this->warning_count; 142 | } 143 | } 144 | 145 | /** 146 | * Returns all errors. 147 | * 148 | * @since n.e.x.t 149 | * 150 | * @return array All errors with their data. 151 | */ 152 | public function get_errors() { 153 | return $this->errors; 154 | } 155 | 156 | /** 157 | * Returns all warnings. 158 | * 159 | * @since n.e.x.t 160 | * 161 | * @return array All warnings with their data. 162 | */ 163 | public function get_warnings() { 164 | return $this->warnings; 165 | } 166 | 167 | /** 168 | * Returns the number of errors. 169 | * 170 | * @since n.e.x.t 171 | * 172 | * @return int Number of errors found. 173 | */ 174 | public function get_error_count() { 175 | return $this->error_count; 176 | } 177 | 178 | /** 179 | * Returns the number of warnings. 180 | * 181 | * @since n.e.x.t 182 | * 183 | * @return int Number of warnings found. 184 | */ 185 | public function get_warning_count() { 186 | return $this->warning_count; 187 | } 188 | } 189 | -------------------------------------------------------------------------------- /includes/Checker/Preparations/Use_Minimal_Theme_Preparation.php: -------------------------------------------------------------------------------- 1 | theme_slug = $theme_slug; 48 | $this->themes_dir = $themes_dir; 49 | } 50 | 51 | /** 52 | * Runs this preparation step for the environment and returns a cleanup function. 53 | * 54 | * @since n.e.x.t 55 | * 56 | * @global array $wp_theme_directories 57 | * 58 | * @return callable Cleanup function to revert any changes made here. 59 | * 60 | * @throws Exception Thrown when preparation fails. 61 | */ 62 | public function prepare() { 63 | // Override the theme slug and name. 64 | add_filter( 'template', array( $this, 'get_theme_slug' ) ); 65 | add_filter( 'stylesheet', array( $this, 'get_theme_slug' ) ); 66 | add_filter( 'pre_option_template', array( $this, 'get_theme_slug' ) ); 67 | add_filter( 'pre_option_stylesheet', array( $this, 'get_theme_slug' ) ); 68 | add_filter( 'pre_option_current_theme', array( $this, 'get_theme_name' ) ); 69 | 70 | // Override the theme directory. 71 | add_filter( 'pre_option_template_root', array( $this, 'get_theme_root' ) ); 72 | add_filter( 'pre_option_stylesheet_root', array( $this, 'get_theme_root' ) ); 73 | 74 | // Registers the custom themes directory if relevant. 75 | if ( ! empty( $this->themes_dir ) ) { 76 | register_theme_directory( $this->themes_dir ); 77 | 78 | // Force new directory scan to ensure the test theme directory is available. 79 | search_theme_directories( true ); 80 | } 81 | 82 | // Return the cleanup function. 83 | return function () { 84 | global $wp_theme_directories; 85 | 86 | remove_filter( 'template', array( $this, 'get_theme_slug' ) ); 87 | remove_filter( 'stylesheet', array( $this, 'get_theme_slug' ) ); 88 | remove_filter( 'pre_option_template', array( $this, 'get_theme_slug' ) ); 89 | remove_filter( 'pre_option_stylesheet', array( $this, 'get_theme_slug' ) ); 90 | remove_filter( 'pre_option_current_theme', array( $this, 'get_theme_name' ) ); 91 | 92 | remove_filter( 'pre_option_template_root', array( $this, 'get_theme_root' ) ); 93 | remove_filter( 'pre_option_stylesheet_root', array( $this, 'get_theme_root' ) ); 94 | 95 | if ( ! empty( $this->themes_dir ) ) { 96 | $index = array_search( untrailingslashit( $this->themes_dir ), $wp_theme_directories, true ); 97 | if ( false !== $index ) { 98 | array_splice( $wp_theme_directories, $index, 1 ); 99 | $wp_theme_directories = array_values( $wp_theme_directories ); 100 | 101 | // Force new directory scan to remove the test theme directory. 102 | search_theme_directories( true ); 103 | } 104 | } 105 | }; 106 | } 107 | 108 | /** 109 | * Gets the theme slug. 110 | * 111 | * Used as a filter callback. 112 | * 113 | * @since n.e.x.t 114 | * 115 | * @return string The theme slug. 116 | */ 117 | public function get_theme_slug() { 118 | return $this->theme_slug; 119 | } 120 | 121 | /** 122 | * Gets the theme name. 123 | * 124 | * Used as a filter callback. 125 | * 126 | * @since n.e.x.t 127 | * 128 | * @return string The theme name. 129 | * 130 | * @throws Exception Thrown if theme does not exist for some reason. 131 | */ 132 | public function get_theme_name() { 133 | $theme = wp_get_theme( $this->theme_slug, $this->themes_dir ); 134 | if ( ! $theme->exists() ) { 135 | throw new Exception( 136 | __( 'Invalid theme: Theme does not exist for some reason.', 'plugin-check' ) 137 | ); 138 | } 139 | return $theme->display( 'Name' ); 140 | } 141 | 142 | /** 143 | * Gets the theme root. 144 | * 145 | * Used as a filter callback. 146 | * 147 | * @since n.e.x.t 148 | * 149 | * @return string The theme root. 150 | */ 151 | public function get_theme_root() { 152 | return get_raw_theme_root( $this->theme_slug, true ); 153 | } 154 | } 155 | -------------------------------------------------------------------------------- /test-content/themes/wp-empty-theme/functions.php: -------------------------------------------------------------------------------- 1 | tag in the document head, 35 | * WordPress will provide it for us. 36 | */ 37 | add_theme_support( 'title-tag' ); 38 | 39 | /** 40 | * Add post-formats support. 41 | */ 42 | add_theme_support( 43 | 'post-formats', 44 | array( 45 | 'link', 46 | 'aside', 47 | 'gallery', 48 | 'image', 49 | 'quote', 50 | 'status', 51 | 'video', 52 | 'audio', 53 | 'chat', 54 | ) 55 | ); 56 | 57 | /* 58 | * Enable support for Post Thumbnails on posts and pages. 59 | * 60 | * @link https://developer.wordpress.org/themes/functionality/featured-images-post-thumbnails/ 61 | */ 62 | add_theme_support( 'post-thumbnails' ); 63 | set_post_thumbnail_size( 1568, 9999 ); 64 | 65 | /* 66 | * Switch default core markup for search form, comment form, and comments 67 | * to output valid HTML5. 68 | */ 69 | add_theme_support( 70 | 'html5', 71 | array( 72 | 'comment-form', 73 | 'comment-list', 74 | 'gallery', 75 | 'caption', 76 | 'style', 77 | 'script', 78 | 'navigation-widgets', 79 | ) 80 | ); 81 | 82 | /* 83 | * Add support for core custom logo. 84 | * 85 | * @link https://codex.wordpress.org/Theme_Logo 86 | */ 87 | $logo_width = 300; 88 | $logo_height = 100; 89 | 90 | add_theme_support( 91 | 'custom-logo', 92 | array( 93 | 'height' => $logo_height, 94 | 'width' => $logo_width, 95 | 'flex-width' => true, 96 | 'flex-height' => true, 97 | 'unlink-homepage-logo' => true, 98 | ) 99 | ); 100 | 101 | // Add theme support for selective refresh for widgets. 102 | add_theme_support( 'customize-selective-refresh-widgets' ); 103 | 104 | // Add support for full and wide align images. 105 | add_theme_support( 'align-wide' ); 106 | 107 | // Add support for editor styles. 108 | add_theme_support( 'editor-styles' ); 109 | 110 | // Add support for responsive embedded content. 111 | add_theme_support( 'responsive-embeds' ); 112 | } 113 | } 114 | add_action( 'after_setup_theme', 'wp_empty_theme_setup' ); 115 | 116 | /** 117 | * Sets the content width in pixels, based on the theme's design and stylesheet. 118 | * 119 | * Priority 0 to make it available to lower priority callbacks. 120 | * 121 | * @global int $content_width Content width. 122 | */ 123 | function wp_empty_theme_content_width() { 124 | // This variable is intended to be overruled from themes. 125 | // Open WPCS issue: {@link https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/1043}. 126 | // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound 127 | $GLOBALS['content_width'] = 750; 128 | } 129 | add_action( 'after_setup_theme', 'wp_empty_theme_content_width', 0 ); 130 | 131 | /** 132 | * Prints the minimum theme stylesheet with WP-required directives. 133 | */ 134 | function wp_empty_theme_print_min_style() { 135 | $css = file_get_contents( get_stylesheet_directory() . '/min-style.css' ); 136 | ?> 137 | 140 | %2$s'; 14 | 15 | $time_string = sprintf( 16 | $time_string, 17 | esc_attr( get_the_date( DATE_W3C ) ), 18 | esc_html( get_the_date() ) 19 | ); 20 | echo ''; 21 | printf( 22 | /* translators: %s: Publish date. */ 23 | esc_html__( 'Published %s', 'wp-empty-theme' ), 24 | $time_string // phpcs:ignore WordPress.Security.EscapeOutput 25 | ); 26 | echo ''; 27 | } 28 | } 29 | 30 | if ( ! function_exists( 'wp_empty_theme_posted_by' ) ) { 31 | /** 32 | * Prints HTML with meta information about theme author. 33 | */ 34 | function wp_empty_theme_posted_by() { 35 | if ( ! get_the_author_meta( 'description' ) && post_type_supports( get_post_type(), 'author' ) ) { 36 | echo ''; 37 | printf( 38 | /* translators: %s: Author name. */ 39 | esc_html__( 'By %s', 'wp-empty-theme' ), 40 | '' . esc_html( get_the_author() ) . '' 41 | ); 42 | echo ''; 43 | } 44 | } 45 | } 46 | 47 | if ( ! function_exists( 'wp_empty_theme_entry_meta_footer' ) ) { 48 | /** 49 | * Prints HTML with meta information for the categories, tags and comments. 50 | * Footer entry meta is displayed differently in archives and single posts. 51 | */ 52 | function wp_empty_theme_entry_meta_footer() { 53 | 54 | // Early exit if not a post. 55 | if ( 'post' !== get_post_type() ) { 56 | return; 57 | } 58 | 59 | // Hide meta information on pages. 60 | if ( ! is_single() ) { 61 | 62 | if ( is_sticky() ) { 63 | echo '

' . esc_html_x( 'Featured post', 'Label for sticky posts', 'wp-empty-theme' ) . '

'; 64 | } 65 | 66 | // Posted on. 67 | wp_empty_theme_posted_on(); 68 | 69 | // Edit post link. 70 | edit_post_link( 71 | sprintf( 72 | /* translators: %s: Name of current post. Only visible to screen readers. */ 73 | esc_html__( 'Edit %s', 'wp-empty-theme' ), 74 | '' 75 | ), 76 | '', 77 | '
' 78 | ); 79 | 80 | if ( has_category() || has_tag() ) { 81 | 82 | echo '

'; 83 | 84 | /* translators: Used between list items, there is a space after the comma. */ 85 | $categories_list = get_the_category_list( __( ', ', 'wp-empty-theme' ) ); 86 | if ( $categories_list ) { 87 | printf( 88 | /* translators: %s: List of categories. */ 89 | '' . esc_html__( 'Categorized as %s', 'wp-empty-theme' ) . ' ', 90 | $categories_list // phpcs:ignore WordPress.Security.EscapeOutput 91 | ); 92 | } 93 | 94 | /* translators: Used between list items, there is a space after the comma. */ 95 | $tags_list = get_the_tag_list( '', __( ', ', 'wp-empty-theme' ) ); 96 | if ( $tags_list ) { 97 | printf( 98 | /* translators: %s: List of tags. */ 99 | '' . esc_html__( 'Tagged %s', 'wp-empty-theme' ) . '', 100 | $tags_list // phpcs:ignore WordPress.Security.EscapeOutput 101 | ); 102 | } 103 | echo '

'; 104 | } 105 | } else { 106 | 107 | echo '

'; 108 | // Posted on. 109 | wp_empty_theme_posted_on(); 110 | // Posted by. 111 | wp_empty_theme_posted_by(); 112 | // Edit post link. 113 | edit_post_link( 114 | sprintf( 115 | /* translators: %s: Name of current post. Only visible to screen readers. */ 116 | esc_html__( 'Edit %s', 'wp-empty-theme' ), 117 | '' 118 | ), 119 | '', 120 | '' 121 | ); 122 | echo '

'; 123 | 124 | if ( has_category() || has_tag() ) { 125 | 126 | echo '

'; 127 | 128 | /* translators: Used between list items, there is a space after the comma. */ 129 | $categories_list = get_the_category_list( __( ', ', 'wp-empty-theme' ) ); 130 | if ( $categories_list ) { 131 | printf( 132 | /* translators: %s: List of categories. */ 133 | '' . esc_html__( 'Categorized as %s', 'wp-empty-theme' ) . ' ', 134 | $categories_list // phpcs:ignore WordPress.Security.EscapeOutput 135 | ); 136 | } 137 | 138 | /* translators: Used between list items, there is a space after the comma. */ 139 | $tags_list = get_the_tag_list( '', __( ', ', 'wp-empty-theme' ) ); 140 | if ( $tags_list ) { 141 | printf( 142 | /* translators: %s: List of tags. */ 143 | '' . esc_html__( 'Tagged %s', 'wp-empty-theme' ) . '', 144 | $tags_list // phpcs:ignore WordPress.Security.EscapeOutput 145 | ); 146 | } 147 | echo '

'; 148 | } 149 | } 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Code_Obfuscation_Check.php: -------------------------------------------------------------------------------- 1 | flags = $flags; 48 | } 49 | 50 | /** 51 | * Gets the categories for the check. 52 | * 53 | * Every check must have at least one category. 54 | * 55 | * @since n.e.x.t 56 | * 57 | * @return array The categories for the check. 58 | */ 59 | public function get_categories() { 60 | return array( Check_Categories::CATEGORY_PLUGIN_REPO ); 61 | } 62 | 63 | /** 64 | * Amends the given result by running the check on the given list of files. 65 | * 66 | * @since n.e.x.t 67 | * 68 | * @param Check_Result $result The check result to amend, including the plugin context to check. 69 | * @param array $files List of absolute file paths. 70 | * 71 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 72 | * the check). 73 | */ 74 | protected function check_files( Check_Result $result, array $files ) { 75 | $php_files = self::filter_files_by_extension( $files, 'php' ); 76 | 77 | if ( $this->flags & self::TYPE_ZEND ) { 78 | $this->look_for_zendguard( $result, $php_files ); 79 | } 80 | if ( $this->flags & self::TYPE_SOURCEGUARDIAN ) { 81 | $this->look_for_sourceguardian( $result, $php_files ); 82 | } 83 | if ( $this->flags & self::TYPE_IONCUBE ) { 84 | $this->look_for_ioncube( $result, $php_files ); 85 | } 86 | } 87 | 88 | /** 89 | * Looks for Zend Guard obfuscated files and amends the given result with an error if found. 90 | * 91 | * @since n.e.x.t 92 | * 93 | * @param Check_Result $result The check result to amend, including the plugin context to check. 94 | * @param array $php_files List of absolute PHP file paths. 95 | */ 96 | protected function look_for_zendguard( Check_Result $result, array $php_files ) { 97 | $obfuscated_file = self::file_preg_match( '/(<\?php \@Zend;)|(This file was encoded by)/', $php_files ); 98 | if ( $obfuscated_file ) { 99 | $this->add_result_error_for_file( 100 | $result, 101 | sprintf( 102 | /* translators: %s: tool name */ 103 | __( 'Code Obfuscation tools are not permitted. Detected: %s', 'plugin-check' ), 104 | __( 'Zend Guard', 'plugin-check' ) 105 | ), 106 | 'obfuscated_code_detected', 107 | $obfuscated_file 108 | ); 109 | } 110 | } 111 | 112 | /** 113 | * Looks for Source Guardian obfuscated files and amends the given result with an error if found. 114 | * 115 | * @since n.e.x.t 116 | * 117 | * @param Check_Result $result The check result to amend, including the plugin context to check. 118 | * @param array $php_files List of absolute PHP file paths. 119 | */ 120 | protected function look_for_sourceguardian( Check_Result $result, array $php_files ) { 121 | $obfuscated_file = self::file_preg_match( "/(sourceguardian\.com)|(function_exists$'sg_load'$)|(\$__x=)/", $php_files ); 122 | if ( $obfuscated_file ) { 123 | $this->add_result_error_for_file( 124 | $result, 125 | sprintf( 126 | /* translators: %s: tool name */ 127 | __( 'Code Obfuscation tools are not permitted. Detected: %s', 'plugin-check' ), 128 | __( 'Source Guardian', 'plugin-check' ) 129 | ), 130 | 'obfuscated_code_detected', 131 | $obfuscated_file 132 | ); 133 | } 134 | } 135 | 136 | /** 137 | * Looks for ionCube obfuscated files and amends the given result with an error if found. 138 | * 139 | * @since n.e.x.t 140 | * 141 | * @param Check_Result $result The check result to amend, including the plugin context to check. 142 | * @param array $php_files List of absolute PHP file paths. 143 | */ 144 | protected function look_for_ioncube( Check_Result $result, array $php_files ) { 145 | $obfuscated_file = self::file_str_contains( $php_files, 'ionCube' ); 146 | if ( $obfuscated_file ) { 147 | $this->add_result_error_for_file( 148 | $result, 149 | sprintf( 150 | /* translators: %s: tool name */ 151 | __( 'Code Obfuscation tools are not permitted. Detected: %s', 'plugin-check' ), 152 | __( 'ionCube', 'plugin-check' ) 153 | ), 154 | 'obfuscated_code_detected', 155 | $obfuscated_file 156 | ); 157 | } 158 | } 159 | } 160 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Plugin_Readme_Check.php: -------------------------------------------------------------------------------- 1 | plugin()->is_single_file_plugin() ) { 52 | return; 53 | } 54 | 55 | $plugin_relative_path = $result->plugin()->path(); 56 | 57 | // Filter the readme files. 58 | $readme = $this->filter_files_for_readme( $files, $plugin_relative_path ); 59 | 60 | // If the readme file does not exist, add a warning and skip other tests. 61 | if ( empty( $readme ) ) { 62 | $this->add_result_warning_for_file( 63 | $result, 64 | __( 'The plugin readme.txt does not exist.', 'plugin-check' ), 65 | 'no_plugin_readme', 66 | 'readme.txt' 67 | ); 68 | 69 | return; 70 | } 71 | 72 | // Check the readme file for default text. 73 | $this->check_default_text( $result, $readme ); 74 | 75 | // Check the readme file for a valid license. 76 | $this->check_license( $result, $readme ); 77 | 78 | // Check the readme file for a valid version. 79 | $this->check_stable_tag( $result, $readme ); 80 | } 81 | 82 | /** 83 | * Checks the readme file for default text. 84 | * 85 | * @since n.e.x.t 86 | * 87 | * @param Check_Result $result The Check Result to amend. 88 | * @param array $files Array of plugin files. 89 | */ 90 | private function check_default_text( Check_Result $result, array $files ) { 91 | $default_text_patterns = array( 92 | 'Here is a short description of the plugin.', 93 | 'Tags: tag1', 94 | 'Donate link: http://example.com/', 95 | ); 96 | 97 | foreach ( $default_text_patterns as $pattern ) { 98 | $file = self::file_str_contains( $files, $pattern ); 99 | if ( $file ) { 100 | $this->add_result_warning_for_file( 101 | $result, 102 | __( 'The readme appears to contain default text.', 'plugin-check' ), 103 | 'default_readme_text', 104 | $file 105 | ); 106 | break; 107 | } 108 | } 109 | } 110 | 111 | /** 112 | * Checks the readme file for a valid license. 113 | * 114 | * @since n.e.x.t 115 | * 116 | * @param Check_Result $result The Check Result to amend. 117 | * @param array $files Array of plugin files. 118 | */ 119 | private function check_license( Check_Result $result, array $files ) { 120 | $matches = array(); 121 | // Get the license from the readme file. 122 | $file = self::file_preg_match( '/(License:|License URI:)\s*(.+)*/i', $files, $matches ); 123 | 124 | if ( empty( $matches ) ) { 125 | return; 126 | } 127 | 128 | // Test for a valid SPDX license identifier. 129 | if ( ! preg_match( '/^([a-z0-9\-\+\.]+)(\sor\s([a-z0-9\-\+\.]+))*$/i', $matches[2] ) ) { 130 | $this->add_result_warning_for_file( 131 | $result, 132 | __( 'Your plugin has an invalid license declared. Please update your readme with a valid SPDX license identifier.', 'plugin-check' ), 133 | 'invalid_license', 134 | $file 135 | ); 136 | } 137 | } 138 | 139 | /** 140 | * Checks the readme file stable tag. 141 | * 142 | * @since n.e.x.t 143 | * 144 | * @param Check_Result $result The Check Result to amend. 145 | * @param array $files Array of plugin files. 146 | */ 147 | private function check_stable_tag( Check_Result $result, array $files ) { 148 | $matches = array(); 149 | // Get the Stable tag from readme file. 150 | $file = self::file_preg_match( '/Stable tag:\s*([a-z0-9\.]+)/i', $files, $matches ); 151 | if ( ! $file ) { 152 | return; 153 | } 154 | 155 | $stable_tag = isset( $matches[1] ) ? $matches[1] : ''; 156 | 157 | if ( 'trunk' === $stable_tag ) { 158 | $this->add_result_error_for_file( 159 | $result, 160 | __( "It's recommended not to use 'Stable Tag: trunk'.", 'plugin-check' ), 161 | 'trunk_stable_tag', 162 | $file 163 | ); 164 | } 165 | 166 | // Check the readme file Stable tag against the plugin's main file version. 167 | $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $result->plugin()->basename() ); 168 | 169 | if ( 170 | $stable_tag && ! empty( $plugin_data['Version'] ) && 171 | $stable_tag !== $plugin_data['Version'] 172 | ) { 173 | $this->add_result_error_for_file( 174 | $result, 175 | __( 'The Stable Tag in your readme file does not match the version in your main plugin file.', 'plugin-check' ), 176 | 'stable_tag_mismatch', 177 | $file 178 | ); 179 | } 180 | } 181 | } 182 | -------------------------------------------------------------------------------- /includes/Traits/URL_Aware.php: -------------------------------------------------------------------------------- 1 | array(), 59 | 'post' => array(), 60 | 'server' => array(), 61 | 'global_vars' => array(), 62 | ); 63 | 64 | /** 65 | * Backups the original values for any global state that may be modified to be restored later. 66 | * 67 | * @since n.e.x.t 68 | */ 69 | protected function backup_globals() { 70 | $this->global_values = array( 71 | 'get' => $_GET, // phpcs:ignore WordPress.Security.NonceVerification.Recommended 72 | 'post' => $_POST, // phpcs:ignore WordPress.Security.NonceVerification.Missing 73 | 'server' => $_SERVER, 74 | ); 75 | 76 | $global_vars = array(); 77 | $global_keys = array_merge( $this->query_globals, $this->wp_globals ); 78 | 79 | foreach ( $global_keys as $query_global ) { 80 | if ( isset( $GLOBALS[ $query_global ] ) ) { 81 | $global_vars[ $query_global ] = $GLOBALS[ $query_global ]; 82 | } 83 | } 84 | 85 | $this->global_values['global_vars'] = $global_vars; 86 | } 87 | 88 | /** 89 | * Restores the original values for any global state that may have been modified. 90 | * 91 | * @since n.e.x.t 92 | */ 93 | protected function restore_globals() { 94 | $_GET = $this->global_values['get']; 95 | $_POST = $this->global_values['post']; 96 | $_SERVER = $this->global_values['server']; 97 | 98 | $global_vars = $this->global_values['global_vars']; 99 | $global_keys = array_merge( $this->query_globals, $this->wp_globals ); 100 | 101 | foreach ( $global_keys as $query_global ) { 102 | if ( isset( $global_vars[ $query_global ] ) ) { 103 | $GLOBALS[ $query_global ] = $global_vars[ $query_global ]; 104 | } else { 105 | unset( $GLOBALS[ $query_global ] ); 106 | } 107 | } 108 | } 109 | 110 | /** 111 | * Sets the global state to as if a given URL has been requested. 112 | * 113 | * @since n.e.x.t 114 | * 115 | * @param string $url URL to simulate request for. 116 | * 117 | * @SuppressWarnings(PHPMD.NPathComplexity) 118 | */ 119 | protected function go_to( $url ) { 120 | /* 121 | * Note: the WP and WP_Query classes like to silently fetch parameters 122 | * from all over the place (globals, GET, etc), which makes it tricky 123 | * to run them more than once without very carefully clearing everything. 124 | */ 125 | $_GET = array(); 126 | $_POST = array(); 127 | 128 | foreach ( $this->query_globals as $v ) { 129 | if ( isset( $GLOBALS[ $v ] ) ) { 130 | unset( $GLOBALS[ $v ] ); 131 | } 132 | } 133 | 134 | $parts = wp_parse_url( $url ); 135 | if ( isset( $parts['scheme'] ) ) { 136 | $req = isset( $parts['path'] ) ? $parts['path'] : ''; 137 | if ( isset( $parts['query'] ) ) { 138 | $req .= '?' . $parts['query']; 139 | // Parse the URL query vars into $_GET. 140 | // phpcs:ignore WordPress.Security.NonceVerification.Recommended 141 | parse_str( $parts['query'], $_GET ); 142 | } 143 | } else { 144 | $req = $url; 145 | } 146 | 147 | if ( ! isset( $parts['query'] ) ) { 148 | $parts['query'] = ''; 149 | } 150 | 151 | $_SERVER['REQUEST_URI'] = $req; 152 | unset( $_SERVER['PATH_INFO'] ); 153 | 154 | unset( $GLOBALS['wp_query'], $GLOBALS['wp_the_query'] ); 155 | $GLOBALS['wp_the_query'] = new \WP_Query(); 156 | $GLOBALS['wp_query'] = $GLOBALS['wp_the_query']; 157 | 158 | $public_query_vars = $GLOBALS['wp']->public_query_vars; 159 | $private_query_vars = $GLOBALS['wp']->private_query_vars; 160 | 161 | $GLOBALS['wp'] = new \WP(); 162 | $GLOBALS['wp']->public_query_vars = $public_query_vars; 163 | $GLOBALS['wp']->private_query_vars = $private_query_vars; 164 | 165 | // Clean up query vars. 166 | foreach ( $GLOBALS['wp']->public_query_vars as $v ) { 167 | unset( $GLOBALS[ $v ] ); 168 | } 169 | 170 | foreach ( $GLOBALS['wp']->private_query_vars as $v ) { 171 | unset( $GLOBALS[ $v ] ); 172 | } 173 | 174 | // Set up query vars for taxonomies and post types. 175 | foreach ( get_taxonomies( array(), 'objects' ) as $t ) { 176 | if ( $t->publicly_queryable && ! empty( $t->query_var ) ) { 177 | $GLOBALS['wp']->add_query_var( $t->query_var ); 178 | } 179 | } 180 | 181 | foreach ( get_post_types( array(), 'objects' ) as $t ) { 182 | if ( is_post_type_viewable( $t ) && ! empty( $t->query_var ) ) { 183 | $GLOBALS['wp']->add_query_var( $t->query_var ); 184 | } 185 | } 186 | 187 | $GLOBALS['wp']->main( $parts['query'] ); 188 | } 189 | 190 | /** 191 | * Simulate all the urls like WP and run the cleanup function. 192 | * 193 | * @since n.e.x.t 194 | * 195 | * @param array $urls An array of URLs to run. 196 | * @param callable $callback Callback function to run for each URL. 197 | */ 198 | protected function run_for_urls( $urls, $callback ) { 199 | if ( ! empty( $urls ) ) { 200 | foreach ( $urls as $url ) { 201 | $this->go_to( $url ); 202 | $callback( $url ); 203 | } 204 | } 205 | } 206 | } 207 | -------------------------------------------------------------------------------- /includes/Checker/Runtime_Environment_Setup.php: -------------------------------------------------------------------------------- 1 | set_prefix( $table_prefix . 'pc_' ); 35 | 36 | // Create and populate the test database tables if they do not exist. 37 | if ( $wpdb->posts !== $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $wpdb->posts ) ) ) { 38 | /* 39 | * Set the same permalink structure *before* install finishes, 40 | * so that wp_install_maybe_enable_pretty_permalinks() does not flush rewrite rules. 41 | * 42 | * See https://github.com/WordPress/plugin-check/issues/330 43 | */ 44 | add_action( 45 | 'populate_options', 46 | static function () use ( $permalink_structure ) { 47 | add_option( 'permalink_structure', $permalink_structure ); 48 | } 49 | ); 50 | 51 | wp_install( 52 | 'Plugin Check', 53 | 'plugincheck', 54 | 'demo@plugincheck.test', 55 | false 56 | ); 57 | 58 | // Activate the same plugins in the test environment. 59 | update_option( 'active_plugins', $active_plugins ); 60 | } 61 | 62 | // Restore the old prefix. 63 | $wpdb->set_prefix( $old_prefix ); 64 | 65 | // Return early if the plugin check object cache already exists. 66 | if ( defined( 'WP_PLUGIN_CHECK_OBJECT_CACHE_DROPIN_VERSION' ) && WP_PLUGIN_CHECK_OBJECT_CACHE_DROPIN_VERSION ) { 67 | return; 68 | } 69 | 70 | // Create the object-cache.php file. 71 | if ( $wp_filesystem || WP_Filesystem() ) { 72 | // Do not replace the object-cache.php file if it already exists. 73 | if ( ! $wp_filesystem->exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { 74 | $wp_filesystem->copy( WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'drop-ins/object-cache.copy.php', WP_CONTENT_DIR . '/object-cache.php' ); 75 | } 76 | } 77 | } 78 | 79 | /** 80 | * Cleans up the runtime environment setup. 81 | * 82 | * @since n.e.x.t 83 | */ 84 | public function clean_up() { 85 | global $wpdb, $table_prefix, $wp_filesystem; 86 | 87 | require_once ABSPATH . '/wp-admin/includes/upgrade.php'; 88 | 89 | $old_prefix = $wpdb->set_prefix( $table_prefix . 'pc_' ); 90 | $tables = $wpdb->tables(); 91 | 92 | foreach ( $tables as $table ) { 93 | $wpdb->query( "DROP TABLE IF EXISTS `$table`" ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared 94 | } 95 | 96 | // Restore the old prefix. 97 | $wpdb->set_prefix( $old_prefix ); 98 | 99 | // Return early if the plugin check object cache does not exist. 100 | if ( ! defined( 'WP_PLUGIN_CHECK_OBJECT_CACHE_DROPIN_VERSION' ) || ! WP_PLUGIN_CHECK_OBJECT_CACHE_DROPIN_VERSION ) { 101 | return; 102 | } 103 | 104 | // Remove the object-cache.php file. 105 | if ( $wp_filesystem || WP_Filesystem() ) { 106 | if ( ! $wp_filesystem->exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { 107 | return; 108 | } 109 | 110 | // Check the drop-in file matches the copy. 111 | $original_content = $wp_filesystem->get_contents( WP_CONTENT_DIR . '/object-cache.php' ); 112 | $copy_content = $wp_filesystem->get_contents( WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'drop-ins/object-cache.copy.php' ); 113 | 114 | if ( $original_content && $original_content === $copy_content ) { 115 | $wp_filesystem->delete( WP_CONTENT_DIR . '/object-cache.php' ); 116 | } 117 | } 118 | } 119 | 120 | /** 121 | * Checks if the WordPress Environment can be set up for runtime checks. 122 | * 123 | * @since n.e.x.t 124 | * 125 | * @return bool Returns true if the runtime environment can be set up, false if not. 126 | */ 127 | public function can_set_up() { 128 | global $wp_filesystem; 129 | 130 | require_once ABSPATH . '/wp-admin/includes/upgrade.php'; 131 | 132 | if ( ! is_object( $wp_filesystem ) && ! WP_Filesystem() ) { 133 | return false; 134 | } 135 | 136 | // Check if the object-cache.php file exists. 137 | if ( $wp_filesystem->exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { 138 | // Check If the object-cache.php file is the Plugin Check version. 139 | if ( defined( 'WP_PLUGIN_CHECK_OBJECT_CACHE_DROPIN_VERSION' ) && WP_PLUGIN_CHECK_OBJECT_CACHE_DROPIN_VERSION ) { 140 | return true; 141 | } 142 | } else { 143 | // Get the correct Plugin Check directory when run too early. 144 | if ( ! defined( 'WP_PLUGIN_CHECK_PLUGIN_DIR_PATH' ) ) { 145 | $object_cache_copy = dirname( __DIR__, 2 ) . '/plugin-check/drop-ins/object-cache.copy.php'; 146 | } else { 147 | $object_cache_copy = WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'drop-ins/object-cache.copy.php'; 148 | } 149 | 150 | // If the file does not exist, check if we can place it. 151 | $wp_filesystem->copy( $object_cache_copy, WP_CONTENT_DIR . '/object-cache.php' ); 152 | 153 | /** 154 | * PHPStan ignore reason: PHPStan raised an issue because we have redundant file existence checks in our code. 155 | * We perform this double check because we want to ensure that we can write the file we're testing. 156 | * 157 | * @phpstan-ignore-next-line 158 | */ 159 | if ( $wp_filesystem->exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { 160 | // Remove the file before returning. 161 | $wp_filesystem->delete( WP_CONTENT_DIR . '/object-cache.php' ); 162 | 163 | return true; 164 | } 165 | } 166 | 167 | return false; 168 | } 169 | } 170 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Abstract_PHP_CodeSniffer_Check.php: -------------------------------------------------------------------------------- 1 | true, 34 | 'extensions' => true, 35 | 'sniffs' => true, 36 | 'exclude' => true, //phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_exclude 37 | ); 38 | 39 | /** 40 | * Returns an associative array of arguments to pass to PHPCS. 41 | * 42 | * @since n.e.x.t 43 | * 44 | * @return array { 45 | * An associative array of PHPCS CLI arguments. Can include one or more of the following options. 46 | * 47 | * @type string $standard The name or path to the coding standard to check against. 48 | * @type string $extensions A comma separated list of file extensions to check against. 49 | * @type string $sniffs A comma separated list of sniff codes to include from checks. 50 | * @type string $exclude A comma separated list of sniff codes to exclude from checks. 51 | * } 52 | */ 53 | abstract protected function get_args(); 54 | 55 | /** 56 | * Amends the given result by running the check on the associated plugin. 57 | * 58 | * @since n.e.x.t 59 | * 60 | * @param Check_Result $result The check result to amend, including the plugin context to check. 61 | * 62 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 63 | * the check). 64 | */ 65 | final public function run( Check_Result $result ) { 66 | // Include the PHPCS autoloader. 67 | $autoloader = WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'vendor/squizlabs/php_codesniffer/autoload.php'; 68 | 69 | if ( file_exists( $autoloader ) ) { 70 | include_once $autoloader; 71 | } 72 | 73 | if ( ! class_exists( '\PHP_CodeSniffer\Runner' ) ) { 74 | throw new Exception( 75 | __( 'Unable to find PHPCS Runner class.', 'plugin-check' ) 76 | ); 77 | } 78 | 79 | // Backup the original command line arguments. 80 | $orig_cmd_args = $_SERVER['argv']; 81 | 82 | // Create the default arguments for PHPCS. 83 | $defaults = array( 84 | '', 85 | $result->plugin()->location(), 86 | '--report=Json', 87 | '--report-width=9999', 88 | ); 89 | 90 | $directories_to_ignore = Plugin_Request_Utility::get_directories_to_ignore(); 91 | if ( ! empty( $directories_to_ignore ) ) { 92 | $defaults[] = '--ignore=*/' . implode( '/*,*/', $directories_to_ignore ) . '/*'; 93 | } 94 | 95 | // Set the check arguments for PHPCS. 96 | $_SERVER['argv'] = $this->parse_argv( $this->get_args(), $defaults ); 97 | 98 | // Reset PHP_CodeSniffer config. 99 | $this->reset_php_codesniffer_config(); 100 | 101 | // Run PHPCS. 102 | try { 103 | ob_start(); 104 | $runner = new Runner(); 105 | $runner->runPHPCS(); 106 | $reports = ob_get_clean(); 107 | } catch ( Exception $e ) { 108 | $_SERVER['argv'] = $orig_cmd_args; 109 | throw $e; 110 | } 111 | 112 | // Restore original arguments. 113 | $_SERVER['argv'] = $orig_cmd_args; 114 | 115 | // Parse the reports into data to add to the overall $result. 116 | $reports = json_decode( trim( $reports ), true ); 117 | 118 | if ( empty( $reports['files'] ) ) { 119 | return; 120 | } 121 | 122 | foreach ( $reports['files'] as $file_name => $file_results ) { 123 | if ( empty( $file_results['messages'] ) ) { 124 | continue; 125 | } 126 | 127 | foreach ( $file_results['messages'] as $file_message ) { 128 | $this->add_result_message_for_file( 129 | $result, 130 | strtoupper( $file_message['type'] ) === 'ERROR', 131 | $file_message['message'], 132 | $file_message['source'], 133 | $file_name, 134 | $file_message['line'], 135 | $file_message['column'] 136 | ); 137 | } 138 | } 139 | } 140 | 141 | /** 142 | * Parse the command arguments. 143 | * 144 | * @since n.e.x.t 145 | * 146 | * @param array $argv An array of arguments to pass. 147 | * @param array $defaults An array of default arguments. 148 | * @return array An indexed array of PHPCS CLI arguments. 149 | */ 150 | private function parse_argv( $argv, $defaults ) { 151 | // Only accept allowed PHPCS arguments from check arguments array. 152 | $check_args = array_intersect_key( $argv, $this->allowed_args ); 153 | 154 | // Format check arguments for PHPCS. 155 | foreach ( $check_args as $key => $value ) { 156 | $defaults[] = "--{$key}=$value"; 157 | } 158 | 159 | return $defaults; 160 | } 161 | 162 | /** 163 | * Resets \PHP_CodeSniffer\Config::$overriddenDefaults to prevent 164 | * incorrect results when running multiple checks. 165 | * 166 | * @since n.e.x.t 167 | */ 168 | private function reset_php_codesniffer_config() { 169 | if ( class_exists( '\PHP_CodeSniffer\Config' ) ) { 170 | /* 171 | * PHPStan ignore reason: PHPStan raised an issue because we can't 172 | * use class in ReflectionClass. 173 | * 174 | * @phpstan-ignore-next-line 175 | */ 176 | $reflected_phpcs_config = new \ReflectionClass( '\PHP_CodeSniffer\Config' ); 177 | $overridden_defaults = $reflected_phpcs_config->getProperty( 'overriddenDefaults' ); 178 | $overridden_defaults->setAccessible( true ); 179 | $overridden_defaults->setValue( array() ); 180 | $overridden_defaults->setAccessible( false ); 181 | } 182 | } 183 | } 184 | -------------------------------------------------------------------------------- /includes/Checker/Checks/File_Type_Check.php: -------------------------------------------------------------------------------- 1 | flags = $flags; 50 | } 51 | 52 | /** 53 | * Gets the categories for the check. 54 | * 55 | * Every check must have at least one category. 56 | * 57 | * @since n.e.x.t 58 | * 59 | * @return array The categories for the check. 60 | */ 61 | public function get_categories() { 62 | return array( Check_Categories::CATEGORY_PLUGIN_REPO ); 63 | } 64 | 65 | /** 66 | * Amends the given result by running the check on the given list of files. 67 | * 68 | * @since n.e.x.t 69 | * 70 | * @param Check_Result $result The check result to amend, including the plugin context to check. 71 | * @param array $files List of absolute file paths. 72 | * 73 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 74 | * the check). 75 | */ 76 | protected function check_files( Check_Result $result, array $files ) { 77 | if ( $this->flags & self::TYPE_COMPRESSED ) { 78 | $this->look_for_compressed_files( $result, $files ); 79 | } 80 | if ( $this->flags & self::TYPE_PHAR ) { 81 | $this->look_for_phar_files( $result, $files ); 82 | } 83 | if ( $this->flags & self::TYPE_VCS ) { 84 | $this->look_for_vcs_directories( $result, $files ); 85 | } 86 | if ( $this->flags & self::TYPE_HIDDEN ) { 87 | $this->look_for_hidden_files( $result, $files ); 88 | } 89 | if ( $this->flags & self::TYPE_APPLICATION ) { 90 | $this->look_for_application_files( $result, $files ); 91 | } 92 | } 93 | 94 | /** 95 | * Looks for compressed files and amends the given result with an error if found. 96 | * 97 | * @since n.e.x.t 98 | * 99 | * @param Check_Result $result The check result to amend, including the plugin context to check. 100 | * @param array $files List of absolute file paths. 101 | */ 102 | protected function look_for_compressed_files( Check_Result $result, array $files ) { 103 | $compressed_files = self::filter_files_by_extensions( $files, array( 'zip', 'gz', 'tgz', 'rar', 'tar', '7z' ) ); 104 | if ( $compressed_files ) { 105 | foreach ( $compressed_files as $file ) { 106 | $this->add_result_error_for_file( 107 | $result, 108 | __( 'Compressed files are not permitted.', 'plugin-check' ), 109 | 'compressed_files', 110 | $file 111 | ); 112 | } 113 | } 114 | } 115 | 116 | /** 117 | * Looks for PHAR files and amends the given result with an error if found. 118 | * 119 | * @since n.e.x.t 120 | * 121 | * @param Check_Result $result The check result to amend, including the plugin context to check. 122 | * @param array $files List of absolute file paths. 123 | */ 124 | protected function look_for_phar_files( Check_Result $result, array $files ) { 125 | $phar_files = self::filter_files_by_extension( $files, 'phar' ); 126 | if ( $phar_files ) { 127 | foreach ( $phar_files as $file ) { 128 | $this->add_result_error_for_file( 129 | $result, 130 | __( 'Phar files are not permitted.', 'plugin-check' ), 131 | 'phar_files', 132 | $file 133 | ); 134 | } 135 | } 136 | } 137 | 138 | /** 139 | * Looks for VCS directories and amends the given result with an error if found. 140 | * 141 | * @since n.e.x.t 142 | * 143 | * @param Check_Result $result The check result to amend, including the plugin context to check. 144 | * @param array $files List of absolute file paths. 145 | */ 146 | protected function look_for_vcs_directories( Check_Result $result, array $files ) { 147 | $directories = array_flip( array( '.git', '.svn', '.hg', '.bzr' ) ); 148 | 149 | $vcs_directories = array_filter( 150 | array_unique( 151 | array_map( 152 | function ( $file ) { 153 | return dirname( $file ); 154 | }, 155 | $files 156 | ) 157 | ), 158 | function ( $directory ) use ( $directories ) { 159 | return isset( $directories[ basename( $directory ) ] ); 160 | } 161 | ); 162 | 163 | if ( $vcs_directories ) { 164 | // Only use an error in production, otherwise a warning. 165 | $is_error = ( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) && 'production' === wp_get_environment_type(); 166 | foreach ( $vcs_directories as $dir ) { 167 | $this->add_result_message_for_file( 168 | $result, 169 | $is_error, 170 | __( 'Version control checkouts should not be present.', 'plugin-check' ), 171 | 'vcs_present', 172 | $dir 173 | ); 174 | } 175 | } 176 | } 177 | 178 | /** 179 | * Looks for hidden files and amends the given result with an error if found. 180 | * 181 | * @since n.e.x.t 182 | * 183 | * @param Check_Result $result The check result to amend, including the plugin context to check. 184 | * @param array $files List of absolute file paths. 185 | */ 186 | protected function look_for_hidden_files( Check_Result $result, array $files ) { 187 | // Any files outside of 'vendor' or 'node_modules' directories that start with a period. 188 | $hidden_files = self::filter_files_by_regex( $files, '/^((?!\/vendor\/|\/node_modules\/).)*\/\.\w+(\.\w+)*$/' ); 189 | if ( $hidden_files ) { 190 | foreach ( $hidden_files as $file ) { 191 | $this->add_result_error_for_file( 192 | $result, 193 | __( 'Hidden files are not permitted.', 'plugin-check' ), 194 | 'hidden_files', 195 | $file 196 | ); 197 | } 198 | } 199 | } 200 | 201 | /** 202 | * Looks for application files and amends the given result with an error if found. 203 | * 204 | * @since n.e.x.t 205 | * 206 | * @param Check_Result $result The check result to amend, including the plugin context to check. 207 | * @param array $files List of absolute file paths. 208 | */ 209 | protected function look_for_application_files( Check_Result $result, array $files ) { 210 | $application_files = self::filter_files_by_extensions( 211 | $files, 212 | array( 'a', 'bin', 'bpk', 'deploy', 'dist', 'distz', 'dmg', 'dms', 'DS_Store', 'dump', 'elc', 'exe', 'iso', 'lha', 'lrf', 'lzh', 'o', 'obj', 'phar', 'pkg', 'sh', 'so' ) 213 | ); 214 | if ( $application_files ) { 215 | foreach ( $application_files as $file ) { 216 | $this->add_result_error_for_file( 217 | $result, 218 | __( 'Application files are not permitted.', 'plugin-check' ), 219 | 'application_detected', 220 | $file 221 | ); 222 | } 223 | } 224 | } 225 | } 226 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Plugin_Updater_Check.php: -------------------------------------------------------------------------------- 1 | flags = $flags; 49 | } 50 | 51 | /** 52 | * Gets the categories for the check. 53 | * 54 | * Every check must have at least one category. 55 | * 56 | * @since n.e.x.t 57 | * 58 | * @return array The categories for the check. 59 | */ 60 | public function get_categories() { 61 | return array( Check_Categories::CATEGORY_PLUGIN_REPO ); 62 | } 63 | 64 | /** 65 | * Amends the given result by running the check on the given list of files. 66 | * 67 | * @since n.e.x.t 68 | * 69 | * @param Check_Result $result The check result to amend, including the plugin context to check. 70 | * @param array $files List of absolute file paths. 71 | * 72 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 73 | * the check). 74 | */ 75 | protected function check_files( Check_Result $result, array $files ) { 76 | $php_files = self::filter_files_by_extension( $files, 'php' ); 77 | 78 | // Looks for "UpdateURI" in plugin header. 79 | if ( $this->flags & self::TYPE_PLUGIN_UPDATE_URI_HEADER ) { 80 | $this->look_for_update_uri_header( $result ); 81 | } 82 | 83 | // Looks for special updater file. 84 | if ( $this->flags & self::TYPE_PLUGIN_UPDATER_FILE ) { 85 | $this->look_for_updater_file( $result, $php_files ); 86 | } 87 | 88 | // Looks for plugin updater code in plugin files. 89 | if ( $this->flags & self::TYPE_PLUGIN_UPDATERS ) { 90 | $this->look_for_plugin_updaters( $result, $php_files ); 91 | } 92 | 93 | // Looks for plugin updater routines in plugin files. 94 | if ( $this->flags & self::TYPE_PLUGIN_UPDATER_ROUTINES ) { 95 | $this->look_for_updater_routines( $result, $php_files ); 96 | } 97 | } 98 | 99 | /** 100 | * Looks for UpdateURI in plugin header and amends the given result with an error if found. 101 | * 102 | * @since n.e.x.t 103 | * 104 | * @param Check_Result $result The check result to amend, including the plugin context to check. 105 | */ 106 | protected function look_for_update_uri_header( Check_Result $result ) { 107 | if ( ! function_exists( 'get_plugin_data' ) ) { 108 | require_once ABSPATH . 'wp-admin/includes/plugin.php'; 109 | } 110 | 111 | $plugin_main_file = WP_PLUGIN_DIR . '/' . $result->plugin()->basename(); 112 | $plugin_header = get_plugin_data( $plugin_main_file ); 113 | if ( ! empty( $plugin_header['UpdateURI'] ) ) { 114 | $this->add_result_error_for_file( 115 | $result, 116 | __( 'Plugin Updater detected. Use of the Update URI header is not helpful in plugins hosted on WordPress.org.', 'plugin-check' ), 117 | 'plugin_updater_detected', 118 | $plugin_main_file 119 | ); 120 | } 121 | } 122 | 123 | /** 124 | * Looks for plugin updater file and amends the given result with an error if found. 125 | * 126 | * @since n.e.x.t 127 | * 128 | * @param Check_Result $result The check result to amend, including the plugin context to check. 129 | * @param array $php_files List of absolute PHP file paths. 130 | */ 131 | protected function look_for_updater_file( Check_Result $result, array $php_files ) { 132 | 133 | $plugin_update_files = self::filter_files_by_regex( $php_files, '/plugin-update-checker\.php$/' ); 134 | 135 | if ( $plugin_update_files ) { 136 | foreach ( $plugin_update_files as $file ) { 137 | $this->add_result_error_for_file( 138 | $result, 139 | sprintf( 140 | /* translators: %s: The match updater file name. */ 141 | __( 'Plugin Updater detected. These are not permitted in WordPress.org hosted plugins. Detected: %s', 'plugin-check' ), 142 | basename( $file ) 143 | ), 144 | 'plugin_updater_detected', 145 | $file 146 | ); 147 | } 148 | } 149 | } 150 | 151 | /** 152 | * Looks for plugin updater code in plugin files and amends the given result with an error if found. 153 | * 154 | * @since n.e.x.t 155 | * 156 | * @param Check_Result $result The check result to amend, including the plugin context to check. 157 | * @param array $php_files List of absolute PHP file paths. 158 | */ 159 | protected function look_for_plugin_updaters( Check_Result $result, array $php_files ) { 160 | 161 | $look_for_regex = array( 162 | '#\'plugin-update-checker\'#', 163 | '#WP_GitHub_Updater#', 164 | '#WPGitHubUpdater#', 165 | '#class [A-Z_]+_Plugin_Updater#i', 166 | '#updater\.\w+\.\w{2,5}#i', 167 | '#site_transient_update_plugins#', 168 | ); 169 | 170 | foreach ( $look_for_regex as $regex ) { 171 | $matches = array(); 172 | $updater_file = self::file_preg_match( $regex, $php_files, $matches ); 173 | if ( $updater_file ) { 174 | $this->add_result_error_for_file( 175 | $result, 176 | sprintf( 177 | /* translators: %s: The match updater string. */ 178 | __( 'Plugin Updater detected. These are not permitted in WordPress.org hosted plugins. Detected: %s', 'plugin-check' ), 179 | esc_attr( $matches[0] ) 180 | ), 181 | 'plugin_updater_detected', 182 | $updater_file 183 | ); 184 | } 185 | } 186 | } 187 | 188 | /** 189 | * Looks for plugin updater routines in plugin files and amends the given result with an error if found. 190 | * 191 | * @since n.e.x.t 192 | * 193 | * @param Check_Result $result The check result to amend, including the plugin context to check. 194 | * @param array $php_files List of absolute PHP file paths. 195 | */ 196 | protected function look_for_updater_routines( Check_Result $result, array $php_files ) { 197 | 198 | $look_for_regex = array( 199 | '#auto_update_plugin#', 200 | '#pre_set_site_transient_update_\w+#i', 201 | '#_site_transient_update_\w+#i', 202 | ); 203 | 204 | foreach ( $look_for_regex as $regex ) { 205 | $matches = array(); 206 | $updater_file = self::file_preg_match( $regex, $php_files, $matches ); 207 | if ( $updater_file ) { 208 | $this->add_result_warning_for_file( 209 | $result, 210 | sprintf( 211 | /* translators: %s: The match file name. */ 212 | __( 'Detected code which may be altering WordPress update routines. Detected: %s', 'plugin-check' ), 213 | esc_html( $matches[0] ) 214 | ), 215 | 'update_modification_detected', 216 | $updater_file 217 | ); 218 | } 219 | } 220 | } 221 | } 222 | -------------------------------------------------------------------------------- /includes/Checker/Default_Check_Collection.php: -------------------------------------------------------------------------------- 1 | $check_obj` pairs. 23 | * 24 | * @since n.e.x.t 25 | * @var array 26 | */ 27 | private $checks; 28 | 29 | /** 30 | * List of check slugs, in the same order as `$checks` - effectively the keys of that array. 31 | * 32 | * @since n.e.x.t 33 | * @var array 34 | */ 35 | private $slugs; 36 | 37 | /** 38 | * Constructor. 39 | * 40 | * @since n.e.x.t 41 | * 42 | * @param array $checks Map of `$check_slug => $check_obj` pairs for the collection. 43 | */ 44 | public function __construct( array $checks ) { 45 | $this->checks = $checks; 46 | $this->slugs = array_keys( $this->checks ); 47 | } 48 | 49 | /** 50 | * Returns the raw indexed array representation of this collection. 51 | * 52 | * @since n.e.x.t 53 | * 54 | * @return array The indexed array of check objects. 55 | */ 56 | public function to_array(): array { 57 | return array_values( $this->checks ); 58 | } 59 | 60 | /** 61 | * Returns the raw map of check slugs and their check objects as a representation of this collection. 62 | * 63 | * @since n.e.x.t 64 | * 65 | * @return array Map of `$check_slug => $check_obj` pairs. 66 | */ 67 | public function to_map(): array { 68 | return $this->checks; 69 | } 70 | 71 | /** 72 | * Returns a new check collection containing the subset of checks based on the given check filter function. 73 | * 74 | * @since n.e.x.t 75 | * 76 | * @phpstan-param callable(Check,string): bool $filter_fn 77 | * 78 | * @param callable $filter_fn Filter function that accepts a Check object and a Check slug and 79 | * should return a boolean for whether to include the check in the new collection. 80 | * @return Check_Collection New check collection, effectively a subset of this one. 81 | */ 82 | public function filter( callable $filter_fn ): Check_Collection { 83 | return new self( 84 | array_filter( 85 | $this->checks, 86 | $filter_fn, 87 | ARRAY_FILTER_USE_BOTH 88 | ) 89 | ); 90 | } 91 | 92 | /** 93 | * Returns a new check collection containing the subset of checks based on the given check slugs. 94 | * 95 | * If the given list is empty, the same collection will be returned without any change. 96 | * 97 | * @since n.e.x.t 98 | * 99 | * @param array $check_slugs List of slugs to limit to only those. If empty, the same collection is returned. 100 | * @return Check_Collection New check collection, effectively a subset of this one. 101 | */ 102 | public function include( array $check_slugs ): Check_Collection { 103 | // Return unmodified collection if no check slugs to limit to are given. 104 | if ( ! $check_slugs ) { 105 | return $this; 106 | } 107 | 108 | $check_slugs = array_flip( $check_slugs ); 109 | 110 | $checks = array(); 111 | foreach ( $this->checks as $slug => $check ) { 112 | if ( ! isset( $check_slugs[ $slug ] ) ) { 113 | continue; 114 | } 115 | 116 | $checks[ $slug ] = $check; 117 | } 118 | 119 | return new self( $checks ); 120 | } 121 | 122 | /** 123 | * Returns a new check collection excluding the provided checks. 124 | * 125 | * If the given list is empty, the same collection will be returned without any change. 126 | * 127 | * @since n.e.x.t 128 | * 129 | * @param array $check_slugs List of slugs to exclude. If empty, the same collection is returned. 130 | * @return Check_Collection New check collection, effectively a subset of this one. 131 | */ 132 | public function exclude( array $check_slugs ): Check_Collection { 133 | // Return unmodified collection if no check slugs to exclude are given. 134 | if ( ! $check_slugs ) { 135 | return $this; 136 | } 137 | 138 | return $this->filter( 139 | static function ( Check $check, $slug ) use( $check_slugs ) { 140 | return ! in_array( $slug, $check_slugs, true ); 141 | } 142 | ); 143 | } 144 | 145 | /** 146 | * Throws an exception if any of the given check slugs are not present, or returns the same collection otherwise. 147 | * 148 | * @since n.e.x.t 149 | * 150 | * @param array $check_slugs List of slugs to limit to only those. If empty, the same collection is returned. 151 | * @return Check_Collection The unchanged check collection. 152 | * 153 | * @throws Exception Thrown when any of the given check slugs is not present in the collection. 154 | */ 155 | public function require( array $check_slugs ): Check_Collection { 156 | foreach ( $check_slugs as $slug ) { 157 | if ( ! isset( $this->checks[ $slug ] ) ) { 158 | throw new Exception( 159 | sprintf( 160 | /* translators: %s: The Check slug. */ 161 | __( 'Check with the slug "%s" does not exist.', 'plugin-check' ), 162 | $slug 163 | ) 164 | ); 165 | } 166 | } 167 | 168 | return $this; 169 | } 170 | 171 | /** 172 | * Counts the checks in the collection. 173 | * 174 | * @since n.e.x.t 175 | * 176 | * @return int Number of checks in the collection. 177 | */ 178 | public function count(): int { 179 | return count( $this->checks ); 180 | } 181 | 182 | /** 183 | * Returns an iterator for the checks in the collection. 184 | * 185 | * @since n.e.x.t 186 | * 187 | * @return Traversable Checks iterator. 188 | */ 189 | public function getIterator(): Traversable { 190 | return new ArrayIterator( $this->checks ); 191 | } 192 | 193 | /** 194 | * Checks whether a check exists with the given slug or index. 195 | * 196 | * @since n.e.x.t 197 | * 198 | * @param string|int $offset Either a check slug (string) or index (integer). 199 | * @return bool True if a check exists at the given slug or index, false otherwise. 200 | */ 201 | #[\ReturnTypeWillChange] 202 | public function offsetExists( $offset ) { 203 | if ( is_string( $offset ) ) { 204 | return isset( $this->checks[ $offset ] ); 205 | } 206 | 207 | return isset( $this->slugs[ $offset ] ); 208 | } 209 | 210 | /** 211 | * Retrieves the check with the given slug or index. 212 | * 213 | * @since n.e.x.t 214 | * 215 | * @param string|int $offset Either a check slug (string) or index (integer). 216 | * @return Check|null Check with the given slug or index, or null if it does not exist. 217 | */ 218 | #[\ReturnTypeWillChange] 219 | public function offsetGet( $offset ) { 220 | if ( is_string( $offset ) ) { 221 | if ( isset( $this->checks[ $offset ] ) ) { 222 | return $this->checks[ $offset ]; 223 | } 224 | return null; 225 | } 226 | 227 | if ( isset( $this->slugs[ $offset ] ) ) { 228 | return $this->checks[ $this->slugs[ $offset ] ]; 229 | } 230 | 231 | return null; 232 | } 233 | 234 | /** 235 | * Sets a check in the collection. 236 | * 237 | * This method does nothing as the collection is read-only. 238 | * 239 | * @since n.e.x.t 240 | * 241 | * @param string|int $offset Either a check slug (string) or index (integer). 242 | * @param mixed $value Value to set. 243 | */ 244 | #[\ReturnTypeWillChange] 245 | public function offsetSet( $offset, $value ) { 246 | // Not implemented as this is a read-only collection. 247 | } 248 | 249 | /** 250 | * Removes a check from the collection. 251 | * 252 | * This method does nothing as the collection is read-only. 253 | * 254 | * @since n.e.x.t 255 | * 256 | * @param string|int $offset Either a check slug (string) or index (integer). 257 | */ 258 | #[\ReturnTypeWillChange] 259 | public function offsetUnset( $offset ) { 260 | // Not implemented as this is a read-only collection. 261 | } 262 | } 263 | -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | === Plugin Check === 2 | 3 | Contributors: wordpressdotorg 4 | Requires at least: 6.3 5 | Tested up to: 6.4 6 | Requires PHP: 7.0 7 | Stable tag: n.e.x.t 8 | License: GPLv2 or later 9 | License URI: https://www.gnu.org/licenses/gpl-2.0.html 10 | Tags: plugin best practices, testing, accessibility, performance, security 11 | 12 | Plugin Check is a WordPress.org tool which provides checks to help plugins meet the directory requirements and follow various best practices. 13 | 14 | == Description == 15 | 16 | Plugin Check is a tool for testing whether your plugin meets the required standards for the WordPress.org plugin directory. With this plugin you will be able to run most of the checks used for new submissions, and check if your plugin meets the requirements. 17 | 18 | Additionally, the tool flags violations or concerns around plugin development best practices, from basic requirements like correct usage of internationalization functions to accessibility, performance, and security best practices. 19 | 20 | The checks can be run either using the WP Admin user interface or WP-CLI: 21 | 22 | * To check a plugin using WP Admin, please navigate to the _Tools > Plugin Check_ menu. You need to be able to manage plugins on your site in order to access that screen. 23 | * To check a plugin using WP-CLI, please use the `wp plugin check` command. For example, to check the "Hello Dolly" plugin: `wp plugin check hello.php` 24 | * Note that by default when using WP-CLI, only static checks can be executed. In order to also include runtime checks, a workaround is currently necessary using the `--require` argument of WP-CLI, to manually load the `cli.php` file within the plugin checker directory before WordPress is loaded. For example: `wp plugin check hello.php --require=./wp-content/plugins/plugin-check/cli.php` 25 | 26 | The checks are grouped into several categories, so that you can customize which kinds of checks you would like to run on a plugin. 27 | 28 | Keep in mind that this plugin is not a replacement for the manual review process, but it will help you speed up the process of getting your plugin approved for the WordPress.org plugin repository, and it will also help you avoid some common mistakes. 29 | 30 | Even if you do not intend to host your plugin in the WordPress.org directory, you are encouraged to use Plugin Check so that your plugin follows the base requirements and best practices for WordPress plugins. 31 | 32 | == Installation == 33 | 34 | = Installation from within WordPress = 35 | 36 | 1. Visit **Plugins > Add New**. 37 | 2. Search for **Plugin Check**. 38 | 3. Install and activate the Plugin Check plugin. 39 | 40 | = Manual installation = 41 | 42 | 1. Upload the entire `plugin-check` folder to the `/wp-content/plugins/` directory. 43 | 2. Visit **Plugins**. 44 | 3. Activate the Plugin Check plugin. 45 | 46 | == Frequently Asked Questions == 47 | 48 | = Where can I contribute to the plugin? = 49 | 50 | All development for this plugin is handled via [GitHub](https://github.com/WordPress/plugin-check/) any issues or pull requests should be posted there. 51 | 52 | = What if the plugin reports something that's correct as an "error" or "warning"? = 53 | 54 | We strive to write a plugin in a way that minimizes false positives but if you find one, please report it in the GitHub repo. For certain false positives, such as those detected by PHPCodeSniffer, you may be able to annotate the code to ignore the specific problem for a specific line. 55 | 56 | = Why does it flag something as bad? = 57 | 58 | It's not flagging "bad" things, as such. Plugin Check is designed to be a non-perfect way to test for compliance with the [Plugin Review guidelines](https://make.wordpress.org/plugins/handbook/performing-reviews/review-checklist/), as well as additional plugin development best practices in accessibility, performance, security and other areas. Not all plugins must adhere to these guidelines. The purpose of the checking tool is to ensure that plugins uploaded to the [central WordPress.org plugin repository](https://wordpress.org/plugins/) meet the latest standards of WordPress plugin and will work on a wide variety of sites. 59 | 60 | Many sites use custom plugins, and that's perfectly okay. But plugins that are intended for use on many different kinds of sites by the public need to have a certain minimum level of capabilities, in order to ensure proper functioning in many different environments. The Plugin Review guidelines are created with that goal in mind. 61 | 62 | This plugin checker is not perfect, and never will be. It is only a tool to help plugin authors, or anybody else who wants to make their plugin more capable. All plugins submitted to WordPress.org are hand-reviewed by a team of experts. The automated plugin checker is meant to be a useful tool only, not an absolute system of measurement. 63 | 64 | = Does a plugin need to pass all checks to be approved in the WordPress.org plugin directory? = 65 | 66 | To be approved in the WordPress.org plugin directory, a plugin must typically pass all checks in the "Plugin repo" category. Other checks are additional and may not be required to pass. 67 | 68 | In any case, passing the checks in this tool likely helps to achieve a smooth plugin review process, but is no guarantee that a plugin will be approved in the WordPress.org plugin directory. 69 | 70 | == Changelog == 71 | 72 | = [0.2.1] 2023-09-22 = 73 | 74 | * Added - 'View in code editor' link beneath each PHPCS error or warning. Props @EvanHerman, @westonruter, @felixarntz, @mukeshpanchal27 [#262](https://github.com/10up/plugin-check/pull/262) 75 | * Fix - Ensure `readme.txt` has priority over `readme.md` when both are present. Props @bordoni, @afragen [#258](https://github.com/10up/plugin-check/pull/258) 76 | * Fix - Ensure that the PHPCS check runs even when the PHPCS binary is not executable. Props @bordoni, @shawn-digitalpoint, @mrfoxtalbot [#254](https://github.com/10up/plugin-check/pull/254) 77 | * Fix - Readme changes and typos. Props @aaronjorbin. [#261](https://github.com/10up/plugin-check/pull/261) 78 | * Fix - Long lines of code with PHPCS check no longer expand over the size of the notice. Props @bordoni, @felixarntz. [#263](https://github.com/10up/plugin-check/pull/263) 79 | * Fix - Ensure that we have PHP 7.2 compatibility remove trailing comma. Props @bordoni, @leoloso. [#265](https://github.com/10up/plugin-check/issues/265) 80 | * Fix - Include all strings that were missed in the previous release. Props @bordoni, @pixolin. [#270](https://github.com/10up/plugin-check/issues/270) 81 | 82 | = [0.2.0] 2023-09-18 = 83 | 84 | * Feature - Enable modification of the PHP Binary path used by the plugin with `PLUGIN_CHECK_PHP_BIN` constant. 85 | * Feature - Include a check for the usage of `ALLOW_UNFILTERED_UPLOADS` on any PHP files - Props EvanHerman at [#45](https://github.com/WordPress/plugin-check/pull/45) 86 | * Feature - Include a check for the presence of the application files (`.a`, `.bin`, `.bpk`, `.deploy`, `.dist`, `.distz`, `.dmg`, `.dms`, `.DS_Store`, `.dump`, `.elc`, `.exe`, `.iso`, `.lha`, `.lrf`, `.lzh`, `.o`, `.obj`, `.phar`, `.pkg`, `.sh`, '.so`) - Props EvanHerman at [#43](https://github.com/WordPress/plugin-check/pull/43) 87 | * Feature - Include a check for the presence of the readme.txt or readme.md file - Props EvanHerman at [#42](https://github.com/WordPress/plugin-check/pull/42) 88 | * Fix - Ensure that Readme parsing is included properly when a readme.md or readme.txt file is present. Props Bordoni [#52](https://github.com/WordPress/plugin-check/pull/52) 89 | * Tweak - Disallow functions `move_uploaded_file`, `passthru`, `proc_open` - Props alexsanford at [#50](https://github.com/WordPress/plugin-check/pull/50) 90 | * Tweak - Change the message type for using functions WordPress already includes from Warning to Error. Props davidperezgar at [#18](https://github.com/WordPress/plugin-check/issues/18) 91 | * Tweak - Change the message type for incorrect usage of Stable tag from Notice/Warning to Error. Props davidperezgar at [#3](https://github.com/WordPress/plugin-check/issues/3) 92 | 93 | = [0.1] 2011-09-04 = 94 | 95 | Original version of the plugin check tool, not a released version of the plugin, this changelog is here for historical purposes only. 96 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Enqueued_Scripts_Size_Check.php: -------------------------------------------------------------------------------- 1 | threshold_size = $threshold_size; 55 | } 56 | 57 | /** 58 | * Gets the categories for the check. 59 | * 60 | * Every check must have at least one category. 61 | * 62 | * @since n.e.x.t 63 | * 64 | * @return array The categories for the check. 65 | */ 66 | public function get_categories() { 67 | return array( Check_Categories::CATEGORY_PERFORMANCE ); 68 | } 69 | 70 | /** 71 | * Runs this preparation step for the environment and returns a cleanup function. 72 | * 73 | * @since n.e.x.t 74 | * 75 | * @return callable Cleanup function to revert any changes made here. 76 | * 77 | * @throws Exception Thrown when preparation fails. 78 | */ 79 | public function prepare() { 80 | $orig_scripts = isset( $GLOBALS['wp_scripts'] ) ? $GLOBALS['wp_scripts'] : null; 81 | 82 | // Backup the original values for the global state. 83 | $this->backup_globals(); 84 | 85 | return function () use ( $orig_scripts ) { 86 | if ( is_null( $orig_scripts ) ) { 87 | unset( $GLOBALS['wp_scripts'] ); 88 | } else { 89 | $GLOBALS['wp_scripts'] = $orig_scripts; 90 | } 91 | 92 | $this->restore_globals(); 93 | }; 94 | } 95 | 96 | /** 97 | * Returns an array of shared preparations for the check. 98 | * 99 | * @since n.e.x.t 100 | * 101 | * @return array Returns a map of $class_name => $constructor_args pairs. If the class does not 102 | * need any constructor arguments, it would just be an empty array. 103 | */ 104 | public function get_shared_preparations() { 105 | $demo_posts = array_map( 106 | static function ( $post_type ) { 107 | return array( 108 | 'post_title' => "Demo {$post_type} post", 109 | 'post_content' => 'Test content', 110 | 'post_type' => $post_type, 111 | 'post_status' => 'publish', 112 | ); 113 | }, 114 | $this->get_viewable_post_types() 115 | ); 116 | 117 | return array( 118 | Demo_Posts_Creation_Preparation::class => array( $demo_posts ), 119 | ); 120 | } 121 | 122 | /** 123 | * Runs the check on the plugin and amends results. 124 | * 125 | * @since n.e.x.t 126 | * 127 | * @param Check_Result $result The check results to amend and the plugin context. 128 | */ 129 | public function run( Check_Result $result ) { 130 | $this->run_for_urls( 131 | $this->get_urls(), 132 | function ( $url ) use ( $result ) { 133 | $this->check_url( $result, $url ); 134 | } 135 | ); 136 | } 137 | 138 | /** 139 | * Gets the list of URLs to run this check for. 140 | * 141 | * @since n.e.x.t 142 | * 143 | * @return array List of URL strings (either full URLs or paths). 144 | * 145 | * @throws Exception Thrown when a post type URL cannot be retrieved. 146 | */ 147 | protected function get_urls() { 148 | $urls = array( home_url() ); 149 | 150 | foreach ( $this->get_viewable_post_types() as $post_type ) { 151 | $posts = get_posts( 152 | array( 153 | 'posts_per_page' => 1, 154 | 'post_type' => $post_type, 155 | 'post_status' => array( 'publish', 'inherit' ), 156 | ) 157 | ); 158 | 159 | if ( ! isset( $posts[0] ) ) { 160 | throw new Exception( 161 | sprintf( 162 | /* translators: %s: The Post Type name. */ 163 | __( 'Unable to retrieve post URL for post type: %s', 'plugin-check' ), 164 | $post_type 165 | ) 166 | ); 167 | } 168 | 169 | $urls[] = get_permalink( $posts[0] ); 170 | } 171 | 172 | return $urls; 173 | } 174 | 175 | /** 176 | * Amends the given result by running the check for the given URL. 177 | * 178 | * @since n.e.x.t 179 | * 180 | * @param Check_Result $result The check result to amend, including the plugin context to check. 181 | * @param string $url URL to run the check for. 182 | * 183 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 184 | * the check). 185 | * 186 | * @SuppressWarnings(PHPMD.NPathComplexity) 187 | */ 188 | protected function check_url( Check_Result $result, $url ) { 189 | // Reset the WP_Scripts instance. 190 | unset( $GLOBALS['wp_scripts'] ); 191 | 192 | // Run the 'wp_enqueue_script' action, wrapped in an output buffer in case of any callbacks printing scripts 193 | // directly. This is discouraged, but some plugins or themes are still doing it. 194 | ob_start(); 195 | wp_enqueue_scripts(); 196 | wp_scripts()->do_head_items(); 197 | wp_scripts()->do_footer_items(); 198 | ob_get_clean(); 199 | 200 | $plugin_scripts = array(); 201 | $plugin_script_size = 0; 202 | 203 | foreach ( wp_scripts()->done as $handle ) { 204 | $script = wp_scripts()->registered[ $handle ]; 205 | 206 | if ( ! $script->src || strpos( $script->src, $result->plugin()->url() ) !== 0 ) { 207 | continue; 208 | } 209 | 210 | // Get size of script src. 211 | $script_path = str_replace( $result->plugin()->url(), $result->plugin()->path(), $script->src ); 212 | $script_size = function_exists( 'wp_filesize' ) ? wp_filesize( $script_path ) : filesize( $script_path ); 213 | 214 | // Get size of additional inline scripts. 215 | if ( ! empty( $script->extra['after'] ) ) { 216 | foreach ( $script->extra['after'] as $extra ) { 217 | $script_size += ( is_string( $extra ) ) ? mb_strlen( $extra, '8bit' ) : 0; 218 | } 219 | } 220 | 221 | if ( ! empty( $script->extra['before'] ) ) { 222 | foreach ( $script->extra['before'] as $extra ) { 223 | $script_size += ( is_string( $extra ) ) ? mb_strlen( $extra, '8bit' ) : 0; 224 | } 225 | } 226 | 227 | $plugin_scripts[] = array( 228 | 'path' => $script_path, 229 | 'size' => $script_size, 230 | ); 231 | $plugin_script_size += $script_size; 232 | } 233 | 234 | if ( $plugin_script_size > $this->threshold_size ) { 235 | foreach ( $plugin_scripts as $plugin_script ) { 236 | $this->add_result_warning_for_file( 237 | $result, 238 | sprintf( 239 | 'This script has a size of %1$s which in combination with the other scripts enqueued on %2$s exceeds the script size threshold of %3$s.', 240 | size_format( $plugin_script['size'] ), 241 | $url, 242 | size_format( $this->threshold_size ) 243 | ), 244 | 'EnqueuedScriptsSize.ScriptSizeGreaterThanThreshold', 245 | $plugin_script['path'] 246 | ); 247 | } 248 | } 249 | } 250 | 251 | /** 252 | * Returns an array of viewable post types. 253 | * 254 | * @since n.e.x.t 255 | * 256 | * @return array Array of viewable post type slugs. 257 | */ 258 | private function get_viewable_post_types() { 259 | if ( ! is_array( $this->viewable_post_types ) ) { 260 | $this->viewable_post_types = array_filter( get_post_types(), 'is_post_type_viewable' ); 261 | } 262 | 263 | return $this->viewable_post_types; 264 | } 265 | } 266 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Enqueued_Styles_Scope_Check.php: -------------------------------------------------------------------------------- 1 | backup_globals(); 81 | 82 | return function () use ( $orig_scripts ) { 83 | if ( is_null( $orig_scripts ) ) { 84 | unset( $GLOBALS['wp_styles'] ); 85 | } else { 86 | $GLOBALS['wp_styles'] = $orig_scripts; 87 | } 88 | 89 | $this->restore_globals(); 90 | }; 91 | } 92 | 93 | /** 94 | * Returns an array of shared preparations for the check. 95 | * 96 | * @since n.e.x.t 97 | * 98 | * @return array Returns a map of $class_name => $constructor_args pairs. If the class does not 99 | * need any constructor arguments, it would just be an empty array. 100 | */ 101 | public function get_shared_preparations() { 102 | $demo_posts = array_map( 103 | static function ( $post_type ) { 104 | return array( 105 | 'post_title' => "Demo {$post_type} post", 106 | 'post_content' => 'Test content', 107 | 'post_type' => $post_type, 108 | 'post_status' => 'publish', 109 | ); 110 | }, 111 | $this->get_viewable_post_types() 112 | ); 113 | 114 | return array( 115 | Demo_Posts_Creation_Preparation::class => array( $demo_posts ), 116 | ); 117 | } 118 | 119 | /** 120 | * Runs the check on the plugin and amends results. 121 | * 122 | * @since n.e.x.t 123 | * 124 | * @param Check_Result $result The check results to amend and the plugin context. 125 | */ 126 | public function run( Check_Result $result ) { 127 | $urls = $this->get_urls(); 128 | $this->run_for_urls( 129 | $urls, 130 | function () use ( $result ) { 131 | $this->check_url( $result ); 132 | } 133 | ); 134 | 135 | if ( ! empty( $this->plugin_styles ) ) { 136 | $url_count = count( $urls ); 137 | foreach ( $this->plugin_styles as $plugin_style ) { 138 | if ( isset( $plugin_style['count'] ) && ( $url_count === $plugin_style['count'] ) ) { 139 | $this->add_result_warning_for_file( 140 | $result, 141 | __( 'This style is being loaded in all contexts.', 'plugin-check' ), 142 | 'EnqueuedStylesScope', 143 | $plugin_style['path'] 144 | ); 145 | } 146 | } 147 | } 148 | } 149 | 150 | /** 151 | * Gets the list of URLs to run this check for. 152 | * 153 | * @since n.e.x.t 154 | * 155 | * @return array List of URL strings (either full URLs or paths). 156 | * 157 | * @throws Exception Thrown when a post type URL cannot be retrieved. 158 | */ 159 | protected function get_urls() { 160 | $urls = array( home_url( '/' ), get_search_link(), get_author_posts_url( 1 ) ); 161 | foreach ( $this->get_viewable_post_types() as $post_type ) { 162 | $args = array( 163 | 'posts_per_page' => 1, 164 | 'post_type' => $post_type, 165 | 'post_status' => array( 'publish', 'inherit' ), 166 | 'ignore_sticky_posts' => true, 167 | 'no_found_rows' => true, 168 | 'lazy_load_term_meta' => false, 169 | 'update_post_meta_cache' => false, 170 | 'update_post_term_cache' => false, 171 | ); 172 | 173 | $the_query = new \WP_Query( $args ); 174 | 175 | if ( $the_query->have_posts() ) { 176 | while ( $the_query->have_posts() ) { 177 | $the_query->the_post(); 178 | 179 | $urls[] = get_permalink(); 180 | $post = get_post(); 181 | $taxonomy_names = get_post_taxonomies( $post ); 182 | foreach ( $taxonomy_names as $taxonomy_name ) { 183 | if ( ! is_taxonomy_viewable( $taxonomy_name ) ) { 184 | continue; 185 | } 186 | 187 | $terms = get_the_terms( $post, $taxonomy_name ); 188 | if ( ! is_array( $terms ) ) { 189 | continue; 190 | } 191 | foreach ( $terms as $term ) { 192 | $term_link = get_term_link( $term ); 193 | if ( ! is_wp_error( $term_link ) ) { 194 | $urls[] = $term_link; 195 | } 196 | } 197 | } 198 | } 199 | } else { 200 | throw new Exception( 201 | sprintf( 202 | /* translators: %s: The Post Type name. */ 203 | __( 'Unable to retrieve post URL for post type: %s', 'plugin-check' ), 204 | $post_type 205 | ) 206 | ); 207 | } 208 | 209 | /* Restore original Post Data */ 210 | wp_reset_postdata(); 211 | } 212 | 213 | return $urls; 214 | } 215 | 216 | /** 217 | * Amends the given result by running the check for the given URL. 218 | * 219 | * @since n.e.x.t 220 | * 221 | * @param Check_Result $result The check result to amend, including the plugin context to check. 222 | * 223 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 224 | * the check). 225 | */ 226 | protected function check_url( Check_Result $result ) { 227 | // Reset the wp_styles instance. 228 | unset( $GLOBALS['wp_styles'] ); 229 | 230 | /* 231 | * Run the 'wp_enqueue_script' action, wrapped in an output buffer in case of any callbacks printing styles 232 | * directly. This is discouraged, but some plugins or themes are still doing it. 233 | */ 234 | $wp_styles = wp_styles(); 235 | ob_start(); 236 | wp_enqueue_scripts(); 237 | $wp_styles->do_footer_items(); 238 | ob_get_clean(); 239 | 240 | foreach ( $wp_styles->done as $handle ) { 241 | $style = $wp_styles->registered[ $handle ]; 242 | 243 | if ( ! $style->src || strpos( $style->src, $result->plugin()->url() ) !== 0 ) { 244 | continue; 245 | } 246 | 247 | $style_path = str_replace( $result->plugin()->url(), $result->plugin()->path(), $style->src ); 248 | 249 | if ( ! isset( $this->plugin_style_count[ $handle ] ) ) { 250 | $this->plugin_style_count[ $handle ] = 0; 251 | } 252 | $this->plugin_style_count[ $handle ] += 1; 253 | 254 | $this->plugin_styles[ $handle ] = array( 255 | 'path' => $style_path, 256 | 'count' => $this->plugin_style_count[ $handle ], 257 | ); 258 | } 259 | } 260 | 261 | /** 262 | * Returns an array of viewable post types. 263 | * 264 | * @since n.e.x.t 265 | * 266 | * @return array Array of viewable post type slugs. 267 | */ 268 | private function get_viewable_post_types() { 269 | if ( ! is_array( $this->viewable_post_types ) ) { 270 | $this->viewable_post_types = array_filter( get_post_types(), 'is_post_type_viewable' ); 271 | } 272 | 273 | return $this->viewable_post_types; 274 | } 275 | } 276 | -------------------------------------------------------------------------------- /includes/Checker/Checks/Abstract_File_Check.php: -------------------------------------------------------------------------------- 1 | plugin() ); 53 | $this->check_files( $result, $files ); 54 | } 55 | 56 | /** 57 | * Amends the given result by running the check on the given list of files. 58 | * 59 | * @since n.e.x.t 60 | * 61 | * @param Check_Result $result The check result to amend, including the plugin context to check. 62 | * @param array $files List of absolute file paths. 63 | * 64 | * @throws Exception Thrown when the check fails with a critical error (unrelated to any errors detected as part of 65 | * the check). 66 | */ 67 | abstract protected function check_files( Check_Result $result, array $files ); 68 | 69 | /** 70 | * Filters a given list of files to only contain those with specific extension. 71 | * 72 | * @since n.e.x.t 73 | * 74 | * @param array $files List of absolute file paths. 75 | * @param string $extension File extension to match. 76 | * @return array Filtered $files list. 77 | */ 78 | final protected static function filter_files_by_extension( array $files, $extension ) { 79 | return self::filter_files_by_extensions( $files, array( $extension ) ); 80 | } 81 | 82 | /** 83 | * Filters a given list of files to only contain those with specific extensions. 84 | * 85 | * @since n.e.x.t 86 | * 87 | * @param array $files List of absolute file paths. 88 | * @param array $extensions List of file extensions to match. 89 | * @return array Filtered $files list. 90 | */ 91 | final protected static function filter_files_by_extensions( array $files, array $extensions ) { 92 | // Inverse the array to speed up lookup. 93 | $lookup = array_flip( $extensions ); 94 | 95 | return array_values( 96 | array_filter( 97 | $files, 98 | static function ( $file ) use ( $lookup ) { 99 | return isset( $lookup[ pathinfo( $file, PATHINFO_EXTENSION ) ] ); 100 | } 101 | ) 102 | ); 103 | } 104 | 105 | /** 106 | * Filters a given list of files to only contain those where the file name matches the given regular expression. 107 | * 108 | * @since n.e.x.t 109 | * 110 | * @param array $files List of absolute file paths. 111 | * @param string $regex Regular expression for file paths to match. 112 | * @return array Filtered $files list. 113 | */ 114 | final protected static function filter_files_by_regex( array $files, $regex ) { 115 | return preg_grep( $regex, $files ); 116 | } 117 | 118 | /** 119 | * Performs a regular expression match on the file contents of the given list of files. 120 | * 121 | * This is a wrapper around the native `preg_match()` function that will match the first occurrence within the 122 | * list of files. 123 | * 124 | * @since n.e.x.t 125 | * 126 | * @param string $pattern The pattern to search for. 127 | * @param array $files List of absolute file paths. 128 | * @param array $matches Optional. Array to store the matches, passed by reference. Similar to `preg_match()`, 129 | * `$matches[0]` will contain the text that matched the full pattern, `$matches[1]` will 130 | * have the text that matched the first captured parenthesized subpattern, and so on. 131 | * @return string|bool File path if a match was found, false otherwise. 132 | */ 133 | final protected static function file_preg_match( $pattern, array $files, array &$matches = null ) { 134 | foreach ( $files as $file ) { 135 | $contents = self::file_get_contents( $file ); 136 | if ( preg_match( $pattern, $contents, $m ) ) { 137 | $matches = $m; 138 | return $file; 139 | } 140 | } 141 | return false; 142 | } 143 | 144 | /** 145 | * Performs a check indicating if the needle is contained in the file contents of the given list of files. 146 | * 147 | * This is a wrapper around the native `str_contains()` function that will find the needle within the list of 148 | * files. 149 | * 150 | * @since n.e.x.t 151 | * 152 | * @param array $files List of absolute file paths. 153 | * @param string $needle The substring to search for. 154 | * @return string|bool File path if needle was found, false otherwise. 155 | */ 156 | final protected static function file_str_contains( array $files, $needle ) { 157 | foreach ( $files as $file ) { 158 | $contents = self::file_get_contents( $file ); 159 | if ( str_contains( $contents, $needle ) ) { 160 | return $file; 161 | } 162 | } 163 | return false; 164 | } 165 | 166 | /** 167 | * Gets the contents of the given file. 168 | * 169 | * This is effectively a caching wrapper around the native `file_get_contents()` function. 170 | * 171 | * @since n.e.x.t 172 | * 173 | * @param string $file The file name. 174 | * @return string The file contents. 175 | */ 176 | private static function file_get_contents( $file ) { 177 | if ( isset( self::$file_contents_cache[ $file ] ) ) { 178 | return self::$file_contents_cache[ $file ]; 179 | } 180 | 181 | // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents 182 | self::$file_contents_cache[ $file ] = file_get_contents( $file ); 183 | 184 | return self::$file_contents_cache[ $file ]; 185 | } 186 | 187 | /** 188 | * Gets the list of all files that are part of the given plugin. 189 | * 190 | * @since n.e.x.t 191 | * 192 | * @param Check_Context $plugin Context for the plugin to check. 193 | * @return array List of absolute file paths. 194 | */ 195 | private static function get_files( Check_Context $plugin ) { 196 | $location = $plugin->location(); 197 | 198 | if ( isset( self::$file_list_cache[ $location ] ) ) { 199 | return self::$file_list_cache[ $location ]; 200 | } 201 | 202 | self::$file_list_cache[ $location ] = array(); 203 | 204 | // If the location is a plugin folder, get all its files. 205 | // Otherwise, it is a single-file plugin. 206 | if ( $plugin->is_single_file_plugin() ) { 207 | self::$file_list_cache[ $location ][] = $location; 208 | } else { 209 | $iterator = new RecursiveIteratorIterator( new RecursiveDirectoryIterator( $location ) ); 210 | foreach ( $iterator as $file ) { 211 | if ( ! $file->isFile() ) { 212 | continue; 213 | } 214 | 215 | $file_path = $file->getPathname(); 216 | 217 | $directories_to_ignore = Plugin_Request_Utility::get_directories_to_ignore(); 218 | 219 | // Flag to check if the file should be included or not. 220 | $include_file = true; 221 | 222 | foreach ( $directories_to_ignore as $directory ) { 223 | // Check if the current file belongs to the directory you want to ignore. 224 | if ( false !== strpos( $file_path, '/' . $directory . '/' ) ) { 225 | $include_file = false; 226 | break; // Skip the file if it matches any ignored directory. 227 | } 228 | } 229 | 230 | if ( $include_file ) { 231 | self::$file_list_cache[ $location ][] = $file_path; 232 | } 233 | } 234 | } 235 | 236 | return self::$file_list_cache[ $location ]; 237 | } 238 | } 239 | -------------------------------------------------------------------------------- /includes/Admin/Admin_Page.php: -------------------------------------------------------------------------------- 1 | admin_ajax = $admin_ajax; 44 | } 45 | 46 | /** 47 | * Registers WordPress hooks for the admin page. 48 | * 49 | * @since n.e.x.t 50 | */ 51 | public function add_hooks() { 52 | add_action( 'admin_menu', array( $this, 'add_and_initialize_page' ) ); 53 | add_filter( 'plugin_action_links', array( $this, 'filter_plugin_action_links' ), 10, 4 ); 54 | add_action( 'admin_enqueue_scripts', array( $this, 'add_jump_to_line_code_editor' ) ); 55 | 56 | $this->admin_ajax->add_hooks(); 57 | } 58 | 59 | /** 60 | * Adds the admin page under the tools menu. 61 | * 62 | * @since n.e.x.t 63 | */ 64 | public function add_page() { 65 | $this->hook_suffix = add_management_page( 66 | __( 'Plugin Check', 'plugin-check' ), 67 | __( 'Plugin Check', 'plugin-check' ), 68 | 'activate_plugins', 69 | 'plugin-check', 70 | array( $this, 'render_page' ) 71 | ); 72 | } 73 | 74 | /** 75 | * Adds and initializes the admin page under the tools menu. 76 | * 77 | * @since n.e.x.t 78 | */ 79 | public function add_and_initialize_page() { 80 | $this->add_page(); 81 | add_action( 'load-' . $this->get_hook_suffix(), array( $this, 'initialize_page' ) ); 82 | } 83 | 84 | /** 85 | * Initializes page hooks. 86 | * 87 | * @since n.e.x.t 88 | */ 89 | public function initialize_page() { 90 | add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); 91 | add_action( 'admin_footer', array( $this, 'admin_footer' ) ); 92 | } 93 | 94 | /** 95 | * Loads the check's script. 96 | * 97 | * @since n.e.x.t 98 | */ 99 | public function enqueue_scripts() { 100 | wp_enqueue_script( 101 | 'plugin-check-admin', 102 | WP_PLUGIN_CHECK_PLUGIN_DIR_URL . 'assets/js/plugin-check-admin.js', 103 | array( 104 | 'wp-util', 105 | ), 106 | WP_PLUGIN_CHECK_VERSION, 107 | true 108 | ); 109 | 110 | wp_add_inline_script( 111 | 'plugin-check-admin', 112 | 'const PLUGIN_CHECK = ' . json_encode( 113 | array( 114 | 'nonce' => $this->admin_ajax->get_nonce(), 115 | 'actionGetChecksToRun' => Admin_AJAX::ACTION_GET_CHECKS_TO_RUN, 116 | 'actionSetUpRuntimeEnvironment' => Admin_AJAX::ACTION_SET_UP_ENVIRONMENT, 117 | 'actionRunChecks' => Admin_AJAX::ACTION_RUN_CHECKS, 118 | 'actionCleanUpRuntimeEnvironment' => Admin_AJAX::ACTION_CLEAN_UP_ENVIRONMENT, 119 | 'successMessage' => __( 'No errors found.', 'plugin-check' ), 120 | 'errorMessage' => __( 'Errors were found.', 'plugin-check' ), 121 | ) 122 | ), 123 | 'before' 124 | ); 125 | } 126 | 127 | /** 128 | * Enqueue a script in the WordPress admin on plugin-editor.php. 129 | * 130 | * @since n.e.x.t 131 | * 132 | * @param string $hook_suffix The current admin page. 133 | */ 134 | public function add_jump_to_line_code_editor( $hook_suffix ) { 135 | if ( 'plugin-editor.php' !== $hook_suffix ) { 136 | return; 137 | } 138 | 139 | $line = (int) ( $_GET['line'] ?? 0 ); 140 | if ( ! $line ) { 141 | return; 142 | } 143 | 144 | wp_add_inline_script( 145 | 'wp-theme-plugin-editor', 146 | sprintf( 147 | ' 148 | ( 149 | ( originalInitCodeEditor ) => { 150 | wp.themePluginEditor.initCodeEditor = function() { 151 | originalInitCodeEditor.apply( this, arguments ); 152 | this.instance.codemirror.doc.setCursor( %d - 1 ); 153 | }; 154 | } 155 | )( wp.themePluginEditor.initCodeEditor ); 156 | ', 157 | wp_json_encode( $line ) 158 | ) 159 | ); 160 | } 161 | 162 | /** 163 | * Returns the list of plugins. 164 | * 165 | * @since n.e.x.t 166 | * 167 | * @return array List of available plugins. 168 | */ 169 | private function get_available_plugins() { 170 | $available_plugins = get_plugins(); 171 | 172 | if ( empty( $available_plugins ) ) { 173 | return array(); 174 | } 175 | 176 | $plugin_check_base_name = plugin_basename( WP_PLUGIN_CHECK_MAIN_FILE ); 177 | 178 | if ( isset( $available_plugins[ $plugin_check_base_name ] ) ) { 179 | unset( $available_plugins[ $plugin_check_base_name ] ); 180 | } 181 | 182 | return $available_plugins; 183 | } 184 | 185 | /** 186 | * Renders the "Plugin Check" page. 187 | * 188 | * @since n.e.x.t 189 | * 190 | * @SuppressWarnings(PHPMD.UnusedLocalVariable) 191 | */ 192 | public function render_page() { 193 | $available_plugins = $this->get_available_plugins(); 194 | 195 | $selected_plugin_basename = filter_input( INPUT_GET, 'plugin', FILTER_SANITIZE_FULL_SPECIAL_CHARS ); 196 | 197 | $categories = Check_Categories::get_categories(); 198 | 199 | // Get user settings for category preferences and set a default value to check all categories by default. 200 | $user_enabled_categories = get_user_setting( 'plugin_check_category_preferences', 'all_categories' ); 201 | $user_enabled_categories = 'all_categories' === $user_enabled_categories ? $categories : explode( '__', $user_enabled_categories ); 202 | 203 | require WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'templates/admin-page.php'; 204 | } 205 | 206 | /** 207 | * Adds "check this plugin" link in the plugins list table. 208 | * 209 | * @since n.e.x.t 210 | * 211 | * @param array $actions List of actions. 212 | * @param string $plugin_file Plugin main file. 213 | * @param array $plugin_data An array of plugin data. 214 | * @param string $context The plugin context. By default this can include 'all', 215 | * 'active', 'inactive', 'recently_activated', 'upgrade', 216 | * 'mustuse', 'dropins', and 'search'. 217 | * @return array The modified list of actions. 218 | */ 219 | public function filter_plugin_action_links( $actions, $plugin_file, $plugin_data, $context ) { 220 | 221 | $plugin_check_base_name = plugin_basename( WP_PLUGIN_CHECK_MAIN_FILE ); 222 | if ( in_array( $context, array( 'mustuse', 'dropins' ), true ) || $plugin_check_base_name === $plugin_file ) { 223 | return $actions; 224 | } 225 | 226 | if ( current_user_can( 'activate_plugins' ) ) { 227 | $actions[] = sprintf( 228 | '%2$s', 229 | esc_url( admin_url( "tools.php?page=plugin-check&plugin={$plugin_file}" ) ), 230 | esc_html__( 'Check this plugin', 'plugin-check' ) 231 | ); 232 | } 233 | 234 | return $actions; 235 | } 236 | 237 | /** 238 | * Render the results table templates in the footer. 239 | * 240 | * @since n.e.x.t 241 | */ 242 | public function admin_footer() { 243 | ob_start(); 244 | require WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'templates/results-table.php'; 245 | $results_table_template = ob_get_clean(); 246 | wp_print_inline_script_tag( 247 | $results_table_template, 248 | array( 249 | 'id' => 'tmpl-plugin-check-results-table', 250 | 'type' => 'text/template', 251 | ) 252 | ); 253 | 254 | ob_start(); 255 | require WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'templates/results-row.php'; 256 | $results_row_template = ob_get_clean(); 257 | wp_print_inline_script_tag( 258 | $results_row_template, 259 | array( 260 | 'id' => 'tmpl-plugin-check-results-row', 261 | 'type' => 'text/template', 262 | ) 263 | ); 264 | 265 | ob_start(); 266 | require WP_PLUGIN_CHECK_PLUGIN_DIR_PATH . 'templates/results-complete.php'; 267 | $results_row_template = ob_get_clean(); 268 | wp_print_inline_script_tag( 269 | $results_row_template, 270 | array( 271 | 'id' => 'tmpl-plugin-check-results-complete', 272 | 'type' => 'text/template', 273 | ) 274 | ); 275 | } 276 | 277 | /** 278 | * Gets the hook suffix under which the admin page is added. 279 | * 280 | * @since n.e.x.t 281 | * 282 | * @return string Hook suffix, or empty string if admin page was not added. 283 | */ 284 | public function get_hook_suffix() { 285 | return $this->hook_suffix; 286 | } 287 | } 288 | --------------------------------------------------------------------------------

{{ data.file }}

20 | 31 |

', 73 | 'title_reply_after' => '

20 | 21 | 22 | 23 |

23 | 30 |

', esc_url( get_permalink() ) ), '