├── assets
    ├── gray-grad.png
    └── style.css
├── checks
    ├── class-tag-check.php
    ├── class-deregister-check.php
    ├── class-gravatar-check.php
    ├── class-theme-support-title-tag.php
    ├── class-php-short-tags-check.php
    ├── class-editor-style-check.php
    ├── class-screen-reader-text-check.php
    ├── class-site-url-check.php
    ├── class-non-printable-check.php
    ├── class-favicon-check.php
    ├── class-included-zip-check.php
    ├── class-script-tag-check.php
    ├── class-directories-check.php
    ├── class-image-size-check.php
    ├── class-comment-reply-check.php
    ├── class-uri-check.php
    ├── class-iframe-check.php
    ├── class-post-pagination-check.php
    ├── class-block-patterns-check.php
    ├── class-fse-required-files-check.php
    ├── class-comment-pagination-check.php
    ├── class-version-php-check.php
    ├── class-post-thumbnail-check.php
    ├── class-time-date-check.php
    ├── class-worms-check.php
    ├── class-include-check.php
    ├── class-version-tested-check.php
    ├── class-generated-check.php
    ├── class-post-format-check.php
    ├── class-comments-check.php
    ├── class-copyright-notice-check.php
    ├── class-cdn-check.php
    ├── class-non-gpl-check.php
    ├── class-no-hidden-admin-bar-check.php
    ├── class-constants-check.php
    ├── class-search-form-check.php
    ├── class-link-check.php
    ├── class-suggested-styles-check.php
    ├── class-title-check.php
    ├── class-theme-support-check.php
    ├── class-style-css-header-check.php
    ├── class-i18n-check.php
    ├── class-screenshot-check.php
    ├── class-deprecated-param-check.php
    ├── class-line-endings-check.php
    ├── class-widgets-check.php
    ├── class-underscores-check.php
    ├── class-customizer-check.php
    ├── class-admin-menu-check.php
    ├── class-filesystem-http-check.php
    ├── class-basic-check.php
    ├── class-bad-things-check.php
    ├── class-escaping-check.php
    ├── class-file-check.php
    ├── class-nav-menu-check.php
    ├── class-plugin-territory-check.php
    ├── class-style-tags-check.php
    ├── class-textdomain-check.php
    └── class-envato-check.php
├── readme.md
├── theme-check.php
├── theme-check-cli.php
├── main.php
└── checkbase.php


/assets/gray-grad.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/envato/envato-theme-check/master/assets/gray-grad.png


--------------------------------------------------------------------------------
/checks/class-tag-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if tags are supported
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if tags are supported.
10 |  */
11 | class Tag_Check implements themecheck {
12 | 	protected $error = array();
13 | 
14 | 	function check( $php_files, $css_files, $other_files ) {
15 | 
16 | 		// Combine all the php files into one string to make it easier to search.
17 | 		$php = implode( ' ', $php_files );
18 | 		checkcount();
19 | 
20 | 		if (
21 | 			strpos( $php, 'the_tags' ) === false &&
22 | 			strpos( $php, 'the_taxonomies' ) === false &&
23 | 			strpos( $php, 'get_the_tag_list' ) === false &&
24 | 			strpos( $php, 'get_the_term_list' ) === false
25 | 		) {
26 | 			$this->error[] = sprintf(
27 | 				'<span class="tc-lead tc-recommended">%s</span> %s',
28 | 				__( 'RECOMMENDED', 'theme-check' ),
29 | 				__( "This theme doesn't seem to display tags. Modify it to display tags in appropriate locations.", 'theme-check' )
30 | 			);
31 | 		}
32 | 
33 | 		return true;
34 | 	}
35 | 
36 | 	function getError() {
37 | 		return $this->error;
38 | 	}
39 | }
40 | 
41 | $themechecks[] = new Tag_Check();
42 | 


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
 1 | # Envato Theme Check
 2 | Plugin Name: Envato Theme Check
 3 | 
 4 | Author: Scott Parry
 5 | 
 6 | Author URI: https://scottparry.co/
 7 | 
 8 | Plugin URI: https://github.com/envato/Envato-Theme-Check
 9 | 
10 | License: GPLv2
11 | 
12 | License URI: https://www.gnu.org/licenses/gpl-2.0.html
13 | 
14 | 
15 | ## Description
16 | <p>The Envato Theme Check is a modified fork of the original Theme Check by Otto42 with additional Envato specific WordPress checks.</p>
17 | <p>It is an easy way to test your theme and make sure it's up-to-date with the latest Envato review standards. With it, you can run all the same automated testing tools on your theme that Envato Reviewers use for WordPress theme submissions.</p>
18 | 
19 | <p>The tests are run through a simple admin menu and all results are displayed at once. This is very handy for theme developers, or anybody looking to make sure that their theme supports the latest WordPress theme standards and practices.</p>
20 | 
21 | ## Frequently Asked Questions
22 | 
23 | #### Do I need to address WARNINGS and INFO notices?
24 | <p>It is strongly recommended that WARNING, RECOMMENDED and INFO notices be resolved if possible. Some may be the result of an issue that is cause for rejection (Reviewers make this decision).</p>
25 | 
26 | #### What do I do if I find a bug, or think something is wrong with the plugin?
27 | <p>You can submit an issue directly here: https://github.com/envato/envato-theme-check/issues</p>


--------------------------------------------------------------------------------
/checks/class-deregister-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if core scripts are deregistered.
 4 |  *
 5 |  * Themes must use WordPress’ default libraries.
 6 |  * WordPress includes a number of libraries such as jQuery.
 7 |  * For security and stability reasons themes may not include those libraries in their own code.
 8 |  * Instead themes must use the versions of those libraries packaged with WordPress.
 9 |  *
10 |  * @package Theme Check
11 |  */
12 | 
13 | /**
14 |  * Checks if core scripts are deregistered.
15 |  */
16 | class Deregister_Check implements themecheck {
17 | 	protected $error = array();
18 | 
19 | 	function check( $php_files, $css_files, $other_files ) {
20 | 		foreach ( $php_files as $file_path => $file_content ) {
21 | 			checkcount();
22 | 
23 | 			if ( false !== strpos( $file_content, 'wp_deregister_script' ) ) {
24 | 				$grep          = tc_preg( '/wp_deregister_script/', $file_path );
25 | 				$this->error[] = sprintf(
26 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
27 | 					__( 'WARNING', 'theme-check' ),
28 | 					sprintf(
29 | 						__( 'Found wp_deregister_script in %1$s. Themes must not deregister scripts that are included in WordPress. Deregistering third party scripts that are registered by parent themes is allowed.', 'theme-check' ),
30 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
31 | 					),
32 | 					$grep
33 | 				);
34 | 			}
35 | 		}
36 | 
37 | 		return true;
38 | 	}
39 | 
40 | 	function getError() {
41 | 		return $this->error;
42 | 	}
43 | }
44 | 
45 | $themechecks[] = new Deregister_Check();
46 | 


--------------------------------------------------------------------------------
/checks/class-gravatar-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks that gravatars are supported in comments.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks that gravatars are supported in comments.
10 |  */
11 | class Gravatar_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$php = implode( ' ', $php_files );
29 | 
30 | 		checkcount();
31 | 
32 | 		if (
33 | 			strpos( $php, 'get_avatar' ) === false &&
34 | 			strpos( $php, 'wp_list_comments' ) === false
35 | 		) {
36 | 			$this->error[] = sprintf(
37 | 				'<span class="tc-lead tc-recommended">%s</span>: %s',
38 | 				__( 'RECOMMENDED', 'theme-check' ),
39 | 				__( "This theme doesn't seem to support the standard avatar functions. Use <strong>get_avatar</strong> or <strong>wp_list_comments</strong> to add this support.", 'theme-check' )
40 | 			);
41 | 		}
42 | 
43 | 		return true;
44 | 	}
45 | 
46 | 	/**
47 | 	 * Get error messages from the checks.
48 | 	 *
49 | 	 * @return array Error message.
50 | 	 */
51 | 	public function getError() {
52 | 		return $this->error;
53 | 	}
54 | }
55 | 
56 | $themechecks[] = new Gravatar_Check();
57 | 


--------------------------------------------------------------------------------
/assets/style.css:
--------------------------------------------------------------------------------
 1 | .tc-box {
 2 | 	padding:20px 0;
 3 | 	border-top:1px solid #dfdfdf;
 4 | }
 5 | .tc-required, .tc-fail {
 6 | 	color:red;
 7 | }
 8 | .tc-warning {
 9 | 	color: orange;
10 | }
11 | .tc-recommended, .tc-pass {
12 | 	color: green;
13 | }
14 | .tc-info {
15 | 	color: blue;
16 | }
17 | .tc-grep span {
18 | 	background: yellow;
19 | }
20 | pre {
21 | 	white-space: pre-wrap;
22 | }
23 | .tc-success {
24 | 	margin:0 20px 20px 20px;
25 | 	background:#e6ffe2;
26 | 	border:1px solid #d1eecc;
27 | }
28 | form {
29 | 	margin: 1.5em auto;
30 | }
31 | .theme-check {
32 | 	margin: 1em auto;
33 | 	border:1px solid #dfdfdf;
34 | 	-moz-border-radius:5px;
35 | 	-khtml-border-radius:5px;
36 | 	-webkit-border-radius:5px;
37 | 	border-radius:5px;
38 | }
39 | .theme-check h2 {
40 | 	margin: 0 0 1em 0;
41 | 	padding: 1em;
42 | 	background:#dfdfdf url("gray-grad.png") repeat-x left top;
43 | 	font-size:20px;
44 | 	border-bottom:1px solid #ccc;
45 | }
46 | .theme-check p {
47 | 	padding:5px 20px;
48 | }
49 | .theme-check form {
50 | 	margin-left: 1.5em;
51 | }
52 | .theme-check ul {
53 | 	margin-left:20px;
54 | }
55 | .theme-check h3 {
56 | 	margin:0 0 10px 20px;
57 | 	padding:0;
58 | }
59 | .theme-check ul {
60 | 	margin-bottom:10px;
61 | }
62 | .theme-info {
63 | 	padding: 1em;
64 | 	border:1px solid #dfdfdf;
65 | 	margin: 1em 1em 0 1em;
66 | }
67 | .theme-info p {
68 | 	padding:0;
69 | 	margin-bottom:10px;
70 | }
71 | .theme-info label {
72 | 	float:left;
73 | 	width:100px;
74 | 	font-weight:bold;
75 | 	display:block;
76 | }
77 | .theme-info span.info {
78 | 	margin-left:100px;
79 | 	display:block;
80 | }
81 | .theme-check input[name="s_info"] {
82 |     margin-left: 0.5em;
83 | }


--------------------------------------------------------------------------------
/checks/class-theme-support-title-tag.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check classic themes for add_theme_support( 'title-tag' ).
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check classic themes for add_theme_support( 'title-tag' ).
10 |  */
11 | class Theme_Support_Title_Tag_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 		$ret = true;
28 | 		$php = implode( ' ', $php_files );
29 | 
30 | 		// Look for add_theme_support( 'title-tag' ).
31 | 		if ( ! preg_match( '#add_theme_support\s?\(\s?[\'|"]title-tag#', $php ) ) {
32 | 			$ret           = false;
33 | 			$this->error[] = sprintf(
34 | 				'<span class="tc-lead tc-required">%s</span>: %s',
35 | 				__( 'REQUIRED', 'theme-check' ),
36 | 				__( 'No reference to <strong>add_theme_support( "title-tag" )</strong> was found in the theme.', 'theme-check' )
37 | 			);
38 | 		}
39 | 
40 | 		return $ret;
41 | 	}
42 | 
43 | 	/**
44 | 	 * Get error messages from the checks.
45 | 	 *
46 | 	 * @return array Error message.
47 | 	 */
48 | 	public function getError() {
49 | 		return $this->error;
50 | 	}
51 | }
52 | 
53 | $themechecks[] = new Theme_Support_Title_Tag_Check();
54 | 


--------------------------------------------------------------------------------
/checks/class-php-short-tags-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if PHP short tags are used
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if PHP short tags are used.
10 |  */
11 | class PHP_Short_Tags_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		foreach ( $php_files as $file_path => $file_content ) {
29 | 			checkcount();
30 | 
31 | 			if ( preg_match( '/<\?(\=?)(?!php|xml)/i', $file_content ) ) {
32 | 				$grep          = tc_preg( '/<\?(\=?)(?!php|xml)/', $file_path );
33 | 				$this->error[] = sprintf(
34 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
35 | 					__( 'WARNING', 'theme-check' ),
36 | 					sprintf(
37 | 						__( 'Found PHP short tags in file %s.', 'theme-check' ),
38 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
39 | 					),
40 | 					$grep
41 | 				);
42 | 			}
43 | 		}
44 | 
45 | 		return true;
46 | 	}
47 | 
48 | 	/**
49 | 	 * Get error messages from the checks.
50 | 	 *
51 | 	 * @return array Error message.
52 | 	 */
53 | 	public function getError() {
54 | 		return $this->error;
55 | 	}
56 | }
57 | 
58 | $themechecks[] = new PHP_Short_Tags_Check();
59 | 


--------------------------------------------------------------------------------
/checks/class-editor-style-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if add_editor_style is included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if add_editor_style is included.
10 |  *
11 |  * Check if add_editor_style is included. If not, recommend it.
12 |  */
13 | class Editor_Style_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 		checkcount();
30 | 		$ret = true;
31 | 
32 | 		$php = implode( ' ', $php_files );
33 | 
34 | 		if ( strpos( $php, 'add_editor_style' ) === false ) {
35 | 			$this->error[] = sprintf(
36 | 				'<span class="tc-lead tc-recommended">%s</span>: %s',
37 | 				__( 'RECOMMENDED', 'theme-check' ),
38 | 				__( 'No reference to <strong>add_editor_style()</strong> was found in the theme. It is recommended that the theme implement editor styling, so as to make the editor content match the resulting post output in the theme, for a better user experience.', 'theme-check' )
39 | 			);
40 | 		}
41 | 
42 | 		return $ret;
43 | 	}
44 | 
45 | 	/**
46 | 	 * Get error messages from the checks.
47 | 	 *
48 | 	 * @return array Error message.
49 | 	 */
50 | 	public function getError() {
51 | 		return $this->error;
52 | 	}
53 | }
54 | 
55 | $themechecks[] = new Editor_Style_Check();
56 | 


--------------------------------------------------------------------------------
/checks/class-screen-reader-text-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if the screen-reader-text class is included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if the screen-reader-text class is included.
10 |  */
11 | class Screen_Reader_Text_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$css = implode( ' ', $css_files );
29 | 
30 | 		$checks = array(
31 | 			'\.screen-reader-text' => __( '<strong>.screen-reader-text</strong> CSS class is generated by WordPress and needs to be styled with your theme CSS. See <a href="http://codex.wordpress.org/CSS#WordPress_Generated_Classes">the Codex</a> for an example implementation.', 'theme-check' ),
32 | 		);
33 | 
34 | 		foreach ( $checks as $key => $check ) {
35 | 			checkcount();
36 | 			if ( ! preg_match( '/' . $key . '/i', $css, $matches ) ) {
37 | 				$this->error[] = sprintf(
38 | 					'<span class="tc-lead tc-info">%s</span> %s',
39 | 					__( 'INFO', 'theme-check' ),
40 | 					$check
41 | 				);
42 | 			}
43 | 		}
44 | 
45 | 		return true;
46 | 	}
47 | 
48 | 	/**
49 | 	 * Get error messages from the checks.
50 | 	 *
51 | 	 * @return array Error message.
52 | 	 */
53 | 	public function getError() {
54 | 		return $this->error;
55 | 	}
56 | }
57 | 
58 | $themechecks[] = new Screen_Reader_Text_Check();
59 | 


--------------------------------------------------------------------------------
/checks/class-site-url-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if site_url is used, and adds an info.
 4 |  *
 5 |  * @link https://developer.wordpress.org/reference/functions/site_url/
 6 |  * @package Theme Check
 7 |  */
 8 | 
 9 | /**
10 |  * Check for site_url
11 |  */
12 | class Site_URL_Check implements themecheck {
13 | 	/**
14 | 	 * Error messages, warnings and info notices.
15 | 	 *
16 | 	 * @var array $error
17 | 	 */
18 | 	protected $error = array();
19 | 
20 | 	/**
21 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
22 | 	 *
23 | 	 * @param array $php_files File paths and content for PHP files.
24 | 	 * @param array $css_files File paths and content for CSS files.
25 | 	 * @param array $other_files Folder names, file paths and content for other files.
26 | 	 */
27 | 	public function check( $php_files, $css_files, $other_files ) {
28 | 
29 | 		checkcount();
30 | 
31 | 		foreach ( $php_files as $file_path => $file_content ) {
32 | 			$filename = tc_filename( $file_path );
33 | 
34 | 			if ( strpos( $file_content, 'site_url' ) !== false ) {
35 | 				$this->error[] = sprintf(
36 | 					'<span class="tc-lead tc-info">%s</span> %s',
37 | 					__( 'INFO', 'theme-check' ),
38 | 					sprintf(
39 | 						__( 'site_url() or get_site_url() was found in %s. site_url() references the URL where the WordPress files are located. Use home_url() if the intention is to point to the site address (home page), and in the search form.', 'theme-check' ),
40 | 						'<strong>' . $filename . '</strong>'
41 | 					)
42 | 				);
43 | 			}
44 | 		}
45 | 
46 | 		return true;
47 | 	}
48 | 
49 | 	/**
50 | 	 * Get error messages from the checks.
51 | 	 *
52 | 	 * @return array Error message.
53 | 	 */
54 | 	public function getError() {
55 | 		return $this->error;
56 | 	}
57 | }
58 | 
59 | $themechecks[] = new Site_URL_Check();
60 | 


--------------------------------------------------------------------------------
/checks/class-non-printable-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if non-printable characters are included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if non-printable characters are included.
10 |  */
11 | class Non_Printable_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		foreach ( $php_files as $file_path => $file_content ) {
29 | 			checkcount();
30 | 
31 | 			// 09 = tab.
32 | 			// 0A = line feed.
33 | 			// 0D = new line.
34 | 			if ( preg_match( '/[\x00-\x08\x0B-\x0C\x0E-\x1F]/', $file_content, $matches ) ) {
35 | 				$grep          = tc_preg( '/[\x00-\x08\x0B-\x0C\x0E-\x1F]/', $file_path );
36 | 				$this->error[] = sprintf(
37 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
38 | 					__( 'WARNING', 'theme-check' ),
39 | 					sprintf(
40 | 						__( 'Non-printable characters were found in the %s file. You may want to check this file for errors.', 'theme-check' ),
41 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
42 | 					),
43 | 					$grep
44 | 				);
45 | 			}
46 | 		}
47 | 
48 | 		return true;
49 | 	}
50 | 
51 | 	/**
52 | 	 * Get error messages from the checks.
53 | 	 *
54 | 	 * @return array Error message.
55 | 	 */
56 | 	public function getError() {
57 | 		return $this->error;
58 | 	}
59 | }
60 | 
61 | $themechecks[] = new Non_Printable_Check();
62 | 


--------------------------------------------------------------------------------
/checks/class-favicon-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks for favicons.
 4 |  *
 5 |  * Note: The check for the icon file is in filenames.php.
 6 |  *
 7 |  * @package Theme Check
 8 |  */
 9 | 
10 | /**
11 |  * Checks for favicons.
12 |  */
13 | class Favicon_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 
30 | 		checkcount();
31 | 
32 | 		foreach ( $php_files as $file_path => $file_content ) {
33 | 
34 | 			$filename = tc_filename( $file_path );
35 | 
36 | 			if (
37 | 				preg_match( '/(<link rel=[\'"](icon|shortcut icon|apple-touch-icon.*)[\'"])/i', $file_content ) ||
38 | 				preg_match( '/(<meta name=[\'"]msapplication-TileImage[\'"])/i', $file_content )
39 | 			) {
40 | 				$this->error[] = sprintf(
41 | 					'<span class="tc-lead tc-info">%s</span>: %s',
42 | 					__( 'INFO', 'theme-check' ),
43 | 					sprintf(
44 | 						__( 'Possible Favicon found in %1$s. Favicons are handled by the Site Icon setting in the customizer since version 4.3.', 'theme-check' ),
45 | 						'<strong>' . $filename . '</strong>'
46 | 					)
47 | 				);
48 | 			}
49 | 		}
50 | 		return true;
51 | 	}
52 | 
53 | 	/**
54 | 	 * Get error messages from the checks.
55 | 	 *
56 | 	 * @return array Error message.
57 | 	 */
58 | 	public function getError() {
59 | 		return $this->error;
60 | 	}
61 | }
62 | 
63 | $themechecks[] = new Favicon_Check();
64 | 


--------------------------------------------------------------------------------
/checks/class-included-zip-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if zip files are included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if zip files are included.
10 |  */
11 | class Included_Zip_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 		$ret = true;
28 | 
29 | 		$filenames = array();
30 | 
31 | 		foreach ( $other_files as $other_key => $otherfile ) {
32 | 			array_push( $filenames, strtolower( basename( $other_key ) ) );
33 | 		}
34 | 
35 | 		$blocklist = array(
36 | 			'\.zip' => __( 'Zipped Plugin', 'theme-check' ),
37 | 		);
38 | 
39 | 		checkcount();
40 | 
41 | 		foreach ( $blocklist as $file => $reason ) {
42 | 			if ( $filename = preg_grep( '/' . $file . '/', $filenames ) ) {
43 | 				$error         = implode( ' ', array_unique( $filename ) );
44 | 				$this->error[] = sprintf(
45 | 					'<span class="tc-lead tc-warning">%s</span>: %s',
46 | 					__( 'REQUIRED', 'theme-check' ),
47 | 					sprintf(
48 | 						__( '<strong>Zip file found.</strong> Plugins are not allowed in themes unless they are being included with TGMPA. The zip file found was <strong>%s</strong>.', 'theme-check' ),
49 | 						$error
50 | 					)
51 | 				);
52 | 				$ret           = false;
53 | 			}
54 | 		}
55 | 
56 | 		return $ret;
57 | 	}
58 | 
59 | 	/**
60 | 	 * Get error messages from the checks.
61 | 	 *
62 | 	 * @return array Error message.
63 | 	 */
64 | 	public function getError() {
65 | 		return $this->error;
66 | 	}
67 | }
68 | 
69 | $themechecks[] = new Included_Zip_Check();
70 | 


--------------------------------------------------------------------------------
/checks/class-script-tag-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if a <script> tag is included in header.php or footer.php
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if:
10 |  * A <script> tag is included in header.php or footer.php
11 |  */
12 | class Script_Tag_Check implements themecheck {
13 | 	/**
14 | 	 * Error messages, warnings and info notices.
15 | 	 *
16 | 	 * @var array $error
17 | 	 */
18 | 	protected $error = array();
19 | 
20 | 	/**
21 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
22 | 	 *
23 | 	 * @param array $php_files File paths and content for PHP files.
24 | 	 * @param array $css_files File paths and content for CSS files.
25 | 	 * @param array $other_files Folder names, file paths and content for other files.
26 | 	 */
27 | 	public function check( $php_files, $css_files, $other_files ) {
28 | 		foreach ( $php_files as $file_path => $file_content ) {
29 | 			checkcount();
30 | 
31 | 			// This check is limited to header.php and footer.php.
32 | 			$filename = tc_filename( $file_path );
33 | 			if ( ! in_array( $filename, array( 'header.php', 'footer.php' ) ) ) {
34 | 				continue;
35 | 			}
36 | 
37 | 			if ( false !== stripos( $file_content, '<script' ) ) {
38 | 				$grep          = tc_preg( '/<script/i', $file_path );
39 | 				$this->error[] = sprintf(
40 | 					'<span class="tc-lead tc-recommended">%s</span>: %s %s',
41 | 					__( 'RECOMMENDED', 'theme-check' ),
42 | 					sprintf(
43 | 						__( 'Found a script tag in %s. Scripts and styles need to be enqueued or added via a hook, otherwise it is more difficult to remove or replace them with plugins or child themes.', 'theme-check' ),
44 | 						'<strong>' . $filename . '</strong>'
45 | 					),
46 | 					$grep
47 | 				);
48 | 			}
49 | 		}
50 | 
51 | 		return true;
52 | 	}
53 | 
54 | 	/**
55 | 	 * Get error messages from the checks.
56 | 	 *
57 | 	 * @return array Error message.
58 | 	 */
59 | 	public function getError() {
60 | 		return $this->error;
61 | 	}
62 | }
63 | 
64 | $themechecks[] = new Script_Tag_Check();
65 | 


--------------------------------------------------------------------------------
/checks/class-directories-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if directories only intended for development are included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if directories only intended for development are included.
10 |  *
11 |  * Check if directories only intended for development are included. If they are, require them to be removed.
12 |  */
13 | class Directories_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 
30 | 		$excluded_directories = array(
31 | 			'.git',
32 | 			'.svn',
33 | 			'.hg',
34 | 			'.bzr',
35 | 		);
36 | 
37 | 		$ret = true;
38 | 
39 | 		$all_filenames = array_merge(
40 | 			array_keys( $php_files ),
41 | 			array_keys( $css_files ),
42 | 			array_keys( $other_files )
43 | 		);
44 | 
45 | 		foreach ( $all_filenames as $path ) {
46 | 			checkcount();
47 | 
48 | 			$filename = basename( $path );
49 | 
50 | 			if ( in_array( $filename, $excluded_directories, true ) ) {
51 | 				$this->error[] = sprintf(
52 | 					'<span class="tc-lead tc-required">%s</span>: %s',
53 | 					__( 'REQUIRED', 'theme-check' ),
54 | 					__( 'Please remove any extraneous directories like .git or .svn from the ZIP file before uploading it.', 'theme-check' )
55 | 				);
56 | 				$ret           = false;
57 | 			}
58 | 		}
59 | 
60 | 		return $ret;
61 | 	}
62 | 
63 | 	/**
64 | 	 * Get error messages from the checks.
65 | 	 *
66 | 	 * @return array Error message.
67 | 	 */
68 | 	public function getError() {
69 | 		return $this->error;
70 | 	}
71 | }
72 | 
73 | $themechecks[] = new Directories_Check();
74 | 


--------------------------------------------------------------------------------
/checks/class-image-size-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if the image sizes are larger than necessary
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if the image sizes are larger than necessary
10 |  */
11 | class Image_Size_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		checkcount();
29 | 
30 | 		foreach ( $other_files as $other_key => $otherfile ) {
31 | 
32 | 			$file = wp_check_filetype_and_ext( $other_key, basename( $other_key ) );
33 | 			if ( 'image/' !== substr( $file['type'], 0, 6 ) ) {
34 | 				continue;
35 | 			}
36 | 
37 | 			// Check if the file is larger than 500 KB.
38 | 			$image_size = filesize( $other_key );
39 | 			if ( $image_size < 500 * KB_IN_BYTES ) {
40 | 				continue;
41 | 			}
42 | 
43 | 			$this->error[] = sprintf(
44 | 				'<span class="tc-lead tc-warning">%s</span>: %s',
45 | 				__( 'WARNING', 'theme-check' ),
46 | 				sprintf(
47 | 					/* translators: %1$s file name. %2$s file size. */
48 | 					__( '%1$s is %2$s in size. Large file sizes have a negative impact on website performance and loading time. Compress images before using them.', 'theme-check' ),
49 | 					'<strong>' . tc_filename( $other_key ) . '</strong>',
50 | 					size_format( $image_size, 1 )
51 | 				)
52 | 			);
53 | 		}
54 | 
55 | 		return true;
56 | 	}
57 | 
58 | 	/**
59 | 	 * Get error messages from the checks.
60 | 	 *
61 | 	 * @return array Error message.
62 | 	 */
63 | 	public function getError() {
64 | 		return $this->error;
65 | 	}
66 | }
67 | 
68 | $themechecks[] = new Image_Size_Check();
69 | 


--------------------------------------------------------------------------------
/checks/class-comment-reply-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if the comment reply script is included in classic themes
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if the comment reply script is included in classic themes.
10 |  *
11 |  * Checks if the comment reply script is included. If not, recommend it.
12 |  */
13 | class Comment_Reply_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 
30 | 		$php = implode( ' ', $php_files );
31 | 
32 | 		checkcount();
33 | 
34 | 		if ( ! preg_match( '/wp_enqueue_script\(\s?("|\')comment-reply("|\')/i', $php ) ) {
35 | 			if ( ! preg_match( '/comment-reply/', $php ) ) {
36 | 				$this->error[] = sprintf(
37 | 					'<span class="tc-lead tc-recommended">%s</span>: %s',
38 | 					__( 'RECOMMENDED', 'theme-check' ),
39 | 					__( 'Could not find the <strong>comment-reply</strong> script enqueued.', 'theme-check' )
40 | 				);
41 | 			} else {
42 | 				$this->error[] = sprintf(
43 | 					'<span class="tc-lead tc-info">%s</span>: %s',
44 | 					__( 'INFO', 'theme-check' ),
45 | 					__( 'Could not find the <strong>comment-reply</strong> script enqueued, however a reference to \'comment-reply\' was found. Make sure that the comment-reply script is being enqueued properly on singular pages.', 'theme-check' )
46 | 				);
47 | 			}
48 | 		}
49 | 
50 | 		return true;
51 | 	}
52 | 
53 | 	/**
54 | 	 * Get error messages from the checks.
55 | 	 *
56 | 	 * @return array Error message.
57 | 	 */
58 | 	public function getError() {
59 | 		return $this->error;
60 | 	}
61 | }
62 | 
63 | $themechecks[] = new Comment_Reply_Check();
64 | 


