Source: includes/classes/Feature/Facets/Types/Meta/Renderer.php

  1. <?php
  2. /**
  3.  * Class responsible for rendering the filters.
  4.  *
  5.  * @since 4.3.0
  6.  * @package elasticpress
  7.  */
  9. namespace ElasticPress\Feature\Facets\Types\Meta;
  11. use ElasticPress\Features;
  13. if ( ! defined( 'ABSPATH' ) ) {
  14. 	exit; // Exit if accessed directly.
  15. }
  17. /**
  18.  * Facets render class
  19.  */
  20. class Renderer extends \ElasticPress\Feature\Facets\Renderer {
  21. 	/**
  22. 	 * Holds the meta field selected.
  23. 	 *
  24. 	 * @var string
  25. 	 */
  26. 	protected $meta_field = '';
  28. 	/**
  29. 	 * Whether the term count should be displayed or not.
  30. 	 *
  31. 	 * @var bool
  32. 	 */
  33. 	protected $display_count = false;
  35. 	/**
  36. 	 * Output the widget or block HTML.
  37. 	 *
  38. 	 * @param array $args     Widget args
  39. 	 * @param array $instance Instance settings
  40. 	 */
  41. 	public function render( $args, $instance ) {
  42. 		$instance = wp_parse_args(
  43. 			$instance,
  44. 			[
  45. 				'title' => '',
  46. 			]
  47. 		);
  49. 		$this->meta_field    = $instance['facet'];
  50. 		$this->display_count = $instance['displayCount'];
  52. 		if ( ! $this->should_render() ) {
  53. 			return;
  54. 		}
  56. 		$args = wp_parse_args(
  57. 			$args,
  58. 			[
  59. 				'before_widget' => '',
  60. 				'before_title'  => '',
  61. 				'after_title'   => '',
  62. 				'after_widget'  => '',
  63. 			]
  64. 		);
  66. 		$feature = Features::factory()->get_registered_feature( 'facets' );
  68. 		$facet_type = $feature->types['meta'];
  70. 		$selected_meta    = $this->get_selected_meta();
  71. 		$selected_filters = $feature->get_selected();
  73. 		/**
  74. 		 * Get all the terms so we know if we should output the widget
  75. 		 */
  76. 		$raw_values = $facet_type->get_meta_values( $instance['facet'] );
  78. 		$values = [];
  80. 		foreach ( $raw_values as $raw_value ) {
  81. 			$values[ $raw_value ] = [
  82. 				'value'       => $raw_value,
  83. 				'name'        => $raw_value,
  84. 				'count'       => 0,
  85. 				'is_selected' => in_array( $raw_value, $selected_meta, true ),
  86. 			];
  88. 			if ( ! empty( $GLOBALS['ep_facet_aggs'][ $facet_type->get_filter_name() . $this->meta_field ][ $raw_value ] ) ) {
  89. 				$values[ $raw_value ]['count'] = (int) $GLOBALS['ep_facet_aggs'][ $facet_type->get_filter_name() . $this->meta_field ][ $raw_value ];
  90. 			}
  91. 		}
  93. 		/**
  94. 		 * Filter meta values, their labels, and count.
  95. 		 *
  96. 		 * If you need to display a value with a different label:
  97. 		 * ```
  98. 		 * add_filter(
  99. 		 *     'ep_facet_meta_all_values',
  100. 		 *     function( $values, $meta_field ) {
  101. 		 *         if ( 'my_field' !== $meta_field ) {
  102. 		 *             return $values;
  103. 		 *         }
  104. 		 *         if ( isset( $values['unreadable_value'] ) ) {
  105. 		 *             $values['unreadable_value']['name'] = 'My Readable Value';
  106. 		 *         }
  107. 		 *         return $values;
  108. 		 *     },
  109. 		 *     10,
  110. 		 *     2
  111. 		 * );
  112. 		 * ```
  113. 		 *
  114. 		 * @hook ep_facet_meta_values_with_count
  115. 		 * @since 4.3.0
  116. 		 * @param {array}  $values     Values with names and counts
  117. 		 * @param {string} $meta_field Meta field
  118. 		 * @param {array}  $instance   Block info
  119. 		 * @return {array} New values
  120. 		 */
  121. 		$values = apply_filters( 'ep_facet_meta_all_values', $values, $this->meta_field, $instance );
  123. 		if ( empty( $values ) ) {
  124. 			return;
  125. 		}
  127. 		echo wp_kses_post( $args['before_widget'] );
  129. 		if ( ! empty( $instance['title'] ) ) {
  130. 			echo wp_kses_post( $args['before_title'] . apply_filters( 'widget_title', $instance['title'] ) . $args['after_title'] );
  131. 		}
  133. 		/**
  134. 		 * Filter facet search threshold
  135. 		 *
  136. 		 * @hook ep_facet_search_threshold
  137. 		 * @param  {int}    $search_threshold Search threshold
  138. 		 * @param  {string} $taxonomy         Current taxonomy
  139. 		 * @param  {string} $context          Hint about where the value will be used
  140. 		 * @param  {array}  $instance         Block instance
  141. 		 * @return  {int} New threshold
  142. 		 */
  143. 		$search_threshold = apply_filters( 'ep_facet_search_threshold', 15, $this->meta_field, 'meta', $instance );
  144. 		?>
  145. 		<div class="terms <?php if ( count( $values ) > $search_threshold ) : ?>searchable<?php endif; ?>">
  146. 			<?php if ( count( $values ) > $search_threshold ) : ?>
  147. 				<input class="facet-search" type="search" placeholder="<?php echo esc_attr( $instance['searchPlaceholder'] ); ?>">
  148. 			<?php endif; ?>
  150. 			<div class="inner">
  151. 				<?php
  152. 				$orderby = $instance['orderby'] ?? 'count';
  153. 				$order   = $instance['order'] ?? 'desc';
  155. 				$values = $this->order_values( $values, $orderby, $order );
  156. 				foreach ( $values as $raw_value => $item ) {
  158. 					$field_filters = $selected_filters;
  159. 					if ( $item['is_selected'] ) {
  160. 						unset( $field_filters[ $facet_type->get_filter_type() ][ $this->meta_field ]['terms'][ $raw_value ] );
  161. 					} else {
  162. 						$field_filters[ $facet_type->get_filter_type() ][ $this->meta_field ]['terms'][ $raw_value ] = 1;
  163. 					}
  165. 					// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
  166. 					echo $this->get_facet_item_value_html(
  167. 						$item,
  168. 						$feature->build_query_url( $field_filters )
  169. 					);
  170. 					// phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped
  171. 				}
  172. 				?>
  173. 			</div>
  174. 		</div>
  175. 		<?php
  177. 		// Enqueue Script & Styles
  178. 		wp_enqueue_script( 'elasticpress-facets' );
  179. 		wp_enqueue_style( 'elasticpress-facets' );
  181. 		echo wp_kses_post( $args['after_widget'] );
  182. 	}
  184. 	/**
  185. 	 * Get the markup for an individual facet item.
  186. 	 *
  187. 	 * @param array  $item  Facet item.
  188. 	 * @param string $url   Filter URL.
  189. 	 * @return string HTML for an individual facet term.
  190. 	 */
  191. 	public function get_facet_item_value_html( $item, string $url ): string {
  192. 		$href = sprintf(
  193. 			'href="%s"',
  194. 			esc_url( $url )
  195. 		);
  197. 		$label = $item['name'];
  198. 		if ( $this->display_count ) {
  199. 			$label .= ' <span>(' . $item['count'] . ')</span>';
  200. 		}
  202. 		/**
  203. 		 * Filter the label for an individual meta value.
  204. 		 *
  205. 		 * @since 4.3.0
  206. 		 * @hook ep_facet_meta_value_label
  207. 		 * @param {string} $label Facet meta value label.
  208. 		 * @param {array}  $item Value array. It contains `value`, `name`, `count`, and `is_selected`.
  209. 		 * @return {string} Individual facet meta value label.
  210. 		 */
  211. 		$label = apply_filters( 'ep_facet_meta_value_label', $label, $item );
  213. 		/**
  214. 		 * Filter the accessible label for an individual facet meta value link.
  215. 		 *
  216. 		 * Used as the aria-label attribute for filter links. The accessible
  217. 		 * label should include additional context around what action will be
  218. 		 * performed by visiting the link, such as whether the filter will be
  219. 		 * added or removed.
  220. 		 *
  221. 		 * @since 4.3.0
  222. 		 * @hook ep_facet_meta_value_accessible_label
  223. 		 * @param {string}  $label Facet meta value accessible label.
  224. 		 * @param {array}   $item Value array. It contains `value`, `name`, `count`, and `is_selected`.
  225. 		 * @return {string} Individual facet term accessible label.
  226. 		 */
  227. 		$accessible_label = apply_filters(
  228. 			'ep_facet_meta_value_accessible_label',
  229. 			$item['is_selected']
  230. 				/* translators: %s: Filter term name. */
  231. 				? sprintf( __( 'Remove filter: %s', 'elasticpress' ), $label )
  232. 				/* translators: %s: Filter term name. */
  233. 				: sprintf( __( 'Apply filter: %s', 'elasticpress' ), $label ),
  234. 			$item
  235. 		);
  237. 		$link = sprintf(
  238. 			'<a aria-label="%1$s" %2$s rel="nofollow"><div class="ep-checkbox %3$s" role="presentation"></div>%4$s</a>',
  239. 			esc_attr( $accessible_label ),
  240. 			$item['count'] ? $href : 'aria-role="link" aria-disabled="true"',
  241. 			$item['is_selected'] ? 'checked' : '',
  242. 			wp_kses_post( $label )
  243. 		);
  245. 		$html = sprintf(
  246. 			'<div class="term level-%1$d %2$s %3$s" data-term-name="%4$s" data-term-slug="%5$s">%6$s</div>',
  247. 			0,
  248. 			$item['is_selected'] ? 'selected' : '',
  249. 			! $item['count'] ? 'empty-term' : '',
  250. 			esc_attr( strtolower( $item['value'] ) ),
  251. 			esc_attr( strtolower( $item['value'] ) ),
  252. 			$link
  253. 		);
  255. 		/**
  256. 		 * Filter the HTML for an individual facet meta value.
  257. 		 *
  258. 		 * For term search to work correctly the outermost wrapper of the term
  259. 		 * HTML must have data-term-name and data-term-slug attributes set to
  260. 		 * lowercase versions of the term name and slug respectively.
  261. 		 *
  262. 		 * @since 4.3.0
  263. 		 * @hook ep_facet_meta_value_html
  264. 		 * @param {string} $html  Facet meta value HTML.
  265. 		 * @param {array}  $item Value array. It contains `value`, `name`, `count`, and `is_selected`.
  266. 		 * @param {string} $url   Filter URL.
  267. 		 * @return {string} Individual facet meta value HTML.
  268. 		 */
  269. 		return apply_filters( 'ep_facet_meta_value_html', $html, $item, $url );
  270. 	}
  272. 	/**
  273. 	 * Determine if the block/widget should or not be rendered.
  274. 	 *
  275. 	 * @return boolean
  276. 	 */
  277. 	protected function should_render(): bool {
  278. 		global $wp_query;
  280. 		if ( empty( $this->meta_field ) ) {
  281. 			return false;
  282. 		}
  284. 		$feature = Features::factory()->get_registered_feature( 'facets' );
  285. 		if ( $wp_query->get( 'ep_facet', false ) && ! $feature->is_facetable( $wp_query ) ) {
  286. 			return false;
  287. 		}
  289. 		$es_success = ( ! empty( $wp_query->elasticsearch_success ) ) ? true : false;
  290. 		if ( ! $es_success ) {
  291. 			return false;
  292. 		}
  294. 		return true;
  295. 	}
  297. 	/**
  298. 	 * Get selected values.
  299. 	 *
  300. 	 * @return array
  301. 	 */
  302. 	protected function get_selected_meta(): array {
  303. 		$feature = Features::factory()->get_registered_feature( 'facets' );
  305. 		$selected_filters = $feature->get_selected();
  306. 		$selected_meta    = [];
  308. 		if ( isset( $selected_filters['meta'][ $this->meta_field ] ) && isset( $selected_filters['meta'][ $this->meta_field ]['terms'] ) ) {
  309. 			$selected_meta = array_map( 'trim', array_keys( $selected_filters['meta'][ $this->meta_field ]['terms'] ) );
  310. 		}
  312. 		return $selected_meta;
  313. 	}
  315. 	/**
  316. 	 * DEPRECATED. Get the markup for an individual facet item.
  317. 	 *
  318. 	 * @param array  $value Value.
  319. 	 * @param string $url   Filter URL.
  320. 	 * @return string HTML for an individual facet term.
  321. 	 */
  322. 	public function get_meta_value_html( array $value, string $url ): string {
  323. 		_deprecated_function( __METHOD__, '4.7.0', '\ElasticPress\Feature\Facets\Types\Meta\Renderer::get_facet_item_value_html()' );
  325. 		return $this->get_facet_item_value_html( $value, $url );
  326. 	}
  327. }