Plugin-Installationsanleitung: Von Upload bis Debugging

Generell sollte die Installation neuer Plugins sowohl stark evaluiert als auch gründlich getestet werden. Das übergeordnete Ziel ist es, so wenig wie möglich externe / Drittanbieter-Plugins zu verwenden. Dennoch lässt sich die Verwendung neuer Plugins, wenn auch nur zeitweise, nicht vermeiden. Langfristig sollte die gewünschte Funktion mit einer maßgeschneiderten Lösung bereitgestellt werden, die keine unnötigen Funktionalitäten beinhaltet.

Derzeit gibt es zwei Hauptansätze für die Installation von Plugins:

Option 1. – Klassisches WordPress-Plugin (verfügbar in der offiziellen Plugins-Bibliothek)

Option 2. – Plugins von Drittanbietern, die über Composer installiert werden können.

1. Plugin vorbereiten bzw hochladen

Option 1: Plugin repository heraussuchen

Plugin Repository auf wpackagist finden:
- Stellen Sie sicher, dass die Repository-ID in einer aktuellen Version über WPackagist verfügbar ist. Kopieren Sie diese ID inkl Versions-Nummer für den nächsten Schritt 2. Im Fall unseres Beispiels wäre dies dann: wpackagist/woocommerce und Version 9.8.0

Option 2: Plugin-Datei direkt herunterladen

ZIP-Datei vorbereiten (falls erforderlich):
- Stellen Sie sicher, dass die Plugin-Datei korrekt strukturiert ist. Die ZIP-Datei sollte direkt die Plugin-Dateien enthalten und nicht in einem Unterordner wie _MACOSX oder plugin-name/ verschachtelt sein.

ZIP-Datei überprüfen:

Öffnen Sie das Terminal und prüfen Sie die Struktur der ZIP-Datei:
```
unzip -l plugin-name.zip
```

Die Ausgabe sollte in etwa so aussehen:

Archive:  plugin-name.zip
  Length      Date    Time    Name
 ---------  ---------- -----   ----
     12345  2025-04-11 12:00   plugin-name/plugin.php
     67890  2025-04-11 12:00   plugin-name/readme.txt
 ---------                     -------

Achten Sie darauf, dass keine _MACOSX-Ordner oder andere unerwünschte Dateien enthalten sind.

ZIP-Datei hochladen (falls ein Release Belt verwendet wird):
- Melden Sie sich beim Release Belt an und laden Sie die ZIP-Datei hoch.
- Notieren Sie sich die Paket-URL und den Paketnamen (z. B. wpgens/wpgens-refer-a-friend-premium).

2. Plugin mit Composer hinzufügen

Option 1: Automatische Installation mit `composer require`

Führen Sie den folgenden Befehl aus, um das Plugin hinzuzufügen und zu installieren:
```
composer require woocommerce:^9.8.0
```
Composer fügt das Plugin automatisch zur require-Sektion der composer.json hinzu und installiert es.

Option 2: Manuelle Konfiguration der `composer.json`

Release Belt in der repositories-Sektion konfigurieren:
- Öffnen Sie die composer.json und fügen Sie das Plugin zur only-Liste des Release Belt-Repositories hinzu:
```
{
  "type": "composer",
  "url": "https://release-belt.devops.fndr-infra.de",
  "only": ["wpgens/wpgens-refer-a-friend-premium"]
}
```
Plugin zur require-Sektion hinzufügen:
- Fügen Sie das Plugin mit der entsprechenden Versionsnummer zur require-Sektion hinzu:
```
"require": {
    "php": ">=8.1",
    "wpgens/wpgens-refer-a-friend-premium": "^4.2.0"
}
```
Änderungen speichern und den folgenden Befehl ausführen:
```
composer update
```

3. Installation überprüfen

Überprüfen Sie die Installation:
- Stellen Sie sicher, dass das Plugin im Verzeichnis public/content/plugins/ installiert wurde:
```
ls public/content/plugins/
```
- Sie sollten einen Ordner mit der gerade verdendeten ID des Plugins – z.B.: woocommerce oder refer-a-friend-for-woocommerce-by-wpgens – sehen.
Installation anzeigen:
- Prüfen Sie, ob das Plugin korrekt installiert wurde durch z.B.:
```
composer show wpgens/refer-a-friend-for-woocommerce-by-wpgens
```

4. Debugging-Schritte

Falls das Plugin nicht in WordPress erscheint oder nicht funktioniert, führen Sie die folgenden Schritte aus:

Plugin-Installation überprüfen:
- Stellen Sie sicher, dass das Plugin korrekt installiert wurde:
```
composer show wpgens/refer-a-friend-for-woocommerce-by-wpgens
```
Überprüfen Sie die in Schritt 1 Option 2 Punkt 1 genannte Datei-Struktur:
- Deaktivieren und aktivieren Sie das Plugin in der WordPress-Admin-Oberfläche.
Fehlerprotokolle prüfen:
- Überprüfen Sie die WordPress-Debug-Logs (wp-content/debug.log) auf mögliche Fehler.
Cache leeren:
- Löschen Sie den Transients-Cache Ihres WordPress-Systems wp transient delete --all und Ihres Browsers (öffnen Sie die Seite erneut über den Inkognito Modus)
wp-transients löschen:
- Löschen Sie den Cache Ihres WordPress-Systems wp cache flush und Ihres Browsers (öffnen Sie die Seite erneut über den Inkognito Modus)
Plugin erneut aktivieren:
- Deaktivieren und aktivieren Sie das Plugin in der WordPress-Admin-Oberfläche.

Zusammenfassung:

Verwenden Sie composer require, um Plugins schnell und einfach hinzuzufügen.
Für manuelle Konfigurationen können Sie die composer.json bearbeiten und anschließend composer update ausführen.
Überprüfen Sie die Installation und führen Sie Debugging-Schritte durch, falls Probleme auftreten.