Skip to content

feat(autosuggest): enable autosuggest in the WordPress admin #4328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
faisalahammad wants to merge 1 commit into
base: develop
Choose a base branch
from
+321 −42
Open

feat(autosuggest): enable autosuggest in the WordPress admin #4328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 161 additions & 41 deletions includes/classes/Feature/Autosuggest/Autosuggest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ public function __construct() {
$this->requires_install_reindex = true;

$this->default_settings = [
'endpoint_url' => '',
'autosuggest_selector' => '',
'trigger_ga_event' => '0',
'endpoint_url' => '',
'autosuggest_selector' => '',
'trigger_ga_event' => '0',
'enable_admin_autosuggest' => '0',
];

$this->available_during_installation = true;
Expand Down Expand Up @@ -80,6 +81,7 @@ public function set_i18n_strings(): void {
*/
public function setup() {
add_action( 'wp_enqueue_scripts', [ $this, 'enqueue_scripts' ] );
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_admin_scripts' ] );
add_filter( 'ep_post_mapping', [ $this, 'mapping' ] );
add_filter( 'ep_post_sync_args', [ $this, 'filter_term_suggest' ], 10 );
add_filter( 'ep_post_fuzziness_arg', [ $this, 'set_fuzziness' ], 10, 3 );
Expand Down Expand Up @@ -293,21 +295,74 @@ public function enqueue_scripts() {
return;
}

$host = Utils\get_host();
$settings = $this->get_settings();
$endpoint_url = $this->get_autosuggest_endpoint_url();

if ( empty( $endpoint_url ) ) {
return;
}

$this->enqueue_autosuggest_assets();

$query = $this->generate_search_query();

wp_localize_script(
'elasticpress-autosuggest',
'epas',
apply_filters(
'ep_autosuggest_options',
$this->get_epas_options( $query, $endpoint_url, $settings )
)
);
}

/**
* Enqueue autosuggest assets for the WordPress admin.
*
* @since 5.4.0
*/
public function enqueue_admin_scripts() {
if ( Utils\is_indexing() ) {
return;
}

$settings = $this->get_settings();

if ( defined( 'EP_AUTOSUGGEST_ENDPOINT' ) && EP_AUTOSUGGEST_ENDPOINT ) {
$endpoint_url = EP_AUTOSUGGEST_ENDPOINT;
} elseif ( Utils\is_epio() ) {
$endpoint_url = trailingslashit( $host ) . Indexables::factory()->get( 'post' )->get_index_name() . '/autosuggest';
} else {
$endpoint_url = $settings['endpoint_url'];
if ( empty( $settings['enable_admin_autosuggest'] ) ) {
return;
}

$capability = apply_filters( 'ep_admin_autosuggest_capability', 'edit_posts' );
if ( ! current_user_can( $capability ) ) {
return;
}

$endpoint_url = $this->get_autosuggest_endpoint_url();

if ( empty( $endpoint_url ) ) {
return;
}

$this->enqueue_autosuggest_assets();

$query = $this->generate_admin_search_query();

wp_localize_script(
'elasticpress-autosuggest',
'epas',
apply_filters(
'ep_autosuggest_options',
$this->get_epas_options( $query, $endpoint_url, $settings )
)
);
}

/**
* Enqueue the shared autosuggest script and stylesheet.
*
* @since 5.4.0
*/
protected function enqueue_autosuggest_assets() {
wp_enqueue_script(
'elasticpress-autosuggest',
EP_URL . 'dist/js/autosuggest-script.js',
Expand All @@ -324,15 +379,43 @@ public function enqueue_scripts() {
Utils\get_asset_info( 'autosuggest-styles', 'dependencies' ),
Utils\get_asset_info( 'autosuggest-styles', 'version' )
);
}

/**
* Get the configured autosuggest endpoint URL.
*
* @since 5.4.0
* @return string
*/
protected function get_autosuggest_endpoint_url() {
if ( defined( 'EP_AUTOSUGGEST_ENDPOINT' ) && EP_AUTOSUGGEST_ENDPOINT ) {
return EP_AUTOSUGGEST_ENDPOINT;
}

if ( Utils\is_epio() ) {
return trailingslashit( Utils\get_host() ) . Indexables::factory()->get( 'post' )->get_index_name() . '/autosuggest';
}

$settings = $this->get_settings();
return $settings['endpoint_url'];
}

/**
* Build the autosuggest options array to localize to JavaScript.
*
* @since 5.4.0
* @param array $query Generated query array.
* @param string $endpoint_url Endpoint URL.
* @param array $settings Feature settings.
* @return array
*/
protected function get_epas_options( $query, $endpoint_url, $settings ) {
/** Features Class @var Features $features */
$features = Features::factory();

/** Search Feature @var Feature\Search\Search $search */
$search = $features->get_registered_feature( 'search' );

$query = $this->generate_search_query();

$epas_options = [
'query' => $query['body'],
'placeholder' => $query['placeholder'],
Expand Down Expand Up @@ -380,37 +463,17 @@ public function enqueue_scripts() {
$epas_options['highlightingClass'] = apply_filters( 'ep_highlighting_class', 'ep-highlight' );
}

/**
* Output variables to use in Javascript
* index: the Elasticsearch index name
* endpointUrl: the Elasticsearch autosuggest endpoint url
* postType: which post types to use for suggestions
* action: the action to take when selecting an item. Possible values are "search" and "navigate".
*/
wp_localize_script(
'elasticpress-autosuggest',
'epas',
/**
* Filter autosuggest JavaScript options
*
* @hook ep_autosuggest_options
* @param {array} $options Autosuggest options to be localized
* @return {array} New options
*/
apply_filters(
'ep_autosuggest_options',
$epas_options
)
);
return $epas_options;
}

/**
* Build a default search request to pass to the autosuggest javascript.
* The request will include a placeholder that can then be replaced.
*
* @param bool $is_admin Whether the query is being generated for the admin.
* @return array Generated ElasticSearch request array( 'placeholder'=> placeholderstring, 'body' => request body )
*/
public function generate_search_query() {
public function generate_search_query( $is_admin = false ) {

/**
* Filter autosuggest query placeholder
Expand All @@ -435,12 +498,16 @@ public function generate_search_query() {
*/
$post_type = apply_filters( 'ep_term_suggest_post_type', array_values( $post_type ) );

$post_status = get_post_stati(
[
'public' => true,
'exclude_from_search' => false,
]
);
if ( $is_admin ) {
$post_status = Indexables::factory()->get( 'post' )->get_indexable_post_status();
} else {
$post_status = get_post_stati(
[
'public' => true,
'exclude_from_search' => false,
]
);
}

/**
* Filter post statuses available to autosuggest
Expand Down Expand Up @@ -503,6 +570,52 @@ public function generate_search_query() {
];
}

/**
* Generate an autosuggest query template for the WordPress admin.
*
* Forces ElasticPress integration for the duration of the query so the
* template can be captured from an admin context.
*
* @since 5.4.0
* @return array Generated query array.
*/
public function generate_admin_search_query() {
$original_user_id = get_current_user_id();
wp_set_current_user( 0 );

add_filter( 'ep_is_integrated_request', [ $this, 'is_integrated_request_for_admin_template' ], 10, 2 );

$query = $this->generate_search_query( true );

remove_filter( 'ep_is_integrated_request', [ $this, 'is_integrated_request_for_admin_template' ], 10 );

wp_set_current_user( $original_user_id );

return $query;
}

/**
* Enable ElasticPress integration for the admin query template.
*
* Applied as a filter on Utils\is_integrated_request() so the query used to
* generate the admin autosuggest template is integrated regardless of the
* request type.
*
* @since 5.4.0
* @param bool $is_integrated Whether queries for the request will be integrated.
* @param string $context Context for the original check.
* @return bool
*/
public function is_integrated_request_for_admin_template( $is_integrated, $context ) {
$supported_contexts = [ 'search', 'autosuggest' ];

if ( in_array( $context, $supported_contexts, true ) ) {
return true;
}

return $is_integrated;
}

/**
* Ensure we do not fallback to WPDB query for this request
*
Expand Down Expand Up @@ -880,6 +993,13 @@ protected function set_settings_schema() {
'label' => __( 'Trigger Google Analytics events', 'elasticpress' ),
'type' => 'checkbox',
],
[
'default' => '0',
'key' => 'enable_admin_autosuggest',
'help' => __( 'Adds autosuggest to admin search fields such as the post list table. Requires a publicly accessible autosuggest endpoint or ElasticPress.io.', 'elasticpress' ),
'label' => __( 'Enable autosuggest in the WordPress admin', 'elasticpress' ),
'type' => 'checkbox',
],
];

$this->maybe_add_epio_settings_schema();
Expand Down
Loading