phpstan wordpress

Wichtig

Hallo zusammen! Dies ist Viktor, der diese Phpstan -Erweiterung betreibt. Ich habe vor, nicht mehr zum WordPress -Ökosystem beizutragen, da es extrem schwierig ist und niemand mich bittet, mich seinem Team anzuschließen, da ich ein Denker, eine DevOps -Person, ein Werkzeughersteller (kein Bauunternehmer) bin.

Bitte unterstützen Sie meine Arbeit, um zu vermeiden, dieses Paket aufzugeben.

Danke schön!

WordPress -Erweiterungen für Phpstan

Statische Analyse für das WordPress -Ökosystem.

• Phpstan
• WordPress

Merkmale

• Ermöglicht Phpstan, WordPress -Plugins und Themen zu analysieren.
• Lädt das Paket php-stubs/wordpress-stubs .
• Bietet dynamische Rückgabetyp-Erweiterungen für Funktionen, die nicht in php-stubs/wordpress-stubs behandelt werden
• Definiert einige WordPress -Kernkonstanten.
• Validiert optionale docBlocks vor apply_filters() und do_action() , die den Typ des ersten @param als endgültig behandeln.

Anforderungen

• Phpstan 2.0 oder höher
• Php 7.4 oder höher (bis zu Php 8.3 getestet)

Installation

Um diese Erweiterung zu verwenden, benötigen Sie sie in Komponist:

composer require --dev szepeviktor/phpstan-wordpress

Wenn Sie auch Phpstan/Extension-Installer installieren, sind Sie alle festgelegt!

Manuelle Installation

Wenn Sie phpstan/extension-installer nicht verwenden möchten, enthalten Sie extension.neon in der Phpstan-Konfiguration Ihres Projekts:

 includes :
    - vendor/szepeviktor/phpstan-wordpress/extension.neon 

Konfiguration

Es ist kein zusätzliches Setup erforderlich. ? Konfigurieren Sie beispielsweise Phpstan - wie unten gezeigt:

 parameters :
    level : 5
    paths :
        - plugin.php
        - inc/

Weitere Informationen finden Sie in der Phpstan Config Reference.

Verwenden Sie den Composer Autoloader oder einen benutzerdefinierten Autoloader!

Verwendung

Führen Sie die Analyse mit: aus:

vendor/bin/phpstan analyze

Dann beheben Sie einen Fehler und GOTO 10 !

Sie finden weitere Informationen im examples , z. B. examples/phpstan.neon.dist

Verwendung in WooCommerce Webshops

In WooCommerce -Stubs finden Sie eine bestimmte Anleitung.

Verwendung eines apply_filters() docBlocks

Das WordPress-Ökosystem verwendet häufig PHPDOC-Docblocks auf nicht standardmäßige Weise, um Parameter zu dokumentieren, die an apply_filters() übergeben wurden. Hier ist ein Beispiel:

 /**
 * Filters the page title when creating an HTML drop-down list of pages.
 *
 * @param string  $title Page title.
 * @param WP_Post $page  Page data object.
 */
$ title = apply_filters ( ' list_pages ' , $ title , $ page );

Diese Erweiterung liest diese Docblocks und weist PHPSTAN an, den Rückgabetyp des Filters als bestimmt auf der Grundlage des ersten @param -Tags zu behandeln. In diesem Beispiel interpretiert Phpstan $title als string .

Für die besten Ergebnisse sicherstellen Sie, dass das erste @param -Tag in diesen DocBlocks korrekt ist.

Machen Sie Ihren Code prüfbar

• Schreiben Sie Clean OOP -Code: 1 Klasse pro Datei und kein zusätzlicher Code außerhalb class Name { ... } .
• Verwenden Sie eine konsistente Klassenbenennung (WPCS oder PSR-4) und speichern Sie Klassen in einem dedizierten inc/ Verzeichnis.
• Fügen Sie präzisen PHPDOC -Blöcken zu Klassen, Eigenschaften, Methoden, Funktionen und apply_filters() -Anrufen hinzu.
• Wählen Sie Ihre wichtigsten Plugin -Datei -Teile.
• Vermeiden Sie die Verwendung von Kernkonstanten und verwenden Sie Kernfunktionen.
• Vermeiden Sie schlechte PHP -Praktiken wie:
  • Funktionen: eval , extract , compact , list
  • Typ Jonglieren: $a = '15'; if ($a) ...
• Wenn Sie einen robusten Code benötigen, versuchen Sie, alle Arten vom Typ Jonglieren zu vermeiden (z. B. if Bedarf eines Booleschen), siehe variable Handhabungsfunktionen
• Vermeiden Sie es, exit_error in WP_CLI::launch oder WP_CLI::runcommand für eine verbesserte Testbarkeit zu aktivieren.

Schmutzige Ecke (FAQ)

WordPress verwendet eine bedingte Funktion und Klassendefinition, um Überschreibungen zu ermöglichen. Verwenden Sie sed -Befehl, um Funktionsstummel auszuschließen, wenn sie zuvor definiert sind.

sed -i -e ' s#function is_gd_image#function __is_gd_image# ' vendor/php-stubs/wordpress-stubs/wordpress-stubs.php