Just another contact form plugin. Simple but flexible.
About Plugin Check (PCP)
Plugin Check is a tool that helps you test if your plugin meets the standards required for the WordPress.org plugin directory, flagging any violations or concerns related to plugin development best practices. You can run checks through the WP Admin interface or WP-CLI, allowing you to customize which types of checks to perform. While it can't replace manual review, Plugin Check can assist in speeding up the approval process for the WordPress.org repository and help you avoid common mistakes, even if you don't plan to host your plugin there.Changelog
1.5.0
- Enhancement – Improve url validation to check duplicate protocol.
- Enhancement – Update severity for incorrect textdomains and i18n error codes.
- Enhancement – Now issues in URL Author check are ERROR instead of WARNING.
- Enhancement – New check for minor version in Tested up.
- Enhancement – Make sure headers are not empty in the requires header check.
- Enhancement – Include experimental option in admin.
- Enhancement – Add Behat test for experimental checks from addons.
- Enhancement – Improve license check for Apache.
- Enhancement – Warn if requires headers are not same in readme and plugin header.
- Fix – Remove warning for dynamic callback in register_setting check.
- Fix – Incorrect database tables being referenced on subsites in Multisite.
1.4.0
- Enhancement – Allow ISC license in the License check.
- Enhancement – Added check for use of settings with sanitization callback.
- Enhancement – Added –ignore-codes in CLI to introduce a mechanism to ignore specific error codes.
- Enhancement – New utils for fetching necessary version info details.
- Enhancement – Added check for unsupported plugin name in plugin header field.
- Enhancement – Segregate the severity of i18n checks. Make sure that is giving errors in the right context.
- Enhancement – Provide more detailed information about checks when the README does not include a tested version or a list of contributors.
- Enhancement – Added rules from WPCS to prevent issues with content being sent before headers and warn about the use of Call-time pass-by-reference.
- Enhancement – Give more context in the error of check wrong named files.
- Enhancement – Simplified PHPUnit setup. Now it does not depend of running inside a WordPress installation.
- Enhancement – Added new check for restricted contributors.
- Fix – Delete transients in unit tests to avoid false positives.
- Fix – Incorrect Tested up to version comparison will make error for two major versions up.
- Fix – Excluded the use of functions file_get_contents and file_put_contents in the check to prevent false positives.
- Fix – Duplicated error message in the check for wrong named files.
- Fix – Use of Json encode wasn’t firing the error message.
- Fix – Change error type of NonEnqueuedImage in ImageFunctions sniff from ERROR to WARNING.
1.3.1
- Enhancement – Add version utilities.
- Fix – Escape error messages.
- Fix – Renamed error type to ERROR_LOW_SEVERITY and WARNING_LOW_SEVERITY.
- Fix – Fix PHPCS checks on unwritable filesystems.
1.3.0
- Enhancement – Update disallowed domains for Plugin URI check.
- Enhancement – Added new checks for Plugin Header fields: missing plugin description, missing plugin version and invalid plugin version.
- Enhancement – New check for validation of donate link in the readme file.
- Enhancement – Increased severity for wrong Plugin Requires.
- Enhancement – Added check Restrict parse_str() without second argument.
- Enhancement – New check for Disallow usage of HEREDOC and NOWDOC.
- Enhancement – Added acronyms allowed in Trademark checks.
- Enhancement – Added option in CLI to add low severity errors and warnings.
- Enhancement – Change error type for License check error codes.
- Enhancement – Always use prefixed tables during runtime check requests.
- Enhancement – Created a new class for checking licenses.
- Enhancement – Added support for MPL-2.0 license.
- Enhancement – Implement gherkin linter in GH action.
- Enhancement – Update check for Contributors in markdown readme files.
- Enhancement – CLI: Fix confusing runtime environment setup order.
- Enhancement – Allow custom checks to provide installed_paths.
- Enhancement – Improved the use of localhost URLs in the Plugin.
- Enhancement – Documented checks in the plugin.
- Enhancement – Increased severity for Code obfuscation checks.
- Enhancement – Diffentiate between no existent readme and default readme file.
- Enhancement – Encourage developers to use native functions for loading images in templates.
- Enhancement – Added a check for not allowing include libraries already in WordPress core.
- Enhancement – Warning for usage of query_posts() in favor of WP_Query.
- Fix – Fix for the local environment is set up before testing.
- Fix – Fix addon checks not being executed when running runtime checks.
- Fix – Allow
defaultas a text domain in the text domain check. - Fix – Allow GitHub URLs in the Plugin URI field.
- Fix – Don’t flag Apache license. It’s allowed in the WordPress.org plugin repository.
- Fix – Removes the path before the plugin, so it won’t affect to badly named files.
1.2.0
- Enhancement – Added a check for badly used names in files.
- Enhancement – Increased severity for
BacktickOperator,DisallowShortOpenTag,DisallowAlternativePHPTags,RestrictedClasses, andRestrictedFunctions. - Enhancement – Added security checks to the Plugin repository category.
- Enhancement – Allowed
runtime-setin code sniffer checks. - Enhancement – Changed warnings to errors in plugin header checks.
- Enhancement – Detect forbidden plugin headers such as repository URIs in the Directory.
- Enhancement – Added a new check for development functions that are not allowed in final plugins.
- Enhancement – Created new images and icons for the plugin.
- Enhancement – Introduced a slug argument in the CLI.
- Enhancement – Added a check for discouraged PHP functions.
- Enhancement – Added validation for Contributors in the readme file.
- Enhancement – Added a warning for mismatched plugin names in the plugin header and readme file.
- Enhancement – Checked for validation of Plugin Header fields: Name, Plugin URI, Description, Author URI, Requires at least, Requires PHP, and Requires Plugins.
- Enhancement – Added a warning if the “Tested up to” value in the readme file exceeds the released version of WordPress.
- Fix – Display a success message if no errors or warnings are found.
- Fix – Made table results responsive.
- Fix – Prevent proceeding to the next check if the Stable Tag value is set to
trunk. - Fix – Allow runtime initialization even when only add-on checks are requested.
- Fix – Fixed an SPDX warning for the
GPL version 3license. - Fix – Prevent runtime checks in the CLI context when they cannot be used.
1.1.0
- Feature – New
Non_Blocking_Scripts_Check(non_blocking_scripts) runtime check to warn about enqueued scripts that use neitherdefernorasync. - Enhancement – Changed the namespace of included checks.
- Enhancement – Introduced severity levels for all errors and warnings.
- Enhancement – CLI: Support checking a plugin from a path or URL.
- Enhancement – Added short descriptions and URLs for each check.
- Enhancement – Improved messaging in check results.
- Enhancement – Updated code obfuscation check with more accurate results.
- Enhancement – Updated plugin review check to flag missing input sanitization (
WordPress.Security.ValidatedSanitizedInput). - Fix – Improve readme checks to exclude invalid files.
- Fix – Only show edit link if files are actually editable.
1.0.2
- Feature – New
Enqueued_Scripts_Scope_Check(enqueued_scripts_scope),Enqueued_Styles_Size_Check(enqueued_styles_size) andEnqueued_Resources_Check(enqueued_resources) performance checks. - Enhancement – Improved readme check and added a new
wp_plugin_check_ignored_readme_warningsfilter. - Enhancement – New
wp_plugin_check_default_categoriesfilter to change the categories which are selected by default. - Enhancement – New
wp_plugin_check_ignore_filesfilter to allow ignoring specific files. - Fix – Correct detection of readme files in Windows by normalizing file paths.
1.0.1
- Fix – Add missing
test-contentfolder needed for runtime checks. - Fix – Do not send emails when setting up test environment.
- Fix – Prevent PHP warning when the
argvvariable isn’t set.
1.0.0
- Feature – Complete overhaul of the plugin, its architecture, and all checks.
- Feature – Added new WP-CLI commands for running checks and listing available options.
- Enhancement – Added option to only run checks for a specific category.
0.2.3
- Tweak – Use version 3.8.0 of the PHP_CodeSniffer library, moving away from
squizlabs/PHP_CodeSnifferto usePHPCSStandards/PHP_CodeSniffer. - Fix – Ensure the plugin works as expected on the WP playground environment to enable reviewers to use PCP. Props @tellyworth.
- Fix – Undefined array key “argv” when running the plugin check in certain environments. Props @afragen. #340
0.2.2
- Enhancement – Include support for Windows Servers.
- Enhancement – Avoid using PHP CLI directly, which enables plugin developers to use PCP in a variety of new environments.
- Fix – Remove dependency on
shell_execandexecfunctions, which enables plugin developers to use PCP in a variety of new environments. - Fix – Prevent problems with Readme parser warning related to
contributor_ignoredfor when running the check outside WP.org. Props @dev4press. #276 - Fix – Remove extra period on the end of the sentence for Phar warning. Props @pixolin. #275
0.2.1
- Added – ‘View in code editor’ link beneath each PHPCS error or warning. Props @EvanHerman, @westonruter, @felixarntz, @mukeshpanchal27 #262
- Fix – Ensure
readme.txthas priority overreadme.mdwhen both are present. Props @bordoni, @afragen #258 - Fix – Ensure that the PHPCS check runs even when the PHPCS binary is not executable. Props @bordoni, @shawn-digitalpoint, @mrfoxtalbot #254
- Fix – Readme changes and typos. Props @aaronjorbin. #261
- Fix – Long lines of code with PHPCS check no longer expand over the size of the notice. Props @bordoni, @felixarntz. #263
- Fix – Ensure that we have PHP 7.2 compatibility remove trailing comma. Props @bordoni, @leoloso. #265
- Fix – Include all strings that were missed in the previous release. Props @bordoni, @pixolin. #270
0.2.0
- Feature – Enable modification of the PHP Binary path used by the plugin with
PLUGIN_CHECK_PHP_BINconstant. - Feature – Include a check for the usage of
ALLOW_UNFILTERED_UPLOADSon any PHP files – Props EvanHerman at #45 - Feature – Include a check for the presence of the application files (
.a,.bin,.bpk,.deploy,.dist,.distz,.dmg,.dms,.DS_Store,.dump,.elc,.exe,.iso,.lha,.lrf,.lzh,.o,.obj,.phar,.pkg,.sh, ‘.so`) – Props EvanHerman at #43 - Feature – Include a check for the presence of the readme.txt or readme.md file – Props EvanHerman at #42
- Fix – Ensure that Readme parsing is included properly when a readme.md or readme.txt file is present. Props Bordoni #52
- Tweak – Disallow functions
move_uploaded_file,passthru,proc_open– Props alexsanford at #50 - Tweak – Change the message type for using functions WordPress already includes from Warning to Error. Props davidperezgar at #18
- Tweak – Change the message type for incorrect usage of Stable tag from Notice/Warning to Error. Props davidperezgar at #3
[0.1] 2011-09-04
Original version of the plugin check tool, not a released version of the plugin, this changelog is here for historical purposes only.
