Automattic\WooCommerce\Abilities

ExtensibleAbilities::get_query_args │ public static │ WC 11.3.0

Get the query arguments of the filters in the input of a list ability. Each key holds one clause for each filter, so array_merge_recursive() adds them to WP_Query or wc_get_orders() arguments with AND. post__in holds the IDs that every include_ids filter returned, without the IDs that any exclude_ids filter returned, or 0 when none remain, because an empty post__in does not filter. Without include_ids, the excluded IDs go to post__not_in, which WP_Query ignores next to post__in.

Метод класса: ExtensibleAbilities{}

Хуков нет.

Возвращает

array<string, array>|\WP_Error. The error of a value that fails its schema, or of a filter that refused its value or failed.

Использование

$result = ExtensibleAbilities::get_query_args( $resource_name, $input );
$resource_name(строка) (обязательный)
Resource.
$input(array<string, mixed>) (обязательный)
Ability input.

Список изменений

С версии 11.3.0 Введена.

Код ExtensibleAbilities::get_query_args() WC 11.3.0

public static function get_query_args( string $resource_name, array $input ) {
	$query_args = array();
	$include    = null;
	$exclude    = array();
	if ( ! self::is_enabled() ) {
		return $query_args;
	}

	foreach ( self::$filters[ $resource_name ] ?? array() as $namespace => $filters ) {
		foreach ( $filters as $filter => $args ) {
			if ( ! is_array( $input['filters']['extensions'][ $namespace ] ?? null ) || ! array_key_exists( $filter, $input['filters']['extensions'][ $namespace ] ) ) {
				continue;
			}

			$value = rest_sanitize_value_from_schema( $input['filters']['extensions'][ $namespace ][ $filter ], $args['schema'], $filter );
			if ( is_wp_error( $value ) ) {
				$value->add_data( array( 'status' => 400 ) );
				return $value;
			}
			try {
				$clauses = call_user_func( $args['callback'], $value );
			} catch ( \Throwable $e ) {
				wc_get_logger()->error(
					sprintf( 'Ability filter "%s.%s" of "%s" failed: %s', $namespace, $filter, $resource_name, $e->getMessage() ),
					array( 'source' => 'extensible-abilities' )
				);
				$clauses = null;
			}
			if ( is_wp_error( $clauses ) ) {
				return $clauses;
			}
			if (
				! is_array( $clauses )
				|| ! empty( array_diff_key( $clauses, array_flip( self::QUERY_ARG_KEYS ) ) )
				|| ( 'product' !== $resource_name && isset( $clauses['tax_query'] ) )
				|| in_array( false, array_map( 'is_array', $clauses ), true )
			) {
				return new \WP_Error(
					'woocommerce_ability_extension_filter_failed',
					/* translators: %s: filter name, such as subscriptions.subscribable. */
					sprintf( __( 'The "%s" filter failed.', 'woocommerce' ), $namespace . '.' . $filter ),
					array( 'status' => 500 )
				);
			}
			if ( isset( $clauses['include_ids'] ) ) {
				$filter_ids = self::get_filter_ids( $clauses['include_ids'], $namespace . '.' . $filter );
				if ( is_wp_error( $filter_ids ) ) {
					return $filter_ids;
				}
				$include = null === $include ? $filter_ids : array_values( array_intersect( $include, $filter_ids ) );
				unset( $clauses['include_ids'] );
			}
			if ( isset( $clauses['exclude_ids'] ) ) {
				$filter_ids = self::get_filter_ids( $clauses['exclude_ids'], $namespace . '.' . $filter );
				if ( is_wp_error( $filter_ids ) ) {
					return $filter_ids;
				}
				$exclude = array_merge( $exclude, $filter_ids );
				unset( $clauses['exclude_ids'] );
			}
			foreach ( $clauses as $key => $clause ) {
				if ( empty( $clause ) ) {
					continue;
				}
				$query_args[ $key ][] = $clause;
			}
		}
	}
	if ( null !== $include ) {
		$include                = array_values( array_diff( $include, $exclude ) );
		$query_args['post__in'] = empty( $include ) ? array( 0 ) : $include;
	} elseif ( ! empty( $exclude ) ) {
		$query_args['post__not_in'] = array_values( array_unique( $exclude ) );
	}
	return $query_args;
}