Nutzungsanleitung

Quick Demo Importer führt ein klick demo import über Werkzeuge → Demo Importer aus. Sie benötigen die Berechtigung manage_options. Jede Demo ist ein Profil: ein Ordner mit einer erforderlichen config.json, die eine geordnete Pipeline von Schritten definiert. Die Schritte laufen nacheinander per AJAX. Schlägt ein Schritt fehl, werden spätere Schritte nicht ausgeführt.

Profil-Speicherorte

• Mitgeliefert: wp-content/plugins/quick-demo-importer/demos/{slug}/
• Eigene: wp-content/uploads/quick-demo-importer/profiles/{slug}/

Existiert derselbe Slug an beiden Orten, wird zuerst das eigene Profil verwendet.

Typische Dateien in einem Profilordner:

{slug}/
  config.json     # erforderlich
  content.xml     # optionaler WXR-Export
  images/         # optionale lokale Medien
  tasks.php       # optionale PHP-Aufgaben

config.json-Wurzelfelder

• name (erforderlich) — Anzeigetitel
• description (optional) — kurze Zusammenfassung
• pipeline (erforderlich) — nicht leeres Array von Schritt-Objekten

Unbekannte Schritttypen werden beim Parsen übersprungen. Bleibt nichts Gültiges übrig, wird das Profil abgelehnt.

Minimales Beispiel:

{
  "name": "My Demo",
  "description": "Theme only",
  "pipeline": [
    { "step": "install_theme", "slug": "twentytwentyfour" }
  ]
}

Pipeline-Schritte für ein klick demo import

Jedes Element braucht "step": "<type>" plus typspezifische Felder. Die Array-Reihenfolge ist die Ausführungsreihenfolge. Nutzen Sie diese Struktur, wenn Sie einen zuverlässigen WordPress-Demo-Import möchten, der Pakete, Medien und Inhalte in einem Ablauf installiert.

1. install_theme

Installiert ein Theme. Aktivierung ist standardmäßig eingeschaltet.

• slug — Theme-Stylesheet / wordpress.org-Slug
• zip_url — HTTPS-ZIP-URL (optionale Alternative oder Ergänzung zum Slug)
• activate — Standard true; auf false setzen, um nur zu installieren

Geben Sie mindestens slug oder zip_url an.

{ "step": "install_theme", "slug": "twentytwentythree" }

{
  "step": "install_theme",
  "slug": "my-theme",
  "zip_url": "https://example.com/my-theme.zip",
  "activate": true
}

• Bereits installiert + activate: true → wechselt das Theme bei Bedarf
• Bereits installiert + activate: false → bleibt unverändert (wird nicht zwangsweise deaktiviert)

2. install_plugin

Installiert ein Plugin. Aktivierung ist standardmäßig eingeschaltet.

• slug — Plugin-Ordner / wordpress.org-Slug
• zip_url — HTTPS-ZIP-URL
• activate — Standard true; auf false setzen, um nur zu installieren

{ "step": "install_plugin", "slug": "classic-editor" }

{
  "step": "install_plugin",
  "slug": "hello-dolly",
  "activate": false
}

{
  "step": "install_plugin",
  "slug": "debug-bar",
  "zip_url": "https://downloads.wordpress.org/plugin/debug-bar.latest-stable.zip"
}

Ist zip_url gesetzt, wird dieses Archiv verwendet und die wordpress.org-API übersprungen. Halten Sie slug am installierten Ordnernamen ausgerichtet, damit die Aktivierung die Plugin-Datei auflösen kann.

3. import_media

Importiert Bilddateien aus einem Profil-Unterverzeichnis in die Mediathek.

• directory — Standard "images"

Erlaubte Erweiterungen: jpg, jpeg, png, gif, webp, ico.

{ "step": "import_media", "directory": "images" }

• Anhang-post_name = bereinigter Dateiname ohne Erweiterung
• Vorhandener Slug → wird übersprungen (sicher erneut ausführbar)
• Diese Slugs später in site_icon, custom_logo oder theme_mods_attachments wiederverwenden

4. import_content

Importiert WXR/XML über den offiziellen WordPress-Importer (WP_Import). Das ist der Standardweg für WordPress-XML-Import und exportierte Demo-Inhalte.

• content_url — remote HTTPS-WXR-URL (wird verwendet, wenn nicht leer)
• content_file — relative Datei unter dem Profil (Standard content.xml)
• fetch_attachments — Standard true
• rewrite_urls — Standard true

{
  "step": "import_content",
  "content_file": "content.xml",
  "fetch_attachments": true,
  "rewrite_urls": true
}

{
  "step": "import_content",
  "content_url": "https://example.com/exports/demo.xml",
  "fetch_attachments": true,
  "rewrite_urls": true
}

Der WordPress-Importer muss aktiv sein. Der Demo-Importer-Bildschirm kann ihn bei Bedarf installieren.

5. apply_setup

Wendet generische Website-Konfiguration an. Demo-spezifische Logik gehört in run_task.

Lesen / Startseite

• show_on_front — page oder posts
• page_on_front / page_for_posts — Seiten-Slug oder Titel

Branding

• site_icon — Anhang-Slug
• custom_logo — Anhang-Slug

Menüs

