SWAMPy

✎ CARVE FLESH

EDITING: api-filter-route.php

<?php

class Redirection_Api_Filter_Route extends Redirection_Api_Route {
	/**
	 * Validate filter param against allowed fields
	 *
	 * @param mixed $value Provided filter value.
	 * @param WP_REST_Request $request Request.
	 * @param string $param Param name.
	 *
	 * @phpstan-param mixed $value
	 * @phpstan-param WP_REST_Request<array<string, mixed>> $request
	 * @phpstan-param string $param
	 * @phpstan-return true|WP_Error
	 * @return true|WP_Error
	 */
	public function validate_filter( $value, $request, $param ) {
		$attrs = $request->get_attributes();
		/** @var array<string, mixed> $attrs */
		$fields = [];
		if ( isset( $attrs['args'] ) && is_array( $attrs['args'] ) ) {
			$args = $attrs['args'];
			if ( isset( $args['filterBy'] ) && is_array( $args['filterBy'] ) ) {
				$filter_by = $args['filterBy'];
				if ( isset( $filter_by['filter_fields'] ) && is_array( $filter_by['filter_fields'] ) ) {
					/** @var list<string> $fields */
					$fields = array_values( array_map( 'strval', $filter_by['filter_fields'] ) );
				}
			}
		}

// An empty string means no filter was set (client sent filterBy= with nothing) — normalize to an empty array
		if ( $value === '' ) {
			$request->set_param( $param, [] );
			return true;
		}

if ( ! is_array( $value ) ) {
			return new WP_Error( 'rest_invalid_param', 'Filter is not an array', array( 'status' => 400 ) );
		}

/** @var array<string, mixed> $value */

if ( count( $fields ) > 0 ) {
			foreach ( array_keys( $value ) as $key ) {
				if ( ! in_array( $key, $fields, true ) ) {
					return new WP_Error( 'rest_invalid_param', 'Filter type is not supported: ' . $key, array( 'status' => 400 ) );
				}
			}
		}

return true;
	}

/**
	 * Build shared filter args
	 *
	 * @param list<string> $order_fields Fields allowed for orderby.
	 * @param list<string> $filters Fields allowed to filter by.
	 * @return array<string, mixed>
	 */
	protected function get_filter_args( $order_fields, $filters = [] ) {
		// Safety check: ensure Red_Item class is loaded (prevents fatal errors during incomplete plugin updates)
		// Use a fallback value if the class doesn't exist
		$max_per_page = 200; // Default fallback value
		if ( class_exists( 'Red_Item' ) ) {
			$max_per_page = Red_Item::MAX_PER_PAGE;
		}

return [
			'filterBy' => [
				'description' => 'Field to filter by',
				'validate_callback' => [ $this, 'validate_filter' ],
				'filter_fields' => $filters,
			],
			'orderby' => [
				'description' => 'Field to order results by',
				'type' => 'string',
				'enum' => $order_fields,
			],
			'direction' => [
				'description' => 'Direction of ordered results',
				'type' => 'string',
				'default' => 'desc',
				'enum' => [ 'asc', 'desc' ],
			],
			'per_page' => [
				'description' => 'Number of results per page',
				'type' => 'integer',
				'default' => 25,
				'minimum' => 5,
				'maximum' => $max_per_page,
			],
			'page' => [
				'description' => 'Page offset',
				'type' => 'integer',
				'minimum' => 0,
				'default' => 0,
			],
		];
	}

/**
	 * Register a bulk action endpoint for a resource
	 *
	 * @param string $namespace REST namespace.
	 * @param string $route REST route.
	 * @param list<string> $orders Allowed order fields.
	 * @param list<string> $filters Allowed filter fields.
	 * @param string $callback Handler method on this class.
	 * @param callable|array{0:self,1:string}|false $permissions Permission callback or false for default.
	 * @return void
	 */
	public function register_bulk( $namespace, $route, $orders, $filters, $callback, $permissions = false ) {
		register_rest_route(
			$namespace,
			$route,
			array_merge(
				$this->get_route( WP_REST_Server::EDITABLE, $callback, $permissions ),
				[
					'args' => array_merge(
						$this->get_filter_args( $orders, $filters ),
						[
							'items' => [
								'description' => 'Comma separated list of item IDs to perform action on',
								'type' => 'array',
								'items' => [
									'type' => 'string',
								],
							],
						]
					),
				]
			)
		);
	}
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 api-404.php	PHP	7.1 KB	2026-03-24 05:17	EDIT
📄 api-core.php	PHP	1.1 KB	2026-03-24 05:17	EDIT
📄 api-export.php	PHP	2.5 KB	2026-03-24 05:17	EDIT
📄 api-filter-route.php	PHP	4 KB	2026-03-24 05:17	EDIT
📄 api-group.php	PHP	10.8 KB	2026-03-24 05:17	EDIT
📄 api-import.php	PHP	6 KB	2026-03-24 05:17	EDIT
📄 api-log.php	PHP	8 KB	2026-03-24 05:17	EDIT
📄 api-plugin.php	PHP	8.4 KB	2026-03-24 05:17	EDIT
📄 api-redirect.php	PHP	15.3 KB	2026-03-24 05:17	EDIT
📄 api-route.php	PHP	1.4 KB	2026-03-24 05:17	EDIT
📄 api-settings.php	PHP	6.2 KB	2026-03-24 05:17	EDIT
📄 api.php	PHP	1.7 KB	2026-03-24 05:17	EDIT