Kontrola wtyczek (PCP)

Opis

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.

Pamiętaj, że wtyczka nie zastępuje jeszcze ręcznego procesu weryfikacji, ale może pomóc przyspieszyć proces zatwierdzania wtyczki do repozytorium wtyczek WordPress.org, a także pozwoli uniknąć niektórych typowych błędów.

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.

Instalacja

Installation from within WordPress

  1. Visit Plugins > Add New.
  2. Search for Plugin Check.
  3. Install and activate the Plugin Check plugin.

Manual installation

  1. Upload the entire plugin-check folder to the /wp-content/plugins/ directory.
  2. Visit Plugins.
  3. Activate the Plugin Check plugin.

Najczęściej zadawane pytania

Czy mogę pomóc w tworzeniu wtyczki?

Rozwój wtyczki jest obsługiwany przez GitHub, wszelkie problemy lub pull requesty proszę zgłaszać w repozytorium githuba.

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.

Dlaczego oznacza coś jako złe?

Nie oznacza to „złych” rzeczy jako takich. Sprawdzanie wtyczek zostało zaprojektowane jako niedoskonały sposób testowania zgodności z wytycznymi dotyczącymi przeglądu wtyczek. Nie wszystkie wtyczki muszą być zgodne z tymi wytycznymi. Celem narzędzia sprawdzającego jest zapewnienie, że wtyczki przesłane do centralnego repozytorium wtyczek WordPress.org spełniają najnowsze standardy wtyczek WordPress i będą działać w wielu różnych witrynach.

Wiele witryn korzysta z własnych wtyczek i jest to całkowicie w porządku. Ale wtyczki, które są przeznaczone do użytku na wielu różnych rodzajach witryn przez społeczeństwo, muszą osiągnąć pewien minimalny poziom, aby zapewnić prawidłowe funkcjonowanie w wielu różnych środowiskach. Wytyczne Plugin Review zostały stworzone z myślą o tym celu.

Proces sprawdzania wtyczek nie jest doskonały i nigdy nie będzie. Jest to tylko narzędzie pomagające autorom wtyczek lub każdemu, kto chce zwiększyć możliwości swojej wtyczki. Wszystkie wtyczki przesłane do WordPress.org są ręcznie sprawdzane przez zespół ekspertów. Automatyczny tester wtyczek ma być jedynie użytecznym narzędziem, a nie absolutnym systemem pomiaru.

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 any case, passing the checks in this tool likely helps to achieve a smooth plugin review process, but is no guarantee that a plugin will be approved in the WordPress.org plugin directory.

Recenzje

2024-03-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-02-14 3 odpowiedzi
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.
Przeczytaj 12 recenzji

Kontrybutorzy i deweloperzy

„Kontrola wtyczek (PCP)” jest oprogramowaniem open source. Poniższe osoby miały wkład w rozwój wtyczki.

Zaangażowani

Wtyczka „Kontrola wtyczek (PCP)” została przetłumaczona na 11 języków. Podziękuj tłumaczom za ich wkład.

Przetłumacz wtyczkę “Kontrola wtyczek (PCP)” na swój język.

Interesuje cię rozwój wtyczki?

Przeglądaj kod, sprawdź repozytorium SVN lub czytaj dziennik rozwoju przez RSS.

Rejestr zmian

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

  • Usprawnienie – yżycie wersji 3.8.0 biblioteki PHP_CodeSniffer, odchodząc od squizlabs/PHP_CodeSniffer na rzecz PHPCSStandards/PHP_CodeSniffer.
  • Poprawka – sprawdzenie czy wtyczka działa zgodnie z oczekiwaniami w środowisku WP playground, aby umożliwić recenzentom korzystanie z PCP. Podziękowania dla @tellyworth.
  • Poprawka – niezdefiniowany klucz tablicy „argv” podczas uruchamiania sprawdzania wtyczki w niektórych środowiskach. Podziękowania dla @afragen. #340.

