Plugin Check (PCP)

説明

Plugin Check は、プラグインが WordPress.org プラグインディレクトリの必要な基準を満たしているかどうかをテストするツールです。このプラグインを使用すると、プラグイン新規登録申請時に使用されるほとんどのチェックを実行し、プラグインが要件を満たしているかどうかを確認できます。

さらに、このツールは、国際化機能の正しい使用法などの基本要件から、アクセシビリティ、パフォーマンス、セキュリティのベストプラクティスに至るまで、プラグイン開発のベストプラクティスに関する違反や懸念を警告します。

チェックは、WP Admin ユーザーインターフェイスまたは WP-CLI を使用して実行できます。

  • WP Admin を使用してプラグインを確認するには、ツール > Plugin Checkに移動してください。その画面にアクセスするには、サイト上のプラグインを管理できる必要があります。
  • To check a plugin using WP-CLI, please use the wp plugin check command. For example, to check the “Hello Dolly” plugin: wp plugin check hello.php
    • WP-CLI を使用する場合、デフォルトでは静的チェックのみが実行できることに注意してください。ランタイム チェックも含めるには、現在、WP-CLI の --require 引数を使用して、プラグイン チェッカー内に cli.php ファイルを手動でロードする回避策が必要です。WordPress がロードされる前のディレクトリ。 例:wp plugin check hello.php --require=./wp-content/plugins/plugin-check/cli.php

チェックはいくつかのカテゴリにグループ化されているため、プラグインで実行するチェックの種類をカスタマイズできます。

このプラグインは手動レビュープロセスに代わるものではありませんが、プラグインを WordPress.org プラグインリポジトリに承認するプロセスをスピードアップするのに役立ち、また、いくつかのよくある間違いを回避するのにも役立ちます。

WordPress.org ディレクトリでプラグインをホストするつもりがない場合でも、プラグインが WordPress プラグインの基本要件とベストプラクティスに従っていることを確認するために、Plugin Check を使用することをお勧めします。

インストール

WordPress 内からのインストール

  1. プラグインの新規追加にアクセスします。
  2. Plugin Check の検索
  3. Plugin Check プラグインをインストールして有効化します。

手動インストール

  1. plugin-check フォルダーを /wp-content/plugins/ ディレクトリにアップロードします。
  2. プラグインにアクセス
  3. Plugin Check プラグインを有効化します。

FAQ

どこでプラグインに貢献できますか ?

このプラグインの開発はすべて GitHub 経由で処理され、問題やプルリクエストはそこに投稿される必要があります。

プラグインが正しいものを「エラー」または「警告」として報告した場合はどうなりますか?

私たちは誤検知を最小限に抑える方法でプラグインを作成するよう努めていますが、それらを見つけた場合は、GitHub リポジトリで報告してください。PHPCodeSniffer によって検出されるものなど、特定の誤検知については、コードに注釈を付けて、特定の行の特定の問題を無視できる場合があります。

なぜ何かが悪いこととしてフラグを立てるのでしょうか ?

それ自体は「悪い」ものとしてフラグを立てているわけではありません。Plugin Check は、プラグインレビューガイドラインへの準拠をテストする完全ではない方法として設計されています。すべてのプラグインがこれらのガイドラインに従う必要があるわけではありません。チェックツールの目的は、WordPress.org プラグインリポジトリにアップロードされたプラグインが WordPress プラグインの最新基準を満たしていることを確認し、幅広いサイトで活躍してくれる事です。

多くのサイトではカスタムプラグインが使用されていますが、それはまったく問題ありません。しかし、一般の人々がさまざまな種類のサイトで使用することを目的としたプラグインは、さまざまな環境で適切に機能するために、一定の最低限の機能を備えている必要があります。プラグインレビューのガイドラインは、その目標を念頭に置いて作成されています。

このプラグインチェッカーは完璧ではありませんし、今後も完璧ではありません。これは、プラグインの作成者、またはプラグインの機能をさらに高めたいと考えている人を支援するためのツールにすぎません。WordPress.org に送信されたすべてのプラグインは、専門家チームによって手作業でレビューされます。自動プラグインチェッカーは、有用なツールのみを目的としており、絶対的な測定システムではありません。

プラグインが WordPress.org プラグインディレクトリで承認されるためには、すべてのチェックに合格する必要がありますか?

WordPress.org プラグイン ディレクトリで承認されるには、通常、プラグインは「プラグインリポジトリ」カテゴリーのすべてのチェックに合格する必要があります。その他のチェックは追加的なものであり、合格する必要がない場合もあります。

いずれの場合でも、このツールのチェックに合格すると、プラグインのレビュープロセスがスムーズに進む可能性がありますが、プラグインが WordPress.org プラグインディレクトリで承認されるという保証はありません。

評価

2024年3月30日
This tool is very useful, not just for developers.Since finding it, I use it to test any new plugins I want to use.I have had good responses from plugin author’s when contacting them to resolve matters.
2024年2月14日 3 replies
Very helpful. Nevertheless I would have expected that you have run the check on your own plugin and fixed all errors. Errors should be automatically priorized by severity in future versions, e.g.: blocker, critical, major, minor, trivial.
12件のレビューをすべて表示

貢献者と開発者

Plugin Check (PCP) はオープンソースソフトウェアです。以下の人々がこのプラグインに貢献しています。

貢献者

“Plugin Check (PCP)” は11ロケールに翻訳されています。 翻訳者のみなさん、翻訳へのご協力ありがとうございます。

“Plugin Check (PCP)” をあなたの言語に翻訳しましょう。

開発に興味がありますか ?

コードを閲覧するか、SVN リポジトリをチェックするか、開発ログRSS で購読してみてください。

変更履歴

1.0.1

  • Fix – Add missing test-content folder needed for runtime checks.
  • Fix – Do not send emails when setting up test environment.
  • Fix – Prevent PHP warning when the argv variable 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_CodeSniffer to use PHPCSStandards/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_exec and exec functions, which enables plugin developers to use PCP in a variety of new environments.
  • Fix – Prevent problems with Readme parser warning related to contributor_ignored for 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.txt has priority over readme.md when 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_BIN constant.
  • Feature – Include a check for the usage of ALLOW_UNFILTERED_UPLOADS on 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.