--------------------------------------------------------------------------------
/checks/class-uri-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check that wordpress.org is not used for theme URI
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check that wordpress.org is not used for theme URI.
10 |  */
11 | class URI_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Theme information. Author URI, theme URI, Author name
21 | 	 *
22 | 	 * @var object $theme
23 | 	 */
24 | 	protected $theme;
25 | 
26 | 	function set_context( $data ) {
27 | 		if ( isset( $data['theme'] ) ) {
28 | 			$this->theme = $data['theme'];
29 | 		}
30 | 	}
31 | 
32 | 	/**
33 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
34 | 	 *
35 | 	 * @param array $php_files File paths and content for PHP files.
36 | 	 * @param array $css_files File paths and content for CSS files.
37 | 	 * @param array $other_files Folder names, file paths and content for other files.
38 | 	 */
39 | 	public function check( $php_files, $css_files, $other_files ) {
40 | 		checkcount();
41 | 		$ret = true;
42 | 
43 | 		if ( ! empty( $this->theme->get( 'ThemeURI' ) ) ) {
44 | 
45 | 			// We allow .org user profiles as Author URI, so only check the Theme URI. We also allow WordPress.com links.
46 | 			if (
47 | 				$this->theme->get( 'Author' ) != 'the WordPress team' &&
48 | 				( stripos( $this->theme->get( 'ThemeURI' ), 'wordpress.org' ) || stripos( $this->theme->get( 'ThemeURI' ), 'w.org' ) )
49 | 			) {
50 | 				$this->error[] = sprintf(
51 | 					'<span class="tc-lead tc-required">%s</span>: %s',
52 | 					__( 'REQUIRED', 'theme-check' ),
53 | 					__( 'Using a WordPress.org Theme URI is reserved for default and bundled themes (Twenty * series).', 'theme-check' )
54 | 				);
55 | 				$ret           = false;
56 | 			}
57 | 		}
58 | 
59 | 		return $ret;
60 | 	}
61 | 
62 | 	/**
63 | 	 * Get error messages from the checks.
64 | 	 *
65 | 	 * @return array Error message.
66 | 	 */
67 | 	public function getError() {
68 | 		return $this->error;
69 | 	}
70 | }
71 | 
72 | $themechecks[] = new URI_Check();
73 | 


--------------------------------------------------------------------------------
/checks/class-iframe-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if iframes are used
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if iframes are used.
10 |  *
11 |  * Check if iframes are used. if they are, inform that the content need to be manually checked.
12 |  */
13 | class Iframe_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 		$ret = true;
30 | 
31 | 		$checks = array(
32 | 			'/<(iframe)[^>]*>/' => __( 'iframes are sometimes used to load unwanted adverts and code on your site', 'theme-check' ),
33 | 		);
34 | 
35 | 		foreach ( $php_files as $php_key => $phpfile ) {
36 | 			foreach ( $checks as $key => $check ) {
37 | 				checkcount();
38 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
39 | 					$filename      = tc_filename( $php_key );
40 | 					$error         = ltrim( $matches[1], '(' );
41 | 					$error         = rtrim( $error, '(' );
42 | 					$grep          = tc_grep( $error, $php_key );
43 | 					$this->error[] = sprintf(
44 | 						'<span class="tc-lead tc-info">%s</span>: %s %s',
45 | 						__( 'INFO', 'theme-check' ),
46 | 						sprintf(
47 | 							__( '%1$s was found in the file %2$s %3$s.', 'theme-check' ),
48 | 							'<strong>' . $error . '</strong>',
49 | 							'<strong>' . $filename . '</strong>',
50 | 							$check
51 | 						),
52 | 						$grep
53 | 					);
54 | 				}
55 | 			}
56 | 		}
57 | 		return $ret;
58 | 	}
59 | 
60 | 	/**
61 | 	 * Get error messages from the checks.
62 | 	 *
63 | 	 * @return array Error message.
64 | 	 */
65 | 	public function getError() {
66 | 		return $this->error;
67 | 	}
68 | }
69 | 
70 | $themechecks[] = new Iframe_Check();
71 | 


--------------------------------------------------------------------------------
/checks/class-post-pagination-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if post pagination and navigation is supported
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if post pagination and navigation is supported
10 |  */
11 | class Post_Pagination_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		// Combine all the php files into one string to make it easier to search.
29 | 		$php = implode( ' ', $php_files );
30 | 		checkcount();
31 | 		if (
32 | 			strpos( $php, 'posts_nav_link' ) === false &&
33 | 			strpos( $php, 'paginate_links' ) === false &&
34 | 			strpos( $php, 'the_posts_pagination' ) === false &&
35 | 			strpos( $php, 'the_posts_navigation' ) === false &&
36 | 			(
37 | 				strpos( $php, 'previous_posts_link' ) === false &&
38 | 				strpos( $php, 'next_posts_link' ) === false
39 | 			)
40 | 		) {
41 | 			$this->error[] = sprintf(
42 | 				'<span class="tc-lead tc-recommended">%s</span> %s',
43 | 				__( 'RECOMMENDED', 'theme-check' ),
44 | 				__( "The theme doesn't have post pagination code in it. Use <strong>posts_nav_link()</strong> or <strong>paginate_links()</strong> or <strong>the_posts_pagination()</strong> or <strong>the_posts_navigation()</strong> or <strong>next_posts_link()</strong> and <strong>previous_posts_link()</strong> to add post pagination.", 'theme-check' )
45 | 			);
46 | 		}
47 | 
48 | 		return true;
49 | 	}
50 | 
51 | 	/**
52 | 	 * Get error messages from the checks.
53 | 	 *
54 | 	 * @return array Error message.
55 | 	 */
56 | 	public function getError() {
57 | 		return $this->error;
58 | 	}
59 | }
60 | $themechecks[] = new Post_Pagination_Check();
61 | 


--------------------------------------------------------------------------------
/checks/class-block-patterns-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if block patterns and block styles are included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if block patterns and block styles are included.
10 |  *
11 |  * Check if block patterns and block styles are included, if not, recommend it.
12 |  */
13 | class Block_Patterns_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 		checkcount();
30 | 
31 | 		$php = implode( ' ', $php_files );
32 | 
33 | 		if ( strpos( $php, 'register_block_pattern' ) === false ) {
34 | 			$this->error[] = sprintf(
35 | 				'<span class="tc-lead tc-recommended">%s</span>: %s',
36 | 				__( 'RECOMMENDED', 'theme-check' ),
37 | 				__( 'No reference to <strong>register_block_pattern</strong> was found in the theme. Theme authors are encouraged to implement custom block patterns as a transition to block themes.', 'theme-check' )
38 | 			);
39 | 		}
40 | 
41 | 		if ( strpos( $php, 'register_block_style' ) === false ) {
42 | 			$this->error[] = sprintf(
43 | 				'<span class="tc-lead tc-recommended">%s</span>: %s',
44 | 				__( 'RECOMMENDED', 'theme-check' ),
45 | 				__( 'No reference to <strong>register_block_style</strong> was found in the theme. Theme authors are encouraged to implement new block styles as a transition to block themes.', 'theme-check' )
46 | 			);
47 | 		}
48 | 
49 | 		return true;
50 | 	}
51 | 
52 | 	/**
53 | 	 * Get error messages from the checks.
54 | 	 *
55 | 	 * @return array Error message.
56 | 	 */
57 | 	public function getError() {
58 | 		return $this->error;
59 | 	}
60 | }
61 | 
62 | $themechecks[] = new Block_Patterns_Check();
63 | 


--------------------------------------------------------------------------------
/checks/class-fse-required-files-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks that Full-Site Editing themes have the required files.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Class FSE_Required_Files_Check
10 |  *
11 |  * Checks that Full-Site Editing themes have the required files.
12 |  *
13 |  * This check is not added to the global array of checks, because it doesn't apply to all themes.
14 |  */
15 | class FSE_Required_Files_Check implements themecheck {
16 | 	/**
17 | 	 * Error messages, warnings and info notices.
18 | 	 *
19 | 	 * @var array $error
20 | 	 */
21 | 	protected $error = array();
22 | 
23 | 	/**
24 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
25 | 	 *
26 | 	 * @param array $php_files File paths and content for PHP files.
27 | 	 * @param array $css_files File paths and content for CSS files.
28 | 	 * @param array $other_files Folder names, file paths and content for other files.
29 | 	 */
30 | 	public function check( $php_files, $css_files, $other_files ) {
31 | 
32 | 		$ret = true;
33 | 
34 | 		$filenames = array();
35 | 
36 | 		foreach ( $other_files as $php_key => $phpfile ) {
37 | 			array_push( $filenames, tc_filename( $php_key ) );
38 | 		}
39 | 
40 | 		if ( ! in_array( 'theme.json', $filenames ) ) {
41 | 			$this->error[] = sprintf( '<span class="tc-lead tc-required">' . __( 'REQUIRED', 'theme-check' ) . '</span>: ' . __( 'Could not find the file theme.json in the theme.', 'theme-check' ), '<strong>theme.json</strong>' );
42 | 			$ret           = false;
43 | 		}
44 | 
45 | 		if ( ! in_array( 'block-templates/index.html', $filenames ) && ! in_array( 'templates/index.html', $filenames ) ) {
46 | 			$this->error[] = sprintf( '<span class="tc-lead tc-required">' . __( 'REQUIRED', 'theme-check' ) . '</span>: ' . __( 'Could not find the index.html template in the theme.', 'theme-check' ), '<strong>index.html</strong>' );
47 | 			$ret           = false;
48 | 		}
49 | 
50 | 		return $ret;
51 | 	}
52 | 
53 | 	/**
54 | 	 * Get error messages from the checks.
55 | 	 *
56 | 	 * @return array Error message.
57 | 	 */
58 | 	public function getError() {
59 | 		return $this->error;
60 | 	}
61 | }
62 | 


--------------------------------------------------------------------------------
/checks/class-comment-pagination-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if comment pagination is included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if comment pagination is included.
10 |  *
11 |  * Checks if comment pagination is included. If not, recommend it.
12 |  */
13 | class Comment_Pagination_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 
30 | 		// Combine all the php files into one string to make it easier to search.
31 | 		$php = implode( ' ', $php_files );
32 | 
33 | 		checkcount();
34 | 
35 | 		if (
36 | 			strpos( $php, 'paginate_comments_links' ) === false &&
37 | 			strpos( $php, 'the_comments_navigation' ) === false &&
38 | 			strpos( $php, 'the_comments_pagination' ) === false &&
39 | 			strpos( $php, 'next_comments_link' ) === false &&
40 | 			strpos( $php, 'previous_comments_link' ) === false
41 | 		) {
42 | 			$this->error[] = sprintf(
43 | 				'<span class="tc-lead tc-recommended">%s</span>: %s',
44 | 				__( 'RECOMMENDED', 'theme-check' ),
45 | 				__( "The theme doesn't have comment pagination code in it. Use <strong>paginate_comments_links()</strong> or <strong>the_comments_navigation</strong> or <strong>the_comments_pagination</strong> or <strong>next_comments_link()</strong> and <strong>previous_comments_link()</strong> to add comment pagination.", 'theme-check' )
46 | 			);
47 | 		}
48 | 
49 | 		return true;
50 | 	}
51 | 
52 | 	/**
53 | 	 * Get error messages from the checks.
54 | 	 *
55 | 	 * @return array Error message.
56 | 	 */
57 | 	public function getError() {
58 | 		return $this->error;
59 | 	}
60 | }
61 | 
62 | $themechecks[] = new Comment_Pagination_Check();
63 | 


--------------------------------------------------------------------------------
/checks/class-version-php-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check for Requires PHP versioning
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check for PHP versioning.
10 |  * Does "Requires PHP" include patch versions (e.g. 7.4.1)?
11 |  * If so, recommend including major and minor verisions only (e.g. 7.4)
12 |  *
13 |  * See: https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/#explanations
14 |  */
15 | class Version_Requires_PHP_Check implements themecheck {
16 | 	/**
17 | 	 * Error messages, warnings and info notices.
18 | 	 *
19 | 	 * @var array $error
20 | 	 */
21 | 	protected $error = array();
22 | 
23 | 	/**
24 | 	 * Theme information. Requires PHP,
25 | 	 *
26 | 	 * @var object $theme
27 | 	 */
28 | 	protected $theme;
29 | 
30 | 	function set_context( $data ) {
31 | 		if ( isset( $data['theme'] ) ) {
32 | 			$this->theme = $data['theme'];
33 | 		}
34 | 	}
35 | 
36 | 	/**
37 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
38 | 	 *
39 | 	 * @param array $php_files File paths and content for PHP files.
40 | 	 * @param array $css_files File paths and content for CSS files.
41 | 	 * @param array $other_files Folder names, file paths and content for other files.
42 | 	 */
43 | 	public function check( $php_files, $css_files, $other_files ) {
44 | 
45 | 		checkcount();
46 | 
47 | 		if ( ! empty( $this->theme->get( 'RequiresPHP' ) ) ) {
48 | 
49 | 			$req_php_decimal_count = substr_count( $this->theme->get( 'RequiresPHP' ), '.' );
50 | 
51 | 			if ( $req_php_decimal_count > 1 ) {
52 | 				$this->error[] = sprintf(
53 | 					'<span class="tc-lead tc-recommended">%s</span>: %s',
54 | 					__( 'RECOMMENDED', 'theme-check' ),
55 | 					__( '<strong>Requires PHP</strong> is recommended to have major and minor versions only (e.g. 7.4). Patch version is not needed (e.g. 7.4.1).', 'theme-check' )
56 | 				);
57 | 			}
58 | 		}
59 | 		return true;
60 | 	}
61 | 
62 | 	/**
63 | 	 * Get error messages from the checks.
64 | 	 *
65 | 	 * @return array Error message.
66 | 	 */
67 | 	public function getError() {
68 | 		return $this->error;
69 | 	}
70 | }
71 | 
72 | $themechecks[] = new Version_Requires_PHP_Check();
73 | 


--------------------------------------------------------------------------------
/checks/class-post-thumbnail-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if post thumbnails are supported
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if post thumbnails are supported
10 |  */
11 | class Post_Thumbnail_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$ret = true;
29 | 
30 | 		// Combine all the php files into one string to make it easier to search.
31 | 		$php = implode( ' ', $php_files );
32 | 		checkcount();
33 | 
34 | 		if ( strpos( $php, 'the_post_thumbnail' ) === false ) {
35 | 			$this->error[] = sprintf(
36 | 				'<span class="tc-lead tc-recommended">%s</span> %s',
37 | 				__( 'RECOMMENDED', 'theme-check' ),
38 | 				__( 'No reference to <strong>the_post_thumbnail()</strong> was found in the theme. It is recommended that the theme implement this functionality instead of using custom fields for thumbnails.', 'theme-check' )
39 | 			);
40 | 		}
41 | 
42 | 		if ( strpos( $php, 'post-thumbnails' ) === false ) {
43 | 			$this->error[] = sprintf(
44 | 				'<span class="tc-lead tc-recommended">%s</span> %s',
45 | 				__( 'RECOMMENDED', 'theme-check' ),
46 | 				__( 'No reference to post-thumbnails was found in the theme. If the theme has a thumbnail like functionality, it should be implemented with <strong>add_theme_support( "post-thumbnails" )</strong> in the functions.php file.', 'theme-check' )
47 | 			);
48 | 		}
49 | 
50 | 		return $ret;
51 | 	}
52 | 
53 | 	/**
54 | 	 * Get error messages from the checks.
55 | 	 *
56 | 	 * @return array Error message.
57 | 	 */
58 | 	public function getError() {
59 | 		return $this->error;
60 | 	}
61 | }
62 | 
63 | $themechecks[] = new Post_Thumbnail_Check();
64 | 


--------------------------------------------------------------------------------
/checks/class-time-date-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if hard coded dates are used
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if hard coded dates are used.
10 |  */
11 | class Time_Date_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$checks = array(
29 | 			'/\sdate_i18n\(\s?["|\'][A-Za-z\s]+\s?["|\']\)/' => 'date_i18n( get_option( \'date_format\' ) )',
30 | 			'/[^get_]the_date\(\s?["|\'][A-Za-z\s]+\s?["|\']\)/' => 'the_date( get_option( \'date_format\' ) )',
31 | 			'/[^get_]the_time\(\s?["|\'][A-Za-z\s]+\s?["|\']\)/' => 'the_time( get_option( \'date_format\' ) )',
32 | 		);
33 | 
34 | 		foreach ( $php_files as $php_key => $phpfile ) {
35 | 			foreach ( $checks as $key => $check ) {
36 | 				checkcount();
37 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
38 | 					$filename      = tc_filename( $php_key );
39 | 					$matches[0]    = str_replace( array( '"', "'" ), '', $matches[0] );
40 | 					$error         = trim( esc_html( rtrim( $matches[0], '(' ) ) );
41 | 					$this->error[] = sprintf(
42 | 						'<span class="tc-lead tc-info">%s</span> %s',
43 | 						__( 'INFO', 'theme-check' ),
44 | 						sprintf(
45 | 							__( 'At least one hard coded date was found in the file %1$s. Consider %2$s instead.', 'theme-check' ),
46 | 							'<strong>' . $filename . '</strong>',
47 | 							"<strong>get_option( 'date_format' )</strong>"
48 | 						)
49 | 					);
50 | 				}
51 | 			}
52 | 		}
53 | 
54 | 		return true;
55 | 	}
56 | 
57 | 	/**
58 | 	 * Get error messages from the checks.
59 | 	 *
60 | 	 * @return array Error message.
61 | 	 */
62 | 	public function getError() {
63 | 		return $this->error;
64 | 	}
65 | }
66 | 
67 | $themechecks[] = new Time_Date_Check();
68 | 


--------------------------------------------------------------------------------
/checks/class-worms-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check for signs of worms and hacks
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check for signs of worms and hacks.
10 |  */
11 | class Worms_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	function check( $php_files, $css_files, $other_files ) {
20 | 		$ret       = true;
21 | 		$php_files = array_merge( $php_files, $other_files );
22 | 		$checks    = array(
23 | 			'/wshell\.php/'                  => __( 'This may be a script used by hackers to get control of your server!', 'theme-check' ),
24 | 			'/ShellBOT/'                     => __( 'This may be a script used by hackers to get control of your server', 'theme-check' ),
25 | 			'/uname -a/'                     => __( 'Tells a hacker what operating system your server is running', 'theme-check' ),
26 | 			'/php \$[a-zA-Z]*=\'as\';/'      => __( 'Symptom of the "Pharma Hack" <a href="http://blog.sucuri.net/2010/07/understanding-and-cleaning-the-pharma-hack-on-wordpress.html">[1]</a>', 'theme-check' ),
27 | 			'/defined?\(\'wp_class_support/' => __( 'Symptom of the "Pharma Hack" <a href="http://blog.sucuri.net/2010/07/understanding-and-cleaning-the-pharma-hack-on-wordpress.html">[1]</a>', 'theme-check' ),
28 | 		);
29 | 
30 | 		foreach ( $php_files as $php_key => $phpfile ) {
31 | 			foreach ( $checks as $key => $check ) {
32 | 				checkcount();
33 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
34 | 					$filename      = tc_filename( $php_key );
35 | 					$error         = $matches[0];
36 | 					$grep          = tc_grep( $error, $php_key );
37 | 					$this->error[] = sprintf(
38 | 						'<span class="tc-lead tc-required">%s</span>: %s %s %s',
39 | 						__( 'REQUIRED', 'theme-check' ),
40 | 						'<strong>' . $filename . '</strong>',
41 | 						$check,
42 | 						$grep
43 | 					);
44 | 					$ret           = false;
45 | 				}
46 | 			}
47 | 		}
48 | 		return $ret;
49 | 	}
50 | 
51 | 	/**
52 | 	 * Get error messages from the checks.
53 | 	 *
54 | 	 * @return array Error message.
55 | 	 */
56 | 	public function getError() {
57 | 		return $this->error;
58 | 	}
59 | }
60 | 
61 | $themechecks[] = new Worms_Check();
62 | 


--------------------------------------------------------------------------------
/checks/class-include-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if include or required is used.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if include or required is used.
10 |  *
11 |  * Check if include or required is used. If they are, inform that they should not be used for templates.
12 |  */
13 | class Include_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 		$checks = array(
30 | 			'/(?<![a-z0-9_\'"])(?:require|include)(?:_once)?\s?[\'"\(]/i' => __( 'The theme appears to use include or require. If these are being used to include separate sections of a template from independent files, then <strong>get_template_part()</strong> should be used instead.', 'theme-check' ),
31 | 		);
32 | 
33 | 		foreach ( $php_files as $file_path => $file_content ) {
34 | 			foreach ( $checks as $check_regex => $check ) {
35 | 				checkcount();
36 | 
37 | 				$filename = tc_filename( $file_path );
38 | 				// This doesn't apply to functions.php.
39 | 				if ( $filename === 'functions.php' ) {
40 | 					continue;
41 | 				}
42 | 
43 | 				if ( preg_match( $check_regex, $file_content, $matches ) ) {
44 | 					$grep          = tc_preg( '/(?<![a-z0-9_\'"])(?:require|include)(?:_once)?\s?[\'"\(]/i', $file_path );
45 | 					$this->error[] = sprintf(
46 | 						'<span class="tc-lead tc-info">%s</span>: <strong>%s</strong> %s %s',
47 | 						__( 'INFO', 'theme-check' ),
48 | 						$filename,
49 | 						$check,
50 | 						$grep
51 | 					);
52 | 				}
53 | 			}
54 | 		}
55 | 
56 | 		return true;
57 | 	}
58 | 
59 | 	/**
60 | 	 * Get error messages from the checks.
61 | 	 *
62 | 	 * @return array Error message.
63 | 	 */
64 | 	public function getError() {
65 | 		return $this->error;
66 | 	}
67 | }
68 | 
69 | $themechecks[] = new Include_Check();
70 | 


--------------------------------------------------------------------------------
/checks/class-version-tested-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check for "Tested up to" versioning
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check for "Tested up to" versioning.
10 |  * Does "Tested up to" include patch versions (e.g. 5.8.1)?
11 |  * If so, recommend including major versions only (e.g. 5.8)
12 |  *
13 |  * See: https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/#explanations
14 |  */
15 | class Version_Tested_Upto_Check implements themecheck {
16 | 	/**
17 | 	 * Error messages, warnings and info notices.
18 | 	 *
19 | 	 * @var array $error
20 | 	 */
21 | 	protected $error = array();
22 | 
23 | 	/**
24 | 	 * Theme information. Requires PHP,
25 | 	 *
26 | 	 * @var object $theme
27 | 	 */
28 | 	protected $theme;
29 | 
30 | 	function set_context( $data ) {
31 | 		if ( isset( $data['theme'] ) ) {
32 | 			$this->theme = $data['theme'];
33 | 		}
34 | 	}
35 | 
36 | 	/**
37 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
38 | 	 *
39 | 	 * @param array $php_files File paths and content for PHP files.
40 | 	 * @param array $css_files File paths and content for CSS files.
41 | 	 * @param array $other_files Folder names, file paths and content for other files.
42 | 	 */
43 | 	public function check( $php_files, $css_files, $other_files ) {
44 | 
45 | 		$filepath   = $this->theme->get_stylesheet_directory() . '/style.css';
46 | 		$theme_data = get_file_data(
47 | 			$filepath,
48 | 			array(
49 | 				'TestedUpto' => 'Tested up to',
50 | 			)
51 | 		);
52 | 
53 | 		if ( ! empty( $theme_data['TestedUpto'] ) ) {
54 | 			$req_tested_decimal_count = substr_count( $theme_data['TestedUpto'], '.' );
55 | 			if ( $req_tested_decimal_count > 1 ) {
56 | 				$this->error[] = sprintf(
57 | 					'<span class="tc-lead tc-recommended">%s</span>: %s',
58 | 					__( 'RECOMMENDED', 'theme-check' ),
59 | 					__( '<strong>Tested up to</strong> is recommended to have major versions only (e.g. 5.8). Patch version is not needed (e.g. 5.8.1).', 'theme-check' )
60 | 				);
61 | 			}
62 | 		}
63 | 		return true;
64 | 	}
65 | 
66 | 	/**
67 | 	 * Get error messages from the checks.
68 | 	 *
69 | 	 * @return array Error message.
70 | 	 */
71 | 	public function getError() {
72 | 		return $this->error;
73 | 	}
74 | }
75 | 
76 | $themechecks[] = new Version_Tested_Upto_Check();
77 | 


--------------------------------------------------------------------------------
/checks/class-generated-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check that the theme is not generated.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check that the theme is not generated.
10 |  */
11 | class Generated_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		// Combine all the php files into one string to make it easier to search.
29 | 		$php = implode( ' ', $php_files );
30 | 
31 | 		checkcount();
32 | 
33 | 		if (
34 | 			// Artisteer.
35 | 			strpos( $php, 'art_normalize_widget_style_tokens' ) !== false
36 | 			|| strpos( $php, 'art_include_lib' ) !== false
37 | 			|| strpos( $php, '_remove_last_slash($url) {' ) !== false
38 | 			|| strpos( $php, 'adi_normalize_widget_style_tokens' ) !== false
39 | 			|| strpos( $php, 'm_normalize_widget_style_tokens' ) !== false
40 | 			|| strpos( $php, "bw = '<!--- BEGIN Widget --->';" ) !== false
41 | 			|| strpos( $php, "ew = '<!-- end_widget -->';" ) !== false
42 | 			|| strpos( $php, "end_widget' => '<!-- end_widget -->'" ) !== false
43 | 			// Lubith.
44 | 			|| strpos( $php, 'Lubith' ) !== false
45 | 			// Templatetoaster.
46 | 			|| strpos( $php, 'templatetoaster_' ) !== false
47 | 			|| strpos( $php, 'Templatetoaster_' ) !== false
48 | 			|| strpos( $php, '@package templatetoaster' ) !== false
49 | 			// wpthemegenerator.
50 | 			|| strpos( $php, 'wptg_' ) !== false
51 | 		) {
52 | 			$this->error[] = sprintf(
53 | 				'<span class="tc-lead tc-warning">%s</span>: %s',
54 | 				__( 'WARNING', 'theme-check' ),
55 | 				__( 'This theme appears to have been auto-generated.', 'theme-check' )
56 | 			);
57 | 		}
58 | 
59 | 		return true;
60 | 	}
61 | 
62 | 	/**
63 | 	 * Get error messages from the checks.
64 | 	 *
65 | 	 * @return array Error message.
66 | 	 */
67 | 	public function getError() {
68 | 		return $this->error;
69 | 	}
70 | }
71 | 
72 | $themechecks[] = new Generated_Check();
73 | 


--------------------------------------------------------------------------------
/checks/class-post-format-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if post formats are supported
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if post formats are supported.
10 |  */
11 | class Post_Format_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$php = implode( ' ', $php_files );
29 | 		$css = implode( ' ', $css_files );
30 | 
31 | 		checkcount();
32 | 
33 | 		$checks = array(
34 | 			'/add_theme_support\(\s?("|\')post-formats("|\')/m',
35 | 		);
36 | 
37 | 		foreach ( $php_files as $php_key => $phpfile ) {
38 | 			foreach ( $checks as $check ) {
39 | 				checkcount();
40 | 				if ( preg_match( $check, $phpfile, $matches ) ) {
41 | 					if (
42 | 						! strpos( $php, 'get_post_format' ) &&
43 | 						! strpos( $php, 'has_post_format' ) &&
44 | 						! strpos( $css, '.format' )
45 | 					) {
46 | 						$filename      = tc_filename( $php_key );
47 | 						$matches[0]    = str_replace( array( '"', "'" ), '', $matches[0] );
48 | 						$error         = esc_html( rtrim( $matches[0], '(' ) );
49 | 						$grep          = tc_grep( rtrim( $matches[0], '(' ), $php_key );
50 | 						$this->error[] = sprintf(
51 | 							'<span class="tc-lead tc-info">%s</span> %s',
52 | 							__( 'INFO', 'theme-check' ),
53 | 							sprintf(
54 | 								__( '%1$s was found in the file %2$s. However get_post_format and/or has_post_format were not found, and no use of formats in the CSS was detected.', 'theme-check' ),
55 | 								'<strong>' . $error . '</strong>',
56 | 								'<strong>' . $filename . '</strong>'
57 | 							)
58 | 						);
59 | 					}
60 | 				}
61 | 			}
62 | 		}
63 | 
64 | 		return true;
65 | 	}
66 | 
67 | 	/**
68 | 	 * Get error messages from the checks.
69 | 	 *
70 | 	 * @return array Error message.
71 | 	 */
72 | 	public function getError() {
73 | 		return $this->error;
74 | 	}
75 | }
76 | 
77 | $themechecks[] = new Post_Format_Check();
78 | 


--------------------------------------------------------------------------------
/checks/class-comments-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if comment templates are included in classic themes
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if comment templates are included in classic themes.
10 |  *
11 |  * Checks if comment templates are included. If not, recommend them.
12 |  */
13 | class Comments_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 
30 | 		$php = implode( ' ', $php_files );
31 | 
32 | 		$checks = array(
33 | 			'comments_template\s*\(' => __( 'See: <a href="https://developer.wordpress.org/reference/functions/comments_template/">comments_template</a><pre> &lt;?php comments_template( $file, $separate_comments ); ?&gt;</pre>', 'theme-check' ),
34 | 			'wp_list_comments\s*\('  => __( 'See: <a href="https://developer.wordpress.org/reference/functions/wp_list_comments/">wp_list_comments</a><pre> &lt;?php wp_list_comments( $args ); ?&gt;</pre>', 'theme-check' ),
35 | 			'comment_form\s*\('      => __( 'See: <a href="https://developer.wordpress.org/reference/functions/comment_form/">comment_form</a><pre> &lt;?php comment_form(); ?&gt;</pre>', 'theme-check' ),
36 | 		);
37 | 
38 | 		foreach ( $checks as $key => $check ) {
39 | 			checkcount();
40 | 			if ( ! preg_match( '/' . $key . '/i', $php ) ) {
41 | 				$key           = str_replace( '\s*\(', '', $key );
42 | 				$this->error[] = sprintf(
43 | 					'<span class="tc-lead tc-recommended">%s</span>: %s',
44 | 					__( 'RECOMMENDED', 'theme-check' ),
45 | 					sprintf(
46 | 						__( 'Could not find %1$s. %2$s', 'theme-check' ),
47 | 						'<strong>' . $key . '</strong>',
48 | 						$check
49 | 					)
50 | 				);
51 | 			}
52 | 		}
53 | 
54 | 		return true;
55 | 	}
56 | 
57 | 	/**
58 | 	 * Get error messages from the checks.
59 | 	 *
60 | 	 * @return array Error message.
61 | 	 */
62 | 	public function getError() {
63 | 		return $this->error;
64 | 	}
65 | }
66 | 
67 | $themechecks[] = new Comments_Check();
68 | 


