Search extends Type implements Formattable_Filter
Represents the Search type.
This type is used to handle the search query and requires no additional methods.
Tags
Interfaces, Classes and Traits
- Formattable_Filter
- Formattable_Filter interface provides a single method "get_active_formatted_values".
Table of Contents
- $filter : Filter
- The filter object.
- __construct() : mixed
- Initialize the type.
- get_active_formatted_values() : string
- Get the formatted values of the filter that are currently active.
- get_filter() : Filter
- Get the filter object.
- get_ids_from_results() : array<string|int, mixed>
- Get the post IDs from the results.
Properties
$filter
The filter object.
protected
Filter
$filter
Methods
__construct()
Initialize the type.
public
__construct(Filter $filter) : mixed
Parameters
- $filter : Filter
-
The filter object.
Return values
mixed —get_active_formatted_values()
Get the formatted values of the filter that are currently active.
public
get_active_formatted_values() : string
Return values
string —get_filter()
Get the filter object.
public
get_filter() : Filter
Return values
Filter —get_ids_from_results()
Get the post IDs from the results.
public
get_ids_from_results(array<string|int, mixed> $results) : array<string|int, mixed>
Parameters
- $results : array<string|int, mixed>
-
The results from the database.