wp stubs

WordPress Stubs

Dieses Repo enthält automatisch generierte WordPress-Stubs, die mit statischen Analysewerkzeugen verwendet werden sollen.

FAQ

• Warum anstelle von "<hier ein Projekt einfügen" hier>?

Der Zweck dieses Projekts ist:

• Mehrere Versionen von WP in derselben Zweigstelle/Version haben
• keine Stubs für Global haben, sondern Stubs für Konstanten haben
• eine super-einfache "Override" -Methode haben. Durch die Deklarierung von Stubs in der Datei fixtures.php ist es möglich, die WordPress -Erklärung für Funktionen, Klassen und Schnittstellen zu überschreiben. Auf diese Weise ist es einfach, falsche Docblocks in WordPress zu beheben und "erweiterte" Dokumentblock zu verwenden, der von statischen Analysatoren unterstützt wird (denken Sie an Array -Form, Typ Aliase, bedingte Rückgabetypen…)

Wie das funktioniert

Jeden Tag ruft ein GitHub Action Workflow die WP.org -API auf, um neue WordPress -Versionen zu finden.

Wenn es neue Versionen findet, generiert und spart es Stubs für sie (mit https://github.com/php-stubs/generator), während gleichzeitig der "neueste" Stub aktualisiert wird.

Wie man benutzt

Die primäre Verwendung gilt für statische Analyse -Tools, beispielsweise Psalm:

Methode 1: Holen Sie sich alle WordPress -Versionen

Schritte:

1. Fordern Sie dieses Projekt ( inpsyde/wp-stubs ) in der Immobilie Ihres Komponisten "require-dev"
2. Erstellen Sie eine psalm.xml -Konfigurationsdatei (siehe Dokumente)
3. Fügen Sie in der Psalm -Konfiguration folgende Zeilen hinzu:

   < stubs >
       < file name = " vendor/inpsyde/wp-stubs/stubs/latest.php " />
   </ stubs >

Sie können latest.php durch eine bestimmte WP -Version ersetzen. Siehe die verfügbaren Versionen im Verzeichnis /stubs .

Hinweis : In diesem Ordner bedeutet eine zweistellige Versionsnummer wie 5.9 nicht unbedingt WordPress Version 5.9 , sondern die neueste in der Serie 5.9.* . Wenn Sie also Composer verwenden, um WordPress zu benötigen und eine Anforderung wie 5.9.* Die Verwendung der stubs/5.9.php -Stubs -Datei stimmt mit der aktuell installierten Version überein.

Der Ordner "Stubs" enthält Stubs vieler Versionen, damit Sie wählen können, aber es wäre auch möglich, ein CI -Skript zu haben, das verschiedene Versionen lädt, um sie gegen verschiedene Stubs zu testen.

Die Paketgröße kann jedoch enorm werden, und wenn sie nicht von der Analyse von IDE ausgeschlossen ist, kann dies die IDE -Leistung beeinflussen.

Methode 2: Holen Sie sich eine bestimmte Version

Voraussetzung:

Deklarieren Sie in Ihrem composer.json ein solches Repository:

{
  "repositories" : [
    {
      "type" : " composer " ,
      "url" : " https://raw.githubusercontent.com/inpsyde/wp-stubs/main " ,
      "only" : [
        " inpsyde/wp-stubs-versions "
      ]
    }
  ]
}

Hinweis für Inpsyde -Entwickler : Die Inpsyde -Organisation im privaten Packagisten spiegelt das obige Repository wider. Für die privaten Repositories von Inpsyde ist dies wahrscheinlich nicht erforderlich, wenn man bedenkt, dass der private Packagiker wahrscheinlich bereits zum Repo composer.json hinzugefügt wird.

Schritte:

1. Erfordern Sie das "Versioned" -Projekt in der Eigenschaft Ihres Komponisten "require-dev" z { "require": { "inpsyde/wp-stubs-versions": "dev-latest" } } . (Beachten Sie, wie der Paketname -versions angehängt ist)
2. Erstellen Sie eine psalm.xml -Konfigurationsdatei (siehe Dokumente)
3. Fügen Sie in der Psalm -Konfiguration folgende Zeilen hinzu:

   < stubs >
       < file name = " vendor/inpsyde/wp-stubs-versions/latest.php " />
   </ stubs >

Mit diesem Ansatz ist die neueste Version die einzige Version des Komponisten.

Mindestanforderungen

Der Code, der die Stubs generiert, erfordert PHP 8.0+. Beim Verbrauch des Pakets gibt es jedoch keine Mindestanforderungen, außer dass es WordPress ausführen kann.

Lizenz

Dieses Repository ist eine kostenlose Software und wird unter den Bedingungen der MIT -Lizenz veröffentlicht. Siehe Lizenz für die vollständige Lizenz.