<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Elementor\Modules\WpRest\Classes;

[2] Fix | Delete

[3] Fix | Delete

use Elementor\Core\Utils\Collection;

[4] Fix | Delete

use Elementor\Modules\WpRest\Base\Query as Base;

[5] Fix | Delete

[6] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[7] Fix | Delete

exit; // Exit if accessed directly.

[8] Fix | Delete

}

[9] Fix | Delete

[10] Fix | Delete

class Term_Query extends Base {

[11] Fix | Delete

const ENDPOINT = 'term';

[12] Fix | Delete

const SEARCH_FILTER_ACCEPTED_ARGS = 3;

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* @param array $clauses Associative array of the clauses for the query.

[16] Fix | Delete

* @param array $taxonomies Array of taxonomy names.

[17] Fix | Delete

* @param array $args The args passed to 'get_terms()'.

[18] Fix | Delete

* @return array Modified clauses.

[19] Fix | Delete

*/

[20] Fix | Delete

public function customize_terms_query( $clauses, $taxonomies, $args ) {

[21] Fix | Delete

if ( ! $args['custom_search'] ) {

[22] Fix | Delete

return $clauses;

[23] Fix | Delete

}

[24] Fix | Delete

[25] Fix | Delete

if ( is_numeric( $args['name__like'] ) ) {

[26] Fix | Delete

$clauses['where'] = '(' . $clauses['where'] . ' OR t.term_id = ' . $args['name__like'] . ')';

[27] Fix | Delete

}

[28] Fix | Delete

[29] Fix | Delete

if ( empty( $args['excluded_taxonomies'] ) ) {

[30] Fix | Delete

return $clauses;

[31] Fix | Delete

}

[32] Fix | Delete

[33] Fix | Delete

$excluded_taxonomies = $args['excluded_taxonomies'];

[34] Fix | Delete

$escaped = array_map( 'esc_sql', $excluded_taxonomies );

[35] Fix | Delete

$list = "'" . implode( "','", $escaped ) . "'";

[36] Fix | Delete

$clauses['where'] .= " AND tt.taxonomy NOT IN ({$list})";

[37] Fix | Delete

[38] Fix | Delete

return $clauses;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* @param \WP_REST_Request $request

[43] Fix | Delete

* @return \WP_REST_Response

[44] Fix | Delete

*/

[45] Fix | Delete

protected function get( \WP_REST_Request $request ) {

[46] Fix | Delete

$params = $request->get_params();

[47] Fix | Delete

$term = trim( $params[ self::SEARCH_TERM_KEY ] ?? '' );

[48] Fix | Delete

[49] Fix | Delete

if ( empty( $term ) ) {

[50] Fix | Delete

return new \WP_REST_Response( [

[51] Fix | Delete

'success' => true,

[52] Fix | Delete

'data' => [

[53] Fix | Delete

'value' => [],

[54] Fix | Delete

],

[55] Fix | Delete

], 200 );

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

$included_taxonomies = $params[ self::INCLUDED_TYPE_KEY ];

[59] Fix | Delete

$excluded_taxonomies = $params[ self::EXCLUDED_TYPE_KEY ];

[60] Fix | Delete

[61] Fix | Delete

$keys_format_map = $params[ self::KEYS_CONVERSION_MAP_KEY ];

[62] Fix | Delete

[63] Fix | Delete

$requested_count = $params[ self::ITEMS_COUNT_KEY ] ?? 0;

[64] Fix | Delete

$validated_count = max( $requested_count, 1 );

[65] Fix | Delete

$count = min( $validated_count, self::MAX_RESPONSE_COUNT );

[66] Fix | Delete

[67] Fix | Delete

$should_hide_empty = $params[ self::HIDE_EMPTY_KEY ] ?? false;

[68] Fix | Delete

[69] Fix | Delete

$query_args = [

[70] Fix | Delete

'number' => $count,

[71] Fix | Delete

'name__like' => $term,

[72] Fix | Delete

'hide_empty' => $should_hide_empty,

[73] Fix | Delete

'taxonomy' => ! empty( $included_taxonomies ) ? $included_taxonomies : null,

[74] Fix | Delete

'excluded_taxonomies' => $excluded_taxonomies ?? [],

[75] Fix | Delete

'suppress_filter' => false,

[76] Fix | Delete

'custom_search' => true,

[77] Fix | Delete

];

[78] Fix | Delete

[79] Fix | Delete

if ( ! empty( $params[ self::META_QUERY_KEY ] ) && is_array( $params[ self::META_QUERY_KEY ] ) ) {

[80] Fix | Delete

$query_args['meta_query'] = $params[ self::META_QUERY_KEY ];

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

$this->add_filter_to_customize_query();

[84] Fix | Delete

$terms = new Collection( get_terms( $query_args ) );

[85] Fix | Delete

$this->remove_filter_to_customize_query();

[86] Fix | Delete

[87] Fix | Delete

$term_group_labels = $terms

[88] Fix | Delete

->reduce( function ( $term_types, $term ) {

[89] Fix | Delete

if ( ! isset( $term_types[ $term->taxonomy ] ) ) {

[90] Fix | Delete

$taxonomy = get_taxonomy( $term->taxonomy );

[91] Fix | Delete

$term_types[ $term->taxonomy ] = $taxonomy->labels->name ?? $term->labels;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

return $term_types;

[95] Fix | Delete

}, [] );

[96] Fix | Delete

[97] Fix | Delete

return new \WP_REST_Response( [

[98] Fix | Delete

'success' => true,

[99] Fix | Delete

'data' => [

[100] Fix | Delete

'value' => $terms

[101] Fix | Delete

->map( function ( $term ) use ( $keys_format_map, $term_group_labels ) {

[102] Fix | Delete

$term_object = (array) $term;

[103] Fix | Delete

[104] Fix | Delete

if ( isset( $term_object['taxonomy'] ) ) {

[105] Fix | Delete

$group_name = $term_object['taxonomy'];

[106] Fix | Delete

[107] Fix | Delete

if ( isset( $term_group_labels[ $group_name ] ) ) {

[108] Fix | Delete

$term_object['taxonomy'] = $term_group_labels[ $group_name ];

[109] Fix | Delete

}

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

return $this->translate_keys( $term_object, $keys_format_map );

[113] Fix | Delete

} )

[114] Fix | Delete

->all(),

[115] Fix | Delete

],

[116] Fix | Delete

], 200 );

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* @return void

[121] Fix | Delete

*/

[122] Fix | Delete

private function add_filter_to_customize_query() {

[123] Fix | Delete

$priority = self::SEARCH_FILTER_PRIORITY;

[124] Fix | Delete

$accepted_args = self::SEARCH_FILTER_ACCEPTED_ARGS;

[125] Fix | Delete

[126] Fix | Delete

add_filter( 'terms_clauses', [ $this, 'customize_terms_query' ], $priority, $accepted_args );

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* @return void

[131] Fix | Delete

*/

[132] Fix | Delete

private function remove_filter_to_customize_query() {

[133] Fix | Delete

$priority = self::SEARCH_FILTER_PRIORITY;

[134] Fix | Delete

$accepted_args = self::SEARCH_FILTER_ACCEPTED_ARGS;

[135] Fix | Delete

[136] Fix | Delete

remove_filter( 'terms_clauses', [ $this, 'customize_terms_query' ], $priority, $accepted_args );

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* @return array

[141] Fix | Delete

*/

[142] Fix | Delete

protected function get_endpoint_registration_args(): array {

[143] Fix | Delete

return [

[144] Fix | Delete

self::INCLUDED_TYPE_KEY => [

[145] Fix | Delete

'description' => 'Included taxonomy containing terms (categories, tags, etc...)',

[146] Fix | Delete

'type' => 'array',

[147] Fix | Delete

'required' => false,

[148] Fix | Delete

'default' => null,

[149] Fix | Delete

'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),

[150] Fix | Delete

],

[151] Fix | Delete

self::EXCLUDED_TYPE_KEY => [

[152] Fix | Delete

'description' => 'Excluded taxonomy containing terms (categories, tags, etc...)',

[153] Fix | Delete

'type' => 'array',

[154] Fix | Delete

'required' => false,

[155] Fix | Delete

'default' => null,

[156] Fix | Delete

'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),

[157] Fix | Delete

],

[158] Fix | Delete

self::SEARCH_TERM_KEY => [

[159] Fix | Delete

'description' => 'Terms to search',

[160] Fix | Delete

'type' => 'string',

[161] Fix | Delete

'required' => false,

[162] Fix | Delete

'default' => '',

[163] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[164] Fix | Delete

],

[165] Fix | Delete

self::KEYS_CONVERSION_MAP_KEY => [

[166] Fix | Delete

'description' => 'Specify keys to extract and convert, i.e. ["key_1" => "new_key_1"].',

[167] Fix | Delete

'type' => 'array',

[168] Fix | Delete

'required' => false,

[169] Fix | Delete

'default' => [

[170] Fix | Delete

'term_id' => 'id',

[171] Fix | Delete

'name' => 'label',

[172] Fix | Delete

'taxonomy' => 'groupLabel',

[173] Fix | Delete

],

[174] Fix | Delete

'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),

[175] Fix | Delete

],

[176] Fix | Delete

self::ITEMS_COUNT_KEY => [

[177] Fix | Delete

'description' => 'Terms per request',

[178] Fix | Delete

'type' => 'integer',

[179] Fix | Delete

'required' => false,

[180] Fix | Delete

'default' => self::MAX_RESPONSE_COUNT,

[181] Fix | Delete

],

[182] Fix | Delete

self::HIDE_EMPTY_KEY => [

[183] Fix | Delete

'description' => 'Whether to include only public terms',

[184] Fix | Delete

'type' => 'boolean',

[185] Fix | Delete

'required' => false,

[186] Fix | Delete

'default' => false,

[187] Fix | Delete

],

[188] Fix | Delete

self::META_QUERY_KEY => [

[189] Fix | Delete

'description' => 'WP_Query meta_query array',

[190] Fix | Delete

'type' => 'array',

[191] Fix | Delete

'required' => false,

[192] Fix | Delete

'default' => null,

[193] Fix | Delete

'sanitize_callback' => fn ( ...$args ) => self::sanitize_string_array( ...$args ),

[194] Fix | Delete

],

[195] Fix | Delete

];

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

protected static function get_allowed_param_keys(): array {

[199] Fix | Delete

return [

[200] Fix | Delete

self::EXCLUDED_TYPE_KEY,

[201] Fix | Delete

self::INCLUDED_TYPE_KEY,

[202] Fix | Delete

self::KEYS_CONVERSION_MAP_KEY,

[203] Fix | Delete

self::META_QUERY_KEY,

[204] Fix | Delete

self::TAX_QUERY_KEY,

[205] Fix | Delete

self::ITEMS_COUNT_KEY,

[206] Fix | Delete

];

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

protected static function get_keys_to_encode(): array {

[210] Fix | Delete

return [

[211] Fix | Delete

self::EXCLUDED_TYPE_KEY,

[212] Fix | Delete

self::INCLUDED_TYPE_KEY,

[213] Fix | Delete

self::KEYS_CONVERSION_MAP_KEY,

[214] Fix | Delete

self::META_QUERY_KEY,

[215] Fix | Delete

self::TAX_QUERY_KEY,

[216] Fix | Delete

];

[217] Fix | Delete

}

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete