`\SearchWP\Query`

Indice

Utilizzo di base
Argomenti
Metodi
Hook

\SearchWP\Query è la classe responsabile dell'esecuzione delle ricerche utilizzando un Engine esistente.

Utilizzo di base

Tutto l'utilizzo di \SearchWP\Query richiede almeno un parametro; una query di ricerca:

	<?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

Per impostazione predefinita $search->results sarà un array di oggetti, formattato in questo modo:

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

Questo generico risultato stdClass fornisce gli elementi essenziali necessari per recuperare ulteriori informazioni sul risultato.

Argomenti

Un array di argomenti può essere passato come secondo parametro durante l'istanziazione di \SearchWP\Query. Sono disponibili diversi argomenti per personalizzare i risultati restituiti.

	<?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

Ecco l'elenco completo degli argomenti disponibili:

engine (string): Il nome dell'Engine da utilizzare per la ricerca. (predefinito: 'default')
mods (\SearchWP\Mod[]): Array di \SearchWP\Mod da utilizzare per la ricerca. (predefinito: [])
site (integer[]): Array di ID sito da utilizzare per la ricerca. (predefinito: get_current_blog_id())
per_page (integer): Quanti risultati restituire per pagina. (predefinito: get_option( 'posts_per_page' ))
page (integer): Quale pagina di risultati restituire. (predefinito: 1)
offset (integer): Offset dei risultati da restituire. (predefinito: 0)
fields (string): Campi da restituire per ogni risultato. (predefinito: 'default'); Accetta: 'default', 'ids', 'all', o 'entries'; 'default' Restituisce object[] con proprietà: 'id', 'source', 'site', 'relevance' (peso).; 'ids' Restituisce string[] di ID risultato (Nota: Source non è fornito, usare solo quando Source può essere dedotto).; 'all' Restituisce array di oggetti Source nativi.; 'entries' Restituisce \SearchWP\Entry[] di risultati.

Metodi

get_results(): Restituisce i risultati.
get_raw_results(): Restituisce il set predefinito di risultati, senza l'applicazione dell'argomento fields.
get_sql(): Restituisce la query SQL utilizzata per trovare i risultati.
get_args(): Restituisce gli argomenti utilizzati per la ricerca.
get_tokens(): Restituisce i \SearchWP\Tokens utilizzati nella query.
get_keywords(): Restituisce la stringa di ricerca originale inviata.
get_errors(): Restituisce eventuali Errori generati. Utile durante il debug.
get_suggested_search(): Restituisce la ricerca suggerita, se applicabile.
get_engine(): Restituisce l'\SearchWP\Engine in uso.
run(): Esegue nuovamente la query di ricerca utilizzando le proprietà correnti.

Hook

Sono disponibili numerosi hook per modificare ulteriormente il comportamento di \SearchWP\Query:

\SearchWP\Query

Utilizzo di base

Argomenti

Metodi

Hook

Crea Oggi Stesso una Migliore Esperienza di Ricerca WordPress

`\SearchWP\Query`