`\SearchWP\Query`

Inhaltsverzeichnis

Grundlegende Verwendung
Argumente
Methoden
Hooks

\SearchWP\Query ist die Klasse, die für die Ausführung von Suchen unter Verwendung einer vorhandenen Engine verantwortlich ist.

Grundlegende Verwendung

Die gesamte Verwendung von \SearchWP\Query erfordert mindestens einen Parameter; eine Suchanfrage:

	<?php
	// @link https://searchwp.com/documentation/classes/searchwp-query/
	$search = new \SearchWP\Query( 'coffee' );

	$results = $search->results; // Array of results.

view raw template.php hosted with ❤ by GitHub

Standardmäßig ist $search->results ein Array von Objekten, das wie folgt formatiert ist:

stdClass Object
(
    [id]        => 1          // Result ID.
        => post.post  // Result Source name.
    [site]      => 1          // Result site ID.
    [relevance] => 150        // Result relevance weight.
)

Dieses generische stdClass-Ergebnis liefert die absoluten Grundlagen, die benötigt werden, um zusätzliche Informationen über das Ergebnis abzurufen.

Argumente

Ein Array von Argumenten kann als zweiter Parameter beim Instanziieren von \SearchWP\Query übergeben werden. Es steht eine Reihe von Argumenten zur Verfügung, um die zurückgegebenen Ergebnisse anzupassen.

	<?php
	// @link https://searchwp.com/documentation/classes/searchwp-query/
	$search = new \SearchWP\Query( 'coffee', [
	'engine' => 'supplemental',
	'per_page' => -1,
	'fields' => 'all',
	] );

	$results = $search->results; // Array of results.

view raw template.php hosted with ❤ by GitHub

Hier ist die vollständige Liste der verfügbaren Argumente:

engine (string): Der Name der zu verwendenden Engine für die Suche. (Standard: 'default')
mods (\SearchWP\Mod[]): Array von \SearchWP\Mods, die für die Suche verwendet werden sollen. (Standard: [])
site (integer[]): Array von Site-IDs, die für die Suche verwendet werden sollen. (Standard: get_current_blog_id())
per_page (integer): Wie viele Ergebnisse pro Seite zurückgegeben werden sollen. (Standard: get_option( 'posts_per_page' ))
page (integer): Welche Seite der Ergebnisse zurückgegeben werden soll. (Standard: 1)
offset (integer): Offset der zurückzugebenden Ergebnisse. (Standard: 0)
fields (string): Felder, die für jedes Ergebnis zurückgegeben werden sollen. (Standard: 'default'); Akzeptiert: 'default', 'ids', 'all' oder 'entries'; 'default' Gibt object[] mit den Eigenschaften: 'id', 'source', 'site', 'relevance' (Gewichtung) zurück.; 'ids' Gibt string[] von Ergebnis-IDs zurück (Hinweis: Quelle wird nicht angegeben, nur verwenden, wenn die Quelle abgeleitet werden kann).; 'all' Gibt ein Array von nativen Quellobjekten zurück.; 'entries' Gibt \SearchWP\Entry[] von Ergebnissen zurück.

Methoden

get_results(): Gibt die Ergebnisse zurück.
get_raw_results(): Gibt den Standardsatz von Ergebnissen zurück, ohne Anwendung des Arguments fields.
get_sql(): Gibt die SQL-Abfrage zurück, die zum Finden von Ergebnissen verwendet wird.
get_args(): Gibt die für die Suche verwendeten Argumente zurück.
get_tokens(): Gibt die für die Abfrage verwendeten \SearchWP\Tokens zurück.
get_keywords(): Gibt den ursprünglichen, übermittelten Suchstring zurück.
get_errors(): Gibt alle generierten Fehler zurück. Nützlich beim Debuggen.
get_suggested_search(): Gibt die vorgeschlagene Suche zurück, falls zutreffend.
get_engine(): Gibt die verwendete \SearchWP\Engine zurück.
run(): Führt die Suchabfrage mit den aktuellen Eigenschaften erneut aus.

Hooks

Es gibt eine Reihe von Hooks, die verfügbar sind, um das Verhalten von \SearchWP\Query weiter zu modifizieren:

\SearchWP\Query

Grundlegende Verwendung

Argumente

Methoden

Hooks

Erstellen Sie noch heute eine bessere WordPress-Sucherfahrung

`\SearchWP\Query`