--------------------------------------------------------------------------------
/theme-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 | Plugin Name: Envato Theme Check
 4 | Plugin URI: https://github.com/envato/Envato-Theme-Check
 5 | Description: Envato Theme Check is a modified fork of the original Theme Check by Otto42 with additional Themeforest specific WordPress checks.
 6 | Author: Scott Parry
 7 | Author URI: https://envato.com
 8 | Version: 2.0.0
 9 | Text Domain: theme-check
10 | License: GPLv2
11 | License URI: https://www.gnu.org/licenses/gpl-2.0.html
12 | */
13 | 
14 | if ( defined( 'WP_CLI' ) && WP_CLI ) {
15 | 	include 'theme-check-cli.php';
16 | }
17 | 
18 | class EnvatoThemeCheck  {
19 | 	function __construct() {
20 | 		add_action( 'admin_init', array( $this, 'tc_i18n' ) );
21 | 		add_action( 'admin_menu', array( $this, 'themecheck_add_page' ) );
22 | 	}
23 | 
24 | 	function tc_i18n() {
25 | 		load_plugin_textdomain( 'theme-check', false, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
26 | 	}
27 | 
28 | 	function load_styles() {
29 | 		wp_enqueue_style( 'style', plugins_url( 'assets/style.css', __FILE__ ), array(), '1', 'screen' );
30 | 	}
31 | 
32 | 	function themecheck_add_page() {
33 | 		$page = add_theme_page( 'Theme Check', 'Theme Check', 'manage_options', 'themecheck', array( $this, 'themecheck_do_page' ) );
34 | 		add_action( 'admin_print_styles-' . $page, array( $this, 'load_styles' ) );
35 | 	}
36 | 
37 | 	function tc_add_headers( $extra_headers ) {
38 | 		$extra_headers = array( 'License', 'License URI', 'Template Version' );
39 | 		return $extra_headers;
40 | 	}
41 | 
42 | 	function themecheck_do_page() {
43 | 		if ( ! current_user_can( 'manage_options' ) ) {
44 | 			wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', 'theme-check' ) );
45 | 		}
46 | 
47 | 		add_filter( 'extra_theme_headers', array( $this, 'tc_add_headers' ) );
48 | 
49 | 		include 'checkbase.php';
50 | 		include 'main.php';
51 | 
52 | 		?>
53 | 		<div id="theme-check" class="wrap">
54 | 		<h1><?php echo esc_html_x( 'Theme Check', 'title of the main page', 'theme-check' ); ?></h1>
55 | 		<div class="theme-check">
56 | 		<?php
57 | 		tc_form();
58 | 		if ( ! isset( $_POST['themename'] ) ) {
59 | 			tc_intro();
60 | 		}
61 | 
62 | 		if ( isset( $_POST['themename'] ) ) {
63 | 			check_admin_referer( 'themecheck-nonce' );
64 | 
65 | 			if ( isset( $_POST['trac'] ) ) {
66 | 				define( 'TC_TRAC', true );
67 | 			}
68 | 
69 | 			wp_raise_memory_limit();
70 | 
71 | 			check_main( wp_unslash( $_POST['themename'] ) );
72 | 		}
73 | 		?>
74 | 		</div> <!-- .theme-check-->
75 | 		</div>
76 | 		<?php
77 | 	}
78 | }
79 | new EnvatoThemeCheck();
80 | 


--------------------------------------------------------------------------------
/checks/class-copyright-notice-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if the theme has a copyright notice.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if the theme has a copyright notice.
10 |  */
11 | class Copyright_Notice_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	protected $slug;
20 | 
21 | 	function set_context( $data ) {
22 | 		if ( isset( $data['slug'] ) ) {
23 | 			$this->slug = $data['slug'];
24 | 		}
25 | 	}
26 | 
27 | 	/**
28 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
29 | 	 *
30 | 	 * @param array $php_files File paths and content for PHP files.
31 | 	 * @param array $css_files File paths and content for CSS files.
32 | 	 * @param array $other_files Folder names, file paths and content for other files.
33 | 	 */
34 | 	public function check( $php_files, $css_files, $other_files ) {
35 | 
36 | 		// Get a list of file names and check for the readme, license.txt and style.css.
37 | 		$combined_files = $css_files + $other_files;
38 | 		$content        = '';
39 | 
40 | 		// Get the contents of themeslug/filename:
41 | 		foreach ( $combined_files as $path => $contents ) {
42 | 			if ( stripos( $path, $this->slug . '/readme.txt' ) ||
43 | 				stripos( $path, $this->slug . '/readme.md' ) ||
44 | 				stripos( $path, $this->slug . '/style.css' ) ||
45 | 				stripos( $path, $this->slug . '/licence.txt' ) !== false ) {
46 | 				$content .= $contents;
47 | 			}
48 | 		}
49 | 
50 | 		checkcount();
51 | 
52 | 		// Check for Copyright and (C) in the combined content of the selected files.
53 | 		if ( ! preg_match( '/[ \t\/*#]*Copyright/i', $content, $matches ) && ! preg_match( '/[ \t\/*#]*\(C\)/i', $content, $matches ) ) {
54 | 			$this->error[] = sprintf(
55 | 				'<span class="tc-lead tc-warning">%s</span>: %s %s',
56 | 				__( 'WARNING', 'theme-check' ),
57 | 				__( 'Could not find a copyright notice for the theme. A copyright notice is needed if your theme is licenced as GPL.', 'theme-check' ),
58 | 				'<a href="' . esc_url( 'https://www.gnu.org/licenses/gpl-howto.html' ) . '" target="_blank">' . __( 'Learn how to add a copyright notice (opens in a new window).', 'theme-check' ) . '</a>'
59 | 			);
60 | 		}
61 | 
62 | 		return true;
63 | 	}
64 | 
65 | 	/**
66 | 	 * Get error messages from the checks.
67 | 	 *
68 | 	 * @return array Error message.
69 | 	 */
70 | 	public function getError() {
71 | 		return $this->error;
72 | 	}
73 | }
74 | 
75 | $themechecks[] = new Copyright_Notice_Check();
76 | 


--------------------------------------------------------------------------------
/checks/class-cdn-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks for resources being loaded from CDNs.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks for resources being loaded from CDNs.
10 |  *
11 |  * Checks for resources being loaded from CDNs. Usage of CDN is required to be removed.
12 |  */
13 | class CDN_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
23 | 	 *
24 | 	 * @param array $php_files File paths and content for PHP files.
25 | 	 * @param array $css_files File paths and content for CSS files.
26 | 	 * @param array $other_files Folder names, file paths and content for other files.
27 | 	 */
28 | 	public function check( $php_files, $css_files, $other_files ) {
29 | 
30 | 		$ret      = true;
31 | 		$php_code = implode( ' ', $php_files );
32 | 		$css_code = implode( ' ', $css_files );
33 | 		$all_code = $php_code . ' ' . $css_code;
34 | 
35 | 		checkcount();
36 | 
37 | 		$cdn_list = array(
38 | 			'bootstrap-maxcdn'    => 'maxcdn.bootstrapcdn.com',
39 | 			'bootstrap-netdna'    => 'netdna.bootstrapcdn.com',
40 | 			'bootstrap-stackpath' => 'stackpath.bootstrapcdn.com',
41 | 			'fontawesome'         => 'kit.fontawesome.com',
42 | 			'googlecode'          => 'googlecode.com/svn/',
43 | 			'oss.maxcdn'          => 'oss.maxcdn.com',
44 | 			'jquery'              => 'code.jquery.com/jquery-',
45 | 			'aspnetcdn'           => 'aspnetcdn.com',
46 | 			'cloudflare'          => 'cloudflare.com',
47 | 			'keycdn'              => 'keycdn.com',
48 | 			'pxgcdn'              => 'pxgcdn.com',
49 | 			'vimeocdn'            => 'vimeocdn.com',  // Usually in JS files.
50 | 		);
51 | 
52 | 		foreach ( $cdn_list as $cdn_slug => $cdn_url ) {
53 | 			if ( false !== strpos( $all_code, $cdn_url ) ) {
54 | 				$this->error[] = sprintf(
55 | 					'<span class="tc-lead tc-required">%s</span>: %s',
56 | 					__( 'REQUIRED', 'theme-check' ),
57 | 					sprintf(
58 | 						__( 'Found the URL of a CDN in the code: %s. You should not load CSS or Javascript resources from a CDN, please bundle them with the theme.', 'theme-check' ),
59 | 						'<code>' . esc_html( $cdn_url ) . '</code>'
60 | 					)
61 | 				);
62 | 				$ret           = false;
63 | 			}
64 | 		}
65 | 
66 | 		return $ret;
67 | 	}
68 | 
69 | 	/**
70 | 	 * Get error messages from the checks.
71 | 	 *
72 | 	 * @return array Error message.
73 | 	 */
74 | 	public function getError() {
75 | 		return $this->error;
76 | 	}
77 | }
78 | 
79 | $themechecks[] = new CDN_Check();
80 | 


--------------------------------------------------------------------------------
/checks/class-non-gpl-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if the theme includes resoruces from websites that does not use a GPL compatible license.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if the theme includes resoruces from websites that does not use a GPL compatible license.
10 |  */
11 | class Non_GPL_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$ret  = true;
29 | 		$code = implode( ' ', $other_files ); // The references are usually in the readme.
30 | 
31 | 		checkcount();
32 | 
33 | 		$link_list = array(
34 | 			'unsplash.com'    => 'https://unsplash.com/license',
35 | 			'pixabay'         => 'https://pixabay.com/service/license/',
36 | 			'freeimages'      => 'https://www.freeimages.com/license',
37 | 			'photopin'        => 'https://www.vecteezy.com/licensing-agreement',
38 | 			'vecteezy'        => 'https://www.vecteezy.com/licensing-agreement',
39 | 			'splitshire'      => 'https://www.splitshire.com/licence/',
40 | 			'freepik'         => 'https://www.freepikcompany.com/legal',
41 | 			'flaticon'        => 'https://www.freepikcompany.com/legal',
42 | 			'pikwizard'       => 'https://pikwizard.com/standard-license',
43 | 			'stock.adobe'     => 'https://stock.adobe.com/license-terms',
44 | 			'elements.envato' => 'https://elements.envato.com/license-terms',
45 | 			'undraw.co'       => 'https://undraw.co/license',
46 | 		);
47 | 
48 | 		foreach ( $link_list as $link_slug => $link_url ) {
49 | 			if ( false !== stripos( $code, $link_slug ) ) {
50 | 				$this->error[] = sprintf(
51 | 					'<span class="tc-lead tc-required">%s</span>: %s %s',
52 | 					__( 'REQUIRED', 'theme-check' ),
53 | 					sprintf(
54 | 						__( 'Found a reference to %s. Assets from this website does not use a license that is compatible with GPL.', 'theme-check' ),
55 | 						'<code>' . esc_html( $link_slug ) . '</code>'
56 | 					),
57 | 					'<a href="' . esc_url( $link_url ) . '" target="_blank">' . __( 'View license (opens in a new window).', 'theme-check' ) . '</a>'
58 | 				);
59 | 			}
60 | 		}
61 | 
62 | 		return $ret;
63 | 	}
64 | 
65 | 	/**
66 | 	 * Get error messages from the checks.
67 | 	 *
68 | 	 * @return array Error message.
69 | 	 */
70 | 	public function getError() {
71 | 		return $this->error;
72 | 	}
73 | }
74 | 
75 | $themechecks[] = new Non_GPL_Check();
76 | 


--------------------------------------------------------------------------------
/checks/class-no-hidden-admin-bar-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if the admin bar gets hidden by the theme
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if the admin bar gets hidden by the theme.
10 |  */
11 | class No_Hidden_Admin_Bar_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$php_regex = "/(add_filter(\s*)\((\s*)(\"|')show_admin_bar(\"|')(\s*)(.*))|(([^\S])show_admin_bar(\s*)\((.*))/";
29 | 		$css_regex = '/(#wpadminbar)/';
30 | 
31 | 		checkcount();
32 | 		// Check php files for filter show_admin_bar, show_admin_bar_front, and show_admin_bar().
33 | 		foreach ( $php_files as $file_path => $file_content ) {
34 | 
35 | 			if ( preg_match( $php_regex, $file_content, $matches ) ) {
36 | 				$grep          = tc_preg( '/show_admin_bar/', $file_path );
37 | 				$this->error[] = sprintf(
38 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
39 | 					__( 'WARNING', 'theme-check' ),
40 | 					sprintf(
41 | 						__( '%1$s Themes are not allowed to hide the admin bar. This warning must be manually checked.', 'theme-check' ),
42 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
43 | 					),
44 | 					$grep
45 | 				);
46 | 			}
47 | 		}
48 | 
49 | 		checkcount();
50 | 		// Check CSS Files for #wpadminbar.
51 | 		foreach ( $css_files as $file_path => $file_content ) {
52 | 
53 | 			// Don't print minified files.
54 | 			if ( strpos( $file_path, '.min.' ) === false ) {
55 | 				$grep = tc_preg( '/#wpadminbar/', $file_path );
56 | 			} else {
57 | 				$grep = '';
58 | 			}
59 | 
60 | 			if ( preg_match( $css_regex, $file_content, $matches ) ) {
61 | 				$this->error[] = sprintf(
62 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
63 | 					__( 'WARNING', 'theme-check' ),
64 | 					sprintf(
65 | 						__( 'The theme is using `#wpadminbar` in %1$s. Hiding the admin bar is not allowed. This warning must be manually checked.', 'theme-check' ),
66 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
67 | 					),
68 | 					$grep
69 | 				);
70 | 			}
71 | 		}
72 | 
73 | 		return true;
74 | 	}
75 | 
76 | 	/**
77 | 	 * Get error messages from the checks.
78 | 	 *
79 | 	 * @return array Error message.
80 | 	 */
81 | 	public function getError() {
82 | 		return $this->error;
83 | 	}
84 | }
85 | 
86 | $themechecks[] = new No_Hidden_Admin_Bar_Check();
87 | 


--------------------------------------------------------------------------------
/checks/class-constants-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if deprecated constants are included
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if deprecated constants are included.
10 |  *
11 |  * Checks if deprecated constants are included. If they are, require them to be removed.
12 |  *
13 |  * @see https://core.trac.wordpress.org/changeset/20212
14 |  */
15 | class Constants_Check implements themecheck {
16 | 	/**
17 | 	 * Error messages, warnings and info notices.
18 | 	 *
19 | 	 * @var array $error
20 | 	 */
21 | 	protected $error = array();
22 | 
23 | 	/**
24 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
25 | 	 *
26 | 	 * @param array $php_files File paths and content for PHP files.
27 | 	 * @param array $css_files File paths and content for CSS files.
28 | 	 * @param array $other_files Folder names, file paths and content for other files.
29 | 	 */
30 | 	public function check( $php_files, $css_files, $other_files ) {
31 | 
32 | 		$ret = true;
33 | 
34 | 		$checks = array(
35 | 			'STYLESHEETPATH'      => 'get_stylesheet_directory()',
36 | 			'TEMPLATEPATH'        => 'get_template_directory()',
37 | 			'PLUGINDIR'           => 'WP_PLUGIN_DIR',
38 | 			'MUPLUGINDIR'         => 'WPMU_PLUGIN_DIR',
39 | 			'HEADER_IMAGE'        => 'add_theme_support( \'custom-header\' )',
40 | 			'NO_HEADER_TEXT'      => 'add_theme_support( \'custom-header\' )',
41 | 			'HEADER_TEXTCOLOR'    => 'add_theme_support( \'custom-header\' )',
42 | 			'HEADER_IMAGE_WIDTH'  => 'add_theme_support( \'custom-header\' )',
43 | 			'HEADER_IMAGE_HEIGHT' => 'add_theme_support( \'custom-header\' )',
44 | 			'BACKGROUND_COLOR'    => 'add_theme_support( \'custom-background\' )',
45 | 			'BACKGROUND_IMAGE'    => 'add_theme_support( \'custom-background\' )',
46 | 		);
47 | 
48 | 		foreach ( $php_files as $php_key => $phpfile ) {
49 | 			foreach ( $checks as $key => $check ) {
50 | 				checkcount();
51 | 				if ( preg_match( '/[\s|\'|\"]' . $key . '(?:\'|"|;|\s)/', $phpfile, $matches ) ) {
52 | 					$filename      = tc_filename( $php_key );
53 | 					$error         = ltrim( rtrim( $matches[0], '(' ), '\'"' );
54 | 					$grep          = tc_grep( $error, $php_key );
55 | 					$this->error[] = sprintf(
56 | 						'<span class="tc-lead tc-required">%s</span>: %s %s',
57 | 						__( 'REQUIRED', 'theme-check' ),
58 | 						sprintf(
59 | 							__( '%1$s was found in the file %2$s. Use %3$s instead.', 'theme-check' ),
60 | 							'<strong>' . $error . '</strong>',
61 | 							'<strong>' . $filename . '</strong>',
62 | 							'<strong>' . $check . '</strong>'
63 | 						),
64 | 						$grep
65 | 					);
66 | 					$ret           = false;
67 | 				}
68 | 			}
69 | 		}
70 | 		return $ret;
71 | 	}
72 | 
73 | 	/**
74 | 	 * Get error messages from the checks.
75 | 	 *
76 | 	 * @return array Error message.
77 | 	 */
78 | 	public function getError() {
79 | 		return $this->error;
80 | 	}
81 | }
82 | 
83 | $themechecks[] = new Constants_Check();
84 | 


--------------------------------------------------------------------------------
/checks/class-search-form-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check that searchform.php is not included directly
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check that searchform.php is not included directly.
10 |  */
11 | class Search_Form_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 		$checks = array(
28 | 			'/searchform.php/' => __( 'Use <strong>get_search_form()</strong> instead of including searchform.php directly. Otherwise, the form can not be filtered.', 'theme-check' ),
29 | 		);
30 | 
31 | 		foreach ( $php_files as $file_path => $file_contents ) {
32 | 			foreach ( $checks as $regex => $check_text ) {
33 | 				checkcount();
34 | 				if ( preg_match( $regex, $file_contents, $out ) ) {
35 | 					$grep          = tc_preg( $regex, $file_path );
36 | 					$this->error[] = sprintf(
37 | 						'<span class="tc-lead tc-warning">%s</span>: %s %s',
38 | 						__( 'WARNING', 'theme-check' ),
39 | 						sprintf(
40 | 							__( '<strong>searchform.php</strong> was found in %1$s. %2$s', 'theme-check' ),
41 | 							'<strong>' . tc_filename( $file_path ) . '</strong>',
42 | 							$check_text
43 | 						),
44 | 						$grep
45 | 					);
46 | 				}
47 | 			}
48 | 
49 | 			$filename = tc_filename( $file_path );
50 | 			// This doesn't apply to searchform.php or WooCommerce product-searchform.php.
51 | 			if ( $filename === 'searchform.php' || $filename === 'product-searchform.php' ) {
52 | 				continue;
53 | 			}
54 | 
55 | 			checkcount();
56 | 
57 | 			// Checking for role="search" instead of form because it has a low risk of false positives.
58 | 			if ( false !== strpos( $file_contents, 'role="search"' ) ) {
59 | 				$grep          = tc_preg( $regex, $file_path );
60 | 				$this->error[] = sprintf(
61 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
62 | 					__( 'WARNING', 'theme-check' ),
63 | 					sprintf(
64 | 						__( '<strong>role="search"</strong> was found in %1$s. %2$s', 'theme-check' ),
65 | 						'<strong>' . tc_filename( $file_path ) . '</strong>',
66 | 						__( 'Use <strong>get_search_form()</strong> instead of hard coding forms. Otherwise, the form can not be filtered.', 'theme-check' )
67 | 					),
68 | 					$grep
69 | 				);
70 | 			}
71 | 		}
72 | 
73 | 		return true;
74 | 	}
75 | 
76 | 	/**
77 | 	 * Get error messages from the checks.
78 | 	 *
79 | 	 * @return array Error message.
80 | 	 */
81 | 	public function getError() {
82 | 		return $this->error;
83 | 	}
84 | }
85 | 
86 | $themechecks[] = new Search_Form_Check();
87 | 


--------------------------------------------------------------------------------
/checks/class-link-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if there are hard-coded links
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if there are hard-coded links
10 |  *
11 |  * Check if there are hard-coded links other than theme or author URI.
12 |  */
13 | class Link_Check implements themecheck {
14 | 	/**
15 | 	 * Error messages, warnings and info notices.
16 | 	 *
17 | 	 * @var array $error
18 | 	 */
19 | 	protected $error = array();
20 | 
21 | 	/**
22 | 	 * Theme information. Author URI, theme URI, Author name
23 | 	 *
24 | 	 * @var object $theme
25 | 	 */
26 | 	protected $theme;
27 | 
28 | 	function set_context( $data ) {
29 | 		if ( isset( $data['theme'] ) ) {
30 | 			$this->theme = $data['theme'];
31 | 		}
32 | 	}
33 | 
34 | 	/**
35 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
36 | 	 *
37 | 	 * @param array $php_files File paths and content for PHP files.
38 | 	 * @param array $css_files File paths and content for CSS files.
39 | 	 * @param array $other_files Folder names, file paths and content for other files.
40 | 	 */
41 | 	public function check( $php_files, $css_files, $other_files ) {
42 | 
43 | 		foreach ( $php_files as $php_key => $phpfile ) {
44 | 			checkcount();
45 | 			$grep = '';
46 | 			// Regex borrowed from TAC.
47 | 			$url_re   = '([[:alnum:]\-\.])+(\\.)([[:alnum:]]){2,4}([[:blank:][:alnum:]\/\+\=\%\&\_\\\.\~\?\-]*)';
48 | 			$title_re = '[[:blank:][:alnum:][:punct:]]*';   // 0 or more: any num, letter(upper/lower) or any punc symbol.
49 | 			$space_re = '(\\s*)';
50 | 			if ( preg_match_all( '/(<a)(\\s+)(href' . $space_re . '=' . $space_re . '"' . $space_re . '((http|https|ftp):\\/\\/)?)' . $url_re . '("' . $space_re . $title_re . $space_re . '>)' . $title_re . '(<\\/a>)/is', $phpfile, $out, PREG_SET_ORDER ) ) {
51 | 				$filename = tc_filename( $php_key );
52 | 				foreach ( $out as $key ) {
53 | 					if ( preg_match( '/\<a\s?href\s?=\s?["|\'](.*?)[\'|"](.*?)\>(.*?)\<\/a\>/is', $key[0], $stripped ) ) {
54 | 						if (
55 | 							! empty( $this->theme->get( 'AuthorURI' ) ) &&
56 | 							! empty( $this->theme->get( 'ThemeURI' ) ) &&
57 | 							$stripped[1] &&
58 | 							! strpos( $stripped[1], $this->theme->get( 'ThemeURI' ) ) &&
59 | 							! strpos( $stripped[1], $this->theme->get( 'AuthorURI' ) ) &&
60 | 							! stripos( $stripped[1], 'WordPress.' )
61 | 						) {
62 | 							$grep .= tc_grep( $stripped[1], $php_key );
63 | 						}
64 | 					}
65 | 				}
66 | 				if ( $grep ) {
67 | 					$this->error[] = sprintf(
68 | 						'<span class="tc-lead tc-info">%s</span>: %s %s',
69 | 						__( 'INFO', 'theme-check' ),
70 | 						sprintf(
71 | 							__( 'Possible hard-coded links were found in the file %s.', 'theme-check' ),
72 | 							'<strong>' . $filename . '</strong>'
73 | 						),
74 | 						$grep
75 | 					);
76 | 				}
77 | 			}
78 | 		}
79 | 
80 | 		return true;
81 | 	}
82 | 
83 | 	/**
84 | 	 * Get error messages from the checks.
85 | 	 *
86 | 	 * @return array Error message.
87 | 	 */
88 | 	public function getError() {
89 | 		return $this->error;
90 | 	}
91 | }
92 | 
93 | $themechecks[] = new Link_Check();
94 | 


--------------------------------------------------------------------------------
/checks/class-suggested-styles-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if style.css includes theme and author URI
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if style.css includes theme and author URI
10 |  */
11 | class Suggested_Styles_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		// Combine all the css files into one string to make it easier to search.
29 | 		$css = implode( ' ', $css_files );
30 | 
31 | 		checkcount();
32 | 
33 | 		$checks = array(
34 | 			'[ \t\/*#]*Theme URI:'  => 'Theme URI:',
35 | 			'[ \t\/*#]*Author URI:' => 'Author URI:',
36 | 		);
37 | 
38 | 		foreach ( $checks as $key => $check ) {
39 | 			if ( ! preg_match( '/' . $key . '/i', $css, $matches ) ) {
40 | 				$this->error[] = sprintf( '<span class="tc-lead tc-recommended">' . __( 'RECOMMENDED', 'theme-check' ) . '</span>: ' . __( '%s is missing from your style.css header.', 'theme-check' ), '<strong>' . $check . '</strong>' );
41 | 			}
42 | 		}
43 | 
44 | 		$css_class_checks = array(
45 | 			'\.sticky'          => __( '<strong>.sticky</strong> css class is recommended in your theme css.', 'theme-check' ),
46 | 			'\.bypostauthor'    => __( '<strong>.bypostauthor</strong> css class is recommended in your theme css.', 'theme-check' ),
47 | 			'\.alignleft'       => __( '<strong>.alignleft</strong> css class is recommended in your theme css.', 'theme-check' ),
48 | 			'\.alignright'      => __( '<strong>.alignright</strong> css class is recommended in your theme css.', 'theme-check' ),
49 | 			'\.aligncenter'     => __( '<strong>.aligncenter</strong> css class is recommended in your theme css.', 'theme-check' ),
50 | 			'\.wp-caption'      => __( '<strong>.wp-caption</strong> css class is recommended in your theme css.', 'theme-check' ),
51 | 			'\.wp-caption-text' => __( '<strong>.wp-caption-text</strong> css class is recommended in your theme css.', 'theme-check' ),
52 | 			'\.gallery-caption' => __( '<strong>.gallery-caption</strong> css class is recommended in your theme css.', 'theme-check' ),
53 | 		);
54 | 
55 | 		foreach ( $css_class_checks as $key => $check ) {
56 | 			if ( ! preg_match( '/' . $key . '/i', $css, $matches ) ) {
57 | 				$this->error[] = sprintf(
58 | 					'<span class="tc-lead tc-recommended">%s</span> %s',
59 | 					__( 'RECOMMENDED', 'theme-check' ),
60 | 					$check
61 | 				);
62 | 			}
63 | 		}
64 | 
65 | 		return true;
66 | 	}
67 | 
68 | 	/**
69 | 	 * Get error messages from the checks.
70 | 	 *
71 | 	 * @return array Error message.
72 | 	 */
73 | 	public function getError() {
74 | 		return $this->error;
75 | 	}
76 | }
77 | 
78 | $themechecks[] = new Suggested_Styles_Check();
79 | 


--------------------------------------------------------------------------------
/checks/class-title-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check for wp_title and title tags.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks for the title:
10 |  * Is there a call to wp_title()?
11 |  * Are there <title> and </title> tags?
12 |  *
13 |  * See: https://make.wordpress.org/themes/handbook/review/required/theme-check-plugin/
14 |  */
15 | class Title_Check implements themecheck {
16 | 	/**
17 | 	 * Error messages, warnings and info notices.
18 | 	 *
19 | 	 * @var array $error
20 | 	 */
21 | 	protected $error = array();
22 | 
23 | 	/**
24 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
25 | 	 *
26 | 	 * @param array $php_files File paths and content for PHP files.
27 | 	 * @param array $css_files File paths and content for CSS files.
28 | 	 * @param array $other_files Folder names, file paths and content for other files.
29 | 	 */
30 | 	public function check( $php_files, $css_files, $other_files ) {
31 | 
32 | 		$php = implode( ' ', $php_files );
33 | 
34 | 		foreach ( $php_files as $file_path => $file_content ) {
35 | 
36 | 			// Check whether there is a call to wp_title().
37 | 			checkcount();
38 | 			if ( preg_match( '/\bwp_title\b/', $file_content ) ) {
39 | 				$filename      = tc_filename( $file_path );
40 | 				$grep          = tc_grep( 'wp_title(', $file_path ); // tc_grep does not use preg_match, so there is a known risk for false positives here.
41 | 				$this->error[] = sprintf(
42 | 					'<span class="tc-lead tc-recommended">%s</span>: %s. %s',
43 | 					__( 'RECOMMENDED', 'theme-check' ),
44 | 					sprintf(
45 | 						__( '<strong>wp_title()</strong> was found in the file %1$s. wp_title was historically used for the document &lt;title&gt; tag and was never intended for other purposes. Use <strong>add_theme_support( "title-tag" )</strong> instead', 'theme-check' ),
46 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
47 | 					),
48 | 					$grep
49 | 				);
50 | 			}
51 | 
52 | 			// Look for anything that looks like <svg>...</svg> and exclude it (inline svg's have titles too).
53 | 			$file_content = preg_replace( '/<svg.*>.*<\/svg>/s', '', $file_content );
54 | 
55 | 			// Look for <title> and </title> tags.
56 | 			checkcount();
57 | 			if ( ( false !== @strpos( $file_content, '<title>' ) ) || ( false !== @strpos( $file_content, '</title>' ) ) ) {
58 | 				$filename      = tc_filename( $file_path );
59 | 				$grep          = tc_grep( '<title>', $file_path );
60 | 				$this->error[] = sprintf(
61 | 					'<span class="tc-lead tc-recommended">%s</span>: %s. %s',
62 | 					__( 'RECOMMENDED', 'theme-check' ),
63 | 					sprintf(
64 | 						__( '<strong>&lt;title&gt;</strong> tag was found in the file %1$s. Document titles must not be hard coded, use <strong>add_theme_support( "title-tag" )</strong> instead', 'theme-check' ),
65 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
66 | 					),
67 | 					$grep
68 | 				);
69 | 			}
70 | 		}
71 | 
72 | 		return true;
73 | 
74 | 	}
75 | 
76 | 	/**
77 | 	 * Get error messages from the checks.
78 | 	 *
79 | 	 * @return array Error message.
80 | 	 */
81 | 	public function getError() {
82 | 		return $this->error;
83 | 	}
84 | }
85 | 
86 | $themechecks[] = new Title_Check();
87 | 


