| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908 |
- <?php
- /**
- * Jetpack Search: Jetpack_Search_Helpers class
- *
- * @package Jetpack
- * @subpackage Jetpack Search
- * @since 5.8.0
- */
- use Automattic\Jetpack\Constants;
- require_once dirname( __FILE__ ) . '/class-jetpack-search-options.php';
- /**
- * Various helper functions for reuse throughout the Jetpack Search code.
- *
- * @since 5.8.0
- */
- class Jetpack_Search_Helpers {
- /**
- * The search widget's base ID.
- *
- * @since 5.8.0
- * @var string
- */
- const FILTER_WIDGET_BASE = 'jetpack-search-filters';
- /**
- * Create a URL for the current search that doesn't include the "paged" parameter.
- *
- * @since 5.8.0
- *
- * @return string The search URL.
- */
- static function get_search_url() {
- $query_args = stripslashes_deep( $_GET );
- // Handle the case where a permastruct is being used, such as /search/{$query}
- if ( ! isset( $query_args['s'] ) ) {
- $query_args['s'] = get_search_query();
- }
- if ( isset( $query_args['paged'] ) ) {
- unset( $query_args['paged'] );
- }
- $query = http_build_query( $query_args );
- return home_url( "?{$query}" );
- }
- /**
- * Wraps add_query_arg() with the URL defaulting to the current search URL.
- *
- * @see add_query_arg()
- *
- * @since 5.8.0
- *
- * @param string|array $key Either a query variable key, or an associative array of query variables.
- * @param string $value Optional. A query variable value.
- * @param bool|string $url Optional. A URL to act upon. Defaults to the current search URL.
- *
- * @return string New URL query string (unescaped).
- */
- static function add_query_arg( $key, $value = false, $url = false ) {
- $url = empty( $url ) ? self::get_search_url() : $url;
- if ( is_array( $key ) ) {
- return add_query_arg( $key, $url );
- }
- return add_query_arg( $key, $value, $url );
- }
- /**
- * Wraps remove_query_arg() with the URL defaulting to the current search URL.
- *
- * @see remove_query_arg()
- *
- * @since 5.8.0
- *
- * @param string|array $key Query key or keys to remove.
- * @param bool|string $query Optional. A URL to act upon. Defaults to the current search URL.
- *
- * @return string New URL query string (unescaped).
- */
- static function remove_query_arg( $key, $url = false ) {
- $url = empty( $url ) ? self::get_search_url() : $url;
- return remove_query_arg( $key, $url );
- }
- /**
- * Returns the name of the search widget's option.
- *
- * @since 5.8.0
- *
- * @return string The search widget option name.
- */
- static function get_widget_option_name() {
- return sprintf( 'widget_%s', self::FILTER_WIDGET_BASE );
- }
- /**
- * Returns the search widget instances from the widget's option.
- *
- * @since 5.8.0
- *
- * @return array The widget options.
- */
- static function get_widgets_from_option() {
- $widget_options = get_option( self::get_widget_option_name(), array() );
- // We don't need this
- if ( ! empty( $widget_options ) && isset( $widget_options['_multiwidget'] ) ) {
- unset( $widget_options['_multiwidget'] );
- }
- return $widget_options;
- }
- /**
- * Returns the widget ID (widget base plus the numeric ID).
- *
- * @param int $number The widget's numeric ID.
- *
- * @return string The widget's numeric ID prefixed with the search widget base.
- */
- static function build_widget_id( $number ) {
- return sprintf( '%s-%d', self::FILTER_WIDGET_BASE, $number );
- }
- /**
- * Wrapper for is_active_widget() with the other parameters automatically supplied.
- *
- * @see is_active_widget()
- *
- * @since 5.8.0
- *
- * @param int $widget_id Widget ID.
- *
- * @return bool Whether the widget is active or not.
- */
- static function is_active_widget( $widget_id ) {
- return (bool) is_active_widget( false, $widget_id, self::FILTER_WIDGET_BASE, true );
- }
- /**
- * Returns an array of the filters from all active search widgets.
- *
- * @since 5.8.0
- *
- * @param array|null $allowed_widget_ids array of allowed widget IDs.
- *
- * @return array Active filters.
- */
- public static function get_filters_from_widgets( $allowed_widget_ids = null ) {
- $filters = array();
- $widget_options = self::get_widgets_from_option();
- if ( empty( $widget_options ) ) {
- return $filters;
- }
- foreach ( (array) $widget_options as $number => $settings ) {
- $widget_id = self::build_widget_id( $number );
- if ( ! self::is_active_widget( $widget_id ) || empty( $settings['filters'] ) ) {
- continue;
- }
- if ( isset( $allowed_widget_ids ) && ! in_array( $widget_id, $allowed_widget_ids, true ) ) {
- continue;
- }
- foreach ( (array) $settings['filters'] as $widget_filter ) {
- $widget_filter['widget_id'] = $widget_id;
- if ( empty( $widget_filter['name'] ) ) {
- $widget_filter['name'] = self::generate_widget_filter_name( $widget_filter );
- }
- $type = ( isset( $widget_filter['type'] ) ) ? $widget_filter['type'] : '';
- $key = sprintf( '%s_%d', $type, count( $filters ) );
- $filters[ $key ] = $widget_filter;
- }
- }
- return $filters;
- }
- /**
- * Get the localized default label for a date filter.
- *
- * @since 5.8.0
- *
- * @param string $type Date type, either year or month.
- * @param bool $is_updated Whether the filter was updated or not (adds "Updated" to the end).
- *
- * @return string The filter label.
- */
- static function get_date_filter_type_name( $type, $is_updated = false ) {
- switch ( $type ) {
- case 'year':
- $string = ( $is_updated )
- ? esc_html_x( 'Year Updated', 'label for filtering posts', 'jetpack' )
- : esc_html_x( 'Year', 'label for filtering posts', 'jetpack' );
- break;
- case 'month':
- default:
- $string = ( $is_updated )
- ? esc_html_x( 'Month Updated', 'label for filtering posts', 'jetpack' )
- : esc_html_x( 'Month', 'label for filtering posts', 'jetpack' );
- break;
- }
- return $string;
- }
- /**
- * Creates a default name for a filter. Used when the filter label is blank.
- *
- * @since 5.8.0
- *
- * @param array $widget_filter The filter to generate the title for.
- *
- * @return string The suggested filter name.
- */
- static function generate_widget_filter_name( $widget_filter ) {
- $name = '';
- if ( ! isset( $widget_filter['type'] ) ) {
- return $name;
- }
- switch ( $widget_filter['type'] ) {
- case 'post_type':
- $name = _x( 'Post Types', 'label for filtering posts', 'jetpack' );
- break;
- case 'date_histogram':
- $modified_fields = array(
- 'post_modified',
- 'post_modified_gmt',
- );
- switch ( $widget_filter['interval'] ) {
- case 'year':
- $name = self::get_date_filter_type_name(
- 'year',
- in_array( $widget_filter['field'], $modified_fields )
- );
- break;
- case 'month':
- default:
- $name = self::get_date_filter_type_name(
- 'month',
- in_array( $widget_filter['field'], $modified_fields )
- );
- break;
- }
- break;
- case 'taxonomy':
- $tax = get_taxonomy( $widget_filter['taxonomy'] );
- if ( ! $tax ) {
- break;
- }
- if ( isset( $tax->label ) ) {
- $name = $tax->label;
- } elseif ( isset( $tax->labels ) && isset( $tax->labels->name ) ) {
- $name = $tax->labels->name;
- }
- break;
- }
- return $name;
- }
- /**
- * Whether we should rerun a search in the customizer preview or not.
- *
- * @since 5.8.0
- *
- * @return bool
- */
- static function should_rerun_search_in_customizer_preview() {
- // Only update when in a customizer preview and data is being posted.
- // Check for $_POST removes an extra update when the customizer loads.
- //
- // Note: We use $GLOBALS['wp_customize'] here instead of is_customize_preview() to support unit tests.
- if ( ! isset( $GLOBALS['wp_customize'] ) || ! $GLOBALS['wp_customize']->is_preview() || empty( $_POST ) ) {
- return false;
- }
- return true;
- }
- /**
- * Since PHP's built-in array_diff() works by comparing the values that are in array 1 to the other arrays,
- * if there are less values in array 1, it's possible to get an empty diff where one might be expected.
- *
- * @since 5.8.0
- *
- * @param array $array_1
- * @param array $array_2
- *
- * @return array
- */
- static function array_diff( $array_1, $array_2 ) {
- // If the array counts are the same, then the order doesn't matter. If the count of
- // $array_1 is higher than $array_2, that's also fine. If the count of $array_2 is higher,
- // we need to swap the array order though.
- if ( count( $array_1 ) !== count( $array_2 ) && count( $array_2 ) > count( $array_1 ) ) {
- $temp = $array_1;
- $array_1 = $array_2;
- $array_2 = $temp;
- }
- // Disregard keys
- return array_values( array_diff( $array_1, $array_2 ) );
- }
- /**
- * Given the widget instance, will return true when selected post types differ from searchable post types.
- *
- * @since 5.8.0
- *
- * @param array $post_types An array of post types.
- *
- * @return bool
- */
- static function post_types_differ_searchable( $post_types ) {
- if ( empty( $post_types ) ) {
- return false;
- }
- $searchable_post_types = get_post_types( array( 'exclude_from_search' => false ) );
- $diff_of_searchable = self::array_diff( $searchable_post_types, (array) $post_types );
- return ! empty( $diff_of_searchable );
- }
- /**
- * Given the array of post types, will return true when these differ from the current search query.
- *
- * @since 5.8.0
- *
- * @param array $post_types An array of post types.
- *
- * @return bool
- */
- static function post_types_differ_query( $post_types ) {
- if ( empty( $post_types ) ) {
- return false;
- }
- if ( empty( $_GET['post_type'] ) ) {
- $post_types_from_query = array();
- } elseif ( is_array( $_GET['post_type'] ) ) {
- $post_types_from_query = $_GET['post_type'];
- } else {
- $post_types_from_query = (array) explode( ',', $_GET['post_type'] );
- }
- $post_types_from_query = array_map( 'trim', $post_types_from_query );
- $diff_query = self::array_diff( (array) $post_types, $post_types_from_query );
- return ! empty( $diff_query );
- }
- /**
- * Determine what Tracks value should be used when updating a widget.
- *
- * @since 5.8.0
- *
- * @param mixed $old_value The old option value.
- * @param mixed $new_value The new option value.
- *
- * @return array|false False if the widget wasn't updated, otherwise an array of the Tracks action and widget properties.
- */
- static function get_widget_tracks_value( $old_value, $new_value ) {
- $old_value = (array) $old_value;
- if ( isset( $old_value['_multiwidget'] ) ) {
- unset( $old_value['_multiwidget'] );
- }
- $new_value = (array) $new_value;
- if ( isset( $new_value['_multiwidget'] ) ) {
- unset( $new_value['_multiwidget'] );
- }
- $old_keys = array_keys( $old_value );
- $new_keys = array_keys( $new_value );
- if ( count( $new_keys ) > count( $old_keys ) ) { // This is the case for a widget being added
- $diff = self::array_diff( $new_keys, $old_keys );
- $action = 'widget_added';
- $widget = empty( $diff ) || ! isset( $new_value[ $diff[0] ] )
- ? false
- : $new_value[ $diff[0] ];
- } elseif ( count( $old_keys ) > count( $new_keys ) ) { // This is the case for a widget being deleted
- $diff = self::array_diff( $old_keys, $new_keys );
- $action = 'widget_deleted';
- $widget = empty( $diff ) || ! isset( $old_value[ $diff[0] ] )
- ? false
- : $old_value[ $diff[0] ];
- } else {
- $action = 'widget_updated';
- $widget = false;
- // This is a bit crazy. Since there can be multiple widgets stored in a single option,
- // we need to diff the old and new values to figure out which widget was updated.
- foreach ( $new_value as $key => $new_instance ) {
- if ( ! isset( $old_value[ $key ] ) ) {
- continue;
- }
- $old_instance = $old_value[ $key ];
- // First, let's test the keys of each instance
- $diff = self::array_diff( array_keys( $new_instance ), array_keys( $old_instance ) );
- if ( ! empty( $diff ) ) {
- $widget = $new_instance;
- break;
- }
- // Next, lets's loop over each value and compare it
- foreach ( $new_instance as $k => $v ) {
- if ( is_scalar( $v ) && (string) $v !== (string) $old_instance[ $k ] ) {
- $widget = $new_instance;
- break;
- }
- if ( 'filters' == $k ) {
- if ( count( $new_instance['filters'] ) != count( $old_instance['filters'] ) ) {
- $widget = $new_instance;
- break;
- }
- foreach ( $v as $filter_key => $new_filter_value ) {
- $diff = self::array_diff( $new_filter_value, $old_instance['filters'][ $filter_key ] );
- if ( ! empty( $diff ) ) {
- $widget = $new_instance;
- break;
- }
- }
- }
- }
- }
- }
- if ( empty( $action ) || empty( $widget ) ) {
- return false;
- }
- return array(
- 'action' => $action,
- 'widget' => self::get_widget_properties_for_tracks( $widget ),
- );
- }
- /**
- * Creates the widget properties for sending to Tracks.
- *
- * @since 5.8.0
- *
- * @param array $widget The widget instance.
- *
- * @return array The widget properties.
- */
- static function get_widget_properties_for_tracks( $widget ) {
- $sanitized = array();
- foreach ( (array) $widget as $key => $value ) {
- if ( '_multiwidget' == $key ) {
- continue;
- }
- if ( is_scalar( $value ) ) {
- $key = str_replace( '-', '_', sanitize_key( $key ) );
- $key = "widget_{$key}";
- $sanitized[ $key ] = $value;
- }
- }
- $filters_properties = ! empty( $widget['filters'] )
- ? self::get_filter_properties_for_tracks( $widget['filters'] )
- : array();
- return array_merge( $sanitized, $filters_properties );
- }
- /**
- * Creates the filter properties for sending to Tracks.
- *
- * @since 5.8.0
- *
- * @param array $filters An array of filters.
- *
- * @return array The filter properties.
- */
- static function get_filter_properties_for_tracks( $filters ) {
- if ( empty( $filters ) ) {
- return $filters;
- }
- $filters_properties = array(
- 'widget_filter_count' => count( $filters ),
- );
- foreach ( $filters as $filter ) {
- if ( empty( $filter['type'] ) ) {
- continue;
- }
- $key = sprintf( 'widget_filter_type_%s', $filter['type'] );
- if ( isset( $filters_properties[ $key ] ) ) {
- $filters_properties[ $key ] ++;
- } else {
- $filters_properties[ $key ] = 1;
- }
- }
- return $filters_properties;
- }
- /**
- * Gets the active post types given a set of filters.
- *
- * @since 5.8.0
- *
- * @param array $filters The active filters for the current query.
- *
- * @return array The active post types.
- */
- public static function get_active_post_types( $filters ) {
- $active_post_types = array();
- foreach ( $filters as $item ) {
- if ( ( 'post_type' == $item['type'] ) && isset( $item['query_vars']['post_type'] ) ) {
- $active_post_types[] = $item['query_vars']['post_type'];
- }
- }
- return $active_post_types;
- }
- /**
- * Sets active to false on all post type buckets.
- *
- * @since 5.8.0
- *
- * @param array $filters The available filters for the current query.
- *
- * @return array The filters for the current query with modified active field.
- */
- public static function remove_active_from_post_type_buckets( $filters ) {
- $modified = $filters;
- foreach ( $filters as $key => $filter ) {
- if ( 'post_type' === $filter['type'] && ! empty( $filter['buckets'] ) ) {
- foreach ( $filter['buckets'] as $k => $bucket ) {
- $bucket['active'] = false;
- $modified[ $key ]['buckets'][ $k ] = $bucket;
- }
- }
- }
- return $modified;
- }
- /**
- * Given a url and an array of post types, will ensure that the post types are properly applied to the URL as args.
- *
- * @since 5.8.0
- *
- * @param string $url The URL to add post types to.
- * @param array $post_types An array of post types that should be added to the URL.
- *
- * @return string The URL with added post types.
- */
- public static function add_post_types_to_url( $url, $post_types ) {
- $url = Jetpack_Search_Helpers::remove_query_arg( 'post_type', $url );
- if ( empty( $post_types ) ) {
- return $url;
- }
- $url = Jetpack_Search_Helpers::add_query_arg(
- 'post_type',
- implode( ',', $post_types ),
- $url
- );
- return $url;
- }
- /**
- * Since we provide support for the widget restricting post types by adding the selected post types as
- * active filters, if removing a post type filter would result in there no longer be post_type args in the URL,
- * we need to be sure to add them back.
- *
- * @since 5.8.0
- *
- * @param array $filters An array of possible filters for the current query.
- * @param array $post_types The post types to ensure are on the link.
- *
- * @return array The updated array of filters with post typed added to the remove URLs.
- */
- public static function ensure_post_types_on_remove_url( $filters, $post_types ) {
- $modified = $filters;
- foreach ( (array) $filters as $filter_key => $filter ) {
- if ( 'post_type' !== $filter['type'] || empty( $filter['buckets'] ) ) {
- $modified[ $filter_key ] = $filter;
- continue;
- }
- foreach ( (array) $filter['buckets'] as $bucket_key => $bucket ) {
- if ( empty( $bucket['remove_url'] ) ) {
- continue;
- }
- $parsed = wp_parse_url( $bucket['remove_url'] );
- if ( ! $parsed ) {
- continue;
- }
- $query = array();
- if ( ! empty( $parsed['query'] ) ) {
- wp_parse_str( $parsed['query'], $query );
- }
- if ( empty( $query['post_type'] ) ) {
- $modified[ $filter_key ]['buckets'][ $bucket_key ]['remove_url'] = self::add_post_types_to_url(
- $bucket['remove_url'],
- $post_types
- );
- }
- }
- }
- return $modified;
- }
- /**
- * Wraps a WordPress filter called "jetpack_search_disable_widget_filters" that allows
- * developers to disable filters supplied by the search widget. Useful if filters are
- * being defined at the code level.
- *
- * @since 5.8.0
- *
- * @return bool
- */
- public static function are_filters_by_widget_disabled() {
- /**
- * Allows developers to disable filters being set by widget, in favor of manually
- * setting filters via `Jetpack_Search::set_filters()`.
- *
- * @module search
- *
- * @since 5.7.0
- *
- * @param bool false
- */
- return apply_filters( 'jetpack_search_disable_widget_filters', false );
- }
- /**
- * Returns the maximum posts per page for a search query.
- *
- * @since 5.8.0
- *
- * @return int
- */
- public static function get_max_posts_per_page() {
- return Jetpack_Search_Options::site_has_vip_index() ? 1000 : 100;
- }
- /**
- * Returns the maximum offset for a search query.
- *
- * @since 5.8.0
- *
- * @return int
- */
- public static function get_max_offset() {
- return Jetpack_Search_Options::site_has_vip_index() ? 9000 : 1000;
- }
- /**
- * Returns the maximum offset for a search query.
- *
- * @since 8.4.0
- * @param string $locale A potentially valid locale string.
- *
- * @return bool
- */
- public static function is_valid_locale( $locale ) {
- if ( ! class_exists( 'GP_Locales' ) ) {
- if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
- require JETPACK__GLOTPRESS_LOCALES_PATH;
- } else {
- // Assume locale to be valid if we can't check with GlotPress.
- return true;
- }
- }
- return false !== GP_Locales::by_field( 'wp_locale', $locale );
- }
- /**
- * Get the version number to use when loading the file. Allows us to bypass cache when developing.
- *
- * @since 8.6.0
- * @param string $file Path of the file we are looking for.
- * @return string $script_version Version number.
- */
- public static function get_asset_version( $file ) {
- return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
- ? filemtime( JETPACK__PLUGIN_DIR . $file )
- : JETPACK__VERSION;
- }
- /**
- * Generates a customizer settings ID for a given post type.
- *
- * @since 8.8.0
- * @param object $post_type Post type object returned from get_post_types.
- * @return string $customizer_id Customizer setting ID.
- */
- public static function generate_post_type_customizer_id( $post_type ) {
- return Jetpack_Search_Options::OPTION_PREFIX . 'disable_post_type_' . $post_type->name;
- }
- /**
- * Generates an array of post types associated with their customizer IDs.
- *
- * @since 8.8.0
- * @return array $ids Post type => post type customizer ID object.
- */
- public static function generate_post_type_customizer_ids() {
- return array_map(
- array( 'self', 'generate_post_type_customizer_id' ),
- get_post_types( array( 'exclude_from_search' => false ), 'objects' )
- );
- }
- /**
- * Sanitizes a checkbox value for writing to the database.
- *
- * @since 8.9.0
- *
- * @param any $value from the customizer form.
- * @return string either '0' or '1'.
- */
- public static function sanitize_checkbox_value( $value ) {
- return true === $value ? '1' : '0';
- }
- /**
- * Sanitizes a checkbox value for rendering the Customizer.
- *
- * @since 8.9.0
- *
- * @param any $value from the database.
- * @return boolean
- */
- public static function sanitize_checkbox_value_for_js( $value ) {
- return '1' === $value;
- }
- /**
- * Passes all options to the JS app.
- */
- public static function generate_initial_javascript_state() {
- $widget_options = self::get_widgets_from_option();
- if ( is_array( $widget_options ) ) {
- $widget_options = end( $widget_options );
- }
- $overlay_widget_ids = is_active_sidebar( 'jetpack-instant-search-sidebar' ) ?
- wp_get_sidebars_widgets()['jetpack-instant-search-sidebar'] : array();
- $filters = self::get_filters_from_widgets();
- $widgets = array();
- $widgets_outside_overlay = array();
- foreach ( $filters as $key => &$filter ) {
- $filter['filter_id'] = $key;
- if ( in_array( $filter['widget_id'], $overlay_widget_ids, true ) ) {
- if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
- $widgets[ $filter['widget_id'] ]['filters'] = array();
- $widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
- }
- $widgets[ $filter['widget_id'] ]['filters'][] = $filter;
- } else {
- if ( ! isset( $widgets_outside_overlay[ $filter['widget_id'] ] ) ) {
- $widgets_outside_overlay[ $filter['widget_id'] ]['filters'] = array();
- $widgets_outside_overlay[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
- }
- $widgets_outside_overlay[ $filter['widget_id'] ]['filters'][] = $filter;
- }
- }
- unset( $filter );
- $has_non_search_widgets = false;
- foreach ( $overlay_widget_ids as $overlay_widget_id ) {
- if ( strpos( $overlay_widget_id, self::FILTER_WIDGET_BASE ) === false ) {
- $has_non_search_widgets = true;
- break;
- }
- }
- $post_type_objs = get_post_types( array( 'exclude_from_search' => false ), 'objects' );
- $post_type_labels = array();
- foreach ( $post_type_objs as $key => $obj ) {
- $post_type_labels[ $key ] = array(
- 'singular_name' => $obj->labels->singular_name,
- 'name' => $obj->labels->name,
- );
- }
- $prefix = Jetpack_Search_Options::OPTION_PREFIX;
- $posts_per_page = (int) get_option( 'posts_per_page' );
- if ( ( $posts_per_page > 20 ) || ( $posts_per_page <= 0 ) ) {
- $posts_per_page = 20;
- }
- $excluded_post_types = get_option( $prefix . 'excluded_post_types' ) ? explode( ',', get_option( $prefix . 'excluded_post_types', '' ) ) : array();
- $post_types = array_values(
- get_post_types(
- array(
- 'exclude_from_search' => false,
- 'public' => true,
- )
- )
- );
- $unexcluded_post_types = array_diff( $post_types, $excluded_post_types );
- // NOTE: If all post types are being excluded, ignore the option value.
- if ( count( $unexcluded_post_types ) === 0 ) {
- $excluded_post_types = array();
- }
- $is_wpcom = defined( 'IS_WPCOM' ) && IS_WPCOM;
- $is_private_site = '-1' === get_option( 'blog_public' );
- $is_jetpack_photon_enabled = method_exists( 'Jetpack', 'is_module_active' ) && Jetpack::is_module_active( 'photon' );
- $options = array(
- 'overlayOptions' => array(
- 'colorTheme' => get_option( $prefix . 'color_theme', 'light' ),
- 'enableInfScroll' => get_option( $prefix . 'inf_scroll', '1' ) === '1',
- 'enableSort' => get_option( $prefix . 'enable_sort', '1' ) === '1',
- 'highlightColor' => get_option( $prefix . 'highlight_color', '#FFC' ),
- 'overlayTrigger' => get_option( $prefix . 'overlay_trigger', 'immediate' ),
- 'resultFormat' => get_option( $prefix . 'result_format', Jetpack_Search_Options::RESULT_FORMAT_MINIMAL ),
- 'showPoweredBy' => get_option( $prefix . 'show_powered_by', '1' ) === '1',
- // These options require kicking off a new search.
- 'defaultSort' => get_option( $prefix . 'default_sort', 'relevance' ),
- 'excludedPostTypes' => $excluded_post_types,
- ),
- // core config.
- 'homeUrl' => home_url(),
- 'locale' => str_replace( '_', '-', self::is_valid_locale( get_locale() ) ? get_locale() : 'en_US' ),
- 'postsPerPage' => $posts_per_page,
- 'siteId' => class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'get_option' ) ? Jetpack::get_option( 'id' ) : get_current_blog_id(),
- 'postTypes' => $post_type_labels,
- 'webpackPublicPath' => plugins_url( '_inc/build/instant-search/', JETPACK__PLUGIN_FILE ),
- 'isPhotonEnabled' => ( $is_wpcom || $is_jetpack_photon_enabled ) && ! $is_private_site,
- // config values related to private site support.
- 'apiRoot' => esc_url_raw( rest_url() ),
- 'apiNonce' => wp_create_nonce( 'wp_rest' ),
- 'isPrivateSite' => $is_private_site,
- 'isWpcom' => $is_wpcom,
- // widget info.
- 'hasOverlayWidgets' => count( $overlay_widget_ids ) > 0,
- 'widgets' => array_values( $widgets ),
- 'widgetsOutsideOverlay' => array_values( $widgets_outside_overlay ),
- 'hasNonSearchWidgets' => $has_non_search_widgets,
- );
- /**
- * Customize Instant Search Options.
- *
- * @module search
- *
- * @since 7.7.0
- *
- * @param array $options Array of parameters used in Instant Search queries.
- */
- return apply_filters( 'jetpack_instant_search_options', $options );
- }
- /**
- * Prints the Instant Search sidebar.
- */
- public static function print_instant_search_sidebar() {
- ?>
- <div class="jetpack-instant-search__widget-area" style="display: none">
- <?php if ( is_active_sidebar( 'jetpack-instant-search-sidebar' ) ) { ?>
- <?php dynamic_sidebar( 'jetpack-instant-search-sidebar' ); ?>
- <?php } ?>
- </div>
- <?php
- }
- }
|