`\SearchWP\Query`

Tabla de contenidos

Uso básico
Argumentos
Métodos
Hooks

\SearchWP\Query es la clase responsable de ejecutar búsquedas utilizando un Engine existente.

Uso básico

Todo uso de \SearchWP\Query requiere al menos un parámetro; una consulta de búsqueda:

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

Por defecto, $search->results será un array de objetos, con el siguiente formato:

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

Este resultado genérico stdClass proporciona lo mínimo necesario para recuperar información adicional sobre el resultado.

Argumentos

Se puede pasar un array de argumentos como segundo parámetro al instanciar \SearchWP\Query. Hay varios argumentos disponibles para personalizar los resultados devueltos.

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

Aquí está la lista completa de argumentos disponibles:

engine (string): El nombre del Engine a utilizar para la búsqueda. (por defecto: 'default')
mods (\SearchWP\Mod[]): Array de \SearchWP\Mods a utilizar para la búsqueda. (por defecto: [])
site (integer[]): Array de IDs de sitios a utilizar para la búsqueda. (por defecto: get_current_blog_id())
per_page (integer): Cuántos resultados devolver por página. (por defecto: get_option( 'posts_per_page' ))
page (integer): Qué página de resultados devolver. (predeterminado: 1)
offset (integer): Offset de los resultados a devolver. (por defecto: 0)
fields (string): Campos a devolver para cada resultado. (por defecto: 'default'); Acepta: 'default', 'ids', 'all', o 'entries'; 'default' Devuelve object[] con propiedades: 'id', 'source', 'site', 'relevance' (peso).; 'ids' Devuelve string[] de IDs de resultados (Nota: La fuente no se proporciona, úselo solo cuando la fuente se pueda inferir).; 'all' Devuelve un array de objetos de Fuente nativos.; 'entries' Devuelve \SearchWP\Entry[] de resultados.

Métodos

get_results(): Devuelve los resultados.
get_raw_results(): Devuelve el conjunto de resultados predeterminado, sin la aplicación del argumento fields.
get_sql(): Devuelve la consulta SQL utilizada para encontrar resultados.
get_args(): Devuelve los argumentos utilizados para la búsqueda.
get_tokens(): Devuelve los \SearchWP\Tokens utilizados en la consulta.
get_keywords(): Devuelve la cadena de búsqueda original enviada.
get_errors(): Devuelve cualquier error generado. Útil para depurar.
get_suggested_search(): Devuelve la búsqueda sugerida si procede.
get_engine(): Devuelve el \SearchWP\Engine en uso.
run(): Vuelve a ejecutar la consulta de búsqueda utilizando las propiedades actuales.

Hooks

Hay una serie de ganchos disponibles para modificar aún más el comportamiento de \SearchWP\Query:

\SearchWP\Query

Uso básico

Argumentos

Métodos

Hooks

Cree hoy mismo una mejor experiencia de búsqueda en WordPress

`\SearchWP\Query`