REST API: Add source parameter for types endpoint

.gitignore

@@ -58,3 +58,6 @@ assets/build/**/*.php
 /blob-report/
 /playwright/.cache/
 /artifacts/
+
+# Claude settings
+**/.claude/settings.local.json

includes/rest-api.php

@@ -3,7 +3,7 @@
  * REST API
  *
  * @package    Secure Custom Fields
- * @since      ACF 6.4.0
+ * @since      SCF 6.5.0
  */
 
 // Exit if accessed directly.

includes/rest-api/class-acf-rest-types-endpoint.php

@@ -14,19 +14,166 @@
 /**
  * Class SCF_Rest_Types_Endpoint
  *
- * Extends the /wp/v2/types endpoint to include SCF fields.
+ * Extends the /wp/v2/types endpoint to include SCF fields and source filtering.
  *
  * @since SCF 6.5.0
  */
 class SCF_Rest_Types_Endpoint {
 
+	/**
+	 * Cached post types for the current request
+	 *
+	 * @var array|null
+	 */
+	private $cached_post_types = null;
+
 	/**
 	 * Initialize the class.
 	 *
 	 * @since SCF 6.5.0
 	 */
 	public function __construct() {
 		add_action( 'rest_api_init', array( $this, 'register_extra_fields' ) );
+		add_action( 'rest_api_init', array( $this, 'register_parameters' ) );
+
+		// Add filter to process REST API requests by route
+		add_filter( 'rest_request_before_callbacks', array( $this, 'filter_types_request' ), 10, 3 );
+
+		// Add filter to process each post type individually
+		add_filter( 'rest_prepare_post_type', array( $this, 'filter_post_type' ), 10, 3 );
+
+		// Clean up null entries from the response
+		add_filter( 'rest_pre_echo_response', array( $this, 'clean_types_response' ), 10, 3 );
+
+		// Clear cache after each request to make the endpoint stateless
+		add_action( 'rest_request_after_callbacks', array( $this, 'clear_cache_for_types_request' ), 10, 1 );
+	}
+
+	/**
+	 * Filter post types requests, fires for both collection and individual requests.
+	 * We only want to handle individual requets to ensure the post type requested matches the source.
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param mixed           $response The current response, either response or null.
+	 * @param array           $handler  The handler for the route.
+	 * @param WP_REST_Request $request  The request object.
+	 * @return mixed The response or null.
+	 */
+	public function filter_types_request( $response, $handler, $request ) {
+		// We only want to handle individual requests
+		$route = $request->get_route();
+		if ( ! preg_match( '#^/wp/v2/types/([^/]+)$#', $route, $matches ) ) {
+			return $response;
+		}
+
+		$source = $request->get_param( 'source' );
+
+		// Only proceed if source parameter is provided and valid
+		if ( ! $source || ! in_array( $source, array( 'core', 'scf', 'other' ), true ) ) {
+			return $response;
+		}
+
+		// Get post types with caching within this single request
+		if ( null === $this->cached_post_types ) {
+			$this->cached_post_types = $this->get_source_post_types( $source );
+		}
+		$source_post_types = $this->cached_post_types;
+
+		// Check if the requested type matches the source
+		$requested_type = $matches[1];
+		if ( ! in_array( $requested_type, $source_post_types, true ) ) {
+			return new WP_Error(
+				'rest_post_type_invalid',
+				__( 'Invalid post type.', 'secure-custom-fields' ),
+				array( 'status' => 404 )
+			);
+		}
+
+		return $response;
+	}
+
+	/**
+	 * Filter individual post type in the response.
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param WP_REST_Response $response The response object.
+	 * @param WP_Post_Type     $post_type The post type object.
+	 * @param WP_REST_Request  $request The request object.
+	 * @return WP_REST_Response|null The filtered response or null to filter it out.
+	 */
+	public function filter_post_type( $response, $post_type, $request ) {
+		$source = $request->get_param( 'source' );
+
+		// Only apply filtering if source parameter is provided and valid
+		if ( ! $source || ! in_array( $source, array( 'core', 'scf', 'other' ), true ) ) {
+			return $response;
+		}
+
+		// Get post types with caching within this single request
+		if ( null === $this->cached_post_types ) {
+			$this->cached_post_types = $this->get_source_post_types( $source );
+		}
+		$source_post_types = $this->cached_post_types;
+
+		if ( ! in_array( $post_type->name, $source_post_types, true ) ) {
+			return null;
+		}
+
+		return $response;
+	}
+
+	/**
+	 * Get an array of post types for each source.
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param string $source The source to get post types for.
+	 * @return array An array of post type names for the specified source.
+	 */
+	private function get_source_post_types( $source ) {
+
+		$core_types = array();
+		$scf_types  = array();
+
+		if ( 'core' === $source || 'other' === $source ) {
+			$all_post_types = get_post_types( array( '_builtin' => true ), 'objects' );
+			foreach ( $all_post_types as $post_type ) {
+				$core_types[] = $post_type->name;
+			}
+		}
+
+		if ( 'scf' === $source || 'other' === $source ) {
+			// Get SCF-managed post types
+			if ( function_exists( 'acf_get_internal_post_type_posts' ) ) {
+				$scf_managed_post_types = acf_get_internal_post_type_posts( 'acf-post-type' );
+				foreach ( $scf_managed_post_types as $scf_post_type ) {
+					if ( isset( $scf_post_type['post_type'] ) ) {
+						$scf_types[] = $scf_post_type['post_type'];
+					}
+				}
+			}
+		}
+
+		switch ( $source ) {
+			case 'core':
+				$result = $core_types;
+				break;
+			case 'scf':
+				$result = $scf_types;
+				break;
+			case 'other':
+				$result = array_diff(
+					array_keys( get_post_types( array(), 'objects' ) ),
+					array_merge( $core_types, $scf_types )
+				);
+				break;
+			default:
+				$result = array();
+		}
+
+		return $result;
 	}
 
 	/**
@@ -40,6 +187,7 @@ public function register_extra_fields() {
 		if ( ! (bool) get_option( 'scf_beta_feature_editor_sidebar_enabled', false ) ) {
 			return;
 		}
+
 		register_rest_field(
 			'type',
 			'scf_field_groups',
@@ -123,4 +271,129 @@ private function get_field_schema() {
 			'context'     => array( 'view', 'edit', 'embed' ),
 		);
 	}
+
+	/**
+	 * Register the source parameter for the post types endpoint.
+	 *
+	 * @since SCF 6.5.0
+	 */
+	public function register_parameters() {
+		if ( ! acf_get_setting( 'rest_api_enabled' ) ) {
+			return;
+		}
+
+		// Register the query parameter with the REST API
+		add_filter( 'rest_type_collection_params', array( $this, 'add_collection_params' ) );
+		add_filter( 'rest_types_collection_params', array( $this, 'add_collection_params' ) );
+
+		// Direct registration for OpenAPI documentation
+		add_filter( 'rest_endpoints', array( $this, 'add_parameter_to_endpoints' ) );
+	}
+
+	/**
+	 * Get the source parameter definition
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param bool $include_validation Whether to include validation callbacks.
+	 * @return array Parameter definition
+	 */
+	private function get_source_param_definition( $include_validation = false ) {
+		$param = array(
+			'description' => __( 'Filter post types by their source.', 'secure-custom-fields' ),
+			'type'        => 'string',
+			'enum'        => array( 'core', 'scf', 'other' ),
+			'required'    => false,
+		);
+
+		// Not needed for OpenAPI documentation
+		if ( $include_validation ) {
+			$param['validate_callback'] = 'rest_validate_request_arg';
+			$param['sanitize_callback'] = 'sanitize_text_field';
+			$param['default']           = null;
+			$param['in']                = 'query';
+		}
+
+		return $param;
+	}
+
+	/**
+	 * Add source parameter directly to the endpoints for proper documentation
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param array $endpoints The REST API endpoints.
+	 * @return array Modified endpoints
+	 */
+	public function add_parameter_to_endpoints( $endpoints ) {
+		$source_param        = $this->get_source_param_definition();
+		$endpoints_to_modify = array( '/wp/v2/types', '/wp/v2/types/(?P<type>[\w-]+)' );
+
+		foreach ( $endpoints_to_modify as $route ) {
+			if ( isset( $endpoints[ $route ] ) ) {
+				foreach ( $endpoints[ $route ] as &$endpoint ) {
+					if ( isset( $endpoint['args'] ) ) {
+						$endpoint['args']['source'] = $source_param;
+					}
+				}
+			}
+		}
+
+		return $endpoints;
+	}
+
+	/**
+	 * Add source parameter to the collection parameters for the types endpoint.
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param array $query_params JSON Schema-formatted collection parameters.
+	 * @return array Modified collection parameters.
+	 */
+	public function add_collection_params( $query_params ) {
+		$query_params['source'] = $this->get_source_param_definition( true );
+		return $query_params;
+	}
+
+	/**
+	 * Clean up null entries from the response
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param array           $response The response data.
+	 * @param WP_REST_Server  $server   The REST server instance.
+	 * @param WP_REST_Request $request  The original request.
+	 * @return array            The filtered response data.
+	 */
+	public function clean_types_response( $response, $server, $request ) {
+		if ( strpos( $request->get_route(), '/wp/v2/types' ) !== 0 ) {
+			return $response;
+		}
+
+		// Only process collection responses (not single post type responses)
+		// Single post type responses have a 'slug' property, collections don't
+		if ( is_array( $response ) && ! isset( $response['slug'] ) ) {
+			$response = array_filter(
+				$response,
+				function ( $entry ) {
+					return null !== $entry;
+				}
+			);
+		}
+
+		return $response;
+	}
+
+	/**
+	 * Clear cache for types endpoint requests to prevent cross-contamination
+	 *
+	 * @since SCF 6.5.0
+	 *
+	 * @param mixed $response The current response.
+	 */
+	public function clear_cache_for_types_request( $response ) {
+		// Clear cache to prevent cross-contamination and make the endpoint stateless
+		$this->cached_post_types = null;
+		return $response;
+	}
 }