Hooks
Les résultats de recherche seront limités aux Hooks grâce à un Moteur Supplémentaire SearchWP
SearchWP inclut un certain nombre de hooks pour permettre une personnalisation unique sans compromettre le code du plugin lui-même. L'intégration avec SearchWP à l'aide de hooks permettra à vos modifications de rester en place même lors de la mise à niveau de SearchWP au fil du temps.
Si vous n'avez jamais utilisé les hooks WordPress auparavant, suivez ce guide de création de plugin de personnalisation SearchWP.
Requête
-
searchwp\query - En utilisant ce hook, vous pouvez manipuler directement la requête de recherche elle-même.
-
searchwp\query\args - Personnalisez les arguments d'une \SearchWP\Query qui est utilisée pour effectuer toutes les requêtes de recherche.
-
searchwp\query\before - Se déclenche immédiatement avant qu'une requête \SearchWP\Query ne soit exécutée, avant que les Mod(s) n'aient été configurés.
-
searchwp\query\do_source_db_where - Contrôlez si SearchWP prend en compte les critères db_where() pour les Sources. Cette fonctionnalité ajoute une couche de protection contre les modifications de contenu effectuées de telle manière que l'indexeur de SearchWP n'ait pas pu les capturer. Si vous êtes convaincu que toutes les modifications de votre contenu sont effectuées via des API telles que capturées par les Sources que vous utilisez […]
-
searchwp\query\logic\{$type}\strict - Influencez la façon dont SearchWP fonctionne à travers ses différentes passes logiques lors de l'exécution des recherches. Par défaut, SearchWP itérera à travers une série de passes logiques lors de l'exécution des recherches dans cet ordre : phrase (c'est-à-dire « guillemets », recherches de phrases) et (c'est-à-dire tous les termes de recherche présents dans tous les résultats) ou (c'est-à-dire tous les termes de recherche présents dans n'importe quel résultat). Après chaque passe, […]
-
searchwp\query\logic\and - Contrôlez si la logique ET est exécutée. Remarque : Par défaut, la logique ET sera ignorée si le seuil de jetons est dépassé. Le seuil par défaut est de 5 mais peut être personnalisé avec le hook searchwp\query\logic\and\token_threshold.
-
searchwp\query\logic\and\token_threshold - Contrôle le seuil que SearchWP considère lorsqu'il décide d'effectuer une passe logique ET. La logique ET peut être problématique en termes de ressources et, dans certains cas, entraîner de longs temps de requête. En raison de l'algorithme de pertinence de SearchWP, ignorer la logique ET car il y a trop de termes de recherche ne dégradera pas la qualité des résultats car les plus […]
-
searchwp\query\logic\phrase - Contrôlez si SearchWP prend en charge les phrases entre guillemets.
-
searchwp\query\mods - Personnalisez les \SearchWP\Mods appliqués lors d'une recherche. Remarque : Il existe certains \SearchWP\Mods internes qui peuvent être présents pour la requête. Ce hook ne permet pas le filtrage de ces \SearchWP\Mods critiques, uniquement des \SearchWP\Mods définis par l'utilisateur. Voir également searchwp\query\do_source_db_where pour les internes.
-
searchwp\query\output_suggested_search - Contrôlez si SearchWP suggère automatiquement des corrections de recherche.
-
searchwp\query\partial_matches - Contrôlez si SearchWP applique sa logique de correspondance partielle lorsque nécessaire.
-
searchwp\query\partial_matches\buoy - Contrôlez si les correspondances exactes reçoivent un poids de pertinence supplémentaire lors de l'application de la logique de correspondance partielle.
-
searchwp\query\partial_matches\did_you_mean - Contrôlez si SearchWP effectue des corrections de type « Vouliez-vous dire » aux recherches qui appliquent la logique de correspondance partielle.
-
searchwp\query\partial_matches\force - Forcez SearchWP à exécuter sa logique de correspondance partielle malgré la découverte de résultats.
-
searchwp\query\partial_matches\fuzzy - Contrôlez si la logique de correspondance partielle utilise la correspondance floue. Par défaut (lorsqu'elle est activée), SearchWP utilisera deux niveaux de logique de correspondance partielle. Trouver des correspondances partielles qui contiennent la chaîne de recherche. Si aucune correspondance partielle n'est trouvée, essayez de trouver des jetons qui ressemblent aux termes de recherche.
-
searchwp\query\partial_matches\fuzzy\force - Par défaut (lorsque la correspondance partielle est activée), SearchWP appliquera deux niveaux de logique de correspondance partielle. Le premier sera l'application de correspondances partielles directes, et si aucune correspondance partielle n'est trouvée, un autre niveau de logique floue sera appliqué. Ce hook peut forcer l'application de cette logique floue même si des correspondances partielles […]
-
searchwp\query\partial_matches\fuzzy\minimum_length - Contrôler la longueur minimale pour les correspondances floues.
-
searchwp\query\partial_matches\fuzzy\threshold - Contrôler le seuil qui détermine si une correspondance partielle floue potentielle est considérée comme une correspondance.
-
searchwp\query\partial_matches\minimum_length - Contrôler la longueur minimale pour les correspondances partielles.
-
searchwp\query\partial_matches\tokens - Manipuler les jetons de correspondance partielle lors de l'application de la logique de correspondance partielle.
-
searchwp\query\partial_matches\wildcard_after - Contrôler si un joker est ajouté après une requête de recherche lors de l'application de la logique de correspondance partielle.
-
searchwp\query\partial_matches\wildcard_before - Contrôler si un joker est ajouté avant une requête de recherche lors de l'application de la logique de correspondance partielle.
-
searchwp\query\per_page - Personnaliser le nombre de résultats retournés par page.
-
searchwp\query\result\load_data - Contrôler si SearchWP charge les données d'attribut d'entrée applicables pour les résultats de recherche. Remarque : Lorsque cette fonctionnalité est activée, seules les données d'attribut ajoutées au moteur seront chargées. Voir également searchwp\query\result\load_data\all_attributes
-
searchwp\query\result\load_data\all_attributes - Contrôler si SearchWP charge toutes les données d'attribut d'entrée pour les résultats de recherche. Remarque : Lorsque cette fonctionnalité est activée, toutes les données d'attribut enregistrées seront chargées. Voir également searchwp\query\result\load_data
-
searchwp\query\results - Modifier les résultats trouvés par SearchWP.
-
searchwp\query\search_string - Personnaliser la chaîne de recherche pour une requête.
-
searchwp\query\tokens\limit - Contrôler le nombre maximum de jetons de recherche acceptés.
-
searchwp\query\tokens\use_stems - Contrôler si les racines de mots-clés de jetons sont utilisées pour une requête.
Post
-
searchwp\source\post\{$post_type}\attribution - Contrôler si les résultats d'un type de publication peuvent être configurés pour attribuer tout le poids à un autre ID de publication.
-
searchwp\source\post\{$post_type}\parent_attribution - Contrôler si les résultats d'un type de publication peuvent être configurés pour attribuer un poids de pertinence à leurs parents.
-
searchwp\source\post\{$post_type}\parent_attribution\strict - Contrôler comment les articles sans parent sont retournés lorsque l'attribution parentale a été activée.
-
searchwp\source\post\attributes\comment - Personnaliser un commentaire avant qu'il ne soit indexé.
-
searchwp\source\post\attributes\comments\args - Contrôler les arguments utilisés pour récupérer les commentaires d'un article lors de l'indexation.
-
searchwp\source\post\attributes\comments\author - Lorsque des commentaires ont été ajoutés à une source basée sur WP_Post, contrôler si l'auteur du commentaire est indexé.
-
searchwp\source\post\attributes\comments\email - Lorsque des commentaires ont été ajoutés à une source basée sur WP_Post, contrôler si l'e-mail du commentaire est indexé.
-
searchwp\source\post\attributes\content - Personnaliser le contenu de l'article avant qu'il ne soit indexé.
-
searchwp\source\post\attributes\content\do_blocks - Contrôler si SearchWP traite les blocs de l'éditeur de blocs (Gutenberg) avant l'indexation.
-
searchwp\source\post\attributes\meta - Manipuler les données des champs personnalisés (postmeta) avant qu'elles ne soient indexées. Voir aussi searchwp\source\post\attributes\meta\${meta_key} pour un seul champ personnalisé.
-
searchwp\source\post\attributes\meta\{$meta_key} - Manipuler les données d'un champ personnalisé (postmeta) pour un seul champ personnalisé avant qu'elles ne soient indexées. Voir aussi searchwp\source\post\attributes\meta\${meta_key} pour tous les champs personnalisés.
-
searchwp\source\post\attributes\meta\ignored - Par défaut, SearchWP ignore les clés de métadonnées qui ne contiennent pas de contenu pertinent pour la recherche. Vous pouvez personnaliser les clés ignorées avec ce hook.
-
searchwp\source\post\attributes\taxonomy\term - Manipuler les termes de taxonomie d'un article avant l'indexation. S'applique uniquement lorsque la taxonomie a été incluse dans un moteur. Voir aussi searchwp\source\post\attributes\taxonomy\terms pour filtrer tous les termes à la fois.
-
searchwp\source\post\attributes\taxonomy\terms - Manipuler les termes de taxonomie d'un article avant l'indexation. S'applique uniquement lorsque la taxonomie a été incluse dans un moteur. Voir aussi searchwp\source\post\attributes\taxonomy\term pour filtrer les termes individuels.
-
searchwp\source\post\global_excerpt - Contrôler si SearchWP trouve un extrait 'global' à partir de tout le contenu de l'article, pas seulement de post_content.
-
searchwp\source\post\global_excerpt\{$post_type} - Contrôler si SearchWP trouve un extrait 'global' à partir de tout le contenu de l'article, pas seulement de post_content pour un seul type d'article.
Tokens
-
searchwp\tokens - Manipuler les jetons lors de l'indexation et de la recherche.
-
searchwp\tokens\apply_rules_to_pattern_matches - Contrôlez si SearchWP applique ses règles de validation (par exemple, longueur minimale) aux correspondances de motifs d'expressions régulières (regex).
-
searchwp\tokens\minimum_length - Contrôlez ce que SearchWP utilise comme longueur minimale de jeton (terme de recherche).
-
searchwp\tokens\regex_patterns - SearchWP recherche les correspondances de motifs d'expressions régulières pour conserver certaines chaînes intactes et éviter la tokenisation qui pourrait réduire leur utilité lors de la recherche. Par défaut, il existe un certain nombre de motifs d'expressions régulières courants pour extraire des chaînes de SKUs, de dates, d'initiales, de noms de fonctions, de numéros de version, etc. Vous pouvez utiliser ce hook pour ajouter vos […]
-
searchwp\tokens\regex_patterns\only_full_matches - Par défaut, SearchWP ne traite que les correspondances complètes pour ses motifs d'expressions régulières. Si vous souhaitez que SearchWP prenne également en compte les correspondances partielles, vous pouvez activer ce comportement avec ce hook.
-
searchwp\tokens\strict - Contrôlez si SearchWP est strict avec les jetons. Lorsqu'il est désactivé (ce qui est le comportement par défaut), SearchWP supprime les accents des caractères.
-
searchwp\tokens\tokenize_pattern_matches - Contrôlez si les correspondances de motifs regex sont tokenisées en parties individuelles.
Index
-
searchwp\background_process\http_basic_auth_credentials - Enseignez à l'indexeur les identifiants d'authentification HTTP Basic. Remarque : ces identifiants sont pour l'authentification HTTP Basic, pas pour vos identifiants de connexion WordPress.
-
searchwp\index\aggressive_delta - Par défaut, SearchWP utilise son processus d'arrière-plan lors du traitement des mises à jour delta. Cela permet de minimiser les temps de chargement des pages. Si vous préférez que SearchWP applique les mises à jour delta en ligne avec les modifications de contenu, vous pouvez utiliser ce hook.
-
searchwp\index\process\enabled - Contrôlez si le processus de gestion des deltas de l'index est activé.
-
searchwp\index\rebuild - Cette action est déclenchée chaque fois que l'index est réinitialisé, juste avant le déclenchement du travail de reconstruction.
-
searchwp\index\tokens_max - Par défaut, SearchWP génère des jetons par lots de 500 maximum. Si vous pensez que votre serveur peut en gérer plus, augmenter cette limite peut améliorer les performances du processus d'indexation. Ce hook peut également être utilisé pour réduire le nombre de jetons générés par lot si vous rencontrez des problèmes avec […]
Indexeur
-
searchwp\background_process\http_basic_auth_credentials - Enseignez à l'indexeur les identifiants d'authentification HTTP Basic. Remarque : ces identifiants sont pour l'authentification HTTP Basic, pas pour vos identifiants de connexion WordPress.
-
searchwp\indexer\alternate - Contrôlez si SearchWP utilise son indexeur alternatif. SearchWP détecte automatiquement quand l'indexeur alternatif est nécessaire, mais ce hook remplace cette détection. Voir aussi : Indexeur alternatif
-
searchwp\indexer\batch_size - Contrôlez le nombre d'entrées indexées lors de chaque lot de l'indexeur.
-
searchwp\indexer\http_basic_auth_credentials - Enseignez à l'indexeur les identifiants d'authentification HTTP Basic. Remarque : ces identifiants sont pour l'authentification HTTP Basic, pas pour vos identifiants de connexion WordPress.
Statistiques
-
searchwp\admin\dashboard_widgets\statistics - Dans le cadre de la fonctionnalité Statistiques de SearchWP, un widget de tableau de bord est fourni pour permettre un aperçu rapide de vos statistiques de recherche lorsque vous vous connectez à votre administration WordPress.
-
searchwp\admin\dashboard_widgets\statistics\days - Par défaut, le widget du tableau de bord des statistiques affiche les recherches populaires des 30 derniers jours. Utilisez ce hook pour modifier cette valeur par défaut.
-
searchwp\statistics\capability - Contrôlez la capacité nécessaire pour afficher les statistiques de SearchWP.
-
searchwp\statistics\log - Contrôlez si SearchWP enregistre cette recherche.
Stopwords
-
searchwp\stopwords - SearchWP utilise des mots vides (stopwords) pour optimiser l'index et améliorer la pertinence des résultats de recherche. La méthode principale pour personnaliser la liste des mots vides est via l'onglet Paramètres de l'écran des paramètres de SearchWP. Vous pouvez cependant filtrer les mots vides par programme.
-
searchwp\stopwords\suggestions - Contrôlez si SearchWP suggère des mots vides.
-
searchwp\stopwords\suggestions\limit - Contrôlez le nombre de suggestions de mots vides affichées par SearchWP.
-
searchwp\stopwords\suggestions\threshold - Contrôlez le seuil utilisé pour déterminer les suggestions de mots vides.
BackgroundProcess
-
searchwp\background_process\http_basic_auth_credentials - Enseignez à l'indexeur les identifiants d'authentification HTTP Basic. Remarque : ces identifiants sont pour l'authentification HTTP Basic, pas pour vos identifiants de connexion WordPress.
-
searchwp\background_process\load_maximum - Lorsque SearchWP surveille la charge CPU, il vérifie un seuil de charge maximal. Lorsque ce seuil est dépassé, SearchWP réduit son processus d'indexation afin de ne pas augmenter davantage la charge CPU. Si votre serveur possède de nombreux cœurs, il est probable que cette charge maximale puisse être augmentée pour correspondre aux capacités de votre serveur.
-
searchwp\background_process\load_monitoring - SearchWP surveillera la charge CPU du système lorsque possible et réduira le processus d'indexation afin d'éviter toute interruption de service pour les visiteurs du site. En utilisant ce hook, vous pouvez désactiver la surveillance de la charge de SearchWP.
-
searchwp\background_process\load_throttle - Lorsque la surveillance de la charge de SearchWP détecte que le seuil de charge CPU a été franchi, un délai d'attente est injecté dans le processus d'indexation. Vous pouvez utiliser ce hook pour personnaliser la durée de ce délai d'attente.
Document
-
searchwp\document\content - Personnalisez le contenu du document extrait.
-
searchwp\document\pdf_metadata\skip - Si les métadonnées PDF doivent être ignorées lors de l'indexation.
-
searchwp\document\skip - Contrôlez si SearchWP doit ignorer le traitement d'un document.
Parser
-
searchwp\parser\pdf - Utilisez un analyseur PDF externe pour extraire le contenu PDF au lieu de celui de SearchWP.
-
searchwp\parser\richtext - Utilisez un analyseur de texte enrichi externe pour extraire le contenu de texte enrichi au lieu de celui de SearchWP.
-
searchwp\parser\text - Utilisez un analyseur de texte externe pour extraire le contenu textuel au lieu de celui de SearchWP.
Debug
-
searchwp\debug - Contrôlez si le débogage est activé.
-
searchwp\debug\dir - Modifiez l'emplacement de stockage des journaux de débogage.
Source
-
searchwp\source\attribute\options - Modifiez les options d'attribut pour une source.
-
searchwp\source\check_db - Contrôlez si SearchWP valide les propriétés de base de données d'une source.
Entry
-
searchwp\entry\data - Personnalisez une entrée \SearchWP\Entry avant son indexation.
-
searchwp\entry\native - Personnalisez l'objet natif d'une entrée \SearchWP\Entry.
Highlighter
-
searchwp\highlighter\case_insensitive - Contrôlez la sensibilité à la casse lors de la mise en surbrillance.
-
searchwp\highlighter\partial_matches - Contrôlez si la mise en surbrillance prend en compte les correspondances partielles.
Templates
-
searchwp_live_search_results_entry_data - Ce hook de filtre vous permet de personnaliser les données de chaque entrée de résultat SearchWP avant qu'elle ne soit rendue dans le modèle de recherche instantanée SearchWP. Il est spécifiquement destiné à la sortie de la recherche instantanée et permet aux développeurs de modifier les propriétés du résultat telles que le titre, le permalien, le balisage d'image et le contenu de l'extrait.
-
searchwp\results\entry\data - Ce hook de filtre permet la personnalisation des données de sortie pour chaque entrée de résultat SearchWP avant qu'elle ne soit transmise au modèle SearchWP. Il peut être utilisé pour modifier le titre affiché, le permalien, l'image ou le contenu, ainsi que pour ajuster le balisage pour des types d'objets spécifiques tels que les articles, les termes de taxonomie ou les utilisateurs.
AdminBar
-
searchwp\admin_bar - Contrôlez si l'entrée de la barre d'administration de SearchWP est activée.
Synonyms
-
searchwp\synonyms - SearchWP utilise des synonymes pour optimiser l'index et augmenter la pertinence des résultats de recherche. La méthode principale de personnalisation de la liste des synonymes se fait via l'onglet Paramètres de l'écran des paramètres de SearchWP. Vous pouvez cependant filtrer les synonymes par programme.
Attribute
-
searchwp\source\attribute\label - Personnaliser l'étiquette d'attribut de la source
Licence
-
searchwp\license\key - Définissez votre clé de licence par programme.
Native
-
searchwp\native\short_circuit - Contrôlez si SearchWP remplace les recherches natives de WordPress.
Paramètres
-
searchwp\settings\capability - Contrôlez la capacité nécessaire pour modifier les paramètres de SearchWP.
SWP_Query
-
searchwp\swp_query\args - Modifiez les arguments utilisés lors de l'instanciation de SWP_Query.
Misc
-
searchwp\auto_update_providers - Remarque : ce hook n'est applicable que lors du changement manuel de site dans un environnement Multisite. SearchWP est capable d'effectuer des recherches Multisite, mais si vous changez manuellement de site en utilisant switch_to_blog(), vous devez en informer SearchWP. Cela ne se produit pas automatiquement et est une exigence d'adhésion lors de l'utilisation de switch_to_blog() ! Sans ce hook en place, SearchWP […]
-
searchwp\extensions - Enregistrez une extension à utiliser dans SearchWP, spécifiquement dans le menu Extensions de l'interface des paramètres de SearchWP.
-
searchwp\integration\wp-all-import - Par défaut, SearchWP s'adaptera automatiquement aux processus exécutés par WP All Import, conformément à la méthode décrite ici : Comment intégrer avec les importations/migrations de contenu. Vous pouvez utiliser ce hook pour empêcher SearchWP de s'intégrer automatiquement aux processus WP All Import si vous préférez implémenter quelque chose par vous-même.
-
searchwp\missing_integration_notices - Par défaut, SearchWP vérifie s'il manque des extensions d'intégration. Vous pouvez désactiver ce comportement avec ce hook.
-
searchwp\nuke_on_delete - Si SearchWP supprime toutes les données lors de la désinstallation
-
searchwp\options\dashboard_stats_link - Contrôlez si le lien Statistiques de SearchWP apparaît.
-
searchwp\options\settings_screen - Contrôlez si la page d'options de SearchWP apparaît.
-
searchwp\post__in - Contrôlez un limiteur global pour les identifiants \WP_Post qui sont pris en compte lors de l'indexation et de la recherche.
-
searchwp\post__not_in - Contrôlez une exclusion globale des identifiants \WP_Post à prendre en compte lors de l'indexation et de la recherche.
-
searchwp\post_stati - Contrôlez les statuts de publication considérés pour les sources basées sur \WP_Post. Notez que pour que ce hook prenne correctement effet, vous devez comprendre comment fonctionne l'index de SearchWP. L'index représente le pool 'maximum' de résultats potentiels, et les requêtes sont exécutées contre cet index pour limiter les entrées retournées. Cela dit, afin de personnaliser quels postes […]
-
searchwp\sources - Contrôlez quel contenu peut être indexé et recherché par SearchWP.
-
searchwp\valid_html_tags - Contrôlez quelles balises HTML SearchWP prendra en compte lors de l'extraction du contenu à indexer.
-
searchwp\weights - Personnalisez les intervalles de poids disponibles lors de la configuration des attributs source de SearchWP Engine.
