<?php
/**
* Jetpack Search widget.
*
* @package automattic/jetpack-search
*/
namespace Automattic\Jetpack\Search;
use Automattic\Jetpack\Assets;
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
use Automattic\Jetpack\Redirect;
use Automattic\Jetpack\Status;
use Automattic\Jetpack\Sync\Modules\Search as Search_Sync_Module;
use Automattic\Jetpack\Tracking;
/**
* Provides a widget to show available/selected filters on searches.
*
* @since 5.0.0
*
* @see WP_Widget
*/
class Search_Widget extends \WP_Widget {
/**
* Number of aggregations (filters) to show by default.
*
* @since 5.8.0
* @var int
*/
const DEFAULT_FILTER_COUNT = 5;
/**
* Default sort order for search results.
*
* @since 5.8.0
* @var string
*/
const DEFAULT_SORT = 'relevance_desc';
/**
* The Jetpack_Search instance.
*
* @since 5.7.0
* @var Jetpack_Search
*/
protected $jetpack_search;
/**
* Module_Control instance
*
* @var Module_Control
*/
protected $module_control;
/**
* Search_Widget constructor.
*
* @param string $name Widget name.
* @since 5.0.0
*/
public function __construct( $name = null ) {
if ( empty( $name ) ) {
$name = esc_html__( 'Search (Jetpack)', 'jetpack-search-pkg' );
}
$this->module_control = new Module_Control();
parent::__construct(
Helper::FILTER_WIDGET_BASE,
$name,
array(
'classname' => 'jetpack-filters widget_search',
'description' => __( 'Instant search and filtering to help visitors quickly find relevant answers and explore your site.', 'jetpack-search-pkg' ),
)
);
if (
Helper::is_active_widget( $this->id ) &&
! $this->is_search_active()
) {
$this->activate_search();
}
if ( is_admin() ) {
add_action( 'sidebar_admin_setup', array( $this, 'widget_admin_setup' ) );
} else {
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_frontend_scripts' ) );
}
add_action( 'jetpack_search_render_filters_widget_title', array( 'Automattic\Jetpack\Search\Template_Tags', 'render_widget_title' ), 10, 3 );
if ( Options::is_instant_enabled() ) {
add_action( 'jetpack_search_render_filters', array( 'Automattic\Jetpack\Search\Template_Tags', 'render_instant_filters' ), 10, 2 );
} else {
add_action( 'jetpack_search_render_filters', array( 'Automattic\Jetpack\Search\Template_Tags', 'render_available_filters' ), 10, 2 );
}
}
/**
* Check whether search is currently active
*
* @since 6.3
*/
public function is_search_active() {
return $this->module_control->is_active();
}
/**
* Activate search
*
* @since 6.3
*/
public function activate_search() {
return $this->module_control->activate();
}
/**
* Enqueues the scripts and styles needed for the customizer.
*
* @since 5.7.0
*/
public function widget_admin_setup() {
// Register jp-tracks and jp-tracks-functions.
Tracking::register_tracks_functions_scripts();
Assets::register_script(
'jetpack-search-widget-admin',
'js/search-widget-admin.js',
__FILE__,
array(
'in_footer' => true,
'textdomain' => 'jetpack-search-pkg',
'css_path' => 'css/search-widget-admin-ui.css',
'dependencies' => array( 'jquery', 'jquery-ui-sortable', 'jp-tracks-functions' ),
)
);
$dotcom_data = ( new Connection_Manager( Package::SLUG ) )->get_connected_user_data();
wp_localize_script(
'jetpack-search-widget-admin',
'jetpack_search_filter_admin',
array(
'defaultFilterCount' => self::DEFAULT_FILTER_COUNT,
'tracksUserData' => ! empty( $dotcom_data ) ? array(
'userid' => $dotcom_data['ID'],
'username' => $dotcom_data['login'],
) : false,
'tracksEventData' => array(
'is_customizer' => (int) is_customize_preview(),
),
'i18n' => array(
'month' => Helper::get_date_filter_type_name( 'month', false ),
'year' => Helper::get_date_filter_type_name( 'year', false ),
'monthUpdated' => Helper::get_date_filter_type_name( 'month', true ),
'yearUpdated' => Helper::get_date_filter_type_name( 'year', true ),
),
)
);
Assets::enqueue_script( 'jetpack-search-widget-admin' );
}
/**
* Enqueue scripts and styles for the frontend.
*
* @since 5.8.0
*/
public function enqueue_frontend_scripts() {
if ( ! is_active_widget( false, false, $this->id_base, true ) || Options::is_instant_enabled() ) {
return;
}
Assets::register_script(
'jetpack-search-widget',
'js/search-widget.js',
__FILE__,
array(
'in_footer' => true,
'textdomain' => 'jetpack-search-pkg',
// Jetpack the plugin would concatenated the style with other styles and minimize. And the style would be dequeued from WP.
// @see https://github.com/Automattic/jetpack/blob/b3de78dce3d88b0d9b283282a5b04515245c8057/projects/plugins/jetpack/tools/builder/frontend-css.js#L52.
// @see https://github.com/Automattic/jetpack/blob/bb1b6a9a9cfa98600441f8fa31c9f9c4ef9a04a5/projects/plugins/jetpack/class.jetpack.php#L106.
'css_path' => 'css/search-widget-frontend.css',
)
);
Assets::enqueue_script( 'jetpack-search-widget' );
}
/**
* Get the list of valid sort types/orders.
*
* @return array The sort orders.
* @since 5.8.0
*/
private function get_sort_types() {
return array(
'relevance|DESC' => is_admin() ? esc_html__( 'Relevance (recommended)', 'jetpack-search-pkg' ) : esc_html__( 'Relevance', 'jetpack-search-pkg' ),
'date|DESC' => esc_html__( 'Newest first', 'jetpack-search-pkg' ),
'date|ASC' => esc_html__( 'Oldest first', 'jetpack-search-pkg' ),
);
}
/**
* Callback for an array_filter() call in order to only get filters for the current widget.
*
* @param array $item Filter item.
*
* @return bool Whether the current filter item is for the current widget.
* @see Search_Widget::widget()
*
* @since 5.7.0
*/
public function is_for_current_widget( $item ) {
return isset( $item['widget_id'] ) && $this->id == $item['widget_id']; // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual
}
/**
* This method returns a boolean for whether the widget should show site-wide filters for the site.
*
* This is meant to provide backwards-compatibility for VIP, and other professional plan users, that manually
* configured filters via `Automattic\Jetpack\Search\Classic_Search::set_filters()`.
*
* @return bool Whether the widget should display site-wide filters or not.
* @since 5.7.0
*/
public function should_display_sitewide_filters() {
$filter_widgets = get_option( 'widget_jetpack-search-filters' );
// This shouldn't be empty, but just for sanity.
if ( empty( $filter_widgets ) ) {
return false;
}
// If any widget has any filters, return false.
foreach ( $filter_widgets as $number => $widget ) {
$widget_id = sprintf( '%s-%d', $this->id_base, $number );
if ( ! empty( $widget['filters'] ) && is_active_widget( false, $widget_id, $this->id_base ) ) {
return false;
}
}
return true;
}
/**
* Widget defaults.
*
* @param array $instance Previously saved values from database.
*/
public function jetpack_search_populate_defaults( $instance ) {
$instance = wp_parse_args(
(array) $instance,
array(
'title' => '',
'search_box_enabled' => true,
'user_sort_enabled' => true,
'sort' => self::DEFAULT_SORT,
'filters' => array( array() ),
'post_types' => array(),
)
);
return $instance;
}
/**
* Populates the instance array with appropriate default values.
*
* @param array $instance Previously saved values from database.
* @return array Instance array with default values approprate for instant search
* @since 8.6.0
*/
public function populate_defaults_for_instant_search( $instance ) {
return wp_parse_args(
(array) $instance,
array(
'title' => '',
'filters' => array(),
)
);
}
/**
* Responsible for rendering the widget on the frontend.
*
* @param array $args Widgets args supplied by the theme.
* @param array $instance The current widget instance.
* @since 5.0.0
*/
public function widget( $args, $instance ) {
$instance = $this->jetpack_search_populate_defaults( $instance );
if ( ( new Status() )->is_offline_mode() ) {
echo $args['before_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?><div id="<?php echo esc_attr( $this->id ); ?>-wrapper">
<div class="jetpack-search-sort-wrapper">
<label>
<?php esc_html_e( 'Jetpack Search not supported in Offline Mode', 'jetpack-search-pkg' ); ?>
</label>
</div>
</div>
<?php
echo $args['after_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
return;
}
if ( Options::is_instant_enabled() ) {
if ( array_key_exists( 'id', $args ) && Instant_Search::INSTANT_SEARCH_SIDEBAR === $args['id'] ) {
$this->widget_empty_instant( $args, $instance );
} else {
$this->widget_instant( $args, $instance );
}
} else {
$this->widget_non_instant( $args, $instance );
}
}
/**
* Render the non-instant frontend widget.
*
* @param array $args Widgets args supplied by the theme.
* @param array $instance The current widget instance.
* @since 8.3.0
*/
public function widget_non_instant( $args, $instance ) {
$display_filters = false;
// Search instance must have been initialized before widget render.
if ( is_search() && Classic_Search::instance() ) {
if ( Helper::should_rerun_search_in_customizer_preview() ) {
Classic_Search::instance()->update_search_results_aggregations();
}
$filters = Classic_Search::instance()->get_filters();
if ( ! Helper::are_filters_by_widget_disabled() && ! $this->should_display_sitewide_filters() ) {
$filters = array_filter( $filters, array( $this, 'is_for_current_widget' ) );
}
if ( ! empty( $filters ) ) {
$display_filters = true;
}
}
if ( ! $display_filters && empty( $instance['search_box_enabled'] ) && empty( $instance['user_sort_enabled'] ) ) {
return;
}
$title = ! empty( $instance['title'] ) ? $instance['title'] : '';
/** This filter is documented in core/src/wp-includes/default-widgets.php */
$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
echo $args['before_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<div id="<?php echo esc_attr( $this->id ); ?>-wrapper" >
<?php
if ( ! empty( $title ) ) {
/**
* Responsible for displaying the title of the Jetpack Search filters widget.
*
* @module search
*
* @param string $title The widget's title
* @param string $args['before_title'] The HTML tag to display before the title
* @param string $args['after_title'] The HTML tag to display after the title
*@since 5.7.0
*/
do_action( 'jetpack_search_render_filters_widget_title', $title, $args['before_title'], $args['after_title'] );
}
$default_sort = isset( $instance['sort'] ) ? $instance['sort'] : self::DEFAULT_SORT;
list( $orderby, $order ) = $this->sorting_to_wp_query_param( $default_sort );
$current_sort = "{$orderby}|{$order}";
// we need to dynamically inject the sort field into the search box when the search box is enabled, and display
// it separately when it's not.
if ( ! empty( $instance['search_box_enabled'] ) ) {
Template_Tags::render_widget_search_form( $instance['post_types'], $orderby, $order );
}
if ( ! empty( $instance['search_box_enabled'] ) && ! empty( $instance['user_sort_enabled'] ) ) :
?>
<div class="jetpack-search-sort-wrapper">
<label>
<?php esc_html_e( 'Sort by', 'jetpack-search-pkg' ); ?>
<select class="jetpack-search-sort">
<?php foreach ( $this->get_sort_types() as $sort => $label ) { ?>
<option value="<?php echo esc_attr( $sort ); ?>" <?php selected( $current_sort, $sort ); ?>>
<?php echo esc_html( $label ); ?>
</option>
<?php } ?>
</select>
</label>
</div>
<?php
endif;
if ( $display_filters ) {
/**
* Responsible for rendering filters to narrow down search results.
*
* @module search
*
* @param array $filters The possible filters for the current query.
* @param array $post_types An array of post types to limit filtering to.
*@since 5.8.0
*/
do_action(
'jetpack_search_render_filters',
$filters,
isset( $instance['post_types'] ) ? $instance['post_types'] : null
);
}
$this->maybe_render_sort_javascript( $instance, $order, $orderby );
echo '</div>';
echo $args['after_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Render the instant frontend widget.
*
* @param array $args Widgets args supplied by the theme.
* @param array $instance The current widget instance.
* @since 8.3.0
*/
public function widget_instant( $args, $instance ) {
// Exit early if search instance has not been initialized.
if ( ! Instant_Search::instance() ) {
return false;
}
if ( Helper::should_rerun_search_in_customizer_preview() ) {
Instant_Search::instance()->update_search_results_aggregations();
}
$filters = Instant_Search::instance()->get_filters();
if ( ! Helper::are_filters_by_widget_disabled() && ! $this->should_display_sitewide_filters() ) {
$filters = array_filter( $filters, array( $this, 'is_for_current_widget' ) );
}
$display_filters = ! empty( $filters );
$title = ! empty( $instance['title'] ) ? $instance['title'] : '';
/** This filter is documented in core/src/wp-includes/default-widgets.php */
$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
echo $args['before_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<div id="<?php echo esc_attr( $this->id ); ?>-wrapper" class="jetpack-instant-search-wrapper">
<?php
if ( ! empty( $title ) ) {
/**
* Responsible for displaying the title of the Jetpack Search filters widget.
*
* @module search
*
* @param string $title The widget's title
* @param string $args['before_title'] The HTML tag to display before the title
* @param string $args['after_title'] The HTML tag to display after the title
*@since 5.7.0
*/
do_action( 'jetpack_search_render_filters_widget_title', $title, $args['before_title'], $args['after_title'] );
}
Template_Tags::render_widget_search_form( array(), '', '' );
if ( $display_filters ) {
/**
* Responsible for rendering filters to narrow down search results.
*
* @module search
*
* @param array $filters The possible filters for the current query.
* @param array $post_types An array of post types to limit filtering to.
*@since 5.8.0
*/
do_action(
'jetpack_search_render_filters',
$filters,
null
);
}
echo '</div>';
echo $args['after_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Render the instant widget for the overlay.
*
* @param array $args Widgets args supplied by the theme.
* @param array $instance The current widget instance.
* @since 8.3.0
*/
public function widget_empty_instant( $args, $instance ) {
$title = isset( $instance['title'] ) ? $instance['title'] : '';
if ( empty( $title ) ) {
$title = '';
}
/** This filter is documented in core/src/wp-includes/default-widgets.php */
$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
echo $args['before_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<div id="<?php echo esc_attr( $this->id ); ?>-wrapper" class="jetpack-instant-search-wrapper">
<?php
if ( ! empty( $title ) ) {
/**
* Responsible for displaying the title of the Jetpack Search filters widget.
*
* @module search
*
* @param string $title The widget's title
* @param string $args['before_title'] The HTML tag to display before the title
* @param string $args['after_title'] The HTML tag to display after the title
*@since 5.7.0
*/
do_action( 'jetpack_search_render_filters_widget_title', $title, $args['before_title'], $args['after_title'] );
}
echo '</div>';
echo $args['after_widget']; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Renders JavaScript for the sorting controls on the frontend.
*
* This JS is a bit complicated, but here's what it's trying to do:
* - find the search form
* - find the orderby/order fields and set default values
* - detect changes to the sort field, if it exists, and use it to set the order field values
*
* @param array $instance The current widget instance.
* @param string $order The order to initialize the select with.
* @param string $orderby The orderby to initialize the select with.
* @since 5.8.0
*/
private function maybe_render_sort_javascript( $instance, $order, $orderby ) {
if ( Options::is_instant_enabled() ) {
return;
}
if ( ! empty( $instance['user_sort_enabled'] ) ) :
?>
<script type="text/javascript">
var jetpackSearchModuleSorting = function() {
var orderByDefault = '<?php echo 'date' === $orderby ? 'date' : 'relevance'; ?>',
orderDefault = '<?php echo 'ASC' === $order ? 'ASC' : 'DESC'; ?>',
widgetId = decodeURIComponent( '<?php echo rawurlencode( $this->id ); ?>' ),
searchQuery = decodeURIComponent( '<?php echo rawurlencode( get_query_var( 's', '' ) ); ?>' ),
isSearch = <?php echo (int) is_search(); ?>;
var container = document.getElementById( widgetId + '-wrapper' ),
form = container.querySelector( '.jetpack-search-form form' ),
orderBy = form.querySelector( 'input[name=orderby]' ),
order = form.querySelector( 'input[name=order]' ),
searchInput = form.querySelector( 'input[name="s"]' ),
sortSelectInput = container.querySelector( '.jetpack-search-sort' );
orderBy.value = orderByDefault;
order.value = orderDefault;
// Some themes don't set the search query, which results in the query being lost
// when doing a sort selection. So, if the query isn't set, let's set it now. This approach
// is chosen over running a regex over HTML for every search query performed.
if ( isSearch && ! searchInput.value ) {
searchInput.value = searchQuery;
}
searchInput.classList.add( 'show-placeholder' );
sortSelectInput.addEventListener( 'change', function( event ) {
var values = event.target.value.split( '|' );
orderBy.value = values[0];
order.value = values[1];
form.submit();
} );
}
if ( document.readyState === 'interactive' || document.readyState === 'complete' ) {
jetpackSearchModuleSorting();
} else {
document.addEventListener( 'DOMContentLoaded', jetpackSearchModuleSorting );
}
</script>
<?php
endif;
}
/**
* Convert a sort string into the separate order by and order parts.
*
* @param string $sort A sort string.
*
* @return array Order by and order.
* @since 5.8.0
*/
private function sorting_to_wp_query_param( $sort ) {
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$parts = explode( '|', $sort );
$orderby = isset( $_GET['orderby'] )
? sanitize_sql_orderby( wp_unslash( $_GET['orderby'] ) )
: $parts[0];
$order = isset( $_GET['order'] )
? ( strtoupper( $_GET['order'] ) === 'ASC' ? 'ASC' : 'DESC' ) // phpcs:ignore WordPress.Security.ValidatedSanitizedInput -- This is validating.
: ( ( isset( $parts[1] ) && 'ASC' === strtoupper( $parts[1] ) ) ? 'ASC' : 'DESC' );
// phpcs:enable WordPress.Security.NonceVerification.Recommended
return array( $orderby, $order );
}
/**
* Updates a particular instance of the widget. Validates and sanitizes the options.
*
* @param array $new_instance New settings for this instance as input by the user via Search_Widget::form().
* @param array $old_instance Old settings for this instance.
*
* @return array Settings to save.
* @since 5.0.0
*/
public function update( $new_instance, $old_instance ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
$new_instance = $this->maybe_reformat_widget( $new_instance );
$instance = array();
$instance['title'] = sanitize_text_field( $new_instance['title'] );
// Keep `search_box_enabled` and `user_sort_enabled` settings when updating widget on Instant Search
// Set `search_box_enabled` and `user_sort_enabled` default to '1' when createing a NEW widget
if ( Options::is_instant_enabled() ) {
$instance['search_box_enabled'] = empty( $old_instance ) ? '1' : $old_instance['search_box_enabled'];
$instance['user_sort_enabled'] = empty( $old_instance ) ? '1' : $old_instance['user_sort_enabled'];
} else {
$instance['search_box_enabled'] = empty( $new_instance['search_box_enabled'] ) ? '0' : '1';
$instance['user_sort_enabled'] = empty( $new_instance['user_sort_enabled'] ) ? '0' : '1';
}
$instance['sort'] = empty( $new_instance['sort'] ) ? self::DEFAULT_SORT : $new_instance['sort'];
$instance['post_types'] = empty( $new_instance['post_types'] ) || empty( $instance['search_box_enabled'] )
? array()
: array_map( 'sanitize_key', $new_instance['post_types'] );
$filters = array();
if ( isset( $new_instance['filter_type'] ) ) {
foreach ( (array) $new_instance['filter_type'] as $index => $type ) {
$count = (int) $new_instance['num_filters'][ $index ];
$count = min( 50, $count ); // Set max boundary at 50.
$count = max( 1, $count ); // Set min boundary at 1.
switch ( $type ) {
case 'taxonomy':
$filters[] = array(
'name' => sanitize_text_field( $new_instance['filter_name'][ $index ] ),
'type' => 'taxonomy',
'taxonomy' => sanitize_key( $new_instance['taxonomy_type'][ $index ] ),
'count' => $count,
);
break;
case 'post_type':
$filters[] = array(
'name' => sanitize_text_field( $new_instance['filter_name'][ $index ] ),
'type' => 'post_type',
'count' => $count,
);
break;
case 'author':
$filters[] = array(
'name' => sanitize_text_field( $new_instance['filter_name'][ $index ] ),
'type' => 'author',
'count' => $count,
);
break;
case 'date_histogram':
$filters[] = array(
'name' => sanitize_text_field( $new_instance['filter_name'][ $index ] ),
'type' => 'date_histogram',
'count' => $count,
'field' => sanitize_key( $new_instance['date_histogram_field'][ $index ] ),
'interval' => sanitize_key( $new_instance['date_histogram_interval'][ $index ] ),
);
break;
}
}
}
if ( ! empty( $filters ) ) {
$instance['filters'] = $filters;
}
return $instance;
}
/**
* Reformats the widget instance array to one that is recognized by the `update` function.
* This is only necessary when handling changes from the block-based widget editor.
*
* @param array $widget_instance - Jetpack Search widget instance.
*
* @return array - Potentially reformatted instance compatible with the save function.
*/
protected function maybe_reformat_widget( $widget_instance ) {
if ( isset( $widget_instance['filter_type'] ) || ! isset( $widget_instance['filters'] ) || ! is_array( $widget_instance['filters'] ) ) {
return $widget_instance;
}
$instance = $widget_instance;
foreach ( $widget_instance['filters'] as $filter ) {
$instance['filter_type'][] = isset( $filter['type'] ) ? $filter['type'] : '';
$instance['taxonomy_type'][] = isset( $filter['taxonomy'] ) ? $filter['taxonomy'] : '';
$instance['filter_name'][] = isset( $filter['name'] ) ? $filter['name'] : '';
$instance['num_filters'][] = isset( $filter['count'] ) ? $filter['count'] : 5;
$instance['date_histogram_field'][] = isset( $filter['field'] ) ? $filter['field'] : '';
$instance['date_histogram_interval'][] = isset( $filter['interval'] ) ? $filter['interval'] : '';
}
unset( $instance['filters'] );
return $instance;
}
/**
* Outputs the settings update form.
*
* @param array $instance Previously saved values from database.
* @since 5.0.0
*/
public function form( $instance ) {
if ( Options::is_instant_enabled() ) {
return $this->form_for_instant_search( $instance );
}
$instance = $this->jetpack_search_populate_defaults( $instance );
$title = wp_strip_all_tags( $instance['title'] );
$hide_filters = Helper::are_filters_by_widget_disabled();
$classes = sprintf(
'jetpack-search-filters-widget %s %s %s',
$hide_filters ? 'hide-filters' : '',
$instance['search_box_enabled'] ? '' : 'hide-post-types',
$this->id
);
?>
<div class="<?php echo esc_attr( $classes ); ?>">
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>">
<?php esc_html_e( 'Title (optional):', 'jetpack-search-pkg' ); ?>
</label>
<input
class="widefat"
id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"
name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>"
type="text"
value="<?php echo esc_attr( $title ); ?>"
/>
</p>
<p>
<label>
<input
type="checkbox"
class="jetpack-search-filters-widget__search-box-enabled"
name="<?php echo esc_attr( $this->get_field_name( 'search_box_enabled' ) ); ?>"
<?php checked( $instance['search_box_enabled'] ); ?>
/>
<?php esc_html_e( 'Show search box', 'jetpack-search-pkg' ); ?>
</label>
</p>
<p>
<label>
<input
type="checkbox"
class="jetpack-search-filters-widget__sort-controls-enabled"
name="<?php echo esc_attr( $this->get_field_name( 'user_sort_enabled' ) ); ?>"
<?php checked( $instance['user_sort_enabled'] ); ?>
<?php disabled( ! $instance['search_box_enabled'] ); ?>
/>
<?php esc_html_e( 'Show sort selection dropdown', 'jetpack-search-pkg' ); ?>
</label>
</p>
<p class="jetpack-search-filters-widget__post-types-select">
<label><?php esc_html_e( 'Post types to search (minimum of 1):', 'jetpack-search-pkg' ); ?></label>
<?php foreach ( get_post_types( array( 'exclude_from_search' => false ), 'objects' ) as $post_type ) : ?>
<label>
<input
type="checkbox"
value="<?php echo esc_attr( $post_type->name ); ?>"
name="<?php echo esc_attr( $this->get_field_name( 'post_types' ) ); ?>[]"
<?php checked( empty( $instance['post_types'] ) || in_array( $post_type->name, $instance['post_types'], true ) ); ?>
/>
<?php echo esc_html( $post_type->label ); ?>
</label>
<?php endforeach; ?>
</p>
<p>
<label>
<?php esc_html_e( 'Default sort order:', 'jetpack-search-pkg' ); ?>
<select
name="<?php echo esc_attr( $this->get_field_name( 'sort' ) ); ?>"
class="widefat jetpack-search-filters-widget__sort-order">
<?php foreach ( $this->get_sort_types() as $sort_type => $label ) { ?>
<option value="<?php echo esc_attr( $sort_type ); ?>" <?php selected( $instance['sort'], $sort_type ); ?>>
<?php echo esc_html( $label ); ?>
</option>
<?php } ?>
</select>
</label>
</p>
<?php if ( ! $hide_filters ) : ?>
<script class="jetpack-search-filters-widget__filter-template" type="text/template">
<?php
echo $this->render_widget_edit_filter( array(), true ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
</script>
<div class="jetpack-search-filters-widget__filters">
<?php foreach ( (array) $instance['filters'] as $filter ) : ?>
<?php $this->render_widget_edit_filter( $filter ); ?>
<?php endforeach; ?>
</div>
<p class="jetpack-search-filters-widget__add-filter-wrapper">
<a class="button jetpack-search-filters-widget__add-filter" href="#">
<?php esc_html_e( 'Add a filter', 'jetpack-search-pkg' ); ?>
</a>
</p>
<noscript>
<p class="jetpack-search-filters-help">
<?php echo esc_html_e( 'Adding filters requires JavaScript!', 'jetpack-search-pkg' ); ?>
</p>
</noscript>
<?php if ( is_customize_preview() ) : ?>
<p class="jetpack-search-filters-help">
<a href="<?php echo esc_url( Redirect::get_url( 'jetpack-support-search', array( 'anchor' => 'filters-not-showing-up' ) ) ); ?>" target="_blank">
<?php esc_html_e( "Why aren't my filters appearing?", 'jetpack-search-pkg' ); ?>
</a>
</p>
<?php endif; ?>
<?php endif; ?>
</div>
<?php
}
/**
* Outputs the widget update form to be used in the Customizer for Instant Search.
*
* @param array $instance Previously saved values from database.
* @since 8.6.0
*/
private function form_for_instant_search( $instance ) {
$instance = $this->populate_defaults_for_instant_search( $instance );
$classes = sprintf( 'jetpack-search-filters-widget %s', $this->id );
?>
<div class="<?php echo esc_attr( $classes ); ?>">
<!-- Title control -->
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>">
<?php esc_html_e( 'Title (optional):', 'jetpack-search-pkg' ); ?>
</label>
<input
class="widefat"
id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"
name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>"
type="text"
value="<?php echo esc_attr( wp_strip_all_tags( $instance['title'] ) ); ?>"
/>
</p>
<!-- Filters control -->
<?php if ( ! Helper::are_filters_by_widget_disabled() ) : ?>
<div class="jetpack-search-filters-widget__filters">
<?php foreach ( (array) $instance['filters'] as $filter ) : ?>
<?php $this->render_widget_edit_filter( $filter, false, true ); ?>
<?php endforeach; ?>
</div>
<p class="jetpack-search-filters-widget__add-filter-wrapper">
<a class="button jetpack-search-filters-widget__add-filter" href="#">
<?php esc_html_e( 'Add a filter', 'jetpack-search-pkg' ); ?>
</a>
</p>
<script class="jetpack-search-filters-widget__filter-template" type="text/template">
<?php $this->render_widget_edit_filter( array(), true, true ); ?>
</script>
<noscript>
<p class="jetpack-search-filters-help">
<?php echo esc_html_e( 'Adding filters requires JavaScript!', 'jetpack-search-pkg' ); ?>
</p>
</noscript>
<?php endif; ?>
</div>
<?php
}
/**
* We need to render HTML in two formats: an Underscore template (client-side)
* and native PHP (server-side). This helper function allows for easy rendering
* of attributes in both formats.
*
* @param string $name Attribute name.
* @param string $value Attribute value.
* @param bool $is_template Whether this is for an Underscore template or not.
* @since 5.8.0
*/
private function render_widget_attr( $name, $value, $is_template ) {
echo $is_template ? "<%= $name %>" : esc_attr( $value ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* We need to render HTML in two formats: an Underscore template (client-size)
* and native PHP (server-side). This helper function allows for easy rendering
* of the "selected" attribute in both formats.
*
* @param string $name Attribute name.
* @param string $value Attribute value.
* @param string $compare Value to compare to the attribute value to decide if it should be selected.
* @param bool $is_template Whether this is for an Underscore template or not.
* @since 5.8.0
*/
private function render_widget_option_selected( $name, $value, $compare, $is_template ) {
$compare_js = rawurlencode( $compare );
echo $is_template ? "<%= decodeURIComponent( '$compare_js' ) === $name ? 'selected=\"selected\"' : '' %>" : selected( $value, $compare ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Responsible for rendering a single filter in the customizer or the widget administration screen in wp-admin.
*
* We use this method for two purposes - rendering the fields server-side, and also rendering a script template for Underscore.
*
* @param array $filter The filter to render.
* @param bool $is_template Whether this is for an Underscore template or not.
* @param bool $is_instant_search Whether this site enables Instant Search or not.
* @since 5.7.0
*/
public function render_widget_edit_filter( $filter, $is_template = false, $is_instant_search = false ) {
$args = wp_parse_args(
$filter,
array(
'name' => '',
'type' => 'taxonomy',
'taxonomy' => '',
'post_type' => '',
'field' => '',
'interval' => '',
'count' => self::DEFAULT_FILTER_COUNT,
)
);
$args['name_placeholder'] = Helper::generate_widget_filter_name( $args );
// Hide author filter when Instant Search is turned off.
if ( ! $is_instant_search && 'author' === $args['type'] ) :
return;
endif;
?>
<div class="jetpack-search-filters-widget__filter is-<?php $this->render_widget_attr( 'type', $args['type'], $is_template ); ?>">
<p class="jetpack-search-filters-widget__type-select">
<label>
<?php esc_html_e( 'Filter Type:', 'jetpack-search-pkg' ); ?>
<select name="<?php echo esc_attr( $this->get_field_name( 'filter_type' ) ); ?>[]" class="widefat filter-select">
<option value="taxonomy" <?php $this->render_widget_option_selected( 'type', $args['type'], 'taxonomy', $is_template ); ?>>
<?php esc_html_e( 'Taxonomy', 'jetpack-search-pkg' ); ?>
</option>
<option value="post_type" <?php $this->render_widget_option_selected( 'type', $args['type'], 'post_type', $is_template ); ?>>
<?php esc_html_e( 'Post Type', 'jetpack-search-pkg' ); ?>
</option>
<?php if ( $is_instant_search ) : ?>
<option value="author" <?php $this->render_widget_option_selected( 'type', $args['type'], 'author', $is_template ); ?>>
<?php esc_html_e( 'Author', 'jetpack-search-pkg' ); ?>
</option>
<?php endif; ?>
<option value="date_histogram" <?php $this->render_widget_option_selected( 'type', $args['type'], 'date_histogram', $is_template ); ?>>
<?php esc_html_e( 'Date', 'jetpack-search-pkg' ); ?>
</option>
</select>
</label>
</p>
<p class="jetpack-search-filters-widget__taxonomy-select">
<label>
<?php
esc_html_e( 'Choose a taxonomy:', 'jetpack-search-pkg' );
$seen_taxonomy_labels = array();
?>
<select name="<?php echo esc_attr( $this->get_field_name( 'taxonomy_type' ) ); ?>[]" class="widefat taxonomy-select">
<?php foreach ( $this->get_allowed_taxonomies_for_widget_filters() as $taxonomy ) : ?>
<option value="<?php echo esc_attr( $taxonomy->name ); ?>" <?php $this->render_widget_option_selected( 'taxonomy', $args['taxonomy'], $taxonomy->name, $is_template ); ?>>
<?php
$label = in_array( $taxonomy->label, $seen_taxonomy_labels, true )
? sprintf(
/* translators: %1$s is the taxonomy name, %2s is the name of its type to help distinguish between several taxonomies with the same name, e.g. category and tag. */
_x( '%1$s (%2$s)', 'A label for a taxonomy selector option', 'jetpack-search-pkg' ),
$taxonomy->label,
$taxonomy->name
)
: $taxonomy->label;
echo esc_html( $label );
$seen_taxonomy_labels[] = $taxonomy->label;
?>
</option>
<?php endforeach; ?>
</select>
</label>
</p>
<p class="jetpack-search-filters-widget__date-histogram-select">
<label>
<?php esc_html_e( 'Choose a field:', 'jetpack-search-pkg' ); ?>
<select name="<?php echo esc_attr( $this->get_field_name( 'date_histogram_field' ) ); ?>[]" class="widefat date-field-select">
<option value="post_date" <?php $this->render_widget_option_selected( 'field', $args['field'], 'post_date', $is_template ); ?>>
<?php esc_html_e( 'Date', 'jetpack-search-pkg' ); ?>
</option>
<option value="post_date_gmt" <?php $this->render_widget_option_selected( 'field', $args['field'], 'post_date_gmt', $is_template ); ?>>
<?php esc_html_e( 'Date GMT', 'jetpack-search-pkg' ); ?>
</option>
<option value="post_modified" <?php $this->render_widget_option_selected( 'field', $args['field'], 'post_modified', $is_template ); ?>>
<?php esc_html_e( 'Modified', 'jetpack-search-pkg' ); ?>
</option>
<option value="post_modified_gmt" <?php $this->render_widget_option_selected( 'field', $args['field'], 'post_modified_gmt', $is_template ); ?>>
<?php esc_html_e( 'Modified GMT', 'jetpack-search-pkg' ); ?>
</option>
</select>
</label>
</p>
<p class="jetpack-search-filters-widget__date-histogram-select">
<label>
<?php esc_html_e( 'Choose an interval:', 'jetpack-search-pkg' ); ?>
<select name="<?php echo esc_attr( $this->get_field_name( 'date_histogram_interval' ) ); ?>[]" class="widefat date-interval-select">
<option value="month" <?php $this->render_widget_option_selected( 'interval', $args['interval'], 'month', $is_template ); ?>>
<?php esc_html_e( 'Month', 'jetpack-search-pkg' ); ?>
</option>
<option value="year" <?php $this->render_widget_option_selected( 'interval', $args['interval'], 'year', $is_template ); ?>>
<?php esc_html_e( 'Year', 'jetpack-search-pkg' ); ?>
</option>
</select>
</label>
</p>
<p class="jetpack-search-filters-widget__title">
<label>
<?php esc_html_e( 'Title:', 'jetpack-search-pkg' ); ?>
<input
class="widefat"
type="text"
name="<?php echo esc_attr( $this->get_field_name( 'filter_name' ) ); ?>[]"
value="<?php $this->render_widget_attr( 'name', $args['name'], $is_template ); ?>"
placeholder="<?php $this->render_widget_attr( 'name_placeholder', $args['name_placeholder'], $is_template ); ?>"
/>
</label>
</p>
<p>
<label>
<?php esc_html_e( 'Maximum number of filters (1-50):', 'jetpack-search-pkg' ); ?>
<input
class="widefat filter-count"
name="<?php echo esc_attr( $this->get_field_name( 'num_filters' ) ); ?>[]"
type="number"
value="<?php $this->render_widget_attr( 'count', $args['count'], $is_template ); ?>"
min="1"
max="50"
step="1"
required
/>
</label>
</p>
<p class="jetpack-search-filters-widget__controls">
<a href="#" class="delete"><?php esc_html_e( 'Remove', 'jetpack-search-pkg' ); ?></a>
</p>
</div>
<?php
}
/**
* Returns the taxonomies for search widget taxonomy dropdown.
*/
protected function get_allowed_taxonomies_for_widget_filters() {
return array_filter(
get_taxonomies( array( 'public' => true ), 'objects' ),
function ( $taxonomy ) {
return in_array(
$taxonomy->name,
/**
* Filters the taxonomies that shows in filter drop downs of the search widget.
*
* @since 0.16.0
*
* @param array $taxonomies_to_show List of taxonomies that shown for search widget.
*/
apply_filters(
'jetpack_search_allowed_taxonomies_for_widget_filters',
array_merge( array( 'category', 'post_tag' ), Search_Sync_Module::get_all_taxonomies() )
),
true
);
}
);
}
}