--------------------------------------------------------------------------------
/checks/class-theme-support-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check for recommended theme support in classic themes
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check for recommended theme support in classic themes.
10 |  */
11 | class Theme_Support_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$php = implode( ' ', $php_files );
29 | 
30 | 		$checks = array(
31 | 			'#add_theme_support\s*\(\s*[\'|"]custom-header#' => __( 'No reference to <strong>add_theme_support( "custom-header", $args )</strong> was found in the theme. It is recommended that the theme implement this functionality if using an image for the header.', 'theme-check' ),
32 | 			'#add_theme_support\s*\(\s*[\'|"]custom-background#' => __( 'No reference to <strong>add_theme_support( "custom-background", $args )</strong> was found in the theme. If the theme uses background images or solid colors for the background, then it is recommended that the theme implement this functionality.', 'theme-check' ),
33 | 			'#add_theme_support\s*\(\s*[\'|"]custom-logo#' => __( 'No reference to <strong>add_theme_support( "custom-logo", $args )</strong> was found in the theme. It is recommended that the theme implement this functionality.', 'theme-check' ),
34 | 			'#add_theme_support\s*\(\s*[\'|"]html5#'       => __( 'No reference to <strong>add_theme_support( "html5", $args )</strong> was found in the theme. It is strongly recommended that the theme implement this functionality.', 'theme-check' ),
35 | 			'#add_theme_support\s*\(\s*[\'|"]responsive-embeds#' => __( 'No reference to <strong>add_theme_support( "responsive-embeds" )</strong> was found in the theme. It is recommended that the theme implement this functionality.', 'theme-check' ),
36 | 			'#add_theme_support\s*\(\s*[\'|"]align-wide#'  => __( 'No reference to <strong>add_theme_support( "align-wide" )</strong> was found in the theme. It is recommended that the theme implement this functionality.', 'theme-check' ),
37 | 			'#add_theme_support\s*\(\s*[\'|"]wp-block-styles#' => __( 'No reference to <strong>add_theme_support( "wp-block-styles" )</strong> was found in the theme. It is recommended that the theme implement this functionality.', 'theme-check' ),
38 | 		);
39 | 
40 | 		foreach ( $checks as $key => $check ) {
41 | 			checkcount();
42 | 			if ( ! preg_match( $key, $php ) ) {
43 | 				$this->error[] = sprintf(
44 | 					'<span class="tc-lead tc-recommended">%s</span>: %s',
45 | 					__( 'RECOMMENDED', 'theme-check' ),
46 | 					$check
47 | 				);
48 | 			}
49 | 		}
50 | 
51 | 		return true;
52 | 	}
53 | 
54 | 	/**
55 | 	 * Get error messages from the checks.
56 | 	 *
57 | 	 * @return array Error message.
58 | 	 */
59 | 	public function getError() {
60 | 		return $this->error;
61 | 	}
62 | }
63 | 
64 | $themechecks[] = new Theme_Support_Check();
65 | 


--------------------------------------------------------------------------------
/checks/class-style-css-header-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks if the style.css file header includes the required items.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks if the style.css file header includes the required items.
10 |  */
11 | class Style_CSS_Header_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$css = implode( ' ', $css_files );
29 | 		$ret = true;
30 | 
31 | 		$checks = array(
32 | 			'[ \t\/*#]*Theme Name:'   => __( '<strong>Theme name:</strong> is missing from your style.css header.', 'theme-check' ),
33 | 			'[ \t\/*#]*Description:'  => __( '<strong>Description:</strong> is missing from your style.css header.', 'theme-check' ),
34 | 			'[ \t\/*#]*Author:'       => __( '<strong>Author:</strong> is missing from your style.css header.', 'theme-check' ),
35 | 			'[ \t\/*#]*Version'       => __( '<strong>Version:</strong> is missing from your style.css header.', 'theme-check' ),
36 | 			'[ \t\/*#]*License:'      => __( '<strong>License:</strong> is missing from your style.css header.', 'theme-check' ),
37 | 			'[ \t\/*#]*License URI:'  => __( '<strong>License URI:</strong> is missing from your style.css header.', 'theme-check' ),
38 | 			'[ \t\/*#]*Text Domain:'  => __( '<strong>Text Domain:</strong> is missing from your style.css header.', 'theme-check' ),
39 | 			'[ \t\/*#]*Tested up to:' => __( '<strong>Tested up to:</strong> is missing from your style.css header. Also, this should be numbers only, so <em>5.0</em> and not <em>WP 5.0</em>', 'theme-check' ),
40 | 			'[ \t\/*#]*Requires PHP:' => __( '<strong>Requires PHP:</strong> is missing from your style.css header.', 'theme-check' ),
41 | 			'[ \t\/*#]*Update URI:'   => __( '<strong>Update URI:</strong> is found from your style.css header. This feature is only for themes that are distributed outside the theme directory. Remove from your style.css file.', 'theme-check' ),
42 | 		);
43 | 
44 | 		foreach ( $checks as $key => $check ) {
45 | 			checkcount();
46 | 
47 | 			if ( $key === '[ \t\/*#]*Update URI:' ) {
48 | 				if ( preg_match( '/' . $key . '/i', $css, $matches ) ) {
49 | 					$this->error[] = sprintf(
50 | 						'<span class="tc-lead tc-required">%s</span> %s',
51 | 						__( 'REQUIRED', 'theme-check' ),
52 | 						$check
53 | 					);
54 | 					$ret           = false;
55 | 				}
56 | 			} else {
57 | 				if ( ! preg_match( '/' . $key . '/i', $css, $matches ) ) {
58 | 					$this->error[] = sprintf(
59 | 						'<span class="tc-lead tc-required">%s</span> %s',
60 | 						__( 'REQUIRED', 'theme-check' ),
61 | 						$check
62 | 					);
63 | 					$ret           = false;
64 | 				}
65 | 			}
66 | 		}
67 | 
68 | 		return $ret;
69 | 	}
70 | 
71 | 	/**
72 | 	 * Get error messages from the checks.
73 | 	 *
74 | 	 * @return array Error message.
75 | 	 */
76 | 	public function getError() {
77 | 		return $this->error;
78 | 	}
79 | }
80 | 
81 | $themechecks[] = new Style_CSS_Header_Check();
82 | 


--------------------------------------------------------------------------------
/checks/class-i18n-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check if there are PHP variables in translation strings.
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check if there are PHP variables in translation strings.
 10 |  */
 11 | class I18N_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 21 | 	 *
 22 | 	 * @param array $php_files File paths and content for PHP files.
 23 | 	 * @param array $css_files File paths and content for CSS files.
 24 | 	 * @param array $other_files Folder names, file paths and content for other files.
 25 | 	 */
 26 | 	public function check( $php_files, $css_files, $other_files ) {
 27 | 
 28 | 		checkcount();
 29 | 
 30 | 		// Make sure the tokenizer is available.
 31 | 		if ( ! function_exists( 'token_get_all' ) ) {
 32 | 			return true;
 33 | 		}
 34 | 
 35 | 		foreach ( $php_files as $php_key => $phpfile ) {
 36 | 			$stmts = array();
 37 | 			foreach ( array( '_e(', '__(', '_e (', '__ (' ) as $finder ) {
 38 | 				$search = $phpfile;
 39 | 				while ( ( $pos = strpos( $search, $finder ) ) !== false &&
 40 | 					strpos( $search, 'pll__' ) === false &&
 41 | 					strpos( $search, 'pll_e' ) === false ) {
 42 | 					$search = substr( $search, $pos );
 43 | 					$open   = 1;
 44 | 					$i      = strpos( $search, '(' ) + 1;
 45 | 					while ( $open > 0 && isset( $search[ $i ] ) ) {
 46 | 						switch ( $search[ $i ] ) {
 47 | 							case '(':
 48 | 								$open++;
 49 | 								break;
 50 | 							case ')':
 51 | 								$open--;
 52 | 								break;
 53 | 						}
 54 | 						$i++;
 55 | 					}
 56 | 					$stmts[] = substr( $search, 0, $i );
 57 | 					$search  = substr( $search, $i );
 58 | 				}
 59 | 			}
 60 | 
 61 | 			foreach ( $stmts as $match ) {
 62 | 				$tokens = token_get_all( '<?php ' . $match . ';' );
 63 | 
 64 | 				if ( ! empty( $tokens ) ) {
 65 | 					foreach ( $tokens as $token ) {
 66 | 						if ( is_array( $token ) && in_array( $token[0], array( T_VARIABLE ) ) ) {
 67 | 							$filename      = tc_filename( $php_key );
 68 | 							$grep          = tc_grep( ltrim( $token[1] ), $php_key );
 69 | 							$this->error[] = sprintf(
 70 | 								'<span class="tc-lead tc-recommended">%s</span>: %s',
 71 | 								__( 'RECOMMENDED', 'theme-check' ),
 72 | 								sprintf(
 73 | 									__( 'Possible variable %1$s found in translation function in %2$s. Translation function calls must not contain PHP variables, use placeholders instead. See <a href="%3$s" target="_blank">Internationalization Guidelines (Opens in a new window)</a>. %4$s', 'theme-check' ),
 74 | 									'<strong>' . $token[1] . '</strong>',
 75 | 									'<strong>' . $filename . '</strong>',
 76 | 									'https://developer.wordpress.org/apis/handbook/internationalization/internationalization-guidelines/#variables',
 77 | 									$grep
 78 | 								)
 79 | 							);
 80 | 							break; // Stop looking at the tokens on this line once a variable is found.
 81 | 						}
 82 | 					}
 83 | 				}
 84 | 			}
 85 | 		}
 86 | 
 87 | 		return true;
 88 | 	}
 89 | 
 90 | 	/**
 91 | 	 * Get error messages from the checks.
 92 | 	 *
 93 | 	 * @return array Error message.
 94 | 	 */
 95 | 	public function getError() {
 96 | 		return $this->error;
 97 | 	}
 98 | }
 99 | 
100 | $themechecks[] = new I18N_Check();
101 | 


--------------------------------------------------------------------------------
/checks/class-screenshot-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check if the screenshot size is correct
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check if the screenshot size is correct.
 10 |  */
 11 | class Screenshot_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 21 | 	 *
 22 | 	 * @param array $php_files File paths and content for PHP files.
 23 | 	 * @param array $css_files File paths and content for CSS files.
 24 | 	 * @param array $other_files Folder names, file paths and content for other files.
 25 | 	 */
 26 | 	public function check( $php_files, $css_files, $other_files ) {
 27 | 
 28 | 		$ret       = true;
 29 | 		$filenames = array();
 30 | 
 31 | 		foreach ( $other_files as $other_key => $otherfile ) {
 32 | 			array_push( $filenames, strtolower( basename( $other_key ) ) );
 33 | 		}
 34 | 
 35 | 		checkcount();
 36 | 
 37 | 		if (
 38 | 			in_array( 'screenshot.png', $filenames ) ||
 39 | 			in_array( 'screenshot.jpg', $filenames )
 40 | 		) {
 41 | 
 42 | 			foreach ( $other_files as $other_key => $otherfile ) {
 43 | 
 44 | 				if (
 45 | 					(
 46 | 						basename( $other_key ) === 'screenshot.png' ||
 47 | 						basename( $other_key ) === 'screenshot.jpg'
 48 | 					) &&
 49 | 					preg_match( '/.*themes\/[^\/]*\/screenshot\.(png|jpg)/', $other_key )
 50 | 				) {
 51 | 					// we have our screenshot!
 52 | 					$image = getimagesize( $other_key );
 53 | 					if ( $image[0] > 1200 || $image[1] > 900 ) {
 54 | 						$this->error[] = sprintf(
 55 | 							'<span class="tc-lead tc-required">%s</span> %s',
 56 | 							__( 'REQUIRED', 'theme-check' ),
 57 | 							sprintf(
 58 | 								__( 'Screenshot is wrong size! Detected: %s. Maximum allowed size is 1200x900px.', 'theme-check' ),
 59 | 								'<strong>' . $image[0] . 'x' . $image[1] . '</strong>'
 60 | 							)
 61 | 						);
 62 | 						$ret           = false;
 63 | 					}
 64 | 					if ( $image[1] / $image[0] != 0.75 ) {
 65 | 						$this->error[] = sprintf(
 66 | 							'<span class="tc-lead tc-required">%s</span> %s',
 67 | 							__( 'REQUIRED', 'theme-check' ),
 68 | 							__( 'Screenshot dimensions are wrong! Ratio of width to height should be 4:3.', 'theme-check' )
 69 | 						);
 70 | 						$ret           = false;
 71 | 					}
 72 | 					if ( $image[0] != 1200 || $image[1] != 900 ) {
 73 | 						$this->error[] = sprintf(
 74 | 							'<span class="tc-lead tc-recommended">%s</span> %s',
 75 | 							__( 'RECOMMENDED', 'theme-check' ),
 76 | 							__( 'Screenshot size should be 1200x900, to account for HiDPI displays. Any 4:3 image size is acceptable, but 1200x900 is preferred.', 'theme-check' )
 77 | 						);
 78 | 					}
 79 | 				}
 80 | 			}
 81 | 		} else {
 82 | 			$this->error[] = sprintf(
 83 | 				'<span class="tc-lead tc-required">%s</span> %s',
 84 | 				__( 'REQUIRED', 'theme-check' ),
 85 | 				__( 'No screenshot detected! Please include a screenshot.png or screenshot.jpg.', 'theme-check' )
 86 | 			);
 87 | 			$ret           = false;
 88 | 		}
 89 | 		return $ret;
 90 | 	}
 91 | 
 92 | 	/**
 93 | 	 * Get error messages from the checks.
 94 | 	 *
 95 | 	 * @return array Error message.
 96 | 	 */
 97 | 	public function getError() {
 98 | 		return $this->error;
 99 | 	}
100 | }
101 | 
102 | $themechecks[] = new Screenshot_Check();
103 | 


--------------------------------------------------------------------------------
/checks/class-deprecated-param-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Checks for the use of deprecated function parameters.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Checks for the use of deprecated function parameters.
10 |  */
11 | class Deprecated_Param_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$checks = array(
29 | 			'get_bloginfo' => array(
30 | 				'home'                 => 'home_url()',
31 | 				'url'                  => 'home_url()',
32 | 				'wpurl'                => 'site_url()',
33 | 				'stylesheet_directory' => 'get_stylesheet_directory_uri()',
34 | 				'template_directory'   => 'get_template_directory_uri()',
35 | 				'template_url'         => 'get_template_directory_uri()',
36 | 				'text_direction'       => 'is_rtl()',
37 | 				'feed_url'             => "get_feed_link( 'feed' ), where feed is rss, rss2 or atom",
38 | 			),
39 | 			'bloginfo'     => array(
40 | 				'home'                 => 'echo esc_url( home_url() )',
41 | 				'url'                  => 'echo esc_url( home_url() )',
42 | 				'wpurl'                => 'echo esc_url( site_url() )',
43 | 				'stylesheet_directory' => 'echo esc_url( get_stylesheet_directory_uri() )',
44 | 				'template_directory'   => 'echo esc_url( get_template_directory_uri() )',
45 | 				'template_url'         => 'echo esc_url( get_template_directory_uri() )',
46 | 				'text_direction'       => 'is_rtl()',
47 | 				'feed_url'             => "echo esc_url( get_feed_link( 'feed' ) ), where feed is rss, rss2 or atom",
48 | 			),
49 | 			'get_option'   => array(
50 | 				'home'     => 'home_url()',
51 | 				'site_url' => 'site_url()',
52 | 			),
53 | 		);
54 | 
55 | 		foreach ( $php_files as $php_key => $php_file ) {
56 | 			// Loop through all functions.
57 | 			foreach ( $checks as $function => $data ) {
58 | 				checkcount();
59 | 
60 | 				// Loop through the parameters and look for all function/parameter combinations.
61 | 				foreach ( $data as $parameter => $replacement ) {
62 | 					if ( preg_match( '/' . $function . '\(\s*("|\')' . $parameter . '("|\')\s*\)/', $php_file, $matches ) ) {
63 | 						$filename      = tc_filename( $php_key );
64 | 						$error         = ltrim( rtrim( $matches[0], '(' ) );
65 | 						$grep          = tc_grep( $error, $php_key );
66 | 						$this->error[] = sprintf(
67 | 							'<span class="tc-lead tc-warning">%s</span>: %s %s',
68 | 							__( 'WARNING', 'theme-check' ),
69 | 							sprintf(
70 | 								__( '%1$s was found in the file %2$s. Use %3$s instead.', 'theme-check' ),
71 | 								'<strong>' . $error . '</strong>',
72 | 								'<strong>' . $filename . '</strong>',
73 | 								'<strong>' . $replacement . '</strong>'
74 | 							),
75 | 							$grep
76 | 						);
77 | 					}
78 | 				}
79 | 			}
80 | 		}
81 | 
82 | 		return true;
83 | 	}
84 | 
85 | 	/**
86 | 	 * Get error messages from the checks.
87 | 	 *
88 | 	 * @return array Error message.
89 | 	 */
90 | 	public function getError() {
91 | 		return $this->error;
92 | 	}
93 | }
94 | 
95 | $themechecks[] = new Deprecated_Param_Check();
96 | 


--------------------------------------------------------------------------------
/checks/class-line-endings-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check if more than one line ending style is used.
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check if more than one line ending style is used.
10 |  */
11 | class Line_Endings_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 		$ret = true;
28 | 		foreach ( $php_files as $php_key => $phpfile ) {
29 | 			if ( preg_match( "/\r\n/", $phpfile ) ) {
30 | 				if ( preg_match( "/[^\r]\n/", $phpfile ) ) {
31 | 					$filename      = tc_filename( $php_key );
32 | 					$this->error[] = sprintf(
33 | 						'<span class="tc-lead tc-required">%s</span>: %s',
34 | 						__( 'REQUIRED', 'theme-check' ),
35 | 						sprintf(
36 | 							__( 'Both DOS and UNIX style line endings were found in the file %s. This causes a problem with SVN repositories and must be corrected before the theme can be accepted. Please change the file to use only one style of line endings.', 'theme-check' ),
37 | 							'<strong>' . $filename . '</strong>'
38 | 						)
39 | 					);
40 | 					$ret           = false;
41 | 				}
42 | 			}
43 | 		}
44 | 		foreach ( $css_files as $css_key => $cssfile ) {
45 | 			if ( preg_match( "/\r\n/", $cssfile ) ) {
46 | 				if ( preg_match( "/[^\r]\n/", $cssfile ) ) {
47 | 					$filename      = tc_filename( $css_key );
48 | 					$this->error[] = sprintf(
49 | 						'<span class="tc-lead tc-required">%s</span>: %s',
50 | 						__( 'REQUIRED', 'theme-check' ),
51 | 						sprintf(
52 | 							__( 'Both DOS and UNIX style line endings were found in the file %1$s. This causes a problem with SVN repositories and must be corrected before the theme can be accepted. Please change the file to use only one style of line endings.', 'theme-check' ),
53 | 							'<strong>' . $filename . '</strong>'
54 | 						)
55 | 					);
56 | 					$ret           = false;
57 | 				}
58 | 			}
59 | 		}
60 | 		foreach ( $other_files as $oth_key => $othfile ) {
61 | 			$e = pathinfo( $oth_key );
62 | 			if ( isset( $e['extension'] ) && in_array( $e['extension'], array( 'txt', 'js' ) ) ) {
63 | 				if ( preg_match( "/\r\n/", $othfile ) ) {
64 | 					if ( preg_match( "/[^\r]\n/", $othfile ) ) {
65 | 						$filename      = tc_filename( $oth_key );
66 | 						$this->error[] = sprintf(
67 | 							'<span class="tc-lead tc-required">%s</span>: %s',
68 | 							__( 'REQUIRED', 'theme-check' ),
69 | 							sprintf(
70 | 								__( 'Both DOS and UNIX style line endings were found in the file %1$s. This causes a problem with SVN repositories and must be corrected before the theme can be accepted. Please change the file to use only one style of line endings.', 'theme-check' ),
71 | 								'<strong>' . $filename . '</strong>'
72 | 							)
73 | 						);
74 | 						$ret           = false;
75 | 					}
76 | 				}
77 | 			}
78 | 		}
79 | 		return $ret;
80 | 	}
81 | 
82 | 	/**
83 | 	 * Get error messages from the checks.
84 | 	 *
85 | 	 * @return array Error message.
86 | 	 */
87 | 	public function getError() {
88 | 		return $this->error;
89 | 	}
90 | }
91 | 
92 | $themechecks[] = new Line_Endings_Check();
93 | 


--------------------------------------------------------------------------------
/checks/class-widgets-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check if widgets are supported in classic themes
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check if widgets are supported in classic themes.
 10 |  */
 11 | class Widgets_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 21 | 	 *
 22 | 	 * @param array $php_files File paths and content for PHP files.
 23 | 	 * @param array $css_files File paths and content for CSS files.
 24 | 	 * @param array $other_files Folder names, file paths and content for other files.
 25 | 	 */
 26 | 	public function check( $php_files, $css_files, $other_files ) {
 27 | 
 28 | 		$ret = true;
 29 | 
 30 | 		// Combine all the php files into one string to make it easier to search.
 31 | 		$php = implode( ' ', $php_files );
 32 | 		checkcount();
 33 | 
 34 | 		// No widgets registered or used.
 35 | 		if (
 36 | 			strpos( $php, 'register_sidebar' ) === false &&
 37 | 			strpos( $php, 'dynamic_sidebar' ) === false
 38 | 		) {
 39 | 			$this->error[] = sprintf(
 40 | 				'<span class="tc-lead tc-recommended">%s</span> %s',
 41 | 				__( 'RECOMMENDED', 'theme-check' ),
 42 | 				__( "This theme contains no sidebars/widget areas. See <a href='https://codex.wordpress.org/Widgets_API'>Widgets API</a>", 'theme-check' )
 43 | 			);
 44 | 			$ret           = true;
 45 | 		}
 46 | 
 47 | 		// Widget area is registered but not used.
 48 | 		if (
 49 | 			strpos( $php, 'register_sidebar' ) !== false &&
 50 | 			strpos( $php, 'dynamic_sidebar' ) === false
 51 | 		) {
 52 | 			$this->error[] = sprintf(
 53 | 				'<span class="tc-lead tc-required">%s</span> %s',
 54 | 				__( 'REQUIRED', 'theme-check' ),
 55 | 				__( "The theme appears to use <strong>register_sidebar()</strong> but no <strong>dynamic_sidebar()</strong> was found. See: <a href='https://developer.wordpress.org/reference/functions/dynamic_sidebar/'>dynamic_sidebar</a><pre> &lt;?php dynamic_sidebar( \$index ); ?&gt;</pre>", 'theme-check' )
 56 | 			);
 57 | 			$ret           = false;
 58 | 		}
 59 | 
 60 | 		// Widget area is used but not registered.
 61 | 		if (
 62 | 			strpos( $php, 'register_sidebar' ) === false &&
 63 | 			strpos( $php, 'dynamic_sidebar' ) !== false
 64 | 		) {
 65 | 			$this->error[] = sprintf(
 66 | 				'<span class="tc-lead tc-required">%s</span> %s',
 67 | 				__( 'REQUIRED', 'theme-check' ),
 68 | 				__( "The theme appears to use <strong>dynamic_sidebars()</strong> but no <strong>register_sidebar()</strong> was found. See: <a href='https://developer.wordpress.org/reference/functions/register_sidebar/'>register_sidebar</a><pre> &lt;?php register_sidebar( \$args ); ?&gt;</pre>", 'theme-check' )
 69 | 			);
 70 | 			$ret           = false;
 71 | 		}
 72 | 
 73 | 		/**
 74 | 		 * There are widgets registered, is the widgets_init action present?
 75 | 		 */
 76 | 		if (
 77 | 			strpos( $php, 'register_sidebar' ) !== false &&
 78 | 			preg_match( '/add_action\s*\(\s*("|\')widgets_init("|\')\s*,/', $php ) == false
 79 | 		) {
 80 | 			$this->error[] = sprintf(
 81 | 				'<span class="tc-lead tc-required">%s</span> %s',
 82 | 				__( 'REQUIRED', 'theme-check' ),
 83 | 				sprintf(
 84 | 					__( 'Sidebars need to be registered in a custom function hooked to the <strong>widgets_init</strong> action. See: %s.', 'theme-check' ),
 85 | 					'<a href="https://developer.wordpress.org/reference/functions/register_sidebar/">register_sidebar()</a>'
 86 | 				)
 87 | 			);
 88 | 			$ret           = false;
 89 | 		}
 90 | 		return $ret;
 91 | 	}
 92 | 
 93 | 	/**
 94 | 	 * Get error messages from the checks.
 95 | 	 *
 96 | 	 * @return array Error message.
 97 | 	 */
 98 | 	public function getError() {
 99 | 		return $this->error;
100 | 	}
101 | }
102 | 
103 | $themechecks[] = new Widgets_Check();
104 | 


--------------------------------------------------------------------------------
/checks/class-underscores-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check if the theme is a copy of underscores.
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check if:
 10 |  * Theme or author URI refers to _s
 11 |  * The readme is a copy of _s
 12 |  * footer credit link refers to _s
 13 |  */
 14 | class Underscores_Check implements themecheck {
 15 | 	/**
 16 | 	 * Error messages, warnings and info notices.
 17 | 	 *
 18 | 	 * @var array $error
 19 | 	 */
 20 | 	protected $error = array();
 21 | 
 22 | 	/**
 23 | 	 * Theme information. Author URI, theme URI, Author name
 24 | 	 *
 25 | 	 * @var object $theme
 26 | 	 */
 27 | 	protected $theme;
 28 | 
 29 | 	function set_context( $data ) {
 30 | 		if ( isset( $data['theme'] ) ) {
 31 | 			$this->theme = $data['theme'];
 32 | 		}
 33 | 	}
 34 | 
 35 | 	/**
 36 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 37 | 	 *
 38 | 	 * @param array $php_files File paths and content for PHP files.
 39 | 	 * @param array $css_files File paths and content for CSS files.
 40 | 	 * @param array $other_files Folder names, file paths and content for other files.
 41 | 	 */
 42 | 	public function check( $php_files, $css_files, $other_files ) {
 43 | 		$ret = true;
 44 | 
 45 | 		checkcount();
 46 | 		if ( ! empty( $this->theme->get( 'AuthorURI' ) ) || ! empty( $this->theme->get( 'ThemeURI' ) ) ) {
 47 | 
 48 | 			if (
 49 | 				stripos( $this->theme->get( 'ThemeURI' ), 'underscores.me' ) ||
 50 | 				stripos( $this->theme->get( 'AuthorURI' ), 'underscores.me' )
 51 | 			) {
 52 | 				$ret           = false;
 53 | 				$this->error[] = sprintf(
 54 | 					'<span class="tc-lead tc-required">%s</span>: %s',
 55 | 					__( 'REQUIRED', 'theme-check' ),
 56 | 					__( 'Found a copy of Underscores. Using underscores.me as Theme URI or Author URI is not allowed. Update the files for your own theme.', 'theme-check' )
 57 | 				);
 58 | 			}
 59 | 		}
 60 | 
 61 | 		checkcount();
 62 | 		foreach ( $other_files as $file_path => $file_content ) {
 63 | 			if (
 64 | 				preg_match( "/Hi. I'm a starter theme called `_s`, or `underscores`, if you like./", $file_content ) ||
 65 | 				preg_match( "/Hi. I'm a starter theme called <code>_s<\/code>, or <em>underscores<\/em>, if/", $file_content )
 66 | 			) {
 67 | 				$ret           = false;
 68 | 				$grep          = tc_preg( "/Hi. I'm a starter theme called/", $file_path );
 69 | 				$this->error[] = sprintf(
 70 | 					'<span class="tc-lead tc-required">%s</span>: %s %s',
 71 | 					__( 'REQUIRED', 'theme-check' ),
 72 | 					sprintf(
 73 | 						__( 'Found a copy of Underscores. See %1$s. <a href="https://github.com/Automattic/_s" target="_new">Learn how to update the files for your own theme.</a>', 'theme-check' ),
 74 | 						'<strong>' . tc_filename( $file_path ) . '</strong>'
 75 | 					),
 76 | 					$grep
 77 | 				);
 78 | 			}
 79 | 		}
 80 | 
 81 | 		/**
 82 | 		 * This check is limited to footer.php, since we are looking for clones of underscores.
 83 | 		 */
 84 | 		checkcount();
 85 | 		foreach ( $php_files as $file_path => $file_content ) {
 86 | 			$filename = tc_filename( $file_path );
 87 | 			if ( 'footer.php' === $filename && preg_match( '/Underscores.me/i', $file_content ) ) {
 88 | 				$ret           = false;
 89 | 				$grep          = tc_preg( '/Underscores.me/i', $file_path );
 90 | 				$this->error[] = sprintf(
 91 | 					'<span class="tc-lead tc-required">%s</span>: %s %s',
 92 | 					__( 'REQUIRED', 'theme-check' ),
 93 | 					sprintf(
 94 | 						__( 'Found a copy of Underscores. See %1$s. Update the files for your own theme.', 'theme-check' ),
 95 | 						'<strong>' . $filename . '</strong>'
 96 | 					),
 97 | 					$grep
 98 | 				);
 99 | 			}
100 | 		}
101 | 
102 | 		return $ret;
103 | 	}
104 | 
105 | 	/**
106 | 	 * Get error messages from the checks.
107 | 	 *
108 | 	 * @return array Error message.
109 | 	 */
110 | 	public function getError() {
111 | 		return $this->error;
112 | 	}
113 | }
114 | 
115 | $themechecks[] = new Underscores_Check();
116 | 


