AI-Kit-Shortcode für WordPress-KI-Funktionen

Die Oberfläche AI-Kit Feature (Pro) kann per Shortcode außerhalb von Gutenberg eingebettet werden.

Das eignet sich für:

  • Inhalte im klassischen Editor,
  • Page-Builder wie Elementor,
  • Templates und Theme-Bereiche mit Shortcode-Unterstützung.
Pro-Funktion

[smartcloud-ai-kit-feature] gehört zu den Pro-Funktionen im Frontend. Ohne aktives Pro-Abonnement wird dieser Shortcode möglicherweise nicht gerendert.


Grundlegende Verwendung

[smartcloud-ai-kit-feature mode="summarize"]

In einem modalen Dialog öffnen:

[smartcloud-ai-kit-feature mode="rewrite" variation="modal" title="Rewrite this section"]

Häufig verwendete Parameter

Der Shortcode bildet die Konfiguration des Blocks AI-Kit Feature ab. Die am häufigsten verwendeten Parameter sind:

  • modesummarize | write | rewrite | translate | proofread
  • variationdefault | modal
  • title — Titel der Oberfläche im Kopfbereich (modal) oder im Bedienfeld (Standard)
  • language — Sprache der Benutzeroberfläche (z. B. en, de, hu)
  • directionltr | rtl | auto
  • colorModelight | dark | auto
  • primaryColor — Theme-Schlüssel oder -Name für die Farbpalette der Oberfläche
  • primaryShade — Zahl (0–9) oder { light, dark }
  • themeOverrides — CSS-Zeichenkette, die auf das Komponenten-Theme angewendet wird
  • autoRun — führt die Funktion direkt nach dem Öffnen aus (typisch für „Diese Seite zusammenfassen“)
  • editable — erlaubt Besuchern, die erzeugte Ausgabe vor dem Auslösen von onAccept mit Live-Vorschau zu bearbeiten
  • acceptButtonTitle — passt die Beschriftung der Schaltfläche „Anwenden/Einfügen“ an, wenn onAccept angebunden ist
  • onDeviceTimeout — überschreibt das standardmäßige On-Device-Zeitlimit (5 s für Übersetzungen, 45 s für andere Modi). Gilt nur, wenn die Website nicht als „Backend only“ konfiguriert ist.

Standardeingabe und -ausgabe

Die meisten Modi akzeptieren eine default-Nutzlast, zum Beispiel:

  • default.text — zu verarbeitender Ausgangstext
  • default.instructions — zusätzliche Anweisungen
  • default.outputLanguage
  • default.tone, default.length
  • default.type (Zusammenfassung), default.outputFormat (plain-text | markdown | html)

Da WordPress-Shortcode-Attribute Zeichenketten sind, werden komplexe Werte üblicherweise als JSON übergeben, sofern Ihre Integration dies unterstützt:

[ai-kit-feature
mode="summarize"
variation="modal"
default='{"type":"tldr","outputFormat":"markdown"}'
]

Tipp: Verschiebe diese Attribute für eine übersichtlichere Formatierung ohne JSON-Escaping in den YAML-Inhalt, wie im nächsten Abschnitt gezeigt.


Konfiguration im YAML-Inhalt (für komplexe Werte empfohlen)

Zusätzlich zu Shortcode-Attributen können Sie jede Eigenschaft per YAML im Inhalt des Shortcodes angeben.

Das ist besonders hilfreich für:

  • mehrzeilige Werte wie themeOverrides,
  • Werte mit Zeichen, die sich in Attributen nur umständlich verwenden lassen, etwa Selektoren mit [],
  • verschachtelte Objekte wie default.* und allowOverride.*.

Beispiel: mehrzeiliges CSS und Selektoren mit []

[smartcloud-ai-kit-feature mode="summarize" variation="modal"]
# Mount the UI next to a specific element (selector can contain [] safely)
target: "[data-widget_type=\"theme-post-content.default\"]"

