slug = 'comments'; $this->title = esc_html__( 'Comments', 'elasticpress' ); $this->summary = __( 'Improve comment search relevancy and query performance.', 'elasticpress' ); $this->docs_url = __( 'https://elasticpress.zendesk.com/hc/en-us/articles/360050447492-Configuring-ElasticPress-via-the-Plugin-Dashboard#comments', 'elasticpress' ); $this->requires_install_reindex = true; parent::__construct(); } /** * Setup search functionality * * @since 3.6.0 */ public function setup() { Indexables::factory()->register( new Indexable\Comment\Comment() ); add_action( 'init', [ $this, 'search_setup' ] ); add_action( 'widgets_init', [ $this, 'register_widget' ] ); add_action( 'rest_api_init', [ $this, 'rest_api_init' ] ); } /** * Setup search integration * * @since 3.6.0 */ public function search_setup() { $admin_integration = apply_filters( 'ep_admin_wp_query_integration', false ); if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) { /** * Filter to integrate with admin ajax queries * * @hook ep_ajax_wp_query_integration * @param {bool} $integrate True to integrate * @return {bool} New value */ if ( ! apply_filters( 'ep_ajax_wp_query_integration', false ) ) { return; } else { $admin_integration = true; } } if ( is_admin() && ! $admin_integration ) { return; } add_filter( 'ep_elasticpress_enabled', [ $this, 'integrate_search_queries' ], 10, 2 ); } /** * Output feature box long text * * @since 3.6.0 */ public function output_feature_box_long() { ?>

query_vars['ep_integrate'] ) && ! filter_var( $query->query_vars['ep_integrate'], FILTER_VALIDATE_BOOLEAN ) ) { $enabled = false; } elseif ( ! empty( $query->query_vars['search'] ) ) { $enabled = true; } return $enabled; } /** * Determine feature reqs status * * @since 3.6.0 * @return FeatureRequirementsStatus */ public function requirements_status() { $status = new FeatureRequirementsStatus( 1 ); return $status; } /** * Register comments widget * * @since 3.6.0 */ public function register_widget() { register_widget( __NAMESPACE__ . '\Widget' ); } /** * Registers the API endpoint to search for comments * * @since 3.6.0 */ public function rest_api_init() { register_rest_route( 'elasticpress/v1', 'comments', [ 'methods' => 'GET', 'callback' => [ $this, 'handle_comments_search' ], 'permission_callback' => '__return_true', 'args' => [ 's' => [ 'validate_callback' => function ( $param ) { return ! empty( $param ); }, 'required' => true, ], 'post_type' => [ 'validate_callback' => function ( $param ) { return ! empty( $param ); }, ], ], ] ); } /** * Handles the search for comments * * @since 3.6.0 * @param \WP_REST_Request $request Rest request * @return array */ public function handle_comments_search( $request ) { $search = $request->get_param( 's' ); if ( empty( $search ) ) { return new \WP_Error( 400 ); } $post_type_filter = explode( ',', $request->get_param( 'post_type' ) ); $searchable_post_types = array_filter( Features::factory()->get_registered_feature( 'search' )->get_searchable_post_types(), function ( $post_type ) { return post_type_supports( $post_type, 'comments' ); } ); if ( ! empty( $post_type_filter ) && is_array( $searchable_post_types ) ) { $post_type_filter = array_intersect( $post_type_filter, $searchable_post_types ); } $default_args = [ 'status' => 'approve', 'search' => $search, 'type' => Indexables::factory()->get( 'comment' )->get_indexable_comment_types(), 'post_type' => empty( $post_type_filter ) ? $searchable_post_types : $post_type_filter, 'post_status' => 'publish', 'number' => 5, ]; /** * Filter to args used in WP_Comment_Query in Widget Search Comment * * @hook ep_comment_search_widget_args * @since 3.6.0 * @param {array} $default_args Defaults args * @return {array} New value */ $args = apply_filters( 'ep_comment_search_widget_args', $default_args ); /** * Fires before the comment query is executed. * * @hook ep_comment_pre_search_widget * @since 3.6.0 * @param {array} $args Args passed to `WP_Comment_Query`. * @param {WP_REST_Request} $request Rest request. */ do_action( 'ep_comment_pre_search_widget', $args, $request ); $comment_query = new \WP_Comment_Query( $args ); /** * Fires after the comment query is executed. * * @hook ep_comment_after_search_widget * @since 3.6.0 * @param {WP_Comment_Query} $comment_query WP_Comment_Query object. * @param {WP_REST_Request} $request Rest request. */ do_action( 'ep_comment_after_search_widget', $comment_query, $request ); $return = []; foreach ( $comment_query->comments as $comment ) { $return[ $comment->comment_ID ] = [ 'id' => $comment->comment_ID, 'content' => $comment->comment_content, 'link' => get_comment_link( $comment ), ]; } /** * Filters the comments response * * @hook ep_comment_search_widget_response * @since 3.6.0 * @param {array} $return The result of fetched comments. * @return {array} New value */ return apply_filters( 'ep_comment_search_widget_response', $return ); } }