--------------------------------------------------------------------------------
/checks/class-customizer-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Checks if Customizer settings have sanitization callbacks
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check whether every Customizer setting has a sanitization callback set.
 10 |  *
 11 |  * Check whether every Customizer setting has a sanitization callback set and that it is not empty.
 12 |  */
 13 | class Customizer_Check implements themecheck {
 14 | 	/**
 15 | 	 * Error messages, warnings and info notices.
 16 | 	 *
 17 | 	 * @var array $error
 18 | 	 */
 19 | 	protected $error = array();
 20 | 
 21 | 	/**
 22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 23 | 	 *
 24 | 	 * @param array $php_files File paths and content for PHP files.
 25 | 	 * @param array $css_files File paths and content for CSS files.
 26 | 	 * @param array $other_files Folder names, file paths and content for other files.
 27 | 	 */
 28 | 	public function check( $php_files, $css_files, $other_files ) {
 29 | 
 30 | 		$ret = true;
 31 | 
 32 | 		checkcount();
 33 | 
 34 | 		foreach ( $php_files as $file_path => $file_content ) {
 35 | 			// Get the arguments passed to the add_setting method.
 36 | 			if ( preg_match_all( '/\$wp_customize->add_setting\(([^;]+)/', $file_content, $matches ) ) {
 37 | 				// The full match is in [0], the match group in [1].
 38 | 				foreach ( $matches[1] as $match ) {
 39 | 					// Check if we have sanitize_callback or sanitize_js_callback.
 40 | 					if (
 41 | 						false === strpos( $match, 'sanitize_callback' ) &&
 42 | 						false === strpos( $match, 'sanitize_js_callback' )
 43 | 					) {
 44 | 						/*
 45 | 						 * Clean up our match to be able to present the results better.
 46 | 						 *
 47 | 						 * Note: The delimiter in the below regex using $match MUST be a special regex character per preg_quote().
 48 | 						 */
 49 | 						$ret           = false;
 50 | 						$match         = preg_split( '/,/', $match );
 51 | 						$grep          = tc_preg( '!' . preg_quote( $match[0], '!' ) . '!', $file_path );
 52 | 						$grep          = preg_split( '/,/', $grep );
 53 | 						$this->error[] = sprintf(
 54 | 							'<span class="tc-lead tc-required">%s</span>: %s %s',
 55 | 							__( 'REQUIRED', 'theme-check' ),
 56 | 							sprintf(
 57 | 								__( 'Found a Customizer setting called %1$s in %2$s that did not have a sanitization callback function. ', 'theme-check' ) . __( 'Every call to the <strong>add_setting()</strong> method needs to have a sanitization callback function passed.', 'theme-check' ),
 58 | 								'<strong>' . $match[0] . '</strong>',
 59 | 								'<strong>' . tc_filename( $file_path ) . '</strong>'
 60 | 							),
 61 | 							$grep[0]
 62 | 						);
 63 | 					} else {
 64 | 						// There's a callback, check that no empty parameter is passed.
 65 | 						if ( preg_match( '/[\'"](?:sanitize_callback|sanitize_js_callback)[\'"]\s*=>\s*[\'"]\s*[\'"]/', $match ) ) {
 66 | 							$ret           = false;
 67 | 							$match         = preg_split( '/,/', $match );
 68 | 							$grep          = tc_preg( '/[\'"](?:sanitize_callback|sanitize_js_callback)[\'"]\s*=>\s*[\'"]\s*[\'"]/', $file_path );
 69 | 							$grep          = preg_split( '/,/', $grep );
 70 | 							$this->error[] = sprintf(
 71 | 								'<span class="tc-lead tc-required">%s</span>: %s %s',
 72 | 								__( 'REQUIRED', 'theme-check' ),
 73 | 								sprintf(
 74 | 									__( 'Found a Customizer setting called %1$s in %2$s that had an empty value passed as sanitization callback. You need to pass a function name as sanitization callback.', 'theme-check' ),
 75 | 									'<strong>' . $match[0] . '</strong>',
 76 | 									'<strong>' . tc_filename( $file_path ) . '</strong>'
 77 | 								),
 78 | 								$grep[0]
 79 | 							);
 80 | 						}
 81 | 					}
 82 | 				}
 83 | 			}
 84 | 		}
 85 | 
 86 | 		return $ret;
 87 | 	}
 88 | 
 89 | 	/**
 90 | 	 * Get error messages from the checks.
 91 | 	 *
 92 | 	 * @return array Error message.
 93 | 	 */
 94 | 	public function getError() {
 95 | 		return $this->error;
 96 | 	}
 97 | }
 98 | 
 99 | $themechecks[] = new Customizer_Check();
100 | 


--------------------------------------------------------------------------------
/checks/class-admin-menu-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check for creation of admin menus
  4 |  *
  5 |  * Checks that user levels are not used when creating admin menus.
  6 |  * Checks that only add_theme_page, add_menu_page and add_submenu_page are used to create admin menus.
  7 |  *
  8 |  * @package Theme Check
  9 |  */
 10 | 
 11 | /**
 12 |  * Check for creation of admin menus.
 13 |  *
 14 |  * Checks that user levels are not used when creating admin menus.
 15 |  * Checks that only add_theme_page, add_menu_page and add_submenu_page are used to create admin menus.
 16 |  */
 17 | class Admin_Menu_Check implements themecheck {
 18 | 	/**
 19 | 	 * Error messages, warnings and info notices.
 20 | 	 *
 21 | 	 * @var array $error
 22 | 	 */
 23 | 	protected $error = array();
 24 | 
 25 | 	/**
 26 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 27 | 	 *
 28 | 	 * @param array $php_files File paths and content for PHP files.
 29 | 	 * @param array $css_files File paths and content for CSS files.
 30 | 	 * @param array $other_files Folder names, file paths and content for other files.
 31 | 	 */
 32 | 	public function check( $php_files, $css_files, $other_files ) {
 33 | 
 34 | 		$ret = true;
 35 | 
 36 | 		// Check for levels deprecated in 2.0 in creating menus.
 37 | 		$checks = array(
 38 | 			'/([^_](add_(admin|submenu|menu|dashboard|posts|media|links|pages|comments|theme|plugins|users|management|options)_page)\s?\([^,]*,[^,]*,\s[\'|"]?(level_[0-9]|[0-9])[^;|\r|\r\n]*)/' => __( 'User levels were deprecated in <strong>2.0</strong>. Please see <a href="https://wordpress.org/support/article/roles-and-capabilities/">Roles and Capabilities</a>', 'theme-check' ),
 39 | 			'/[^a-z0-9](current_user_can\s?\(\s?[\'\"]level_[0-9][\'\"]\s?\))[^\r|\r\n]*/' => __( 'User levels were deprecated in <strong>2.0</strong>. Please see <a href="https://wordpress.org/support/article/roles-and-capabilities/">Roles and Capabilities</a>', 'theme-check' ),
 40 | 		);
 41 | 
 42 | 		foreach ( $php_files as $php_key => $phpfile ) {
 43 | 			foreach ( $checks as $key => $check ) {
 44 | 				checkcount();
 45 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
 46 | 					$filename      = tc_filename( $php_key );
 47 | 					$grep          = tc_grep( isset( $matches[2] ) ? $matches[2] : $matches[1], $php_key );
 48 | 					$this->error[] = sprintf(
 49 | 						'<span class="tc-lead tc-warning">%s</span>: <strong>%s</strong>. %s %s',
 50 | 						__( 'WARNING', 'theme-check' ),
 51 | 						$filename,
 52 | 						$check,
 53 | 						$grep
 54 | 					);
 55 | 				}
 56 | 			}
 57 | 		}
 58 | 
 59 | 		// Check for add_admin_page's, except for add_theme_page.
 60 | 		// Note to TGMPA: Stop trying to bypass theme check.
 61 | 		$checks = array(
 62 | 			'/(?<!function)[^_>:](add_[a-z]+_page)/' => _x(
 63 | 				'Themes should not use <strong>%s()</strong>.',
 64 | 				'function name',
 65 | 				'theme-check'
 66 | 			),
 67 | 		);
 68 | 
 69 | 		foreach ( $php_files as $php_key => $phpfile ) {
 70 | 			foreach ( $checks as $key => $check ) {
 71 | 				checkcount();
 72 | 				if ( preg_match_all( $key, $phpfile, $matches ) ) {
 73 | 					foreach ( $matches[1] as $match ) {
 74 | 						if ( in_array( $match, array( 'add_theme_page', 'add_menu_page', 'add_submenu_page' ), true ) ) {
 75 | 							continue;
 76 | 						}
 77 | 						$filename   = tc_filename( $php_key );
 78 | 						$error      = ltrim( rtrim( $match, '(' ) );
 79 | 						$grep       = tc_grep( $error, $php_key );
 80 | 						$notallowed = sprintf( $check, $match );
 81 | 
 82 | 						$this->error[] = sprintf(
 83 | 							'<span class="tc-lead tc-recommended">%s</span>: <strong>%s</strong>. %s %s',
 84 | 							__( 'RECOMMENDED', 'theme-check' ),
 85 | 							$filename,
 86 | 							$notallowed,
 87 | 							$grep
 88 | 						);
 89 | 					}
 90 | 				}
 91 | 			}
 92 | 		}
 93 | 
 94 | 		return true;
 95 | 	}
 96 | 
 97 | 	/**
 98 | 	 * Get error messages from the checks.
 99 | 	 *
100 | 	 * @return array Error message.
101 | 	 */
102 | 	public function getError() {
103 | 		return $this->error;
104 | 	}
105 | }
106 | 
107 | $themechecks[] = new Admin_Menu_Check();
108 | 


--------------------------------------------------------------------------------
/checks/class-filesystem-http-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check for filesystem operations and HTTP requests.
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check for filesystem operations and HTTP requests.
 10 |  */
 11 | class Filesystem_HTTP_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 21 | 	 *
 22 | 	 * @param array $php_files File paths and content for PHP files.
 23 | 	 * @param array $css_files File paths and content for CSS files.
 24 | 	 * @param array $other_files Folder names, file paths and content for other files.
 25 | 	 */
 26 | 	public function check( $php_files, $css_files, $other_files ) {
 27 | 
 28 | 		$checks = array(
 29 | 			// Filesystem operations are not advised. file_get_contents() is allowed.
 30 | 			'/[^a-z0-9](?<!_)(readfile|fopen)\s?\(/i' => __( 'File read operations should use file_get_contents() but are discouraged unless required', 'theme-check' ),
 31 | 			'/[^a-z0-9](?<!_)(fopen|fclose|fread|fwrite|file_put_contents)\s?\(/i' => __( 'File write operations should are avoided unless necessary', 'theme-check' ),
 32 | 			// HTTP Requests should use WP_HTTP.
 33 | 			'/[^a-z0-9](?<!_)(curl_exec|curl_init|fsockopen|pfsockopen|stream_context_create)\s?\(/' => __( 'HTTP requests should be made using the WordPress HTTP wrappers, such as wp_safe_remote_get() and wp_safe_remote_post()', 'theme-check' ),
 34 | 		);
 35 | 
 36 | 		foreach ( $php_files as $php_key => $phpfile ) {
 37 | 			foreach ( $checks as $key => $check ) {
 38 | 				checkcount();
 39 | 
 40 | 				if ( preg_match_all( $key, $phpfile, $matches ) ) {
 41 | 					$filename = tc_filename( $php_key );
 42 | 
 43 | 					foreach ( $matches[1] as $match ) {
 44 | 						$error = ltrim( $match, '(' );
 45 | 						$error = rtrim( $error, '(' );
 46 | 
 47 | 						$grep          = tc_grep( $error, $php_key );
 48 | 						$this->error[] = sprintf(
 49 | 							'<span class="tc-lead tc-warning">%s</span>: %s %s',
 50 | 							__( 'WARNING', 'theme-check' ),
 51 | 							sprintf(
 52 | 								__( '%1$s was found in the file %2$s. %3$s.', 'theme-check' ),
 53 | 								'<strong>' . $error . '</strong>',
 54 | 								'<strong>' . $filename . '</strong>',
 55 | 								$check
 56 | 							),
 57 | 							$grep
 58 | 						);
 59 | 					}
 60 | 				}
 61 | 			}
 62 | 		}
 63 | 
 64 | 		foreach ( $php_files as $php_key => $phpfile ) {
 65 | 
 66 | 			$checks = array(
 67 | 				// WP_Filesystem should only be used for theme upgrade operations. It should not be used to avoid the fopen()/file_put_contents()/etc warnings.
 68 | 				'/[^a-z0-9](?<!_)(WP_Filesystem)\s?\(/i' => __( 'Theme Check is not able to determine if WP_Filesystem is used correctly. WP_Filesystem should only be used for theme upgrade operations, not for all file operations. Before continuing, you must manually review the code. Consider using file_get_contents(), scandir(), or glob(). It is not recommended to make changes to third-party frameworks that use WP_Filesystem, for example, TGMPA', 'theme-check' ),
 69 | 			);
 70 | 
 71 | 			foreach ( $checks as $key => $check ) {
 72 | 				checkcount();
 73 | 
 74 | 				if ( preg_match_all( $key, $phpfile, $matches ) ) {
 75 | 					$filename = tc_filename( $php_key );
 76 | 
 77 | 					foreach ( $matches[1] as $match ) {
 78 | 						$error = ltrim( $match, '(' );
 79 | 						$error = rtrim( $error, '(' );
 80 | 
 81 | 						$grep          = tc_grep( $error, $php_key );
 82 | 						$this->error[] = sprintf(
 83 | 							'<span class="tc-lead tc-info">%s</span>: %s <br><code>%s</code>',
 84 | 							__( 'INFO', 'theme-check' ),
 85 | 							sprintf(
 86 | 								__( '%1$s was found in the file %2$s. %3$s.', 'theme-check' ),
 87 | 								'<strong>' . $error . '</strong>',
 88 | 								'<strong>' . $filename . '</strong>',
 89 | 								$check
 90 | 							),
 91 | 							$grep
 92 | 						);
 93 | 					}
 94 | 				}
 95 | 			}
 96 | 		}
 97 | 
 98 | 		return true;
 99 | 
100 | 	}
101 | 
102 | 	/**
103 | 	 * Get error messages from the checks.
104 | 	 *
105 | 	 * @return array Error message.
106 | 	 */
107 | 	public function getError() {
108 | 		return $this->error;
109 | 	}
110 | }
111 | 
112 | $themechecks[] = new Filesystem_HTTP_Check();
113 | 


--------------------------------------------------------------------------------
/checks/class-basic-check.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Check for basic functions needed for classic themes to work correctly
 4 |  *
 5 |  * @package Theme Check
 6 |  */
 7 | 
 8 | /**
 9 |  * Check for basic functions needed for classic themes to work correctly.
10 |  */
11 | class Basic_Check implements themecheck {
12 | 	/**
13 | 	 * Error messages, warnings and info notices.
14 | 	 *
15 | 	 * @var array $error
16 | 	 */
17 | 	protected $error = array();
18 | 
19 | 	/**
20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
21 | 	 *
22 | 	 * @param array $php_files File paths and content for PHP files.
23 | 	 * @param array $css_files File paths and content for CSS files.
24 | 	 * @param array $other_files Folder names, file paths and content for other files.
25 | 	 */
26 | 	public function check( $php_files, $css_files, $other_files ) {
27 | 
28 | 		$php  = implode( ' ', $php_files );
29 | 		$grep = '';
30 | 		$ret  = true;
31 | 
32 | 		$checks = array(
33 | 			'DOCTYPE'             => __( 'See: <a href="https://codex.wordpress.org/HTML_to_XHTML">https://codex.wordpress.org/HTML_to_XHTML</a><pre>&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"<br />"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"?&gt;</pre>', 'theme-check' ),
34 | 			'(wp_body_open\s*\()|(do_action\s*\(\s*["\']wp_body_open)' => __( 'See: <a href="https://developer.wordpress.org/reference/functions/wp_body_open/">wp_body_open</a><pre> &lt;?php wp_body_open(); ?&gt;</pre>', 'theme-check' ),
35 | 			'wp_footer\s*\('      => __( 'See: <a href="https://developer.wordpress.org/reference/functions/wp_footer/">wp_footer</a><pre> &lt;?php wp_footer(); ?&gt;</pre>', 'theme-check' ),
36 | 			'wp_head\s*\('        => __( 'See: <a href="https://developer.wordpress.org/reference/functions/wp_head/">wp_head</a><pre> &lt;?php wp_head(); ?&gt;</pre>', 'theme-check' ),
37 | 			'language_attributes' => __( 'See: <a href="https://developer.wordpress.org/reference/functions/language_attributes/">language_attributes</a><pre>&lt;html &lt;?php language_attributes(); ?&gt;</pre>', 'theme-check' ),
38 | 			'charset'             => __( 'There must be a charset defined in the Content-Type or the meta charset tag in the head.', 'theme-check' ),
39 | 			'add_theme_support\s*\(\s?("|\')automatic-feed-links("|\')\s?\)' => __( 'See: <a href="https://developer.wordpress.org/reference/functions/add_theme_support/">add_theme_support</a><pre> &lt;?php add_theme_support( $feature ); ?&gt;</pre>', 'theme-check' ),
40 | 			'body_class\s*\('     => __( 'See: <a href="https://developer.wordpress.org/reference/functions/body_class/">body_class</a><pre> &lt;?php body_class( $class ); ?&gt;</pre>', 'theme-check' ),
41 | 			'wp_link_pages\s*\('  => __( 'See: <a href="https://developer.wordpress.org/reference/functions/wp_link_pages/">wp_link_pages</a><pre> &lt;?php wp_link_pages( $args ); ?&gt;</pre>', 'theme-check' ),
42 | 			'post_class\s*\('     => __( 'See: <a href="https://developer.wordpress.org/reference/functions/post_class/">post_class</a><pre> &lt;div id="post-&lt;?php the_ID(); ?&gt;" &lt;?php post_class(); ?&gt;&gt;</pre>', 'theme-check' ),
43 | 		);
44 | 
45 | 		foreach ( $checks as $key => $check ) {
46 | 			checkcount();
47 | 			if ( ! preg_match( '/' . $key . '/i', $php ) ) {
48 | 				if ( $key === 'add_theme_support\s*\(\s?("|\')automatic-feed-links("|\')\s?\)' ) {
49 | 					$key = __( 'add_theme_support( \'automatic-feed-links\' )', 'theme-check' );
50 | 				}
51 | 				if ( $key === 'body_class\s*\(' ) {
52 | 					$key = __( 'body_class call in body tag', 'theme-check' );
53 | 				}
54 | 				if ( $key === '(wp_body_open\s*\()|(do_action\s*\(\s*["\']wp_body_open)' ) {
55 | 					$key = __( 'wp_body_open action or function call at the very top of the body just after the opening body tag', 'theme-check' );
56 | 				}
57 | 				$key           = str_replace( '\s*\(', '', $key );
58 | 				$this->error[] = sprintf(
59 | 					'<span class="tc-lead tc-required">%s</span>: %s',
60 | 					__( 'REQUIRED', 'theme-check' ),
61 | 					sprintf(
62 | 						__( 'Could not find %1$s. %2$s', 'theme-check' ),
63 | 						'<strong>' . $key . '</strong>',
64 | 						$check
65 | 					)
66 | 				);
67 | 				$ret           = false;
68 | 			}
69 | 		}
70 | 
71 | 		return $ret;
72 | 	}
73 | 
74 | 	/**
75 | 	 * Get error messages from the checks.
76 | 	 *
77 | 	 * @return array Error message.
78 | 	 */
79 | 	public function getError() {
80 | 		return $this->error;
81 | 	}
82 | }
83 | 
84 | $themechecks[] = new Basic_Check();
85 | 


--------------------------------------------------------------------------------
/checks/class-bad-things-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check for code that is not allowed
  4 |  *
  5 |  * Checks for code that is not allowed, server settings, and affiliate links.
  6 |  *
  7 |  * @package Theme Check
  8 |  */
  9 | 
 10 | /**
 11 |  * Check for code that is not allowed.
 12 |  *
 13 |  * Checks for code that is not allowed, server settings, and affiliate links.
 14 |  */
 15 | class Bad_Things_Check implements themecheck {
 16 | 	/**
 17 | 	 * Error messages, warnings and info notices.
 18 | 	 *
 19 | 	 * @var array $error
 20 | 	 */
 21 | 	protected $error = array();
 22 | 
 23 | 	/**
 24 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 25 | 	 *
 26 | 	 * @param array $php_files File paths and content for PHP files.
 27 | 	 * @param array $css_files File paths and content for CSS files.
 28 | 	 * @param array $other_files Folder names, file paths and content for other files.
 29 | 	 */
 30 | 	public function check( $php_files, $css_files, $other_files ) {
 31 | 		$ret = true;
 32 | 
 33 | 		$checks = array(
 34 | 			'/(?<![_|a-z0-9|\.])eval\s?\(/i' => __( 'eval() is not allowed.', 'theme-check' ),
 35 | 			'/[^a-z0-9](?<!_)(popen|proc_open|[^_]exec|shell_exec|system|passthru)\(/' => __( 'PHP system calls are often disabled by server admins and should not be in themes', 'theme-check' ),
 36 | 			'/\s?ini_set\(/'                 => __( 'Themes should not change server PHP settings', 'theme-check' ),
 37 | 			'/base64_decode/'                => __( 'base64_decode() is not allowed', 'theme-check' ),
 38 | 			'/base64_encode/'                => __( 'base64_encode() is not allowed', 'theme-check' ),
 39 | 			'/uudecode/ims'                  => __( 'uudecode() is not allowed', 'theme-check' ),
 40 | 			'/str_rot13/ims'                 => __( 'str_rot13() is not allowed', 'theme-check' ),
 41 | 			'/cx=[0-9]{21}:[a-z0-9]{10}/'    => __( 'Google search code detected', 'theme-check' ),
 42 | 			'/pub-[0-9]{16}/i'               => __( 'Google advertising code detected', 'theme-check' ),
 43 | 			'/sharesale/i'                   => __( 'Sharesale affiliate link detected', 'theme-check' ),
 44 | 			'/affiliate_id/i'                => __( 'Potential affiliate link detected', 'theme-check' ),
 45 | 			'/(elementor_partner_id)|(wpbeaverbuilder.*?fla)/i' => __( 'Potential affiliate link detected', 'theme-check' ),
 46 | 		);
 47 | 
 48 | 		$grep = '';
 49 | 
 50 | 		foreach ( $php_files as $php_key => $phpfile ) {
 51 | 			foreach ( $checks as $key => $check ) {
 52 | 				checkcount();
 53 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
 54 | 					$filename      = tc_filename( $php_key );
 55 | 					$error         = ltrim( trim( $matches[0], '(' ) );
 56 | 					$grep          = tc_grep( $error, $php_key );
 57 | 					$this->error[] = sprintf(
 58 | 						'<span class="tc-lead tc-required">%s</span>: %s %s %s',
 59 | 						__( 'REQUIRED', 'theme-check' ),
 60 | 						sprintf(
 61 | 							__( 'Found %1$s in the file %2$s.', 'theme-check' ),
 62 | 							'<strong>' . $error . '</strong>',
 63 | 							'<strong>' . $filename . '</strong>'
 64 | 						),
 65 | 						$check,
 66 | 						$grep
 67 | 					);
 68 | 					$ret           = false;
 69 | 				}
 70 | 			}
 71 | 		}
 72 | 
 73 | 		$checks = array(
 74 | 			'/cx=[0-9]{21}:[a-z0-9]{10}/' => __( 'Google search code detected', 'theme-check' ),
 75 | 			'/pub-[0-9]{16}/i'            => __( 'Google advertising code detected', 'theme-check' ),
 76 | 		);
 77 | 
 78 | 		foreach ( $other_files as $php_key => $phpfile ) {
 79 | 			foreach ( $checks as $key => $check ) {
 80 | 				checkcount();
 81 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
 82 | 					$filename      = tc_filename( $php_key );
 83 | 					$error         = ltrim( rtrim( $matches[0], '(' ) );
 84 | 					$grep          = tc_grep( $error, $php_key );
 85 | 					$this->error[] = sprintf(
 86 | 						'<span class="tc-lead tc-required">%s</span>: %s %s %s',
 87 | 						__( 'REQUIRED', 'theme-check' ),
 88 | 						sprintf(
 89 | 							__( 'Found <strong>%1$s</strong> in the file <strong>%2$s</strong>.', 'theme-check' ),
 90 | 							$error,
 91 | 							$filename
 92 | 						),
 93 | 						$check,
 94 | 						$grep
 95 | 					);
 96 | 					$ret           = false;
 97 | 				}
 98 | 			}
 99 | 		}
100 | 
101 | 		return $ret;
102 | 	}
103 | 
104 | 	/**
105 | 	 * Get error messages from the checks.
106 | 	 *
107 | 	 * @return array Error message.
108 | 	 */
109 | 	public function getError() {
110 | 		return $this->error;
111 | 	}
112 | }
113 | 
114 | $themechecks[] = new Bad_Things_Check();
115 | 


--------------------------------------------------------------------------------
/checks/class-escaping-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Checks for common escaping issues.
  4 |  *
  5 |  * @link https://make.wordpress.org/themes/handbook/review/required/#code
  6 |  *
  7 |  * @package Theme Check
  8 |  */
  9 | 
 10 | /**
 11 |  * Checks for common escaping issues.
 12 |  */
 13 | class Escaping_Check implements themecheck {
 14 | 	/**
 15 | 	 * Error messages, warnings and info notices.
 16 | 	 *
 17 | 	 * @var array $error
 18 | 	 */
 19 | 	protected $error = array();
 20 | 
 21 | 	/**
 22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 23 | 	 *
 24 | 	 * @param array $php_files File paths and content for PHP files.
 25 | 	 * @param array $css_files File paths and content for CSS files.
 26 | 	 * @param array $other_files Folder names, file paths and content for other files.
 27 | 	 */
 28 | 	public function check( $php_files, $css_files, $other_files ) {
 29 | 
 30 | 		$ret = true;
 31 | 
 32 | 		$warnings = array(
 33 | 			'/="<\?php esc_html_e/'      => __( 'Use esc_attr_e() inside HTML attributes, and esc_url() for link attributes', 'theme-check' ),
 34 | 			'/="<\?php echo esc_html__/' => __( 'Use esc_attr__() inside HTML attributes, and esc_url() for link attributes', 'theme-check' ),
 35 | 			'/="<\?php esc_html\(/'      => __( 'Use esc_attr() inside HTML attributes, and esc_url() for link attributes', 'theme-check' ),
 36 | 			'/><\?php echo esc_attr\(/'  => __( 'Only use esc_attr() inside HTML attributes. Use esc_html() between HTML tags', 'theme-check' ),
 37 | 			'/><\?php echo esc_attr__/'  => __( 'Only use esc_attr__() inside HTML attributes. Use esc_html__() between HTML tags', 'theme-check' ),
 38 | 			'/><\?php esc_attr_e/'       => __( 'Only use esc_attr_e() inside HTML attributes. Use esc_html_e() between HTML tags', 'theme-check' ),
 39 | 		);
 40 | 
 41 | 		$required = array(
 42 | 			'/echo home_url/'                   => __( 'home_url() must be escaped. Use esc_url() for link attributes', 'theme-check' ),
 43 | 			'/echo get_template_directory_uri/' => __( 'get_template_directory_uri() must be escaped when output as part of a link or image source. Use esc_url() for link attributes', 'theme-check' ),
 44 | 		);
 45 | 
 46 | 		foreach ( $php_files as $php_key => $phpfile ) {
 47 | 
 48 | 			checkcount();
 49 | 			if ( false !== strpos( $phpfile, 'echo get_theme_mod' ) ) {
 50 | 				$filename      = tc_filename( $php_key );
 51 | 				$error         = 'echo get_theme_mod';
 52 | 				$grep          = tc_grep( $error, $php_key );
 53 | 				$this->error[] = sprintf(
 54 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
 55 | 					__( 'WARNING', 'theme-check' ),
 56 | 					sprintf(
 57 | 						__( 'Found %1$s in %2$s. <a href="%3$s" target="_blank">Theme options must be escaped (Opens in a new window).</a>. ', 'theme-check' ),
 58 | 						'<code>' . esc_html( $error ) . '</code>',
 59 | 						'<strong>' . $filename . '</strong>',
 60 | 						'https://developer.wordpress.org/themes/theme-security/data-sanitization-escaping/#escaping-securing-output'
 61 | 					),
 62 | 					$grep
 63 | 				);
 64 | 
 65 | 			}
 66 | 
 67 | 			foreach ( $warnings as $key => $check ) {
 68 | 				checkcount();
 69 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
 70 | 					$filename      = tc_filename( $php_key );
 71 | 					$error         = $matches[0];
 72 | 					$grep          = tc_grep( $error, $php_key );
 73 | 					$this->error[] = sprintf(
 74 | 						'<span class="tc-lead tc-warning">%s</span>: %s %s',
 75 | 						__( 'WARNING', 'theme-check' ),
 76 | 						sprintf(
 77 | 							__( 'Found %1$s in %2$s. %3$s. A manual review is needed.', 'theme-check' ),
 78 | 							'<code>' . esc_html( $error ) . '</code>',
 79 | 							'<strong>' . $filename . '</strong>',
 80 | 							$check
 81 | 						),
 82 | 						$grep
 83 | 					);
 84 | 				}
 85 | 			}
 86 | 
 87 | 			foreach ( $required as $key => $check ) {
 88 | 				checkcount();
 89 | 				if ( preg_match( $key, $phpfile, $matches ) ) {
 90 | 					$filename      = tc_filename( $php_key );
 91 | 					$error         = $matches[0];
 92 | 					$grep          = tc_grep( $error, $php_key );
 93 | 					$this->error[] = sprintf(
 94 | 						'<span class="tc-lead tc-required">%s</span>: %s %s',
 95 | 						__( 'REQUIRED', 'theme-check' ),
 96 | 						sprintf(
 97 | 							__( 'Found %1$s in %2$s. %3$s. A manual review is needed.', 'theme-check' ),
 98 | 							'<code>' . esc_html( $error ) . '</code>',
 99 | 							'<strong>' . $filename . '</strong>',
100 | 							$check
101 | 						),
102 | 						$grep
103 | 					);
104 | 
105 | 					$ret = false;
106 | 				}
107 | 			}
108 | 		}
109 | 		return $ret;
110 | 	}
111 | 
112 | 	/**
113 | 	 * Get error messages from the checks.
114 | 	 *
115 | 	 * @return array Error message.
116 | 	 */
117 | 	public function getError() {
118 | 		return $this->error;
119 | 	}
120 | }
121 | 
122 | $themechecks[] = new Escaping_Check();
123 | 