• menus — Objekt-Map: { "location_slug": "Menüname" }

Theme-Mods

• theme_mods — skalare Werte
• theme_mods_attachments — Theme-Mod-Schlüssel → Anhang-Slug → wird als URL gespeichert

Optionen

• options — WordPress-Optionsobjekt (Skalare)
• permalink_structure innerhalb von options aktualisiert die Struktur und leert Rewrite-Regeln

{
  "step": "apply_setup",
  "show_on_front": "page",
  "page_on_front": "welcome",
  "page_for_posts": "notes",
  "site_icon": "demo-three-icon",
  "custom_logo": "demo-three-logo",
  "menus": { "primary": "Main Menu" },
  "theme_mods": { "my_setting": "value" },
  "theme_mods_attachments": { "hero_image": "hero-banner" },
  "options": {
    "blogname": "Demo Site",
    "permalink_structure": "/%postname%/",
    "posts_per_page": 5
  }
}

6. run_task

Führt eine Methode aus der Profil-tasks.php-Klasse aus.

• name (erforderlich) — Methodenname
• tasks_class (optional) — muss mit QDIMP_Tasks_ beginnen

{ "step": "run_task", "name": "setup_primary_menu" }

{
  "step": "run_task",
  "name": "pin_welcome_note",
  "tasks_class": "QDIMP_Tasks_demo_three"
}

Beispiel-Klassenform:

<?php
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

class QDIMP_Tasks_my_demo {
	public function my_method() {
		return 'Done.';
	}
}

Klassenauflösung: Schritt tasks_class → QDIMP_Tasks_{demo_slug} → erste geladene QDIMP_Tasks_*-Klasse, die die Methode hat. Über die UI importierte eigene Profile entfernen alle run_task-Schritte aus Sicherheitsgründen.

Vollständiges Pipeline-Beispiel

{
  "name": "Starter Shop",
  "description": "Theme, WooCommerce, media, content, setup, menu task",
  "pipeline": [
    { "step": "install_theme", "slug": "twentytwentyfour" },
    { "step": "install_plugin", "slug": "woocommerce" },
    { "step": "import_media", "directory": "images" },
    {
      "step": "import_content",
      "content_file": "content.xml",
      "fetch_attachments": true,
      "rewrite_urls": true
    },
    {
      "step": "apply_setup",
      "show_on_front": "page",
      "page_on_front": "home",
      "page_for_posts": "blog",
      "site_icon": "site-icon",
      "options": {
        "blogname": "Starter Shop",
        "permalink_structure": "/%postname%/"
      }
    },
    { "step": "run_task", "name": "setup_primary_menu" }
  ]
}

Admin-Workflows

Eine mitgelieferte Demo ausführen

1. Werkzeuge → Demo Importer öffnen
2. Sicherstellen, dass der WordPress-Importer bereit ist
3. Eine Demo auswählen, Schritte prüfen, Import starten

Ein eigenes Profil importieren

1. Vollständige config.json einfügen oder eine lokale .json-Datei wählen (wird im Browser gelesen)
2. Profil importieren
3. Den neuen Eintrag Custom auswählen und ausführen

• JSON-Größenlimit ca. 512 KB
• Nur bekannte Schritttypen werden behalten
• run_task-Schritte werden beim eigenen Import entfernt
• Profile werden unter Uploads gespeichert und können in der UI gelöscht werden

Praktische Tipps

• Reihenfolge zählt: Theme/Plugins vor abhängigem Inhalt installieren; import_media vor apply_setup ausführen, wenn Sie Bild-Slugs referenzieren.
• Erneute Läufe: installierte Themes/Plugins werden nicht blind neu installiert; vorhandene Medien-Slugs werden übersprungen; Aufgabenmethoden sollten einen zweiten Lauf vertragen.
• Schöne Permalinks: permalink_structure unter apply_setup → options setzen, damit Rewrite-Regeln aktualisiert werden (wichtig bei nginx).
• Setup generisch halten: einmalige Aufräumarbeiten oder Menü-Neuaufbauten gehören in tasks.php.
• Leere Schlüssel weglassen: fügen Sie kein "zip_url": "" hinzu; lassen Sie das Feld weg, wenn ungenutzt.

Fehler und Sicherheit

Jeder Schritt liefert eine Erfolgsmeldung oder einen Fehler. Die UI zeigt die Meldung und stoppt die Pipeline. Häufige Ursachen sind ein fehlender Seiten-Slug in apply_setup, inaktiver WordPress-Importer, ungültige ZIP-URL, fehlender images/-Ordner oder eine fehlende Aufgabenmethode.

• Nur Administratoren können Imports ausführen
• Remote-URLs müssen gültige http/https-Ziele sein
• Path-Traversal wird für Inhalts- und Medienpfade blockiert
• Versenden Sie kein beliebiges PHP über den eigenen Profil-Import; nutzen Sie mitgelieferte tasks.php nur für vertrauenswürdige Demos

Mit einem gut geordneten Profil wird ein klick demo import zu einer wiederholbaren Möglichkeit, WordPress-Demo-Import-Ergebnisse zu liefern: Pakete, Medien, WXR-Inhalte und abschließende Website-Optionen in einem kontrollierten Durchlauf.