themeOverrides: |
:host {
--ai-kit-modal-max-width: 760px;
}

default:
text: "Summarize the content of the current page"
outputFormat: markdown

allowOverride:
outputLanguage: true
[/smartcloud-ai-kit-feature]
hinweis

Wenn dieselbe Eigenschaft sowohl als Attribut als auch im YAML angegeben ist, hat der YAML-Inhalt Vorrang vor dem Attribut.


Praktische Muster

„Diese Seite zusammenfassen“

[smartcloud-ai-kit-feature mode="summarize" variation="modal"]
autoRun: true
[/smartcloud-ai-kit-feature]

„Ins Ungarische übersetzen“

[smartcloud-ai-kit-feature mode="translate" variation="modal"]
default:
outputLanguage: hu
[/smartcloud-ai-kit-feature]

Fehlerbehebung

  • Wenn nichts gerendert wird, prüfen Sie die Funktionsentscheidung (On-Device und/oder Backend) und stellen Sie sicher, dass der Browser des Benutzers die angeforderte Funktion unterstützt.
  • Wenn der Backend-Fallback aktiviert ist, prüfen Sie die Backend-URL und die Sicherheitsrichtlinie für Ihre Frontend-Pfade.
  • Für eine Steuerung auf Entwicklerebene können Sie statt Shortcodes WpSuite.plugins.aiKit.features.renderFeature() verwenden.

Die Oberfläche AI-Kit Doc Search (Pro) kann per Shortcode außerhalb von Gutenberg eingebettet werden.

Typische Einsatzbereiche:

  • Inhalte im klassischen Editor,
  • Page-Builder wie Elementor,
  • Templates und Theme-Bereiche mit Shortcode-Unterstützung.
Pro-Funktion

[smartcloud-ai-kit-doc-search] gehört zu den Pro-Funktionen im Frontend. Ohne aktives Pro-Abonnement wird dieser Shortcode möglicherweise nicht gerendert.


Grundlegende Verwendung

[smartcloud-ai-kit-doc-search]

In einer modalen Oberfläche öffnen, sofern Ihr Build dies unterstützt:

[smartcloud-ai-kit-doc-search variation="modal" title="Search our docs"]

Häufig verwendete Parameter

  • variationdefault (üblich) oder andere buildspezifische Werte.
  • autoRun — führt die Suche direkt beim Laden aus (Standard: true).
  • title — optionaler Titel über dem Eingabefeld.
  • inputSelector — liest die Suchanfrage aus einem vorhandenen Eingabefeld oder Textbereich der Seite.
  • topK — maximale Ergebniszahl (Standard: 10).
  • snippetMaxChars — maximale Länge des Textausschnitts pro Ergebnis (Standard: 160).
  • searchButtonIcon — Base64-Daten-URL für das Suchsymbol (SVG/PNG).
  • showSearchButtonTitle / showSearchButtonIcon — blendet Schaltflächenbeschriftung und Symbol unabhängig voneinander ein oder aus.
  • language — Sprache der Benutzeroberfläche (system, en, hu, …).
  • directionltr | rtl | auto.
  • colorModelight | dark | auto.
  • primaryColor — Schlüssel oder Name der Primärfarbe des Themes.
  • themeOverrides — CSS-Zeichenkette, die auf das Komponenten-Theme angewendet wird.

Konfiguration im YAML-Inhalt (für komplexe Werte empfohlen)

Wie beim Feature-Shortcode können Sie jede Eigenschaft als YAML im Inhalt des Shortcodes übergeben. Das ist besonders praktisch für mehrzeiliges themeOverrides.

[smartcloud-ai-kit-doc-search title="Search the docs"]
themeOverrides: |
:host {
--ai-kit-modal-max-width: 820px;
}
[/smartcloud-ai-kit-doc-search]
hinweis

Wenn dieselbe Eigenschaft sowohl als Attribut als auch im YAML angegeben ist, hat der YAML-Inhalt Vorrang vor dem Attribut.