`\SearchWP\Query`

Table des matières

Utilisation de base
Arguments
Méthodes
Hooks

\SearchWP\Query est la classe responsable de l'exécution des recherches en utilisant un Moteur existant.

Utilisation de base

Toute utilisation de \SearchWP\Query nécessite au moins un paramètre ; une requête de recherche :

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

Par défaut, $search->results sera un tableau d'objets, formaté comme suit :

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

Ce résultat générique stdClass fournit le strict nécessaire pour récupérer des informations supplémentaires sur le résultat.

Arguments

Un tableau d'arguments peut être passé comme deuxième paramètre lors de l'instanciation de \SearchWP\Query. Un certain nombre d'arguments sont disponibles pour personnaliser les résultats retournés.

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

Voici la liste complète des arguments disponibles :

engine (string): Le nom du Moteur à utiliser pour la recherche. (défaut : 'default')
mods (\SearchWP\Mod[]): Tableau de \SearchWP\Mods à utiliser pour la recherche. (défaut : [])
site (integer[]): Tableau d'IDs de sites à utiliser pour la recherche. (défaut : get_current_blog_id())
per_page (integer): Combien de résultats retourner par page. (défaut : get_option( 'posts_per_page' ))
page (integer): Quelle page de résultats retourner. (défaut : 1)
offset (integer): Décalage des résultats à retourner. (défaut : 0)
fields (string): Champs à retourner pour chaque résultat. (défaut : 'default'); Accepte : 'default', 'ids', 'all', ou 'entries'; 'default' Retourne object[] avec les propriétés : 'id', 'source', 'site', 'relevance' (poids).; 'ids' Retourne string[] d'IDs de résultats (Note : La source n'est pas fournie, à utiliser uniquement lorsque la source peut être déduite).; 'all' Retourne un tableau d'objets Source natifs.; 'entries' Retourne \SearchWP\Entry[] de résultats.

Méthodes

get_results(): Retourne les résultats.
get_raw_results(): Retourne l'ensemble par défaut des résultats, sans l'application de l'argument fields.
get_sql(): Retourne la requête SQL utilisée pour trouver les résultats.
get_args(): Retourne les arguments utilisés pour la recherche.
get_tokens(): Retourne les \SearchWP\Tokens utilisés dans la requête.
get_keywords(): Retourne la chaîne de recherche originale soumise.
get_errors(): Retourne les erreurs générées. Utile pour le débogage.
get_suggested_search(): Retourne la recherche suggérée le cas échéant.
get_engine(): Retourne le \SearchWP\Engine utilisé.
run(): Réexécute la requête de recherche en utilisant les propriétés actuelles.

Hooks

Un certain nombre de hooks sont disponibles pour modifier davantage le comportement de \SearchWP\Query :

\SearchWP\Query

Utilisation de base

Arguments

Méthodes

Hooks

Créez dès aujourd'hui une meilleure expérience de recherche WordPress

`\SearchWP\Query`