--------------------------------------------------------------------------------
/checks/class-file-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check for files that are not allowed and files that are required.
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check for files that are not allowed and files that are required.
 10 |  */
 11 | class File_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 21 | 	 *
 22 | 	 * @param array $php_files File paths and content for PHP files.
 23 | 	 * @param array $css_files File paths and content for CSS files.
 24 | 	 * @param array $other_files Folder names, file paths and content for other files.
 25 | 	 */
 26 | 	public function check( $php_files, $css_files, $other_files ) {
 27 | 
 28 | 		$ret = true;
 29 | 
 30 | 		$filenames = array();
 31 | 
 32 | 		foreach ( $php_files as $php_key => $phpfile ) {
 33 | 			array_push( $filenames, strtolower( basename( $php_key ) ) );
 34 | 		}
 35 | 		foreach ( $other_files as $php_key => $phpfile ) {
 36 | 			array_push( $filenames, strtolower( basename( $php_key ) ) );
 37 | 		}
 38 | 		foreach ( $css_files as $php_key => $phpfile ) {
 39 | 			array_push( $filenames, strtolower( basename( $php_key ) ) );
 40 | 		}
 41 | 
 42 | 		$allowlist = array(
 43 | 			'wpml-config.xml',
 44 | 			'loco.xml',
 45 | 			'phpcs.xml',
 46 | 		);
 47 | 
 48 | 		$blocklist = array(
 49 | 			'thumbs\.db'          => __( 'Windows thumbnail store', 'theme-check' ),
 50 | 			'desktop\.ini'        => __( 'windows system file', 'theme-check' ),
 51 | 			'project\.properties' => __( 'NetBeans Project File', 'theme-check' ),
 52 | 			'project\.xml'        => __( 'NetBeans Project File', 'theme-check' ),
 53 | 			'\.kpf'               => __( 'Komodo Project File', 'theme-check' ),
 54 | 			'^\.+[a-zA-Z0-9]'     => __( 'Hidden Files or Folders', 'theme-check' ),
 55 | 			'php\.ini'            => __( 'PHP server settings file', 'theme-check' ),
 56 | 			'dwsync\.xml'         => __( 'Dreamweaver project file', 'theme-check' ),
 57 | 			'error_log'           => __( 'PHP error log', 'theme-check' ),
 58 | 			'web\.config'         => __( 'Server settings file', 'theme-check' ),
 59 | 			'\.sql'               => __( 'SQL dump file', 'theme-check' ),
 60 | 			'__MACOSX'            => __( 'OSX system file', 'theme-check' ),
 61 | 			'\.lubith'            => __( 'Lubith theme generator file', 'theme-check' ),
 62 | 			'\.sh'                => __( 'Shell script file', 'theme-check' ),
 63 | 			'favicon\.ico'        => __( 'Favicon', 'theme-check' ),
 64 | 		);
 65 | 
 66 | 		$musthave = array( 'index.php', 'style.css', 'readme.txt' );
 67 | 
 68 | 		$fse_find = array_filter(
 69 | 			array_keys( $other_files ),
 70 | 			function( $file_name ) {
 71 | 				if ( false !== stripos( $file_name, 'templates/index.html' ) || false !== stripos( $file_name, 'block-templates/index.html' ) ) {
 72 | 					return true;
 73 | 				}
 74 | 
 75 | 				return false;
 76 | 			}
 77 | 		);
 78 | 
 79 | 		if ( ! empty( $fse_find ) ) {
 80 | 			$fse_not_needed = array_search( 'index.php', $musthave );
 81 | 			unset( $musthave[ $fse_not_needed ] );
 82 | 		}
 83 | 
 84 | 		checkcount();
 85 | 
 86 | 		foreach ( $blocklist as $file => $reason ) {
 87 | 			if ( $filename     = preg_grep( '/' . $file . '/', $filenames ) ) {
 88 | 				$commons = array_intersect( $filename, $allowlist );
 89 | 				foreach ( $commons as $common ) {
 90 | 					if ( ( $allowed_key = array_search( $common, $filename ) ) !== false ) {
 91 | 						unset( $filename[ $allowed_key ] );
 92 | 					}
 93 | 				}
 94 | 				if ( empty( $filename ) ) {
 95 | 					continue;
 96 | 				}
 97 | 				$error         = implode( ' ', array_unique( $filename ) );
 98 | 				$this->error[] = sprintf(
 99 | 					'<span class="tc-lead tc-required">%s</span>: %s',
100 | 					__( 'REQUIRED', 'theme-check' ),
101 | 					sprintf(
102 | 						__( '%1$s %2$s found. This file must not be in the production version of the theme.', 'theme-check' ),
103 | 						'<strong>' . $error . '</strong>',
104 | 						$reason
105 | 					)
106 | 				);
107 | 				$ret           = false;
108 | 			}
109 | 		}
110 | 
111 | 		foreach ( $musthave as $file ) {
112 | 			if ( ! in_array( $file, $filenames ) ) {
113 | 				$this->error[] = sprintf(
114 | 					'<span class="tc-lead tc-required">%s</span>: %s',
115 | 					__( 'REQUIRED', 'theme-check' ),
116 | 					sprintf(
117 | 						__( 'Could not find the file %s in the theme.', 'theme-check' ),
118 | 						'<strong>' . $file . '</strong>'
119 | 					)
120 | 				);
121 | 				$ret           = false;
122 | 			}
123 | 		}
124 | 
125 | 		return $ret;
126 | 	}
127 | 
128 | 	/**
129 | 	 * Get error messages from the checks.
130 | 	 *
131 | 	 * @return array Error message.
132 | 	 */
133 | 	public function getError() {
134 | 		return $this->error;
135 | 	}
136 | }
137 | 
138 | $themechecks[] = new File_Check();
139 | 


--------------------------------------------------------------------------------
/checks/class-nav-menu-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Checks if nav menus are supported and if theme location or menu names are used
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Checks if nav menus are supported and if theme location or menu names are used.
 10 |  */
 11 | class Nav_Menu_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 21 | 	 *
 22 | 	 * @param array $php_files File paths and content for PHP files.
 23 | 	 * @param array $css_files File paths and content for CSS files.
 24 | 	 * @param array $other_files Folder names, file paths and content for other files.
 25 | 	 */
 26 | 	public function check( $php_files, $css_files, $other_files ) {
 27 | 
 28 | 		$ret        = true;
 29 | 		$name_check = false;
 30 | 
 31 | 		$php = implode( ' ', $php_files );
 32 | 
 33 | 		checkcount();
 34 | 		if ( strpos( $php, 'nav_menu' ) === false ) {
 35 | 			$this->error[] = sprintf(
 36 | 				'<span class="tc-lead tc-recommended">%s</span>: %s',
 37 | 				__( 'RECOMMENDED', 'theme-check' ),
 38 | 				__( "No reference to nav_menu's was found in the theme. Note that if your theme has a menu bar, it is required to use the WordPress nav_menu functionality for it.", 'theme-check' )
 39 | 			);
 40 | 		}
 41 | 
 42 | 		// Look for add_theme_support( 'menus' ).
 43 | 		checkcount();
 44 | 		if ( preg_match( '/add_theme_support\s*\(\s?("|\')menus("|\')\s?\)/', $php ) ) {
 45 | 			/* translators: 1: function found, 2: function to be used */
 46 | 			$this->error[] = sprintf(
 47 | 				'<span class="tc-lead tc-required">%s</span>: %s',
 48 | 				__( 'REQUIRED', 'theme-check' ),
 49 | 				sprintf(
 50 | 					__( 'Reference to %1$s was found in the theme. This should be removed and %2$s used instead.', 'theme-check' ),
 51 | 					'<strong>add_theme_support( "menus" )</strong>',
 52 | 					'<a href="https://developer.wordpress.org/reference/functions/register_nav_menus/">register_nav_menus()</a>'
 53 | 				)
 54 | 			);
 55 | 			$ret           = false;
 56 | 		}
 57 | 
 58 | 		foreach ( $php_files as $file_path => $file_content ) {
 59 | 			$filename = tc_filename( $file_path );
 60 | 
 61 | 			// We are checking for wp_nav_menu( specifically, to allow wp_nav_menu  and wp_nav_menu_item in filters etc.
 62 | 			if ( strpos( $file_content, 'wp_nav_menu(' ) !== false ) {
 63 | 				$menu_part = explode( 'wp_nav_menu(', $file_content );
 64 | 				$menu_part = explode( ';', $menu_part[1] );
 65 | 
 66 | 				// If there is a menu, check for a theme location, which is required.
 67 | 				// Check if the arguments are placed outside wp_nav_menu.
 68 | 				checkcount();
 69 | 				if ( strpos( $menu_part[0], '$' ) !== false && strpos( $menu_part[0], 'theme_location' ) === false ) {
 70 | 					$menu_args     = explode( '$', $menu_part[0], 1 );
 71 | 					$name          = explode( ')', $menu_args[0] );
 72 | 					$this->error[] = sprintf(
 73 | 						'<span class="tc-lead tc-warning">%s</span>: %s',
 74 | 						__( 'WARNING', 'theme-check' ),
 75 | 						sprintf(
 76 | 							__( 'A menu without a theme_location was found in %1$s. %2$s is used inside wp_nav_menu(). You must manually check if the theme_location is included.', 'theme-check' ),
 77 | 							'<strong>' . $filename . '</strong>',
 78 | 							'<code>' . $name[0] . '</code>'
 79 | 						)
 80 | 					);
 81 | 					$name_check    = true;
 82 | 				} else {
 83 | 					checkcount();
 84 | 					if ( strpos( $menu_part[0], 'theme_location' ) === false ) {
 85 | 						$this->error[] = sprintf(
 86 | 							'<span class="tc-lead tc-required">%s</span>: %s',
 87 | 							__( 'REQUIRED', 'theme-check' ),
 88 | 							sprintf(
 89 | 								__( 'A menu without a theme_location was found in %1$s.', 'theme-check' ),
 90 | 								'<strong>' . $filename . '</strong>'
 91 | 							)
 92 | 						);
 93 | 						$ret           = false;
 94 | 						$name_check    = true;
 95 | 					}
 96 | 				}
 97 | 
 98 | 				// We only need to warn for the menu name if theme location is not set.
 99 | 				checkcount();
100 | 				if ( $name_check === true && preg_match( '/("|\')menu("|\').*?=>/', $menu_part[0] ) ) {
101 | 					$this->error[] = sprintf(
102 | 						'<span class="tc-lead tc-required">%s</span>: %s',
103 | 						__( 'REQUIRED', 'theme-check' ),
104 | 						sprintf(
105 | 							__( 'A menu name is being used for a menu in %1$s. By using menu name, the menu would be required to have the exact same name in the WordPress admin area. Use a theme_location instead.', 'theme-check' ),
106 | 							'<strong>' . $filename . '</strong>'
107 | 						)
108 | 					);
109 | 					$ret           = false;
110 | 				}
111 | 			}
112 | 		}
113 | 
114 | 		return $ret;
115 | 	}
116 | 
117 | 	/**
118 | 	 * Get error messages from the checks.
119 | 	 *
120 | 	 * @return array Error message.
121 | 	 */
122 | 	public function getError() {
123 | 		return $this->error;
124 | 	}
125 | }
126 | 
127 | $themechecks[] = new Nav_Menu_Check();
128 | 


--------------------------------------------------------------------------------
/checks/class-plugin-territory-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Checks for Plugin Territory Guidelines.
  4 |  *
  5 |  * @link https://make.wordpress.org/themes/handbook/review/required/#presentation-vs-functionality
  6 |  *
  7 |  * @package Theme Check
  8 |  */
  9 | 
 10 | /**
 11 |  * Checks for Plugin Territory
 12 |  */
 13 | class Plugin_Territory_Check implements themecheck {
 14 | 	/**
 15 | 	 * Error messages, warnings and info notices.
 16 | 	 *
 17 | 	 * @var array $error
 18 | 	 */
 19 | 	protected $error = array();
 20 | 
 21 | 	/**
 22 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 23 | 	 *
 24 | 	 * @param array $php_files File paths and content for PHP files.
 25 | 	 * @param array $css_files File paths and content for CSS files.
 26 | 	 * @param array $other_files Folder names, file paths and content for other files.
 27 | 	 */
 28 | 	public function check( $php_files, $css_files, $other_files ) {
 29 | 		$ret = true;
 30 | 
 31 | 		// Functions that are required to be removed from the theme.
 32 | 		$forbidden_functions = array(
 33 | 			'register_post_type',
 34 | 			'register_taxonomy',
 35 | 			'register_block_type',
 36 | 			'add_role',
 37 | 			'add_shortcode',
 38 | 			'registerBlockType',
 39 | 		);
 40 | 
 41 | 		// Hooks (actions & filters) that are required to be removed from the theme.
 42 | 		$forbidden_hooks = array(
 43 | 			'filter' => array(
 44 | 				'mime_types',
 45 | 				'upload_mimes',
 46 | 				'user_contactmethods',
 47 | 			),
 48 | 		);
 49 | 
 50 | 		/**
 51 | 		 * Check for removal of non presentational hooks.
 52 | 		 */
 53 | 		$blocklist = array(
 54 | 			'wp_head'           => array(
 55 | 				'wp_generator', // @link https://developer.wordpress.org/reference/functions/wp_generator/
 56 | 				'feed_links', // @link https://developer.wordpress.org/reference/functions/feed_links/
 57 | 				'feed_links_extra', // @link https://developer.wordpress.org/reference/functions/feed_links_extra/
 58 | 				'wp_resource_hints', // @link https://developer.wordpress.org/reference/functions/wp_resource_hints/
 59 | 				'adjacent_posts_rel_link_wp_head', // @link https://developer.wordpress.org/reference/functions/adjacent_posts_rel_link_wp_head/
 60 | 				'wp_shortlink_wp_head', // @link https://developer.wordpress.org/reference/functions/wp_shortlink_wp_head/
 61 | 				'_admin_bar_bump_cb', // @link https://developer.wordpress.org/reference/functions/_admin_bar_bump_cb/
 62 | 				'rsd_link', // @link https://developer.wordpress.org/reference/functions/rsd_link/
 63 | 				'rest_output_link_wp_head', // @link https://developer.wordpress.org/reference/functions/rest_output_link_wp_head/
 64 | 				'wp_oembed_add_discovery_links', // @link https://developer.wordpress.org/reference/functions/wp_oembed_add_discovery_links/
 65 | 				'wp_oembed_add_host_js', // @link https://developer.wordpress.org/reference/functions/wp_oembed_add_host_js/
 66 | 				'rel_canonical', // @link https://developer.wordpress.org/reference/functions/rel_canonical/
 67 | 			),
 68 | 			'template_redirect' => array(
 69 | 				'rest_output_link_header', // @link https://developer.wordpress.org/reference/functions/rest_output_link_header/
 70 | 				'wp_shortlink_header', // @link https://developer.wordpress.org/reference/functions/wp_shortlink_header/
 71 | 				'redirect_canonical',  // @link https://developer.wordpress.org/reference/functions/redirect_canonical/
 72 | 			),
 73 | 		);
 74 | 
 75 | 		foreach ( $php_files as $php_key => $phpfile ) {
 76 | 
 77 | 			foreach ( $forbidden_functions as $function ) {
 78 | 				checkcount();
 79 | 				if ( preg_match( '/[\s?]' . $function . '\s?\(/', $phpfile ) ) {
 80 | 					$filename      = tc_filename( $php_key );
 81 | 					$grep          = tc_grep( $function, $php_key );
 82 | 					$this->error[] = sprintf(
 83 | 						'<span class="tc-lead tc-required">%s</span>: %s',
 84 | 						__( 'REQUIRED', 'theme-check' ),
 85 | 						sprintf(
 86 | 							__( 'The theme uses the %1$s function in the file %2$s. %1$s is plugin-territory functionality and must not be used in themes. Use a plugin instead. %3$s', 'theme-check' ),
 87 | 							'<strong>' . esc_html( $function ) . '()</strong>',
 88 | 							esc_html( $filename ),
 89 | 							$grep
 90 | 						)
 91 | 					);
 92 | 					$ret           = false;
 93 | 				}
 94 | 			}
 95 | 
 96 | 			foreach ( $forbidden_hooks as $type => $hooks ) {
 97 | 				foreach ( $hooks as $hook ) {
 98 | 					checkcount();
 99 | 					if ( preg_match( '/[\s?]add_' . $type . '\s*\(\s*([\'"])' . $hook . '([\'"])\s*,/', $phpfile ) ) {
100 | 						$filename      = tc_filename( $php_key );
101 | 						$grep          = tc_grep( $hook, $php_key );
102 | 						$this->error[] = sprintf(
103 | 							'<span class="tc-lead tc-required">%s</span>: %s',
104 | 							__( 'REQUIRED', 'theme-check' ),
105 | 							sprintf(
106 | 								__( 'The theme uses the %1$s %2$s in the file %3$s. This is plugin-territory functionality and must not be used in themes. Use a plugin instead. %4$s', 'theme-check' ),
107 | 								'<strong>' . esc_html( $hook ) . '</strong>',
108 | 								esc_html( $type ),
109 | 								$filename,
110 | 								$grep
111 | 							)
112 | 						);
113 | 						$ret           = false;
114 | 					}
115 | 				}
116 | 			}
117 | 
118 | 			foreach ( $blocklist as $hook => $functions ) {
119 | 				foreach ( $functions as $function ) {
120 | 					checkcount();
121 | 					if ( preg_match( '/[\s?]remove_action\s*\(\s*([\'"])' . $hook . '([\'"])\s*,\s*([\'"])' . $function . '([\'"])/', $phpfile ) ) {
122 | 						$filename      = tc_filename( $php_key );
123 | 						$grep          = tc_preg( '/' . $hook . '([\'"])\s*,\s*([\'"])' . $function . '([\'"])/', $php_key );
124 | 						$this->error[] = sprintf(
125 | 							'<span class="tc-lead tc-required">%s</span>: %s',
126 | 							__( 'REQUIRED', 'theme-check' ),
127 | 							sprintf(
128 | 								__( 'The theme uses <strong>remove_action %1$s %2$s</strong> in the file %3$s. This is plugin-territory functionality and must not be used in themes. Use a plugin instead. %4$s', 'theme-check' ),
129 | 								esc_html( $hook ),
130 | 								esc_html( $function ),
131 | 								$filename,
132 | 								$grep
133 | 							)
134 | 						);
135 | 						$ret           = false;
136 | 					}
137 | 				}
138 | 			}
139 | 		}
140 | 
141 | 		return $ret;
142 | 	}
143 | 
144 | 	/**
145 | 	 * Get error messages from the checks.
146 | 	 *
147 | 	 * @return array Error message.
148 | 	 */
149 | 	public function getError() {
150 | 		return $this->error;
151 | 	}
152 | }
153 | 
154 | $themechecks[] = new Plugin_Territory_Check();
155 | 


--------------------------------------------------------------------------------
/checks/class-style-tags-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Checks if the tags in style.css are valid
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Checks if the tags in style.css are valid.
 10 |  */
 11 | class Style_Tags_Check implements themecheck {
 12 | 
 13 | 	/**
 14 | 	 * Error messages, warnings and info notices.
 15 | 	 *
 16 | 	 * @var array $error
 17 | 	 */
 18 | 	protected $error = array();
 19 | 
 20 | 	/**
 21 | 	 * Array of theme tags in style.css
 22 | 	 *
 23 | 	 * @var array $tags
 24 | 	 */
 25 | 	protected $tags = array();
 26 | 
 27 | 	/**
 28 | 	 * The WP_Theme instance being checked.
 29 | 	 *
 30 | 	 * @var WP_Theme $wp_theme
 31 | 	 */
 32 | 	protected $wp_theme = false;
 33 | 
 34 | 	function set_context( $data ) {
 35 | 		if ( isset( $data['theme'] ) ) {
 36 | 			$this->tags     = $data['theme']['Tags'];
 37 | 			$this->wp_theme = $data['theme'];
 38 | 		}
 39 | 	}
 40 | 
 41 | 	/**
 42 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 43 | 	 *
 44 | 	 * @param array $php_files File paths and content for PHP files.
 45 | 	 * @param array $css_files File paths and content for CSS files.
 46 | 	 * @param array $other_files Folder names, file paths and content for other files.
 47 | 	 */
 48 | 	public function check( $php_files, $css_files, $other_files ) {
 49 | 		checkcount();
 50 | 
 51 | 		if ( ! $this->tags ) {
 52 | 			$this->error[] = sprintf(
 53 | 				'<span class="tc-lead tc-info">%s</span> %s',
 54 | 				__( 'INFO', 'theme-check' ),
 55 | 				__( '<strong>Tags:</strong> is either empty or missing in style.css header.', 'theme-check' )
 56 | 			);
 57 | 		} else {
 58 | 			$deprecated_tags    = $this->get_deprecated_tags();
 59 | 			$allowed_tags       = $this->get_allowed_tags();
 60 | 			$subject_tags       = $this->get_subject_tags();
 61 | 			$subject_tags_count = 0;
 62 | 			$subject_tags_name  = '';
 63 | 
 64 | 			foreach ( $this->tags as $tag ) {
 65 | 
 66 | 				if ( strpos( strtolower( $tag ), 'accessibility-ready' ) !== false ) {
 67 | 					$this->error[] = sprintf(
 68 | 						'<span class="tc-lead tc-info">%s</span> %s',
 69 | 						__( 'INFO', 'theme-check' ),
 70 | 						__( 'Themes that use the tag accessibility-ready will need to undergo an accessibility review.', 'theme-check' ) . ' ' . __( 'See <a href="https://make.wordpress.org/themes/handbook/review/accessibility/">https://make.wordpress.org/themes/handbook/review/accessibility/</a>', 'theme-check' )
 71 | 					);
 72 | 				}
 73 | 
 74 | 				if ( ! in_array( strtolower( $tag ), $allowed_tags ) ) {
 75 | 					if ( in_array( strtolower( $tag ), $deprecated_tags ) ) {
 76 | 						$this->error[] = sprintf(
 77 | 							'<span class="tc-lead tc-info">%s</span> %s',
 78 | 							__( 'INFO', 'theme-check' ),
 79 | 							sprintf(
 80 | 								__( 'The tag %s has been deprecated, please remove it from your style.css header.', 'theme-check' ),
 81 | 								'<strong>' . $tag . '</strong>'
 82 | 							)
 83 | 						);
 84 | 					} else {
 85 | 						$this->error[] = sprintf(
 86 | 							'<span class="tc-lead tc-info">%s</span> %s',
 87 | 							__( 'INFO', 'theme-check' ),
 88 | 							sprintf(
 89 | 								__( 'Found wrong tag, remove %s from your style.css header.', 'theme-check' ),
 90 | 								'<strong>' . $tag . '</strong>'
 91 | 							)
 92 | 						);
 93 | 					}
 94 | 				}
 95 | 
 96 | 				if ( in_array( strtolower( $tag ), $subject_tags ) ) {
 97 | 					$subject_tags_name .= strtolower( $tag ) . ', ';
 98 | 					$subject_tags_count++;
 99 | 				}
100 | 
101 | 				if ( $tag === 'full-site-editing' && $this->wp_theme ) {
102 | 					$theme_dir = $this->wp_theme->get_stylesheet_directory();
103 | 
104 | 					// Check if the theme has all the required files.
105 | 					if (
106 | 						! isset( $other_files[ "{$theme_dir}/theme.json" ] ) ||
107 | 						(
108 | 							! isset( $other_files[ "{$theme_dir}/templates/index.html" ] ) &&
109 | 							! isset( $other_files[ "{$theme_dir}/block-templates/index.html" ] )
110 | 						)
111 | 					) {
112 | 						$this->error[] = sprintf(
113 | 							'<span class="tc-lead tc-required">%s</span> %s',
114 | 							__( 'REQUIRED', 'theme-check' ),
115 | 							sprintf(
116 | 								__( 'The tag %s is being used, please remove it from your style.css header. It is only allowed for Block Themes.', 'theme-check' ),
117 | 								'<strong>' . $tag . '</strong>'
118 | 							)
119 | 						);
120 | 					}
121 | 				}
122 | 
123 | 				if ( in_array( strtolower( $tag ), $allowed_tags ) ) {
124 | 					if ( count( array_keys( $this->tags, $tag ) ) > 1 ) {
125 | 						$this->error[] = sprintf(
126 | 							'<span class="tc-lead tc-info">%s</span> %s',
127 | 							__( 'INFO', 'theme-check' ),
128 | 							sprintf(
129 | 								__( 'The tag %s is being used more than once, please remove it from your style.css header.', 'theme-check' ),
130 | 								'<strong>' . $tag . '</strong>'
131 | 							)
132 | 						);
133 | 					}
134 | 				}
135 | 			}
136 | 
137 | 			if ( $subject_tags_count > 3 ) {
138 | 				$this->error[] = sprintf(
139 | 					'<span class="tc-lead tc-info">%s</span>: %s %s',
140 | 					__( 'INFO', 'theme-check' ),
141 | 					sprintf(
142 | 						__( 'A maximum of 3 subject tags are allowed. The theme has %1$u subjects tags ( %2$s ). Please remove the subject tags, which do not directly apply to the theme.', 'theme-check' ),
143 | 						$subject_tags_count,
144 | 						'<strong>' . rtrim( $subject_tags_name, ', ' ) . '</strong>'
145 | 					),
146 | 					sprintf(
147 | 						'<a href="%s">%s</a>',
148 | 						'https://make.wordpress.org/themes/handbook/review/required/theme-tags/',
149 | 						__( 'See Theme Tags', 'theme-check' )
150 | 					)
151 | 				);
152 | 			}
153 | 		}
154 | 
155 | 		return true;
156 | 	}
157 | 
158 | 	/**
159 | 	 * Get error messages from the checks.
160 | 	 *
161 | 	 * @return array Error message.
162 | 	 */
163 | 	public function getError() {
164 | 		return $this->error;
165 | 	}
166 | 
167 | 	/**
168 | 	 * Get full list of allowed tags - including subject tags.
169 | 	 *
170 | 	 * @return array
171 | 	 */
172 | 	private function get_allowed_tags() {
173 | 		$allowed_tags = array(
174 | 			'grid-layout',
175 | 			'one-column',
176 | 			'two-columns',
177 | 			'three-columns',
178 | 			'four-columns',
179 | 			'left-sidebar',
180 | 			'right-sidebar',
181 | 			'wide-blocks',
182 | 			'flexible-header',
183 | 			'footer-widgets',
184 | 			'accessibility-ready',
185 | 			'block-patterns',
186 | 			'block-styles',
187 | 			'buddypress',
188 | 			'custom-background',
189 | 			'custom-colors',
190 | 			'custom-header',
191 | 			'custom-logo',
192 | 			'custom-menu',
193 | 			'editor-style',
194 | 			'featured-image-header',
195 | 			'featured-images',
196 | 			'front-page-post-form',
197 | 			'full-width-template',
198 | 			'full-site-editing',
199 | 			'microformats',
200 | 			'post-formats',
201 | 			'rtl-language-support',
202 | 			'sticky-post',
203 | 			'style-variations',
204 | 			'template-editing',
205 | 			'theme-options',
206 | 			'threaded-comments',
207 | 			'translation-ready',
208 | 		);
209 | 		return array_merge( $allowed_tags, self::get_subject_tags() );
210 | 	}
211 | 
212 | 	/**
213 | 	 * Get the list of subject tags.
214 | 	 *
215 | 	 * @return array
216 | 	 */
217 | 	private function get_subject_tags() {
218 | 		return array(
219 | 			'blog',
220 | 			'e-commerce',
221 | 			'education',
222 | 			'entertainment',
223 | 			'food-and-drink',
224 | 			'holiday',
225 | 			'news',
226 | 			'photography',
227 | 			'portfolio',
228 | 		);
229 | 	}
230 | 
231 | 	/**
232 | 	 * Get the list of deprecated tags.
233 | 	 *
234 | 	 * @return array
235 | 	 */
236 | 	private function get_deprecated_tags() {
237 | 		return array(
238 | 			'flexible-width',
239 | 			'fixed-width',
240 | 			'black',
241 | 			'blue',
242 | 			'brown',
243 | 			'gray',
244 | 			'green',
245 | 			'orange',
246 | 			'pink',
247 | 			'purple',
248 | 			'red',
249 | 			'silver',
250 | 			'tan',
251 | 			'white',
252 | 			'yellow',
253 | 			'dark',
254 | 			'light',
255 | 			'fixed-layout',
256 | 			'fluid-layout',
257 | 			'responsive-layout',
258 | 			'blavatar',
259 | 			'holiday',
260 | 			'photoblogging',
261 | 			'seasonal',
262 | 		);
263 | 	}
264 | }
265 | $themechecks[] = new Style_Tags_Check();
266 | 


