SearchWP implements Registerable, Service
Handles integration with SearchWP
Tags
Interfaces, Classes and Traits
- Registerable
- Service
Table of Contents
- $applicable : mixed
- $args : mixed
- add_admin_option() : array<string|int, mixed>
- Add admin UI option for Document Download indexing.
- add_document_download_index() : array<string|int, mixed>
- Index PDF and document files which are attached to document posts and store as a custom field in SearchWP.
- filter_protected_results() : array<string|int, mixed>
- Filters the results to not include protected documents.
- handle_dlp_args() : array<string|int, mixed>
- Store the args so we can pass them to the SearchWP query.
- handle_documents_query() : mixed
- Determine if we should run the query through SearchWP
- handle_searchwp_args() : array<string|int, mixed>
- Run our query through SearchWP.
- register() : mixed
- {@inheritdoc}
- remove_document_download_from_custom_fields() : array<string|int, mixed>
- Remove document download meta data from custom fields list.
Properties
$applicable
private
mixed
$applicable
= false
Tags
$args
private
mixed
$args
Tags
Methods
add_admin_option()
Add admin UI option for Document Download indexing.
public
add_admin_option(array<string|int, mixed> $keys, array<string|int, mixed> $args) : array<string|int, mixed>
Parameters
- $keys : array<string|int, mixed>
- $args : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —add_document_download_index()
Index PDF and document files which are attached to document posts and store as a custom field in SearchWP.
public
add_document_download_index(array<string|int, mixed> $data, Entry $entry) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
- $entry : Entry
Tags
Return values
array<string|int, mixed> —filter_protected_results()
Filters the results to not include protected documents.
public
filter_protected_results(array<string|int, mixed> $results, Query $query) : array<string|int, mixed>
Parameters
- $results : array<string|int, mixed>
- $query : Query
Tags
Return values
array<string|int, mixed> —handle_dlp_args()
Store the args so we can pass them to the SearchWP query.
public
handle_dlp_args(array<string|int, mixed> $query_args, Table_Query $query) : array<string|int, mixed>
Parameters
- $query_args : array<string|int, mixed>
- $query : Table_Query
Tags
Return values
array<string|int, mixed> —handle_documents_query()
Determine if we should run the query through SearchWP
public
handle_documents_query(Table_Query $query) : mixed
Parameters
- $query : Table_Query
Tags
Return values
mixed —handle_searchwp_args()
Run our query through SearchWP.
public
handle_searchwp_args(array<string|int, mixed> $args, WP_Query $query) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>
- $query : WP_Query
Tags
Return values
array<string|int, mixed> —register()
{@inheritdoc}
public
register() : mixed
Tags
Return values
mixed —remove_document_download_from_custom_fields()
Remove document download meta data from custom fields list.
public
remove_document_download_from_custom_fields(mixed $custom_fields_list, mixed $post_id) : array<string|int, mixed>
Parameters
- $custom_fields_list : mixed
- $post_id : mixed