Reworking params and also ensure redirects happen early

Author: gin0115

mu-plugins/osi-api/osi-api.php

@@ -31,7 +31,7 @@ public static function init() {
 		// Add all custom rewrites
 		add_action( 'init', array( $instance, 'add_rewrites' ) );
 		add_filter( 'query_vars', array( $instance, 'add_query_vars' ), 0 );
-		add_action( 'template_redirect', array( $instance, 'handle_redirects' ) );
+		add_action( 'template_redirect', array( $instance, 'handle_redirects' ), 0 );
 	}
 
 	/**
@@ -49,17 +49,17 @@ public function register_routes() {
 				'callback'            => array( $this, 'get_licenses' ),
 				'permission_callback' => '__return_true',
 				'args'                => array(
-					'name'    => array(
+					'license_name' => array(
 						'required'    => false,
 						'type'        => 'string',
 						'description' => 'Filter by license name',
 					),
-					'keyword' => array(
+					'keyword'      => array(
 						'required'    => false,
 						'type'        => 'string',
 						'description' => 'Filter licenses by keyword',
 					),
-					'steward' => array(
+					'steward'      => array(
 						'required'    => false,
 						'type'        => 'string',
 						'description' => 'Filter licenses by steward',
@@ -111,7 +111,7 @@ public function register_routes() {
 	public function get_licenses( WP_REST_Request $data ) {
 
 		// Check if we have an ID passed.
-		$name = $data->get_param( 'name' );
+		$name = $data->get_param( 'license_name' );
 
 		// Check if we have any keyword passed.
 		$keyword = $data->get_param( 'keyword' );
@@ -184,14 +184,20 @@ public function get_license_by_slug( WP_REST_Request $request ) {
 		}
 
 		// Get the license post by slug
-		$license = get_page_by_path( $slug, OBJECT, 'license' );
-
-		if ( ! $license ) {
+		$licenses = get_posts(
+			array(
+				'name'        => $slug,
+				'post_type'   => 'license',
+				'post_status' => 'publish',
+				'numberposts' => 1,
+			)
+		);
+		if ( empty( $licenses ) ) {
 			return new WP_REST_Response( array( 'error' => 'License not found.' ), 404 );
 		}
 
 		// Compile the license model
-		$model = $this->get_license_model( $license->ID );
+		$model = $this->get_license_model( $licenses[0]->ID );
 
 		return new WP_REST_Response( $model, 200 );
 	}
@@ -224,7 +230,7 @@ public function get_license_model( string $id ): ?array {
 			'submitter_name'          => get_post_meta( $license->ID, 'submitter', true ),
 			'approval_date'           => get_post_meta( $license->ID, 'approval_date', true ),
 			'license_steward_version' => get_post_meta( $license->ID, 'license_steward_version', true ),
-			'licanse_steward_url'     => get_post_meta( $license->ID, 'license_steward_version_url', true ),
+			'license_steward_url'     => get_post_meta( $license->ID, 'license_steward_version_url', true ),
 			'board_minutes'           => get_post_meta( $license->ID, 'link_to_board_minutes_url', true ),
 		);
 
@@ -304,9 +310,8 @@ public function posts_where_title_like( string $where, \WP_Query $query ) {
 	 * @return void
 	 */
 	public function add_rewrites() {
-		// This is used to redirect /api/licenses to the REST API endpoint.
 		add_rewrite_rule(
-			'^api/licenses?$', // regex for /api/licenses or /api/licenses
+			'^api/licenses?/?$',
 			'index.php?osi_api_redirect=1',
 			'top'
 		);
@@ -317,8 +322,6 @@ public function add_rewrites() {
 			'index.php?osi_api_slug_redirect=1&license_slug=$matches[1]',
 			'top'
 		);
-
-		flush_rewrite_rules();
 	}
 
 	/**
@@ -341,18 +344,28 @@ public function add_query_vars( array $vars ): array {
 	 * @return void
 	 */
 	public function handle_redirects() {
+
+		// Prevent WordPress canonical redirects for custom API endpoints
+		if ( get_query_var( 'osi_api_redirect' ) || get_query_var( 'osi_api_slug_redirect' ) ) {
+			remove_filter( 'template_redirect', 'redirect_canonical' );
+		}
+
 		if ( get_query_var( 'osi_api_redirect' ) ) {
 			// Build REST request
 			$request = new WP_REST_Request( 'GET', '/osi/v1/licenses' );
 
 			// Add query parameters if any
 			if ( ! empty( $_GET ) ) { // phpcs:ignore WordPress.Security.NonceVerification
 				foreach ( $_GET as $key => $value ) { // phpcs:ignore WordPress.Security.NonceVerification
-					// Sanitize key and value
+					// Remap reserved "name" param to avoid canonical redirect
+					if ( $key === 'name' ) {
+						$key = 'license_name';
+					}
+
 					$sanitized_key   = sanitize_key( $key );
 					$sanitized_value = is_array( $value )
-						? array_map( 'sanitize_text_field', $value )
-						: sanitize_text_field( $value );
+					? array_map( 'sanitize_text_field', $value )
+					: sanitize_text_field( $value );
 
 					$request->set_param( $sanitized_key, $sanitized_value );
 				}
@@ -397,6 +410,7 @@ public function handle_redirects() {
 		}
 	}
 
+
 	/**
 	 * Get the License scehema.
 	 *