--------------------------------------------------------------------------------
/theme-check-cli.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Run Envato Theme Check from the command line
  4 |  */
  5 | include 'checkbase.php';
  6 | include 'main.php';
  7 | 
  8 | class ThemeCheckCLI extends WP_CLI_Command {
  9 |     function __construct()
 10 |     {
 11 |         parent::__construct();
 12 |         $this->fetcher = new \WP_CLI\Fetchers\Theme;
 13 |     }
 14 |     /**
 15 |     * Show a list of the current themes
 16 |     *
 17 |     * ## OPTIONS
 18 |     *
 19 |     * [--errors=<errors>]
 20 |     * : set true to return only themes with errors, false for only without errors. Default: false
 21 |     *
 22 |     * [--allowed=<allowed>]
 23 |     * : (Multisite) set true to return only themes allowed on this site, false for only those not allowed,
 24 |     * 'site' for only site-allowed, 'network' for only network-allowed.
 25 |     *
 26 |     * [--blog_id=<id>]
 27 |     * : (Multisite) Blog ID, if different than current
 28 |     *
 29 |     * @subcommand list
 30 |     */
 31 |     public function list_themes( $args = array(), $assoc_args = array() )
 32 |     {
 33 |         $defaults       = array( 'errors' => false, 'allowed' => null, 'blog_id' => 0 );
 34 |         $args           = wp_parse_args( $assoc_args, $defaults );
 35 |         $args['errors'] = 'true' === $args['errors'];
 36 | 
 37 |         if ( ( 'true' == $args['allowed'] ) || ( 'false' == $args['allowed'] ) )
 38 |             $args['allowed'] = 'true' === $args['allowed'];
 39 | 
 40 |         $themes = wp_get_themes( $args );
 41 | 
 42 |         foreach ( $themes as $slug => $theme )
 43 |         {
 44 |             WP_CLI::line( $slug . ': ' . $theme->get('Name') );
 45 |         }
 46 |     }
 47 |     /**
 48 |     * Check a theme
 49 |     *
 50 |     * <theme>
 51 |     * : The theme slug to check
 52 |     *
 53 |     * [--format=<format>]
 54 |     * : set to true to format as json. Default: false
 55 |     *
 56 |     */
 57 |     public function check( $args = array(), $assoc_args = array() )
 58 |     {
 59 |         global $themechecks;
 60 | 
 61 |         checkcount();
 62 | 
 63 |         // prevent undefined index errors
 64 |         if (!array_key_exists('format', $assoc_args)) {
 65 |             $assoc_args['format'] = '';
 66 |         }
 67 | 
 68 |         // empty array for the json format
 69 |         $required_json    = array();
 70 |         $warnings_json    = array();
 71 |         $recommended_json = array();
 72 |         $errors_json      = array();
 73 |         $result_json      = array();
 74 | 
 75 |         $theme = $this->fetcher->get_check( $args[0] );
 76 |         $files = $theme->get_files( null, -1 );
 77 |         $css   = $php = $other = array();
 78 | 
 79 |         foreach( $files as $key => $filename )
 80 |         {
 81 |             if ( strpos( $filename, 'tgm-plugin-activation' ) === false && strpos( $filename, 'class-merlin' ) === false ) {
 82 |                 if ( substr( $filename, -4 ) == '.php' )
 83 |                 {
 84 |                     $php[ $filename ] = php_strip_whitespace( $filename );
 85 |                 }
 86 |                 else if ( substr( $filename, -4 ) == '.css' )
 87 |                 {
 88 |                     $css[ $filename ] = file_get_contents( $filename );
 89 |                 }
 90 |                 else
 91 |                 {
 92 |                     $other[ $filename ] = ( ! is_dir( $filename ) ) ? file_get_contents( $filename ) : '';
 93 |                 }
 94 |             }
 95 |         }
 96 | 
 97 |         $success = run_themechecks($php, $css, $other);
 98 |         $errors  = array();
 99 | 
100 |         foreach ( $themechecks as $check )
101 |         {
102 |             if ( $check instanceof themecheck )
103 |             {
104 |                 $error = $check->getError();
105 | 
106 |                 if ( ! empty( $error ) )
107 |                 {
108 |                     $errors = array_merge( $error, $errors );
109 |                 }
110 |             }
111 |         }
112 | 
113 |         $errors = array_unique( $errors );
114 |         $errors = array_map( 'strip_tags', $errors );
115 |         rsort( $errors );
116 | 
117 |         // assume to pass unless we see a required or warning message.
118 |         $pass = true;
119 | 
120 |         foreach ( $errors as $error )
121 |         {
122 |             list( $type, $message ) = explode( ':', $error, 2 );
123 | 
124 |             if ( 'REQUIRED' == trim( $type ) )
125 |             {
126 |                 if ( 'true' == $assoc_args['format'] )
127 |                 {
128 |                     array_push( $required_json, "REQUIRED: " . trim( $message ) );
129 |                 }
130 |                 else
131 |                 {
132 |                     WP_CLI::warning( '%rREQUIRED:%n ' . trim( $message ) );
133 |                 }
134 |                 $pass = false;
135 |             }
136 |             elseif ( 'WARNING' == trim( $type ) )
137 |             {
138 |                 if ( 'true' == $assoc_args['format'] )
139 |                 {
140 |                     array_push( $warnings_json, "WARNING: " . trim( $message ) );
141 |                 }
142 |                 else
143 |                 {
144 |                     WP_CLI::warning( '%yWARNING:%n ' . trim( $message ) );
145 |                 }
146 |                 $pass = false;
147 | 
148 |             }
149 |             elseif ( 'RECOMMENDED' == trim( $type ) )
150 |             {
151 |                 if ( 'true' == $assoc_args['format'] )
152 |                 {
153 |                     array_push( $recommended_json, "RECOMMENDED: " . trim( $message ) );
154 |                 }
155 |                 else
156 |                 {
157 |                     WP_CLI::warning( '%cRECOMMENDED:%n ' . trim( $message ) );
158 |                 }
159 |             }
160 |             else
161 |             {
162 |                 if ( 'true' == $assoc_args['format'] )
163 |                 {
164 |                     array_push( $errors_json, "ERROR: " . trim( $error ) );
165 |                 }
166 |                 else
167 |                 {
168 |                     WP_CLI::warning( $error );
169 |                 }
170 |             }
171 |         }
172 | 
173 |         WP_CLI::line();
174 | 
175 |         if ( empty( $errors ) )
176 |         {
177 |             if ( 'true' == $assoc_args['format'] )
178 |             {
179 |                 array_push( $result_json, "SUCCESS" );
180 |                 array_push( $result_json, "THEME PASSED REVIEW" );
181 |             }
182 |             else
183 |             {
184 |                 WP_CLI::success( "THEME PASSED REVIEW" );
185 |             }
186 |         }
187 |         elseif ( true === $pass )
188 |         {
189 |             if ( 'true' == $assoc_args['format'] )
190 |             {
191 |                 array_push( $result_json, "SUCCESS" );
192 |                 array_push( $result_json, "THEME PASSED REVIEW WITH RECOMMENDED CHANGES" );
193 |             }
194 |             else
195 |             {
196 |                 WP_CLI::success( "THEME PASSED REVIEW WITH RECOMMENDED CHANGES" );
197 |             }
198 |         }
199 |         else
200 |         {
201 |             if ( 'true' == $assoc_args['format'] )
202 |             {
203 |                 array_push( $result_json, "FAIL" );
204 |                 array_push( $result_json, "THEME DID NOT PASS REVIEW" );
205 |             }
206 |             else
207 |             {
208 |                 WP_CLI::line( WP_CLI::colorize( "%RFAIL:%n THEME DID NOT PASS REVIEW" ) );
209 |             }
210 |         }
211 | 
212 |         if ( 'true' == $assoc_args['format'] )
213 |         {
214 |             $output = array (
215 |                 'result'      => $result_json,
216 |                 'required'    => $required_json,
217 |                 'recommended' => $recommended_json,
218 |                 'warnings'    => $warnings_json,
219 |                 'errors'      => $errors_json
220 |             );
221 |             echo htmlspecialchars_decode( json_encode( $output, JSON_UNESCAPED_SLASHES ) );
222 |         }
223 |     }
224 |     /**
225 |     * Check for the active theme
226 |     *
227 |     * [--format=<format>]
228 |     * : set to true to format as json. Default: false
229 |     *
230 |     */
231 |     public function active( $args = array(), $assoc_args = array() )
232 |     {
233 |         $active_theme = wp_get_theme();
234 |         $theme_folder_name = $active_theme->template;
235 |         // Next four lines set up $themename and $data for wp cli version, as check_main is never run
236 |         global $themename, $data;
237 |         $themename = $theme_folder_name;
238 |         $theme = get_theme_root( $theme_folder_name ) . "/$theme_folder_name";
239 |         $data = tc_get_theme_data( $theme . '/style.css' );
240 |         $this->check( array($theme_folder_name), $assoc_args);
241 |     }
242 | }
243 | 
244 | class ThemeCheckCLILogger extends WP_CLI\Loggers\Regular {
245 |     public function _line( $message, $label, $color, $handle = STDOUT )
246 |     {
247 |         if ( ! empty( $label ) )
248 |         {
249 |             $label = \cli\Colors::colorize( "$color$label:%n ", $this->in_color );
250 |         }
251 |         $this->write( $handle, "{$label}{$message}\n" );
252 |     }
253 | 
254 |     function warning( $message )
255 |     {
256 |         $this->_line( WP_CLI::colorize( $message ), '', '', STDERR );
257 |     }
258 | }
259 | WP_CLI::set_logger( new ThemeCheckCLILogger( true ) );
260 | 
261 | WP_CLI::add_command( 'theme review', 'ThemeCheckCLI' );
262 | 


--------------------------------------------------------------------------------
/main.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Functions for displaying theme information, test results, and the form
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Present theme information and test results.
 10 |  *
 11 |  * @param string $theme_slug theme slug of the theme to be tested.
 12 |  */
 13 | function check_main( $theme_slug ) {
 14 | 	global $checkcount;
 15 | 
 16 | 	/**
 17 | 	 * Get theme data. Return early if the theme is not found.
 18 | 	 *
 19 | 	 * @link https://developer.wordpress.org/reference/functions/wp_get_theme/
 20 | 	 */
 21 | 	$theme = wp_get_theme( $theme_slug );
 22 | 	if ( ! $theme->exists() ) {
 23 | 		return;
 24 | 	}
 25 | 
 26 | 	// Run the checks.
 27 | 	$success = run_themechecks_against_theme( $theme, $theme_slug );
 28 | 
 29 | 	// Display theme info.
 30 | 	echo '<h2>' . esc_html__( 'Theme Info', 'theme-check' ) . ': </h2>';
 31 | 	echo '<div class="theme-info">';
 32 | 
 33 | 	$screenshot = $theme->get_screenshot( 'relative' );
 34 | 	if ( $screenshot ) {
 35 | 		$screenshot_file = $theme->get_stylesheet_directory() . '/' . $screenshot;
 36 | 		$image_size      = getimagesize( $screenshot_file );
 37 | 		$image_filesize  = filesize( $screenshot_file );
 38 | 
 39 | 		echo '<div style="float:right" class="theme-info"><img style="max-height:180px;" src="' . esc_url( $theme->get_screenshot() ) . '" />';
 40 | 		echo '<br /><div style="text-align:center">' . intval( $image_size[0] ) . 'x' . intval( $image_size[1] ) . ' ' . round( $image_filesize / 1024 ) . 'k</div></div>';
 41 | 	}
 42 | 
 43 | 	echo ( ! empty( $theme['Title'] ) ) ? '<p><label>' . esc_html__( 'Title', 'theme-check' ) . '</label><span class="info">' . esc_html( $theme['Title'] ) . '</span></p>' : '';
 44 | 	echo ( ! empty( $theme['Version'] ) ) ? '<p><label>' . esc_html__( 'Version', 'theme-check' ) . '</label><span class="info">' . esc_html( $theme['Version'] ) . '</span></p>' : '';
 45 | 	echo ( ! empty( $theme->get( 'Author' ) ) ) ? '<p><label>' . esc_html__( 'Author', 'theme-check' ) . '</label><span class="info">' . esc_html( $theme->get( 'Author' ) ) . '</span></p>' : '';
 46 | 	echo ( ! empty( $theme->get( 'AuthorURI' ) ) ) ? '<p><label>' . esc_html__( 'Author URI', 'theme-check' ) . '</label><span class="info"><a href="' . esc_url( $theme->get( 'AuthorURI' ) ) . '">' . esc_html( $theme->get( 'AuthorURI' ) ) . '</a></span></p>' : '';
 47 | 	echo ( ! empty( $theme->get( 'ThemeURI' ) ) ) ? '<p><label>' . esc_html__( 'Theme URI', 'theme-check' ) . '</label><span class="info"><a href="' . esc_url( $theme->get( 'ThemeURI' ) ) . '">' . esc_html( $theme->get( 'ThemeURI' ) ) . '</a></span></p>' : '';
 48 | 	echo ( ! empty( $theme->get( 'License' ) ) ) ? '<p><label>' . esc_html__( 'License', 'theme-check' ) . '</label><span class="info">' . esc_html( $theme->get( 'License' ) ) . '</span></p>' : '';
 49 | 	echo ( ! empty( $theme->get( 'License URI' ) ) ) ? '<p><label>' . esc_html__( 'License URI', 'theme-check' ) . '</label><span class="info">' . esc_html( $theme->get( 'License URI' ) ) . '</span></p>' : '';
 50 | 	echo ( ! empty( $theme['Tags'] ) ) ? '<p><label>' . esc_html__( 'Tags', 'theme-check' ) . '</label><span class="info">' . esc_html( implode( ', ', $theme['Tags'] ) ) . '</span></p>' : '';
 51 | 	echo ( ! empty( $theme['Description'] ) ) ? '<p><label>' . esc_html__( 'Description', 'theme-check' ) . '</label><span class="info">' . esc_html( $theme['Description'] ) . '</span></p>' : '';
 52 | 
 53 | 	if ( $theme->parent() ) {
 54 | 		echo '<p>';
 55 | 		printf(
 56 | 			/* translators: %s: Name of the parent theme. */
 57 | 			esc_html__( 'This is a child theme. The parent theme is: %s. These files have been included automatically!', 'theme-check' ),
 58 | 			'<strong>' . esc_html( $theme['Template'] ) . '</strong>'
 59 | 		);
 60 | 		echo '</p>';
 61 | 	}
 62 | 
 63 | 	if ( $theme['Template Version'] /* Not supported by WordPress */ ) {
 64 | 		$parent_theme = $theme->parent();
 65 | 		if ( $theme['Template Version'] > $parent_theme['Version'] ) {
 66 | 			echo '<p>';
 67 | 			printf(
 68 | 				esc_html__( 'This child theme requires at least version %1$s of theme %2$s to be installed. You only have %3$s please update the parent theme.', 'theme-check' ),
 69 | 				'<strong>' . esc_html( $theme['Template Version'] ) . '</strong>',
 70 | 				'<strong>' . esc_html( $parent_theme['Title'] ) . '</strong>',
 71 | 				'<strong>' . esc_html( $parent_theme['Version'] ) . '</strong>'
 72 | 			);
 73 | 			echo '</p>';
 74 | 		}
 75 | 
 76 | 		if ( empty( $theme['Template Version'] ) ) {
 77 | 			echo '<p>' . __( 'Child theme does not have the <strong>Template Version</strong> tag in style.css.', 'theme-check' ) . '</p>';
 78 | 		} elseif ( $theme['Template Version'] < $parent_theme['Version'] ) {
 79 | 			echo '<p>';
 80 | 			printf(
 81 | 				esc_html__( 'Child theme is only tested up to version %1$s of %2$s breakage may occur! %3$s installed version is %4$s', 'theme-check' ),
 82 | 				esc_html( $theme['Template Version'] ),
 83 | 				esc_html( $parent_theme['Title'] ),
 84 | 				esc_html( $parent_theme['Title'] ),
 85 | 				esc_html( $parent_theme['Version'] )
 86 | 			);
 87 | 			echo '</p>';
 88 | 		}
 89 | 	}
 90 | 	echo '</div><!-- .theme-info-->';
 91 | 	echo '<p>' . sprintf(
 92 | 		esc_html__( 'Running %1$s tests against %2$s.', 'theme-check' ),
 93 | 		'<strong>' . esc_html( $checkcount ) . '</strong>',
 94 | 		'<strong>' . esc_html( $theme['Title'] ) . '</strong>'
 95 | 	) . '</p>';
 96 | 
 97 | 	$results = display_themechecks();
 98 | 
 99 | 	if ( ! $success ) {
100 | 		echo '<h2>' . sprintf( __( 'One or more errors were found for %1$s.', 'theme-check' ), esc_html( $theme['Title'] ) ) . '</h2>';
101 | 	} else {
102 | 		echo '<h2>' . sprintf( __( '%1$s passed the tests', 'theme-check' ), esc_html( $theme['Title'] ) ) . '</h2>';
103 | 		tc_success();
104 | 	}
105 | 
106 | 	if ( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) {
107 | 		echo '<div class="updated">';
108 | 		echo '<span class="tc-fail">';
109 | 		echo esc_html__( 'WARNING', 'theme-check' );
110 | 		echo '</span> ';
111 | 		echo '<strong>';
112 | 		echo esc_html__( 'WP_DEBUG is not enabled!', 'theme-check' );
113 | 		echo '</strong>';
114 | 		printf(
115 | 			/* translators: %1$s is an opening anchor tag. %2$s is the closing part of the tag. */
116 | 			esc_html__( 'Please test your theme with %1$sdebug enabled%2$s before you upload!', 'theme-check' ),
117 | 			'<a href="https://wordpress.org/support/article/editing-wp-config-php/">',
118 | 			'</a>'
119 | 		);
120 | 		echo '</div>';
121 | 	}
122 | 
123 | 	echo '<div class="tc-box">';
124 | 	echo '<ul class="tc-result">';
125 | 	echo wp_kses(
126 | 		$results,
127 | 		array(
128 | 			'li'     => array(),
129 | 			'span'   => array(
130 | 				'class' => array(),
131 | 			),
132 | 			'strong' => array(),
133 | 			'code'   => array(),
134 | 			'pre'    => array(),
135 | 			'a'      => array(
136 | 				'href' => array(),
137 | 			),
138 | 		)
139 | 	);
140 | 	echo '</ul></div>';
141 | }
142 | 
143 | function tc_intro() {
144 | ?>
145 | 	<h2><?php _e( 'About', 'theme-check' ); ?></h2>
146 | 	<p><?php _e( "The Envato Theme Check plugin is an easy way to test your theme and make sure it's up to date with the latest Themeforest review standards. With it, you can run all the same automated testing tools on your theme that Themeforest Reviewers use for theme submissions.", 'theme-check' ); ?></p>
147 | <?php
148 | }
149 | 
150 | /**
151 |  * Present information about submitting themes.
152 |  */
153 | function tc_success() {
154 | 	?>
155 | 	<div class="tc-success"><p><?php esc_html_e( 'Now that your theme has passed the basic tests you need to check it properly using the test data before you upload it to the WordPress Themes Directory.', 'theme-check' ); ?></p>
156 | 	<p>
157 | 		<?php
158 | 		printf(
159 | 			/* translators: %1$s is an opening anchor tag. %2$s is the closing part of the tag. */
160 | 			esc_html__( 'Make sure to review the guidelines at %1$sTheme Review%2$s before uploading a Theme.', 'theme-check' ),
161 | 			'<a href="https://make.wordpress.org/themes/handbook/review/required/">',
162 | 			'</a>'
163 | 		);
164 | 		?>
165 | 	</p>
166 | 	<h3><?php esc_html_e( 'Useful Links', 'theme-check' ); ?></h3>
167 | 	<ul>
168 | 	<li><a href="https://developer.wordpress.org/themes/"><?php esc_html_e( 'Theme Handbook', 'theme-check' ); ?></a></li>
169 | 	<li><a href="https://wordpress.org/support/forum/wp-advanced/"><?php esc_html_e( 'Developing with WordPress Forum', 'theme-check' ); ?></a></li>
170 | 	<li><a href="https://github.com/WPTRT/theme-unit-test"><?php esc_html_e( 'Theme Unit Tests', 'theme-check' ); ?></a></li>
171 | 	</ul></div>
172 | 	<?php
173 | }
174 | 
175 | /**
176 |  * Print the form for selecting the theme to test.
177 |  */
178 | function tc_form() {
179 | 	echo '<form action="themes.php?page=themecheck" method="post">';
180 | 	echo '<select name="themename">';
181 | 
182 | 	$selected_theme = isset( $_POST['themename'] ) ? wp_unslash( $_POST['themename'] ) : get_stylesheet();
183 | 	foreach ( wp_get_themes() as $theme ) {
184 | 		printf(
185 | 			'<option %s value="%s">%s</option>',
186 | 			selected( $selected_theme, $theme['Stylesheet'], false ),
187 | 			esc_attr( $theme['Stylesheet'] ),
188 | 			esc_html( $theme['Name'] )
189 | 		);
190 | 	}
191 | 
192 | 	echo '</select>';
193 | 
194 | 	echo '<input class="button" type="submit" value="' . esc_attr__( 'Check it!', 'theme-check' ) . '" />';
195 | 	if ( defined( 'TC_PRE' ) || defined( 'TC_POST' ) ) {
196 | 		echo ' <input name="trac" type="checkbox" /> ' . esc_html__( 'Output in Trac format.', 'theme-check' );
197 | 	}
198 | 	echo '<input name="s_info" type="checkbox" /> ' . esc_html__( 'Suppress INFO.', 'theme-check' );
199 | 	wp_nonce_field( 'themecheck-nonce' );
200 | 	echo '</form>';
201 | }
202 | 
203 | 


--------------------------------------------------------------------------------
/checks/class-textdomain-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Check if translation functions have a text domain.
  4 |  *
  5 |  * @package Theme Check
  6 |  */
  7 | 
  8 | /**
  9 |  * Check if translation functions have a text domain.
 10 |  */
 11 | class TextDomain_Check implements themecheck {
 12 | 	/**
 13 | 	 * Error messages, warnings and info notices.
 14 | 	 *
 15 | 	 * @var array $error
 16 | 	 */
 17 | 	protected $error = array();
 18 | 
 19 | 	/**
 20 | 	 * Theme name
 21 | 	 *
 22 | 	 * @var string $name
 23 | 	 */
 24 | 	protected $name = '';
 25 | 
 26 | 	/**
 27 | 	 * Theme slug
 28 | 	 *
 29 | 	 * @var string $slug
 30 | 	 */
 31 | 	protected $slug = '';
 32 | 
 33 | 	protected $is_wporg = false;
 34 | 
 35 | 	// Rules come from WordPress core tool makepot.php, modified to have domain info.
 36 | 	var $rules = array(
 37 | 		'__'                   => array( 'string', 'domain' ),
 38 | 		'_e'                   => array( 'string', 'domain' ),
 39 | 		'_c'                   => array( 'string', 'domain' ),
 40 | 		'_n'                   => array( 'singular', 'plural', 'domain' ),
 41 | 		'_n_noop'              => array( 'singular', 'plural', 'domain' ),
 42 | 		'_nc'                  => array( 'singular', 'plural', 'domain' ),
 43 | 		'__ngettext'           => array( 'singular', 'plural', 'domain' ),
 44 | 		'__ngettext_noop'      => array( 'singular', 'plural', 'domain' ),
 45 | 		'_x'                   => array( 'string', 'context', 'domain' ),
 46 | 		'_ex'                  => array( 'string', 'context', 'domain' ),
 47 | 		'_nx'                  => array( 'singular', 'plural', 'context', 'domain' ),
 48 | 		'_nx_noop'             => array( 'singular', 'plural', 'context', 'domain' ),
 49 | 		'_n_js'                => array( 'singular', 'plural', 'domain' ),
 50 | 		'_nx_js'               => array( 'singular', 'plural', 'context', 'domain' ),
 51 | 		'esc_attr__'           => array( 'string', 'domain' ),
 52 | 		'esc_html__'           => array( 'string', 'domain' ),
 53 | 		'esc_attr_e'           => array( 'string', 'domain' ),
 54 | 		'esc_html_e'           => array( 'string', 'domain' ),
 55 | 		'esc_attr_x'           => array( 'string', 'context', 'domain' ),
 56 | 		'esc_html_x'           => array( 'string', 'context', 'domain' ),
 57 | 		'comments_number_link' => array( 'string', 'singular', 'plural', 'domain' ),
 58 | 	);
 59 | 
 60 | 	// Core names their themes differently.
 61 | 	var $exceptions = array( 'twentyten', 'twentyeleven', 'twentytwelve', 'twentythirteen', 'twentyfourteen', 'twentyfifteen', 'twentysixteen', 'twentyseventeen', 'twentyeighteen', 'twentynineteen', 'twentytwenty', 'twentytwentyone' );
 62 | 
 63 | 	function set_context( $data ) {
 64 | 		if ( isset( $data['theme']['Name'] ) ) {
 65 | 			$this->name = $data['theme']['Name'];
 66 | 		}
 67 | 		if ( isset( $data['slug'] ) ) {
 68 | 			$this->slug = $data['slug'];
 69 | 		}
 70 | 
 71 | 		$this->is_wporg = ! empty( $data['is_wporg'] );
 72 | 	}
 73 | 
 74 | 	/**
 75 | 	 * Check that return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 76 | 	 *
 77 | 	 * @param array $php_files File paths and content for PHP files.
 78 | 	 * @param array $css_files File paths and content for CSS files.
 79 | 	 * @param array $other_files Folder names, file paths and content for other files.
 80 | 	 */
 81 | 	function check( $php_files, $css_files, $other_files ) {
 82 | 		$ret   = true;
 83 | 		$error = '';
 84 | 		checkcount();
 85 | 
 86 | 		// Make sure the tokenizer is available.
 87 | 		if ( ! function_exists( 'token_get_all' ) ) {
 88 | 			return true;
 89 | 		}
 90 | 
 91 | 		$funcs   = array_keys( $this->rules );
 92 | 		$domains = array();
 93 | 
 94 | 		foreach ( $php_files as $php_key => $phpfile ) {
 95 | 			$error = '';
 96 | 			// Tokenize the file.
 97 | 			$tokens         = token_get_all( $phpfile );
 98 | 			$in_func        = false;
 99 | 			$args_started   = false;
100 | 			$parens_balance = 0;
101 | 			$found_domain   = false;
102 | 
103 | 			foreach ( $tokens as $token ) {
104 | 				$string_success = false;
105 | 				if ( is_array( $token ) ) {
106 | 					list( $id, $text ) = $token;
107 | 					if ( T_STRING == $id && in_array( $text, $funcs ) ) {
108 | 						$in_func        = true;
109 | 						$func           = $text;
110 | 						$parens_balance = 0;
111 | 						$args_started   = false;
112 | 						$found_domain   = false;
113 | 					} elseif ( T_CONSTANT_ENCAPSED_STRING == $id ) {
114 | 						if ( $in_func && $args_started ) {
115 | 							if ( ! isset( $this->rules[ $func ][ $args_count ] ) ) {
116 | 								$filename = tc_filename( $php_key );
117 | 								// Avoid a warning when too many arguments are in a function, cause a fail case.
118 | 								$new_args   = $args;
119 | 								$new_args[] = $text;
120 | 								$error      = $new_args['0'];
121 | 								$grep       = tc_grep( $error, $php_key );
122 | 								$lines      = explode( 'Line', $grep );
123 | 
124 | 								foreach ( $lines as $line ) {
125 | 									if ( strpos( $line, $func ) !== false && strpos( $line, $error ) !== false ) {
126 | 										$grep = "<pre class='tc-grep'>" . __( 'Line ', 'theme-check' ) . $line . '</pre>';
127 | 									}
128 | 								}
129 | 
130 | 								$this->error[] = sprintf(
131 | 									'<span class="tc-lead tc-warning">%s</span>: %s',
132 | 									__( 'WARNING', 'theme-check' ),
133 | 									sprintf(
134 | 										__( 'Found a translation function that has an incorrect number of arguments in the file %1$s. Function %2$s, with the arguments %3$s. %4$s', 'theme-check' ),
135 | 										$filename,
136 | 										'<strong>' . $func . '</strong>',
137 | 										'<strong>' . implode( ', ', $new_args ) . '</strong>',
138 | 										$grep
139 | 									)
140 | 								);
141 | 							} elseif ( $this->rules[ $func ][ $args_count ] == 'domain' ) {
142 | 								// Strip quotes from the domain, avoids 'domain' and "domain" not being recognized as the same
143 | 								$text         = str_replace( array( '"', "'" ), '', $text );
144 | 								$domains[]    = $text;
145 | 								$found_domain = true;
146 | 							}
147 | 							if ( $parens_balance == 1 ) {
148 | 								$args_count++;
149 | 								$args[] = $text;
150 | 							}
151 | 						}
152 | 					}
153 | 					$token = $text;
154 | 				} elseif ( '(' == $token ) {
155 | 					if ( $parens_balance == 0 ) {
156 | 						$args         = array();
157 | 						$args_started = true;
158 | 						$args_count   = 0;
159 | 					}
160 | 					++$parens_balance;
161 | 				} elseif ( ')' == $token ) {
162 | 					--$parens_balance;
163 | 					if ( $in_func && 0 == $parens_balance ) {
164 | 						$error = implode( ', ', $args );
165 | 
166 | 						if ( ! $found_domain && ! empty( $error ) ) {
167 | 							$filename = tc_filename( $php_key );
168 | 							$grep     = tc_grep( $error, $php_key );
169 | 							$lines    = explode( 'Line', $grep );
170 | 							foreach ( $lines as $line ) {
171 | 								if ( strpos( $line, $func ) !== false && strpos( $line, $error ) !== false ) {
172 | 									$grep = "<pre class='tc-grep'>" . __( 'Line ', 'theme-check' ) . $line . '</pre>';
173 | 								}
174 | 							}
175 | 
176 | 							$this->error[] = sprintf(
177 | 								'<span class="tc-lead tc-warning">%s</span>: %s',
178 | 								__( 'WARNING', 'theme-check' ),
179 | 								sprintf(
180 | 									__( 'Found a translation function that is missing a text-domain in the file %1$s. Function %2$s, with the arguments %3$s. %4$s', 'theme-check' ),
181 | 									$filename,
182 | 									'<strong>' . $func . '</strong>',
183 | 									'<strong>' . $error . '</strong>',
184 | 									$grep
185 | 								)
186 | 							);
187 | 						}
188 | 
189 | 						$in_func      = false;
190 | 						$func         = '';
191 | 						$args_started = false;
192 | 						$found_domain = false;
193 | 					}
194 | 				}
195 | 			}
196 | 		}
197 | 
198 | 		$domains      = array_unique( $domains );
199 | 		$domainlist   = implode( ', ', $domains );
200 | 		$domainscount = count( $domains );
201 | 
202 | 		// ignore core themes and uploads on w.org for this one check
203 | 		if ( ! in_array( $this->slug, $this->exceptions ) && ! $this->is_wporg ) {
204 | 			$correct_domain = sanitize_title_with_dashes( $this->name );
205 | 			if ( $this->slug != $correct_domain ) {
206 | 				$this->error[] = sprintf(
207 | 					'<span class="tc-lead tc-warning">%s</span>: %s %s',
208 | 					__( 'WARNING', 'theme-check' ),
209 | 					sprintf(
210 | 						__( "Your theme appears to be in the wrong directory for the theme name. The directory name must match the slug of the theme. This theme's correct slug and text-domain is %s.", 'theme-check' ),
211 | 						'<strong>' . $correct_domain . '</strong>'
212 | 					),
213 | 					__( '(If this is a child theme, you can ignore this error.)', 'theme-check' )
214 | 				);
215 | 			} elseif ( ! empty( $domains ) && ! in_array( $correct_domain, $domains ) ) {
216 | 				$this->error[] = sprintf(
217 | 					'<span class="tc-lead tc-required">%s</span>: %s %s',
218 | 					__( 'REQUIRED', 'theme-check' ),
219 | 					sprintf(
220 | 						__( "This theme text domain does not match the theme's slug. The text domain used: %s", 'theme-check' ),
221 | 						'<strong>' . $domainlist . '</strong>'
222 | 					),
223 | 					sprintf(
224 | 						__( "This theme's correct slug and text-domain is %s.", 'theme-check' ),
225 | 						'<strong>' . $correct_domain . '</strong>'
226 | 					)
227 | 				);
228 | 				$ret           = false;
229 | 			}
230 | 		}
231 | 
232 | 		if ( $domainscount > 1 ) {
233 | 			$this->error[] = sprintf(
234 | 				'<span class="tc-lead tc-warning">%s</span>: %s %s',
235 | 				__( 'WARNING', 'theme-check' ),
236 | 				__( 'More than one text-domain is being used in this theme. This means the theme will not be compatible with WordPress.org language packs.', 'theme-check' ),
237 | 				sprintf(
238 | 					__( 'The domains found are %s.', 'theme-check' ),
239 | 					'<strong>' . $domainlist . '</strong>'
240 | 				)
241 | 			);
242 | 		} else {
243 | 			$this->error[] = sprintf(
244 | 				'<span class="tc-lead tc-info">%s</span>: %s %s',
245 | 				__( 'INFO', 'theme-check' ),
246 | 				__( "Only one text-domain is being used in this theme. Make sure it matches the theme's slug correctly so that the theme will be compatible with WordPress.org language packs.", 'theme-check' ),
247 | 				sprintf(
248 | 					__( 'The domain found is %s.', 'theme-check' ),
249 | 					'<strong>' . $domainlist . '</strong>'
250 | 				)
251 | 			);
252 | 
253 | 		}
254 | 
255 | 		if ( $domainscount > 2 ) {
256 | 			$ret = false;
257 | 		}
258 | 
259 | 		return $ret;
260 | 	}
261 | 
262 | 	function getError() {
263 | 		return $this->error;
264 | 	}
265 | }
266 | $themechecks[] = new TextDomain_Check();
267 | 


