Hooks
Os resultados da pesquisa serão limitados a Hooks graças a um Supplemental Engine do SearchWP
O SearchWP inclui vários hooks para permitir personalizações exclusivas sem comprometer o código do plugin em si. A integração com o SearchWP usando hooks permitirá que suas modificações permaneçam no lugar mesmo ao atualizar o SearchWP ao longo do tempo.
Se você nunca usou hooks do WordPress antes, siga este guia de criação de plugins de personalização do SearchWP.
Query
-
searchwp\query - Usando este hook, você pode manipular diretamente a consulta de pesquisa em si.
-
searchwp\query\args - Personalize os argumentos para um \SearchWP\Query que é usado para executar todas as consultas de pesquisa.
-
searchwp\query\before - Dispara imediatamente antes de uma consulta \SearchWP\Query ser executada, antes que os Mod(s) tenham sido configurados.
-
searchwp\query\do_source_db_where - Controle se o SearchWP considera os critérios db_where() para Fontes. Esta funcionalidade adiciona uma camada de proteção contra edições de conteúdo que foram feitas de tal forma que o indexador do SearchWP não conseguiu capturar. Se você tem certeza de que suas edições de conteúdo estão ocorrendo através de APIs conforme capturado pelas Fontes que você está usando […]
-
searchwp\query\logic\{$type}\strict - Influencie como o SearchWP funciona através de suas várias passagens de lógica ao realizar pesquisas. Por padrão, o SearchWP iterará através de uma série de passagens de lógica ao realizar pesquisas nesta ordem: frase (ou seja, “citado”, pesquisas de sentença) e (ou seja, todos os termos de pesquisa presentes em todos os resultados) ou (ou seja, quaisquer termos de pesquisa presentes em qualquer resultado) Após cada passagem, […]
-
searchwp\query\logic\and - Controle se a lógica E é realizada. Nota: Por padrão, a lógica E será ignorada se o limite de tokens for ultrapassado. O limite padrão é 5, mas pode ser personalizado com o hook searchwp\query\logic\and\token_threshold.
-
searchwp\query\logic\and\token_threshold - Controla o limite que o SearchWP considera ao decidir se deve realizar uma passagem de lógica E. A lógica E pode ser problemática em termos de recursos e, em alguns casos, resultar em longos tempos de consulta. Devido ao algoritmo de relevância do SearchWP, ignorar a lógica E porque há muitos termos de pesquisa não degradará a qualidade dos resultados, pois os mais […]
-
searchwp\query\logic\phrase - Controle se o SearchWP suporta frases entre aspas.
-
searchwp\query\mods - Personalize os \SearchWP\Mods aplicados durante uma pesquisa. Nota: Existem alguns \SearchWP\Mods internos que podem estar presentes para a consulta. Este hook não permite a filtragem desses \SearchWP\Mods críticos para a missão, apenas \SearchWP\Mods definidos pelo usuário. Veja também searchwp\query\do_source_db_where para informações internas.
-
searchwp\query\output_suggested_search - Controle se o SearchWP sugere automaticamente correções de pesquisa.
-
searchwp\query\partial_matches - Controle se o SearchWP aplica sua lógica de correspondência parcial quando necessário.
-
searchwp\query\partial_matches\buoy - Controle se correspondências exatas recebem peso de relevância extra ao realizar a lógica de correspondência parcial.
-
searchwp\query\partial_matches\did_you_mean - Controle se o SearchWP realiza correções no estilo "Você quis dizer?" para pesquisas que aplicam a lógica de correspondência parcial.
-
searchwp\query\partial_matches\force - Força o SearchWP a executar sua lógica de correspondência parcial, apesar de resultados terem sido encontrados.
-
searchwp\query\partial_matches\fuzzy - Controle se a lógica de correspondência parcial usa correspondência aproximada. Por padrão (quando ativado), o SearchWP utilizará dois níveis de lógica de correspondência parcial. Encontre correspondências parciais que contenham a string de pesquisa Se nenhuma correspondência parcial for encontrada, tente encontrar tokens que soem como termos de pesquisa
-
searchwp\query\partial_matches\fuzzy\force - Por padrão (quando a correspondência parcial está ativada), SearchWP aplicará dois níveis de lógica de correspondência parcial. O primeiro será a aplicação de correspondências parciais diretas e, se nenhuma correspondência parcial for encontrada, outro nível de lógica fuzzy será aplicado. Este hook pode forçar a aplicação dessa lógica fuzzy mesmo que correspondências parciais [...]
-
searchwp\query\partial_matches\fuzzy\minimum_length - Controle o comprimento mínimo para correspondências fuzzy.
-
searchwp\query\partial_matches\fuzzy\threshold - Controle o limite que determina se uma correspondência parcial fuzzy potencial é considerada uma correspondência.
-
searchwp\query\partial_matches\minimum_length - Controle o comprimento mínimo para correspondências parciais.
-
searchwp\query\partial_matches\tokens - Manipule tokens de correspondência parcial durante a aplicação da lógica de correspondência parcial.
-
searchwp\query\partial_matches\wildcard_after - Controle se um curinga é adicionado após uma consulta de pesquisa ao aplicar a lógica de correspondência parcial.
-
searchwp\query\partial_matches\wildcard_before - Controle se um curinga é adicionado antes de uma consulta de pesquisa ao aplicar a lógica de correspondência parcial.
-
searchwp\query\per_page - Personalize quantos resultados são retornados por página.
-
searchwp\query\result\load_data - Controle se o SearchWP carrega dados de Atributo de Entrada aplicáveis para os resultados da pesquisa. Observação: quando esta funcionalidade está ativada, apenas os dados de Atributo adicionados ao Motor serão carregados. Veja também searchwp\query\result\load_data\all_attributes
-
searchwp\query\result\load_data\all_attributes - Controle se o SearchWP carrega todos os dados de Atributo de Entrada para os resultados da pesquisa. Observação: quando esta funcionalidade está ativada, todos os dados de Atributo registrados serão carregados. Veja também searchwp\query\result\load_data
-
searchwp\query\results - Modifique os resultados encontrados pelo SearchWP.
-
searchwp\query\search_string - Personalize a string de pesquisa para uma Consulta.
-
searchwp\query\tokens\limit - Controle o número máximo de tokens de pesquisa aceitos.
-
searchwp\query\tokens\use_stems - Controle se os radicais de palavras-chave de token são usados para uma Consulta.
Post
-
searchwp\source\post\{$post_type}\attribution - Controle se os resultados de um tipo de postagem podem ser configurados para atribuir todo o peso a outro ID de postagem.
-
searchwp\source\post\{$post_type}\parent_attribution - Controle se os resultados de um tipo de post podem ser configurados para atribuir peso de relevância aos seus pais.
-
searchwp\source\post\{$post_type}\parent_attribution\strict - Controle como Posts sem um pai são retornados quando a atribuição de pai foi habilitada.
-
searchwp\source\post\attributes\comment - Personalize um Comentário antes que ele seja indexado.
-
searchwp\source\post\attributes\comments\args - Controle os argumentos usados para recuperar Comentários de um post durante a indexação.
-
searchwp\source\post\attributes\comments\author - Quando Comentários foram adicionados a uma Fonte baseada em WP_Post, controle se o Autor do Comentário é indexado.
-
searchwp\source\post\attributes\comments\email - Quando Comentários foram adicionados a uma Fonte baseada em WP_Post, controle se o Email do Comentário é indexado.
-
searchwp\source\post\attributes\content - Personalize o conteúdo do post antes que ele seja indexado.
-
searchwp\source\post\attributes\content\do_blocks - Controle se o SearchWP processa os blocos do editor de blocos (Gutenberg) antes da indexação.
-
searchwp\source\post\attributes\meta - Manipule os dados do Campo Personalizado (postmeta) antes que eles sejam indexados. Veja também searchwp\source\post\attributes\meta\${meta_key} para um único Campo Personalizado.
-
searchwp\source\post\attributes\meta\{$meta_key} - Manipule os dados do Campo Personalizado (postmeta) para um único Campo Personalizado antes que eles sejam indexados. Veja também searchwp\source\post\attributes\meta\${meta_key} para todos os Campos Personalizados.
-
searchwp\source\post\attributes\meta\ignored - Por padrão, o SearchWP ignora chaves de meta que não contêm conteúdo relevante para pesquisa. Você pode personalizar quais chaves são ignoradas com este hook.
-
searchwp\source\post\attributes\taxonomy\term - Manipule os termos da taxonomia de uma postagem antes da indexação. Aplica-se apenas quando a Taxonomia foi incluída em um Mecanismo. Veja também searchwp\source\post\attributes\taxonomy\terms para filtrar todos os termos de uma vez.
-
searchwp\source\post\attributes\taxonomy\terms - Manipule os termos de taxonomia para uma postagem antes da indexação. Aplica-se apenas quando a Taxonomia foi incluída em um Motor. Veja também searchwp\source\post\attributes\taxonomy\term para filtrar termos individuais.
-
searchwp\source\post\global_excerpt - Controle se o SearchWP encontra um excerto 'global' de todo o conteúdo do post, não apenas do post_content.
-
searchwp\source\post\global_excerpt\{$post_type} - Controle se o SearchWP encontra um excerto 'global' de todo o conteúdo do post, não apenas do post_content para um único tipo de post.
Tokens
-
searchwp\tokens - Manipule tokens tanto na indexação quanto na pesquisa.
-
searchwp\tokens\apply_rules_to_pattern_matches - Controle se o SearchWP aplica suas regras de validação (por exemplo, comprimento mínimo) a correspondências de padrões de expressão regular (regex).
-
searchwp\tokens\minimum_length - Controle o que o SearchWP usa como comprimento mínimo de token (termo de pesquisa).
-
searchwp\tokens\regex_patterns - O SearchWP pesquisa correspondências de padrões de expressão regular para manter certas strings intactas e evitar a tokenização, que pode reduzir a utilidade durante a pesquisa. Por padrão, há uma série de padrões de expressão regular comuns para extrair strings de SKUs, datas, iniciais, nomes de funções, números de versão e muito mais. Você pode usar este hook para adicionar seus [...]
-
searchwp\tokens\regex_patterns\only_full_matches - Por padrão, o SearchWP processará apenas correspondências completas para seus padrões de expressão regular. Se você deseja que o SearchWP também considere correspondências parciais, pode habilitar esse comportamento com este hook.
-
searchwp\tokens\strict - Controle se o SearchWP é rigoroso com os tokens. Quando desabilitado (que é o comportamento padrão), o SearchWP removerá os acentos dos caracteres.
-
searchwp\tokens\tokenize_pattern_matches - Controle se as correspondências de padrões regex são tokenizadas em partes individuais.
Index
-
searchwp\background_process\http_basic_auth_credentials - Ensine as credenciais de autenticação básica HTTP ao Indexador. Observação: estas credenciais são para autenticação básica HTTP, não para suas credenciais de login do WordPress.
-
searchwp\index\aggressive_delta - Por padrão, o SearchWP utiliza seu processo em segundo plano ao lidar com atualizações delta. Isso ajuda a manter os tempos de carregamento da página no mínimo. Se, em vez disso, você preferir que o SearchWP aplique as atualizações delta em linha com as edições de conteúdo, você pode usar este hook.
-
searchwp\index\process\enabled - Controla se o processo de tratamento de delta do índice está ativado.
-
searchwp\index\rebuild - Esta ação é disparada sempre que o Índice é redefinido, pouco antes do trabalho de reconstrução ser acionado.
-
searchwp\index\tokens_max - Por padrão, o SearchWP gerará tokens em lotes de no máximo 500. Se você acha que seu servidor é capaz de fazer mais do que isso, aumentar esse limite pode melhorar o desempenho do processo de indexação. Este hook também pode ser usado para reduzir o número de tokens gerados por lote caso você esteja tendo problemas com [...]
Indexador
-
searchwp\background_process\http_basic_auth_credentials - Ensine as credenciais de autenticação básica HTTP ao Indexador. Observação: estas credenciais são para autenticação básica HTTP, não para suas credenciais de login do WordPress.
-
searchwp\indexer\alternate - Controle se o SearchWP usa seu indexador alternativo. O SearchWP detecta automaticamente quando o indexador alternativo é necessário, mas este hook substitui essa detecção. Veja também: Indexador Alternativo
-
searchwp\indexer\batch_size - Controle quantas entradas são indexadas durante cada lote do indexador.
-
searchwp\indexer\http_basic_auth_credentials - Ensine as credenciais de autenticação básica HTTP ao Indexador. Observação: estas credenciais são para autenticação básica HTTP, não para suas credenciais de login do WordPress.
Estatísticas
-
searchwp\admin\dashboard_widgets\statistics - Como parte do recurso de Estatísticas do SearchWP, um Widget de Painel é fornecido para permitir uma rápida supervisão de suas estatísticas de pesquisa ao fazer login no seu Painel do WordPress.
-
searchwp\admin\dashboard_widgets\statistics\days - Por padrão, o Widget de Estatísticas do Painel mostra as pesquisas populares dos últimos 30 dias. Use este hook para modificar esse padrão.
-
searchwp\statistics\capability - Controle a Capacidade necessária para visualizar as Estatísticas do SearchWP.
-
searchwp\statistics\log - Controle se o SearchWP registra esta pesquisa.
Stopwords
-
searchwp\stopwords - O SearchWP usa Stopwords para otimizar o índice e aumentar a relevância dos resultados da pesquisa. O principal método de personalização da lista de Stopwords é através da aba Configurações da tela de Configurações do SearchWP. No entanto, você também pode filtrar Stopwords programaticamente.
-
searchwp\stopwords\suggestions - Controle se o SearchWP sugere Stopwords.
-
searchwp\stopwords\suggestions\limit - Controle o número de sugestões de Stopwords mostradas pelo SearchWP.
-
searchwp\stopwords\suggestions\threshold - Controle o limite usado para determinar Stopwords sugeridas.
BackgroundProcess
-
searchwp\background_process\http_basic_auth_credentials - Ensine as credenciais de autenticação básica HTTP ao Indexador. Observação: estas credenciais são para autenticação básica HTTP, não para suas credenciais de login do WordPress.
-
searchwp\background_process\load_maximum - Quando o SearchWP está monitorando a carga da CPU, ele verifica um limite máximo de carga. Quando esse limite é excedido, o SearchWP reduzirá seu processo de indexação para não aumentar ainda mais a carga da CPU. Se o seu servidor tiver muitos núcleos, é provável que esse máximo de carga possa ser aumentado para corresponder à capacidade do seu servidor.
-
searchwp\background_process\load_monitoring - O SearchWP monitorará a carga da CPU do sistema sempre que possível e reduzirá o processo de indexação para evitar interrupções no serviço para os visitantes do site. Usando este hook, você pode desabilitar o monitoramento de carga do SearchWP.
-
searchwp\background_process\load_throttle - Quando o monitoramento de carga do SearchWP detectar que o limite de carga da CPU foi violado, um tempo limite será injetado no processo de indexação. Você pode usar este hook para personalizar a duração desse tempo limite.
Document
-
searchwp\document\content - Personalize o conteúdo do documento extraído.
-
searchwp\document\pdf_metadata\skip - Se os metadados do PDF devem ser ignorados durante a indexação.
-
searchwp\document\skip - Controle se o SearchWP deve ignorar o processamento de um documento.
Parser
-
searchwp\parser\pdf - Utilize um analisador de PDF externo para extrair conteúdo de PDF em vez do SearchWP.
-
searchwp\parser\richtext - Utilize um analisador de rich text externo para extrair conteúdo de rich text em vez do SearchWP.
-
searchwp\parser\text - Utilize um analisador de texto externo para extrair conteúdo de texto em vez do SearchWP.
Debug
-
searchwp\debug - Controle se a depuração está habilitada.
-
searchwp\debug\dir - Modifique onde os logs de depuração são armazenados.
Source
-
searchwp\source\attribute\options - Modificar as Opções de Atributo para uma Fonte.
-
searchwp\source\check_db - Controle se o SearchWP valida as propriedades do banco de dados de uma Fonte.
Entry
-
searchwp\entry\data - Personalize um \SearchWP\Entry antes que ele seja indexado.
-
searchwp\entry\native - Personalize o objeto nativo de um \SearchWP\Entry.
Highlighter
-
searchwp\highlighter\case_insensitive - Controlar a sensibilidade a maiúsculas e minúsculas ao destacar.
-
searchwp\highlighter\partial_matches - Controlar se o destaque considera correspondências parciais.
Templates
-
searchwp_live_search_results_entry_data - Este hook de filtro permite personalizar os dados de cada entrada de resultado do SearchWP antes que ela seja renderizada no template de resultados da Pesquisa ao Vivo do SearchWP. Ele é especificamente destinado à saída da Pesquisa ao Vivo e permite que os desenvolvedores modifiquem propriedades do resultado, como título, link permanente, marcação de imagem e conteúdo do trecho.
-
searchwp\results\entry\data - Este hook de filtro permite a personalização dos dados de saída para cada entrada de resultado do SearchWP antes que ela seja passada para o Template do SearchWP. Ele pode ser usado para modificar o título exibido, link permanente, imagem ou conteúdo, bem como ajustar a marcação para tipos de objeto específicos, como posts, termos de taxonomia ou usuários.
AdminBar
-
searchwp\admin_bar - Controlar se a entrada da Barra de Administração do SearchWP está habilitada.
Synonyms
-
searchwp\synonyms - O SearchWP usa Sinônimos para otimizar o índice e aumentar a relevância dos resultados da pesquisa. O método principal de personalização da lista de Sinônimos é através da aba Configurações da tela de Configurações do SearchWP. Você também pode filtrar Sinônimos programaticamente.
Attribute
-
searchwp\source\attribute\label - Personalizar Rótulo do Atributo de Origem
License
-
searchwp\license\key - Defina programaticamente sua chave de licença.
Native
-
searchwp\native\short_circuit - Controlar se o SearchWP substitui as pesquisas nativas do WordPress.
Configurações
-
searchwp\settings\capability - Controlar a Capacidade necessária para editar as configurações do SearchWP.
SWP_Query
-
searchwp\swp_query\args - Modificar os argumentos usados ao instanciar SWP_Query.
Misc
-
searchwp\auto_update_providers - Nota: Este hook é aplicável apenas ao alternar sites manualmente em um ambiente Multisite. O SearchWP é capaz de realizar pesquisas Multisite, mas se você estiver alternando sites manualmente usando switch_to_blog(), você deve informar o SearchWP sobre isso. Isso não acontece automaticamente e é um requisito de opt-in ao usar switch_to_blog()! Sem este hook implementado, o SearchWP […]
-
searchwp\extensions - Registrar uma Extensão para ser usada no SearchWP, especificamente no menu Extensões da interface de configurações do SearchWP.
-
searchwp\integration\wp-all-import - Por padrão, o SearchWP acomodará automaticamente os processos executados pelo WP All Import conforme o método discutido aqui: Como Integrar com Importações/Migrações de Conteúdo. Você pode usar este hook para impedir que o SearchWP se integre automaticamente aos processos do WP All Import, se preferir implementar algo por conta própria.
-
searchwp\missing_integration_notices - Por padrão, o SearchWP verificará se há Extensões de integração ausentes. Você pode desabilitar esse comportamento com este hook.
-
searchwp\nuke_on_delete - Se o SearchWP exclui todos os dados na desinstalação
-
searchwp\options\dashboard_stats_link - Controle se o link de Estatísticas do SearchWP aparece.
-
searchwp\options\settings_screen - Controle se a página de opções do SearchWP aparece.
-
searchwp\post__in - Controle um limitador global para IDs de \WP_Post que são considerados durante a indexação e a pesquisa.
-
searchwp\post__not_in - Controle uma exclusão global de IDs de \WP_Post a serem considerados durante a indexação e a pesquisa.
-
searchwp\post_stati - Controle os status de postagem considerados para Fontes baseadas em \WP_Post. Observe que, para que este hook tenha o efeito adequado, você deve entender como o Índice do SearchWP funciona. O Índice representa o conjunto 'máximo' de resultados potenciais, e as Consultas são executadas contra esse Índice para limitar as entradas retornadas. Dito isso, para personalizar quais postagens [...]
-
searchwp\sources - Controle qual conteúdo pode ser indexado e pesquisado pelo SearchWP.
-
searchwp\valid_html_tags - Controle quais tags HTML o SearchWP considerará ao extrair conteúdo para indexar.
-
searchwp\weights - Personalize os intervalos de peso disponíveis ao configurar os Atributos de Fonte do Mecanismo do SearchWP.

