`\SearchWP\Query`

Sumário

Uso Básico
Argumentos
Métodos
Hooks

\SearchWP\Query é a classe responsável por executar buscas utilizando um Engine existente.

Uso Básico

Todo uso de \SearchWP\Query requer pelo menos um parâmetro; uma consulta de busca:

	<?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 padrão, $search->results será um array de objetos, formatado assim:

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 fornece o mínimo necessário para recuperar informações adicionais sobre o resultado.

Argumentos

Um array de argumentos pode ser passado como segundo parâmetro ao instanciar \SearchWP\Query. Há uma série de argumentos disponíveis para personalizar os resultados retornados.

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

Aqui está a lista completa de argumentos disponíveis:

engine (string): O nome do Engine a ser usado para a busca. (padrão: 'default')
mods (\SearchWP\Mod[]): Array de \SearchWP\Mods a serem usados para a busca. (padrão: [])
site (integer[]): Array de IDs de sites a serem usados para a busca. (padrão: get_current_blog_id())
per_page (integer): Quantos resultados retornar por página. (padrão: get_option( 'posts_per_page' ))
page (integer): Qual página de resultados retornar. (padrão: 1)
offset (integer): Offset de resultados a serem retornados. (padrão: 0)
fields (string): Campos a serem retornados para cada resultado. (padrão: 'default'); Aceita: 'default', 'ids', 'all', ou 'entries'; 'default' Retorna object[] com as propriedades: 'id', 'source', 'site', 'relevance' (peso).; 'ids' Retorna string[] de IDs de resultados (Nota: Source não é fornecido, use apenas quando Source puder ser inferido).; 'all' Retorna array de objetos Source nativos.; 'entries' Retorna \SearchWP\Entry[] de resultados.

Métodos

get_results(): Retorna os resultados.
get_raw_results(): Retorna o conjunto padrão de resultados, sem a aplicação do argumento fields.
get_sql(): Retorna a consulta SQL usada para encontrar resultados.
get_args(): Retorna os argumentos usados para a pesquisa.
get_tokens(): Retorna os \SearchWP\Tokens usados na consulta.
get_keywords(): Retorna a string de pesquisa original enviada.
get_errors(): Retorna quaisquer Erros gerados. Útil ao depurar.
get_suggested_search(): Retorna a pesquisa sugerida, se aplicável.
get_engine(): Retorna o \SearchWP\Engine em uso.
run(): Reexecuta a consulta de pesquisa usando as propriedades atuais.

Hooks

Há uma série de hooks disponíveis para modificar ainda mais o comportamento de \SearchWP\Query:

\SearchWP\Query

Uso Básico

Argumentos

Métodos

Hooks

Crie uma Experiência de Pesquisa WordPress Melhor Hoje

`\SearchWP\Query`