--------------------------------------------------------------------------------
/checks/class-envato-check.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Extends Theme Check with additional Themeforest reviewer specific checks.
  4 |  */
  5 | class Themeforest implements themecheck {
  6 |     protected $error = array();
  7 | 
  8 |     function check( $php_files, $css_files, $other_files )
  9 |     {
 10 |         $ret = true;
 11 | 
 12 |         $req_checks = array(
 13 |             '/@import url\s?\(/'                            => esc_html__( 'Do not use @import. Instead, use wp_enqueue to load any external stylesheets and fonts correctly', 'theme-check' ),
 14 |             '/.bypostauthor{}/'                             => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 15 |             '/.bypostauthor {}/'                            => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 16 |             '/.sticky{}/'                                   => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 17 |             '/.sticky {}/'                                  => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 18 |             '/.gallery-caption{}/'                          => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 19 |             '/.gallery-caption {}/'                         => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 20 |             '/.screen-reader-text{}/'                       => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 21 |             '/.screen-reader-text {}/'                      => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 22 |             '/.wp-caption-text{}/'                          => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 23 |             '/.wp-caption-text {}/'                         => esc_html__( 'Do not use empty CSS classes to try to trick theme check', 'theme-check' ),
 24 |             '/key=AIza/'                                    => esc_html__( 'Remove personal API key(s). These should be user options', 'theme-check' ),
 25 |             '/(:?^|\s)title=""/'                            => esc_html__( 'Do not leave attributes empty', 'theme-check' ),
 26 |             '/(:?^|\s)title=" "/'                           => esc_html__( 'Do not leave attributes empty', 'theme-check' ),
 27 |             '/(:?^|\s)placeholder=""/'                      => esc_html__( 'Do not leave attributes empty', 'theme-check' ),
 28 |             '/(:?^|\s)placeholder=" "/'                     => esc_html__( 'Do not leave attributes empty', 'theme-check' ),
 29 |             '/[^a-z0-9](?<!_)mkdir\s?\(/'                   => esc_html__( 'mkdir() is not allowed. Use wp_mkdir_p() instead', 'theme-check' ),
 30 |             '/[^a-z0-9](?<!_)htmlspecialchars_decode\s?\(/' => esc_html__( 'Use wp_specialchars_decode instead', 'theme-check' ),
 31 |             '/style_loader_tag/'                            => esc_html__( 'Do not remove core functionality', 'theme-check' ),
 32 |             '/script_loader_tag/'                           => esc_html__( 'Do not remove core functionality', 'theme-check' ),
 33 |             '/style_loader_src/'                            => esc_html__( 'Do not remove core functionality', 'theme-check' ),
 34 |             '/script_loader_src/'                           => esc_html__( 'Do not remove core functionality', 'theme-check' ),
 35 |             '/wp_calculate_image_srcset/'                   => esc_html__( 'Do not remove core functionality', 'theme-check' ),
 36 |             '/[^a-z0-9](?<!_)mail\s?\(/'                    => esc_html__( 'Mail functions are plugin territory', 'theme-check' ),
 37 |             '/[^a-z0-9](?<!_)wp_mail\s?\(/'                 => esc_html__( 'Mail functions are plugin territory', 'theme-check' ),
 38 |             '/posttype/'                                    => esc_html__( 'Custom posttypes are plugin territory', 'theme-check' ),
 39 |             '/create_post_type/'                            => esc_html__( 'Custom posttypes are plugin territory', 'theme-check' ),
 40 |             '/is_plugin_active\s?\(/'                       => esc_html__( 'is_plugin_active() is not reliable. Use function_exists() or class_exists() instead', 'theme-check' ),
 41 |             '/add_action\( &\$this/'                        => esc_html__( 'When creating a callable, never use &$this, use $this instead', 'theme-check' ),
 42 |             '/admin_bar_menu/'                              => esc_html__( 'Themes must not add any entries to the admin bar', 'theme-check' ),
 43 |             '/create_function\s?\(/'                        => esc_html__( 'The create_function() function has been deprecated as of PHP 7.2.0 and must no longer be used', 'theme-check' ),
 44 |             '/marketplace\.envato\.com/'                    => esc_html__( 'The legacy API at marketplace.envato.com has been retired and must no longer be used', 'theme-check' ),
 45 |         );
 46 | 
 47 |         $warn_checks = array(
 48 |             '/@\$/'                                           => esc_html__( 'Possible error suppression is being used', 'theme-check' ),
 49 |             '/@include/'                                      => esc_html__( 'Possible error suppression is being used', 'theme-check' ),
 50 |             '/@require/'                                      => esc_html__( 'Possible error suppression is being used', 'theme-check' ),
 51 |             '/@file/'                                         => esc_html__( 'Possible error suppression is being used', 'theme-check' ),
 52 |             '/[^a-z0-9](?<!_)balanceTags\s?\(\$/'             => esc_html__( 'Possible data validation issues found. balanceTags() does not escape data', 'theme-check' ),
 53 |             '/[^a-z0-9](?<!_)balanceTags\s?\( \$/'            => esc_html__( 'Possible data validation issues found. balanceTags() does not escape data', 'theme-check' ),
 54 |             '/[^a-z0-9](?<!_)force_balance_tags\s?\(\$/'      => esc_html__( 'Possible data validation issues found. force_balance_tags() does not escape data', 'theme-check' ),
 55 |             '/[^a-z0-9](?<!_)force_balance_tags\s?\( \$/'     => esc_html__( 'Possible data validation issues found. force_balance_tags() does not escape data', 'theme-check' ),
 56 |             '/[^a-zA-Z0-9_\x7f-\xff](echo|print)\s*\(?\s*\$/' => esc_html__( 'Possible data validation issues found. All dynamic data must be correctly escaped for the context where it is rendered', 'theme-check' ),
 57 |             '/[^a-z0-9](?<!_)\$_SERVER\s?/'                   => esc_html__( 'PHP Global Variable found. Ensure the context is safe and reliable', 'theme-check' ),
 58 |             '/remove_filter\s?\(/'                            => esc_html__( 'Themes should not remove core filters. Ensure this is a valid use case', 'theme-check' ),
 59 |             '/add_meta_boxes/'                                => esc_html__( 'Custom meta box functions are allowed for design only. Ensure this is a valid use case', 'theme-check' ),
 60 |             '/add_meta_box/'                                  => esc_html__( 'Custom meta box functions are allowed for design only. Ensure this is a valid use case', 'theme-check' ),
 61 |             '/register_widget\s?\(/'                          => esc_html__( 'Custom widgets are plugin territory', 'theme-check' ),
 62 |             '/\/api_keys\/edit/'                              => esc_html__( 'Likely contains instructions to generate keys for the retired legacy API', 'theme-check' ),
 63 |             '/install_code|div_code_name|tmpcontentx|wp_temp_setupx|wp_vcd|edoced_46esab/' => esc_html__( 'Possible WP VCD hack code present', 'theme-check' ),
 64 |             '/165bl|137html|057wp-c|157nten|151co/'           => esc_html__( 'Possible SoakSoak .ico hack code present', 'theme-check' ),
 65 |             '/4LV1N|in73ct0r|d3vil/'                          => esc_html__( 'Possible Webshell code present', 'theme-check' ),
 66 |             '/style_array_chunk\s?\(/'                        => esc_html__( 'Possible Pharma hack code present', 'theme-check' ),
 67 |             '/user_min_browser\s?\(/'                         => esc_html__( 'Possible Google Viagra hack code present', 'theme-check' ),
 68 |             '/String.fromCharCode|lovegreenpencils|secondaryinformtrand|list.insertBefore(s, list.childNodes[0])/' => esc_html__( 'Possible LoveGreenPencils malware code present', 'theme-check' ),
 69 |             '/_0x230d|279875vBeEEE|1fashtG|atxcoder\s?\(/'    => esc_html__( 'Possible Kaswara malware code present', 'theme-check' ),
 70 |             '/date2021|deunco|Mjhn|Сканирование\s?\(/'        => esc_html__( 'Possible Capoae malware code present', 'theme-check' ),
 71 |             '/hex2bin|hex2dec\s?\(/'                          => esc_html__( 'Possible Push Notification Scam', 'theme-check' ),
 72 |         );
 73 | 
 74 |         $grep = '';
 75 | 
 76 |         foreach ( $php_files as $php_key => $phpfile )
 77 |         {
 78 |             foreach ( $req_checks as $key => $check )
 79 |             {
 80 |                 checkcount();
 81 | 
 82 |                 if ( preg_match( $key, $phpfile, $matches ) )
 83 |                 {
 84 |                     $filename = tc_filename( $php_key );
 85 |                     $error = trim( $matches[0] );
 86 |                     $grep = tc_grep( $error, $php_key );
 87 |                     $this->error[] = sprintf('<span class="tc-lead tc-warning">'. __( 'REQUIRED', 'theme-check' ) . '</span>: ' . __( 'Found %1$s in the file %2$s. %3$s. %4$s', 'theme-check' ), '<strong>' . $error . '</strong>', '<strong>' . $filename . '</strong>', $check, $grep );
 88 |                     $ret = false;
 89 |                 }
 90 |             }
 91 |         }
 92 | 
 93 |         foreach ( $php_files as $php_key => $phpfile )
 94 |         {
 95 |             foreach ( $warn_checks as $key => $check )
 96 |             {
 97 |                 checkcount();
 98 | 
 99 |                 if ( preg_match( $key, $phpfile, $matches ) )
100 |                 {
101 |                     $filename = tc_filename( $php_key );
102 |                     $error = trim( $matches[0] );
103 |                     $grep = tc_grep( $error, $php_key );
104 |                     $this->error[] = sprintf('<span class="tc-lead tc-warning">'. __( 'WARNING', 'theme-check' ) . '</span>: ' . __( 'Found %1$s in the file %2$s. %3$s. %4$s', 'theme-check' ), '<strong>' . $error . '</strong>', '<strong>' . $filename . '</strong>', $check, $grep );
105 |                     $ret = false;
106 |                 }
107 |             }
108 |         }
109 | 
110 |         foreach ( $css_files as $php_key => $phpfile )
111 |         {
112 |             foreach ( $req_checks as $key => $check )
113 |             {
114 |                 checkcount();
115 | 
116 |                 if ( preg_match( $key, $phpfile, $matches ) )
117 |                 {
118 |                     $filename = tc_filename( $php_key );
119 |                     $error = trim( $matches[0] );
120 |                     $grep = tc_grep( $error, $php_key );
121 |                     $this->error[] = sprintf('<span class="tc-lead tc-warning">'. __( 'REQUIRED', 'theme-check' ) . '</span>: ' . __( 'Found %1$s in the file %2$s. %3$s. %4$s', 'theme-check' ), '<strong>' . $error . '</strong>', '<strong>' . $filename . '</strong>', $check, $grep );
122 |                     $ret = false;
123 |                 }
124 |             }
125 |         }
126 | 
127 |         foreach ( $css_files as $php_key => $phpfile )
128 |         {
129 |             foreach ( $warn_checks as $key => $check )
130 |             {
131 |                 checkcount();
132 | 
133 |                 if ( preg_match( $key, $phpfile, $matches ) )
134 |                 {
135 |                     $filename = tc_filename( $php_key );
136 |                     $error = trim( $matches[0] );
137 |                     $grep = tc_grep( $error, $php_key );
138 |                     $this->error[] = sprintf('<span class="tc-lead tc-warning">'. __( 'WARNING', 'theme-check' ) . '</span>: ' . __( 'Found %1$s in the file %2$s. %3$s. %4$s', 'theme-check' ), '<strong>' . $error . '</strong>', '<strong>' . $filename . '</strong>', $check, $grep );
139 |                     $ret = false;
140 |                 }
141 |             }
142 |         }
143 | 
144 |         return $ret;
145 |     }
146 |     function getError() { return $this->error; }
147 | }
148 | $themechecks[] = new Themeforest;
149 | 


--------------------------------------------------------------------------------
/checkbase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Runs checks against themes and displays the results
  4 |  *
  5 |  * Runs checks against themes and displays the results. Includes helper functions
  6 |  * for performing checks.
  7 |  *
  8 |  * @package Theme Check
  9 |  */
 10 | 
 11 | // main global to hold our checks.
 12 | global $themechecks;
 13 | $themechecks = array();
 14 | 
 15 | // counter for the checks.
 16 | global $checkcount;
 17 | $checkcount = 0;
 18 | 
 19 | // current WP_Theme being tested. Internal use only.
 20 | global $theme_check_current_theme;
 21 | $theme_check_current_theme = false;
 22 | 
 23 | // interface that all checks should implement.
 24 | interface themecheck {
 25 | 
 26 | 	// should return true for good/okay/acceptable, false for bad/not-okay/unacceptable.
 27 | 	public function check( $php_files, $css_files, $other_files );
 28 | 
 29 | 	// should return an array of strings explaining any problems found.
 30 | 	public function getError();
 31 | }
 32 | 
 33 | // load all the checks in the checks directory.
 34 | foreach ( glob( __DIR__ . '/checks/*.php' ) as $file ) {
 35 | 	include $file;
 36 | }
 37 | 
 38 | do_action( 'themecheck_checks_loaded' );
 39 | 
 40 | /**
 41 |  * Run Theme Check against a given theme.
 42 |  *
 43 |  * @param WP_Theme $theme      A WP_Theme instance.
 44 |  * @param string   $theme_slug The slug of the given theme.
 45 |  * @return bool
 46 |  */
 47 | function run_themechecks_against_theme( $theme, $theme_slug ) {
 48 | 	$files = $theme->get_files(
 49 | 		null /* all file types */,
 50 | 		-1 /* infinite recursion */,
 51 | 		true /* include parent theme files */
 52 | 	);
 53 | 	unset( $files[0] ); // Work around https://core.trac.wordpress.org/ticket/53599
 54 | 
 55 | 	$php   = array();
 56 | 	$css   = array();
 57 | 	$other = array();
 58 | 
 59 | 	foreach ( $files as $filename ) {
 60 | 		if ( strpos( $filename, 'tgm-plugin-activation' ) === false && strpos( $filename, 'class-merlin' ) === false ) {
 61 | 			if ( substr( $filename, -4 ) === '.php' ) {
 62 | 				$php[ $filename ] = file_get_contents( $filename );
 63 | 				$php[ $filename ] = tc_strip_comments( $php[ $filename ] );
 64 | 			} elseif ( substr( $filename, -4 ) === '.css' ) {
 65 | 				$css[ $filename ] = file_get_contents( $filename );
 66 | 			} else {
 67 | 				// In local development it might be useful to skip other files
 68 | 				// (non .php or .css files) in dev directories.
 69 | 				if ( apply_filters( 'tc_skip_development_directories', false ) ) {
 70 | 					if ( tc_is_other_file_in_dev_directory( $filename ) ) {
 71 | 						continue;
 72 | 					}
 73 | 				}
 74 | 				$other[ $filename ] = file_get_contents( $filename );
 75 | 			}
 76 | 		}
 77 | 	}
 78 | 
 79 | 	// Run the checks.
 80 | 	return run_themechecks(
 81 | 		$php,
 82 | 		$css,
 83 | 		$other,
 84 | 		array(
 85 | 			'theme' => $theme,
 86 | 			'slug'  => $theme_slug,
 87 | 		)
 88 | 	);
 89 | }
 90 | 
 91 | /**
 92 |  * Run the Theme Checks against a set of files.
 93 |  *
 94 |  * @param array $php     The PHP files.
 95 |  * @param array $css     The CSS files.
 96 |  * @param array $other   Any non-php/css files.
 97 |  * @param array $context Any context for the Theme Checks.
 98 |  *
 99 |  * @return bool
100 |  */
101 | function run_themechecks( $php, $css, $other, $context = array() ) {
102 | 	global $themechecks, $theme_check_current_theme;
103 | 
104 | 	// Provide context to some functions that need to know the current theme, but aren't passed the object.
105 | 	$theme_check_current_theme = isset( $context['theme'] ) ? $context['theme'] : false;
106 | 
107 | 	$pass = true;
108 | 
109 | 	tc_adapt_checks_for_fse_themes( $php, $css, $other );
110 | 
111 | 	foreach ( $themechecks as $check ) {
112 | 		if ( $check instanceof themecheck ) {
113 | 			if ( $context && is_callable( array( $check, 'set_context' ) ) ) {
114 | 				$check->set_context( $context );
115 | 			}
116 | 
117 | 			$pass = $pass & $check->check( $php, $css, $other );
118 | 		}
119 | 	}
120 | 
121 | 	$theme_check_current_theme = false;
122 | 
123 | 	return $pass;
124 | }
125 | 
126 | function display_themechecks() {
127 | 	$results = '';
128 | 	global $themechecks;
129 | 	$errors = array();
130 | 	foreach ( $themechecks as $check ) {
131 | 		if ( $check instanceof themecheck ) {
132 | 			$error = $check->getError();
133 | 			$error = (array) $error;
134 | 			if ( ! empty( $error ) ) {
135 | 				$errors = array_unique( array_merge( $error, $errors ) );
136 | 			}
137 | 		}
138 | 	}
139 | 	if ( ! empty( $errors ) ) {
140 | 		rsort( $errors );
141 | 		foreach ( $errors as $e ) {
142 | 
143 | 			if ( defined( 'TC_TRAC' ) ) {
144 | 				$results .= ( isset( $_POST['s_info'] ) && preg_match( '/INFO/', $e ) ) ? '' : '* ' . tc_trac( $e ) . "\r\n";
145 | 			} else {
146 | 				$results .= ( isset( $_POST['s_info'] ) && preg_match( '/INFO/', $e ) ) ? '' : '<li>' . tc_trac( $e ) . '</li>';
147 | 			}
148 | 		}
149 | 	}
150 | 
151 | 	if ( defined( 'TC_TRAC' ) ) {
152 | 
153 | 		if ( defined( 'TC_PRE' ) ) {
154 | 			$results = TC_PRE . $results;
155 | 		}
156 | 		$results = '<textarea cols=140 rows=20>' . wp_strip_all_tags( $results );
157 | 		if ( defined( 'TC_POST' ) ) {
158 | 			$results = $results . TC_POST;
159 | 		}
160 | 		$results .= '</textarea>';
161 | 	}
162 | 	return $results;
163 | }
164 | 
165 | function checkcount() {
166 | 	global $checkcount;
167 | 	$checkcount++;
168 | }
169 | 
170 | // some functions theme checks use.
171 | function tc_grep( $error, $file ) {
172 | 	if ( ! file_exists( $file ) ) {
173 | 		return '';
174 | 	}
175 | 	$lines      = file( $file, FILE_IGNORE_NEW_LINES ); // Read the theme file into an array.
176 | 	$line_index = 0;
177 | 	$bad_lines  = '';
178 | 	foreach ( $lines as $this_line ) {
179 | 		if ( stristr( $this_line, $error ) ) {
180 | 			$error      = str_replace( '"', "'", $error );
181 | 			$this_line  = str_replace( '"', "'", $this_line );
182 | 			$error      = ltrim( $error );
183 | 			$pos        = strpos( $this_line, $error );
184 | 			$pre        = ( false !== $pos ? substr( $this_line, 0, $pos ) : false );
185 | 			$pre        = ltrim( htmlspecialchars( $pre ) );
186 | 			$bad_lines .= "<pre class='tc-grep'>" . __( 'Line ', 'theme-check' ) . ( $line_index + 1 ) . ': ' . $pre . htmlspecialchars( substr( stristr( $this_line, $error ), 0, 75 ) ) . '</pre>';
187 | 		}
188 | 		$line_index++;
189 | 	}
190 | 	return str_replace( $error, '<span class="tc-grep">' . $error . '</span>', $bad_lines );
191 | }
192 | 
193 | function tc_preg( $preg, $file ) {
194 | 	if ( ! file_exists( $file ) ) {
195 | 		return '';
196 | 	}
197 | 	$lines      = file( $file, FILE_IGNORE_NEW_LINES ); // Read the theme file into an array.
198 | 	$line_index = 0;
199 | 	$bad_lines  = '';
200 | 	$error      = '';
201 | 	foreach ( $lines as $this_line ) {
202 | 		if ( preg_match( $preg, $this_line, $matches ) ) {
203 | 			$error     = $matches[0];
204 | 			$this_line = str_replace( '"', "'", $this_line );
205 | 			$error     = ltrim( $error );
206 | 			$pre       = '';
207 | 			if ( ! empty( $error ) ) {
208 | 				$pos = strpos( $this_line, $error );
209 | 				$pre = ( false !== $pos ? substr( $this_line, 0, $pos ) : false );
210 | 			}
211 | 			$pre        = ltrim( htmlspecialchars( $pre ) );
212 | 			$bad_lines .= "<pre class='tc-grep'>" . __( 'Line ', 'theme-check' ) . ( $line_index + 1 ) . ': ' . $pre . htmlspecialchars( substr( stristr( $this_line, $error ), 0, 75 ) ) . '</pre>';
213 | 		}
214 | 		$line_index++;
215 | 
216 | 	}
217 | 	return str_replace( $error, '<span class="tc-grep">' . $error . '</span>', $bad_lines );
218 | }
219 | 
220 | function tc_filename( $file ) {
221 | 	// If we know the WP_Theme object, we can get the exact path.
222 | 	$filename = _get_filename_from_current_theme( $file );
223 | 	if ( $filename ) {
224 | 		return $filename;
225 | 	}
226 | 
227 | 	// If the $file exists within a theme-like folder, use that.
228 | 	// Does not support themes nested in directories such as wp-content/themes/pub/wporg-themes/index.php
229 | 	if ( preg_match( '!/themes/[^/]+/(.*)$!i', $file, $m ) ) {
230 | 		return $m[1];
231 | 	}
232 | 
233 | 	// If still nothing, use the basename.
234 | 	return basename( $file );
235 | }
236 | 
237 | /**
238 |  * Get a filename relative to the current theme.
239 |  *
240 |  * @param string $file the file to get a relative filename for.
241 |  * @return false|string The filename, or false on failure.
242 |  * @access private
243 |  */
244 | function _get_filename_from_current_theme( $file ) {
245 | 	global $theme_check_current_theme;
246 | 	static $theme_files = array();
247 | 	static $theme_path  = '';
248 | 
249 | 	if ( empty( $theme_check_current_theme ) ) {
250 | 		return false;
251 | 	}
252 | 
253 | 	// Fetch the files for the theme, once per theme.
254 | 	if ( $theme_path != $theme_check_current_theme->get_stylesheet_directory() ) {
255 | 		$theme_path = $theme_check_current_theme->get_stylesheet_directory();
256 | 
257 | 		$theme_files = $theme_check_current_theme->get_files(
258 | 			null /* all file types */,
259 | 			-1 /* infinite recursion */,
260 | 			true /* include parent theme files */
261 | 		);
262 | 	}
263 | 
264 | 	return array_search( $file, $theme_files, true );
265 | }
266 | 
267 | function tc_trac( $e ) {
268 | 	$trac_left  = array( '<strong>', '</strong>' );
269 | 	$trac_right = array( "'''", "'''" );
270 | 	$html_link  = '/<a\s?href\s?=\s?[\'|"]([^"|\']*)[\'|"]>([^<]*)<\/a>/i';
271 | 	$html_new   = '[$1 $2]';
272 | 	if ( defined( 'TC_TRAC' ) ) {
273 | 		$e = preg_replace( $html_link, $html_new, $e );
274 | 		$e = str_replace( $trac_left, $trac_right, $e );
275 | 		$e = preg_replace( '/<pre.*?>/', "\r\n{{{\r\n", $e );
276 | 		$e = str_replace( '</pre>', "\r\n}}}\r\n", $e );
277 | 	}
278 | 	return $e;
279 | }
280 | 
281 | // Strip comments from a PHP file in a way that will not change the underlying structure of the file.
282 | function tc_strip_comments( $code ) {
283 | 	$strip    = array(
284 | 		T_COMMENT     => true,
285 | 		T_DOC_COMMENT => true,
286 | 	);
287 | 	$newlines = array(
288 | 		"\n" => true,
289 | 		"\r" => true,
290 | 	);
291 | 	$tokens   = token_get_all( $code );
292 | 	reset( $tokens );
293 | 	$return = '';
294 | 	$token  = current( $tokens );
295 | 	while ( $token ) {
296 | 		if ( ! is_array( $token ) ) {
297 | 			$return .= $token;
298 | 		} elseif ( ! isset( $strip[ $token[0] ] ) ) {
299 | 			$return .= $token[1];
300 | 		} else {
301 | 			for ( $i = 0, $token_length = strlen( $token[1] ); $i < $token_length; ++$i ) {
302 | 				if ( isset( $newlines[ $token[1][ $i ] ] ) ) {
303 | 					$return .= $token[1][ $i ];
304 | 				}
305 | 			}
306 | 		}
307 | 		$token = next( $tokens );
308 | 	}
309 | 	return $return;
310 | }
311 | 
312 | /**
313 |  * Used to allow some directories to be skipped during development.
314 |  *
315 |  * @param  string $filename a filename/path.
316 |  * @return boolean
317 |  */
318 | function tc_is_other_file_in_dev_directory( $filename ) {
319 | 	$skip = false;
320 | 	// Filterable List of dirs that you may want to skip other files in during
321 | 	// development.
322 | 	$dev_dirs = apply_filters(
323 | 		'tc_common_dev_directories',
324 | 		array(
325 | 			'node_modules',
326 | 			'vendor',
327 | 		)
328 | 	);
329 | 	foreach ( $dev_dirs as $dev_dir ) {
330 | 		if ( strpos( $filename, $dev_dir ) ) {
331 | 			$skip = true;
332 | 			break;
333 | 		}
334 | 	}
335 | 	return $skip;
336 | }
337 | 
338 | /**
339 |  * Adapt the Theme Checks if the theme is an experiment Full-Site Editing theme.
340 |  *
341 |  * @param array $php_files   The theme's PHP files.
342 |  * @param array $css_files   The theme's CSS files.
343 |  * @param array $other_files Any other theme files.
344 |  *
345 |  * @return bool Whether the theme checks were adapted for FSE or not.
346 |  */
347 | function tc_adapt_checks_for_fse_themes( $php_files, $css_files, $other_files ) {
348 | 	global $themechecks;
349 | 
350 | 	// Get a list of all non PHP and CSS file paths, relative to the theme root.
351 | 	$other_filenames = array();
352 | 	foreach ( $other_files as $path => $contents ) {
353 | 		$other_filenames[] = tc_filename( $path );
354 | 	}
355 | 
356 | 	// Check whether this is a FSE theme by searching for an index.html block template.
357 | 	if ( ! in_array( 'block-templates/index.html', $other_filenames, true ) && ! in_array( 'templates/index.html', $other_filenames, true ) ) {
358 | 		return false;
359 | 	}
360 | 
361 | 	// Remove theme checks that do not apply to FSE themes.
362 | 	foreach ( $themechecks as $key => $check ) {
363 | 		if ( $check instanceof Tag_Check
364 | 			|| $check instanceof Suggested_Styles_Check
365 | 			|| $check instanceof Widgets_Check
366 | 			|| $check instanceof Gravatar_Check
367 | 			|| $check instanceof Post_Pagination_Check
368 | 			|| $check instanceof Basic_Check
369 | 			|| $check instanceof Comments_Check
370 | 			|| $check instanceof Comment_Pagination_Check
371 | 			|| $check instanceof Comment_Reply_Check
372 | 			|| $check instanceof Nav_Menu_Check
373 | 			|| $check instanceof Post_Thumbnail_Check
374 | 			|| $check instanceof Theme_Support_Check
375 | 			|| $check instanceof Editor_Style_Check
376 | 			|| $check instanceof Underscores_Check
377 | 			|| $check instanceof Constants_Check
378 | 			|| $check instanceof Customizer_Check
379 | 			|| $check instanceof Post_Format_Check
380 | 			|| $check instanceof Search_Form_Check
381 | 			|| $check instanceof Theme_Support_Title_Tag_Check
382 | 			|| $check instanceof Screen_Reader_Text_Check
383 | 			|| $check instanceof Include_Check
384 | 		) {
385 | 			unset( $themechecks[ $key ] );
386 | 		}
387 | 	}
388 | 
389 | 	// Add FSE specific checks.
390 | 	$themechecks[] = new FSE_Required_Files_Check();
391 | 
392 | 	return true;
393 | }
394 | 


--------------------------------------------------------------------------------