0.2.2

  • Ulepszenie – włączono obsługę serwerów Windows.
  • Ulepszenie – unikaj bezpośredniego korzystania z PHP CLI, co umożliwia programistom wtyczek korzystanie z PCP w różnych nowych środowiskach.
  • Poprawka – usunięto zależności od funkcji shell_exec i exec, co umożliwia twórcom wtyczek korzystanie z PCP w różnych nowych środowiskach.
  • Poprawka – naprawiono problemom z ostrzeżeniem parsera Readme związanym z contributor_ignored podczas uruchamiania sprawdzania poza WP.org. Podziękowania dla @dev4press. #276.
  • Poprawka – usunięto dodatkową kropkę na końcu zdania dla ostrzeżenia phar. Podziękowania dla @pixolin. #275.

0.2.1

  • Dodano odnośnik „Wyświetl w edytorze kodu” pod każdym błędem lub ostrzeżeniem PHPCS. Props @EvanHerman, @westonruter, @felixarntz, @mukeshpanchal27 #262.
  • Poprawka – upewnij się, że readme.txt ma priorytet nad readme.md, gdy oba są obecne. Props @bordoni, @afragen #258.
  • Poprawka – upewnij się, że sprawdzanie PHPCS działa nawet wtedy, gdy plik binarny PHPCS nie jest wykonywalny. Props @bordoni, @shawn-digitalpoint, @mrfoxtalbot #254.
  • Poprawka – zmiany w Readme i literówki. Props @aaronjorbin. #261.
  • Poprawka – długie linie kodu ze sprawdzaniem PHPCS nie rozszerzają się już ponad rozmiar powiadomienia. Props @bordoni, @felixarntz. #263.
  • Poprawka – upewnij się, że mamy zgodność z PHP 7.2, usuń końcowy przecinek. Props @bordoni, @leoloso. #265.
  • Poprawka – uwzględnij wszystkie ciągi, które zostały pominięte w poprzedniej wersji. Props @bordoni, @pixolin. #270.

0.2.0

  • Funkcja – dodano modyfikację ścieżki binarnej PHP używanej przez wtyczkę za pomocą stałej PLUGIN_CHECK_PHP_BIN.
  • Funkcja – dołączono sprawdzanie użycia ALLOW_UNFILTERED_UPLOADS w dowolnych plikach PHP – Podziękowania dla EvanHermana at #45.
  • Funkcja – dodano sprawdzanie obecności plików aplikacji (.a, .bin, .bpk, .deploy, .dist, .distz, .dmg, .dms, .DS_Store, .dump, .elc, .exe, .iso, .lha, .lrf, .lzh, .o, .obj, .phar, .pkg, .sh, ’.so`) – Podziękowania dla EvanHermana at #43.
  • Funkcja – dodano sprawdzanie obecności pliku readme.txt lub readme.md – Podziękowanie dla EvanHermana na #42.
  • Poprawka – sprawdzenie, że parsowanie pliku readme jest włączone poprawnie, gdy obecny jest plik readme.md lub readme.txt. Podziękowania dla Bordoni #52.
  • Usprawnienie – wyłącz funkcje move_uploaded_file, passthru, proc_open – Podziękowania dla alexsanford w #50.
  • Ulepszenie – zmieniono typ wiadomości dotyczący korzystania z funkcji, które WordPress już zawiera, z ostrzeżenia na błąd. P{odziękowania dla Davidperezgar #18
  • Ulepszenie – zmień typ komunikatu dla nieprawidłowego użycia tagu Stable z Powiadomienie/Ostrzeżenie na Błąd. Podziękowania dla davidperezgar w #3.

[0.1] 2011-09-04

Oryginalna wersja narzędzia do sprawdzania wtyczek, a nie wydana wersja wtyczki, a dziennik zmian jest tutaj tylko do celów historycznych.