Plugin Check (PCP)

Descrizione

Plugin Check is a tool for testing whether your plugin meets the required standards for the WordPress.org plugin directory. With this plugin you will be able to run most of the checks used for new submissions, and check if your plugin meets the requirements.

Additionally, the tool flags violations or concerns around plugin development best practices, from basic requirements like correct usage of internationalization functions to accessibility, performance, and security best practices.

The checks can be run either using the WP Admin user interface or WP-CLI:

  • To check a plugin using WP Admin, please navigate to the Tools > Plugin Check menu. You need to be able to manage plugins on your site in order to access that screen.
  • 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
    • Note that by default when using WP-CLI, only static checks can be executed. In order to also include runtime checks, a workaround is currently necessary using the --require argument of WP-CLI, to manually load the cli.php file within the plugin checker directory before WordPress is loaded. For example: wp plugin check hello.php --require=./wp-content/plugins/plugin-check/cli.php

The checks are grouped into several categories, so that you can customize which kinds of checks you would like to run on a plugin.

Tieni presente che questo plugin non sostituisce ancora il processo di revisione manuale, ma ti aiuterà ad accelerare il processo di approvazione del tuo plugin per il repository dei plugin di WordPress.org e ti aiuterà anche a evitare alcuni errori comuni.

Even if you do not intend to host your plugin in the WordPress.org directory, you are encouraged to use Plugin Check so that your plugin follows the base requirements and best practices for WordPress plugins.

Installazione

Installazione da WordPress

  1. Visita Plugin > Aggiungi nuovo.
  2. Cerca Plugin Check.
  3. Installa e attiva il plugin Plugin Check.

Installazione manuale

  1. Carica l’intera cartella plugin-check nella directory /wp-content/plugins/.
  2. Visita Plugin.
  3. Attiva Plugin Check.

FAQ

Dove posso contribuire al progetto del plugin?

Tutto lo sviluppo di questo plugin viene gestito tramite GitHub, eventuali problemi o richieste pull devono essere pubblicati lì.

What if the plugin reports something that’s correct as an “error” or “warning”?

We strive to write a plugin in a way that minimizes false positives but if you find one, please report it in the GitHub repo. For certain false positives, such as those detected by PHPCodeSniffer, you may be able to annotate the code to ignore the specific problem for a specific line.

Perché lo segnala come errato?

Non segnala necessariamente cose “negative”. Il controllo del plugin è progettato per essere un modo non perfetto per verificare la conformità alle linee guida per la revisione dei plugin. Non tutti i plugin devono attenersi a queste linee guida. Lo scopo dello strumento di controllo è garantire che i plugin caricati nel repository centrale dei plugin di WordPress.org rispettino gli standard più recenti dei plugin di WordPress e funzionino su una vasta gamma di siti.

Molti siti utilizzano plugin personalizzati, e questo va benissimo. Ma i plugin destinati all’uso su molti diversi tipi di siti da parte del pubblico devono avere un certo livello minimo di funzionalità, al fine di garantirne il corretto funzionamento in molti ambienti diversi. Le linee guida per la revisione dei plugin sono create con questo obiettivo in mente.

Questo strumento di verifica dei plugin non è perfetto e non lo sarà mai. È solo uno strumento per aiutare chi sviluppa i plugin o chiunque desideri rendere il proprio plugin più completo. Tutti i plugin inviati a WordPress.org sono sottoposti a una revisione manuale da parte di un team di esperti. Il controllore automatico dei plugin è pensato solo come uno strumento utile, non come un sistema di misurazione assoluto.

Does a plugin need to pass all checks to be approved in the WordPress.org plugin directory?

To be approved in the WordPress.org plugin directory, a plugin must typically pass all checks in the “Plugin repo” category. Other checks are additional and may not be required to pass.

In ogni caso, superare i controlli in questo strumento probabilmente aiuta a ottenere un processo di revisione dei plugin fluido, ma non garantisce che un plugin venga approvato nella directory dei plugin di WordPress.org.

Recensioni

30 Marzo 2024
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.
14 Febbraio 2024 3 risposte
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.
Leggi tutte le recensioni di 12

Contributi e sviluppo

“Plugin Check (PCP)” è un software open source. Le persone che hanno contribuito allo sviluppo di questo plugin sono indicate di seguito.

Collaboratori

“Plugin Check (PCP)” è stato tradotto in 11 lingue. Grazie ai traduttori per i loro contributi.

Traduci “Plugin Check (PCP)” nella tua lingua.

Ti interessa lo sviluppo?

Esplora il codice segui il repository SVN, segui il log delle modifiche tramite RSS.

Changelog (registro delle modifiche)

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

  • Aggiunta – Link ‘Visualizza nell’editor del codice’ sotto ciascun errore o avvertimento PHPCS. Crediti a @EvanHerman, @westonruter, @felixarntz, @mukeshpanchal27 #262
  • Fix – Assicurarsi che readme.txt abbia la priorità su readme.md quando entrambi sono presenti. Crediti a @bordoni, @afragen #258
  • Fix – Assicurarsi che il controllo PHPCS venga eseguito anche quando il binario PHPCS non è eseguibile. Crediti a @bordoni, @shawn-digitalpoint, @mrfoxtalbot #254
  • Fix – Modifiche al README e correzione di errori di battitura. Crediti a @aaronjorbin. #261
  • Fix – Le lunghe righe di codice con il controllo PHPCS non si espandono più oltre le dimensioni dell’avviso. Crediti a @bordoni, @felixarntz. #263
  • Fix – Assicurati di avere la compatibilità con PHP 7.2 e rimuovi la virgola finale. Crediti a @bordoni, @leoloso. #265
  • Fix – Includi tutte le stringhe che erano state trascurate nella precedente versione. Crediti a @bordoni, @pixolin. #270

0.2.0

  • Funzionalità – Abilita la modifica del percorso binario PHP utilizzato dal plugin con la costante PLUGIN_CHECK_PHP_BIN.
  • Funzionalità – Include una verifica dell’uso di ALLOW_UNFILTERED_UPLOADS su qualsiasi file PHP – Crediti a EvanHerman su #45
  • Funzionalità: include un controllo per la presenza dei file dell’applicazione (.a, .bin, .bpk, .deploy, .dist, .distz, .dmg, .dms, .DS_Store, .dump, .elc, .exe, .iso, .lha, .lrf, .lzh, .o, .obj, .phar, .pkg, .sh, '.so`) - sostiene EvanHerman su #43
  • Funzionalità - Includere un controllo per la presenza del file readme.txt o readme.md - Crediti a EvanHerman su #42
  • Fix - Controllo che l'analisi del file Readme sia inclusa correttamente quando è presente un file readme.md o readme.txt. Crediti a Bordoni su #52
  • Modifica - Vietare le funzioni move_uploaded_file, passthru, proc_open - Crediti a alexsanford su #50
  • Modifica - Cambia il tipo di messaggio per l'uso di funzioni già incluse da WordPress da Avviso a Errore. Crediti a davidperezgar su #18
  • Modifica - Cambia il tipo di messaggio per l'uso errato della 'Stable tag' da Notifica/Avviso a Errore. Crediti a davidperezgar su #3

[0.1] 2011-09-04

Versione originale dello strumento di controllo del plugin, non una versione rilasciata del plugin, questo changelog è qui solo per scopi storici.