REST API: Add `source` parameter for types endpoint #128

priethor · 2025-05-12T14:03:56Z

What

Added a new source parameter to the /wp/v2/types REST API endpoint that allows filtering post types by their origin: core (WordPress built-in), scf (for SCF managed types), or other for the rest of CPTs.
Works with both collection (/wp/v2/types) and single item (/wp/v2/types/{type}) endpoints
Properly documented in the OpenAPI schema

Why

When working on the Command Palette Integration and considering using the REST API to define CPT-related commands, requesting specifically for the CPTs managed by SCF became a need, and it will be needed, too, when implementing DataViews.

In fact, this branch is directly based on #124 and started in parallel, as we both realized we needed to tweak the Types endpoint if we wanted to leverage the API.

How

If the source parameter is not defined, nothing changes.
For specific, single-type requests:
- Hooks to rest_request_before_callbacks for the single request, returning 404 if the requested type doesn't meet the criteria.
For collection requests:
- Hooks to rest_prepare_post_type to filter each post type by source before WordPress prepares it.
- Hooks to rest_pre_echo_response to remove null values returned by rest_prepare_post_type in the response array.
- Since the filter rest_prepare_post_type fires once per post type, the Post Types belonging to the requested source are calculated in advance in rest_request_before_callbacks and reused throughout the whole request.

Testing Instructions

API Endpoint Testing:
- Make a GET request to /wp/v2/types to see all post types
- Add ?source=core to filter for WordPress built-in post types only
- Add ?source=scf to see only post types managed by SCF
- Try ?source=other to see post types registered from other sources
- Test single post type endpoints like/wp/v2/types/post?source=core
Validation Testing:
- Try an invalid source value (e.g., ?source=invalid) to verify validation works
- Confirm a 404 error when requesting a post type with the wrong source (e.g., /wp/v2/types/post?source=scf`
Unit and E2E Tests (heavily assisted by AI):
- Run PHPUnit tests: composer test:php -- --filter=Test_REST_Types_Endpoint
- Run E2E tests: npm run test:e2e tests/e2e/rest-api-types-endpoint.spec.ts

Potential follow-ups

Add a hook so that other plugins can register their own sources.

includes/rest-api.php

tests/e2e/rest-api-types-endpoint.spec.ts

cbravobernal

In my opinion, most of console logs are not necessary. Let's avoid to fill the logs of CI with them. The rest of the PR is working as expected, nice job!! 🚀

cbravobernal · 2025-05-26T16:54:21Z

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

+		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;


NIT: We can return on each case.

I like this too; why not? :)

tests/e2e/plugins/scf-test-setup-post-types.php

cbravobernal

Nice work!

mcsf

I didn't comb through every little detail, but overall seems pretty good! I just left a concern about caching.

mcsf · 2025-06-04T17:26:06Z

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

+		if ( null === $this->cached_post_types ) {
+			$this->cached_post_types = $this->get_source_post_types( $source );
+		}
+		$source_post_types = $this->cached_post_types;


In practice, the way the REST API works is that one request corresponds to one fresh execution of the WP stack, including running through SCF_Rest_Types_Endpoint's constructor and down that stack. However, semantically, cached_post_types is an instance property of a class that represents an endpoint, not a request. Here's my concern when I read this chunk:

Is there any scenario (e.g. request batching or sequential rest_do_request calls) where it's possible to process more than one request with the same endpoint instance? If so, this cache will need invalidation. At the very least, it should be source-indexed:

$source_post_types = $this->cached_post_types[ $source ];

… but ideally its lifetime should be that of a request.

No?

You are right! Instead of source-indexing it, which was something I considered from the start and wanted to avoid, I've opted for a cleaner solution in 555217b: clear the cache at the end of each request, so that it is truly stateless.

@mcsf I completely removed the cache in a525023 to make it TRULY stateless.

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

mcsf

This looks much much better. Left some notes, still. Also, don't rely on my approval for merging! You all have the domain knowledge, not me. :)

mcsf · 2025-08-08T10:42:03Z

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

+	 * @return array            The filtered response data.
+	 */
+	public function clean_types_response( $response, $server, $request ) {
+		if ( strpos( $request->get_route(), '/wp/v2/types' ) !== 0 ) {


This match is too eager, catching any word starting with types. Could be a regex pattern similar to one already used in this diff: preg_match( '#^/wp/v2/types/([^/]+)$#'. Drive-by questions:

is there a REST utility for this?

can we assume a trailing slash will always be there, or do we need to account for /types$/?

mcsf · 2025-08-08T10:48:34Z

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

+			$all_post_types = get_post_types( array( '_builtin' => true ), 'objects' );
+			foreach ( $all_post_types as $post_type ) {
+				$core_types[] = $post_type->name;
+			}


There's wp_list_pluck, though I don't know if it performs worse. :)

Ideally, there would be array_column, but AFAIK that operates on items of type array, not object.

(This is an FYI, no need to change unless you'd prefer to.)

mcsf · 2025-08-08T10:51:41Z

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

+			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'] ) ) {


Asking as SCF-ignorant: when would there be no post_type in an item in a collection returned by a function named acf_get_internal_post_type_posts_?

mcsf · 2025-08-08T10:52:42Z

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

+		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;


I like this too; why not? :)

mcsf · 2025-08-08T10:59:23Z

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

+		// Not needed for OpenAPI documentation
+		if ( $include_validation ) {


Is it common practice to explicitly remove them? In other words, is the small complexity cost of this branching worth the benefit of not having these params in the route map? Also, if these params aren't needed and are undesirable, why doesn't the REST framework strip them for all?

cbravobernal and others added 26 commits April 30, 2025 12:10

Initial commit, still with errors

6453b6c

Default should be false

dda11f7

Remove unit to try e2e

ff4c6b0

Add query parameter to filter by post type registration ori

5e704c1

Fix PHPCS error

9f5576e

Don't require the sidebar experiment to be enabled

4c27770

First attempt at filtering post types by registration origin

f61d429

Refactor to make it more elegant

bad53df

Optimization

1e128a3

Add origin to schema

9b29cdb

Clean up response

a4fcb14

Simplify and use a more elegant filter

4386792

Fix single type queries

a3b901a

Cleanup

bc62377

Initial commit, still with errors

1b30485

Default should be false

4938c71

Remove unit to try e2e

08c005c

Clean up response

53f3531

Simplify and use a more elegant filter

1ccf496

Fix single type queries

cebf109

Cleanup

978e331

Resolved conflicts from rebase

2b76395

Fix the scf fields experiment

7382fcf

Rename origin to source

b75c136

Add unit and e2e tests

2a2dfe1

Optimization!

70133ce

priethor self-assigned this May 12, 2025

priethor added 3 commits May 12, 2025 16:30

Fix error in comments

2263520

Remove checks for SCF internal types, we only work with managed CPTs

f5b72e5

Update version references to specify SCF

cbcc576

priethor marked this pull request as draft May 12, 2025 18:12

Comment cleanup

3dc5034

priethor marked this pull request as ready for review May 19, 2025 15:02

Merge trunk into add/origin-parameter-for-types-endpoint

602ffa4

cbravobernal self-requested a review May 20, 2025 14:55

cbravobernal reviewed May 20, 2025

View reviewed changes

includes/rest-api.php Outdated Show resolved Hide resolved

cbravobernal reviewed May 20, 2025

View reviewed changes

tests/e2e/rest-api-types-endpoint.spec.ts Outdated Show resolved Hide resolved

cbravobernal reviewed May 20, 2025

View reviewed changes

tests/e2e/rest-api-types-endpoint.spec.ts Outdated Show resolved Hide resolved

cbravobernal reviewed May 20, 2025

View reviewed changes

tests/e2e/rest-api-types-endpoint.spec.ts Outdated Show resolved Hide resolved

cbravobernal reviewed May 20, 2025

View reviewed changes

tests/e2e/rest-api-types-endpoint.spec.ts Outdated Show resolved Hide resolved

cbravobernal requested changes May 20, 2025

View reviewed changes

priethor added 2 commits May 21, 2025 13:16

Fix @sinceannotation

bbd12f5

Remove console logging from the tests

49c2460

priethor requested a review from cbravobernal May 21, 2025 11:21

priethor and others added 4 commits May 22, 2025 12:11

Fix syntax error

28d571e

Fix comment

a6671a7

Make the e2e test more accurate yet simple

17003e9

Merge branch 'trunk' into add/origin-parameter-for-types-endpoint

525b240

cbravobernal reviewed May 26, 2025

View reviewed changes

tests/e2e/plugins/scf-test-setup-post-types.php Outdated Show resolved Hide resolved

cbravobernal approved these changes May 26, 2025

View reviewed changes

priethor added 2 commits May 27, 2025 13:48

Fix typo

221cec4

Fix the tests cleanup

e5588b7

mcsf reviewed Jun 4, 2025

View reviewed changes

Clear post type cache after each request

9003531

priethor force-pushed the add/origin-parameter-for-types-endpoint branch from 555217b to 9003531 Compare June 19, 2025 17:44

priethor added 3 commits June 19, 2025 19:53

Cleanup based on feedback

8f37ea8

Remove the cache to make requests truly stateless

a525023

Merge trunk into add/origin-parameter-for-types-endpoint

a74cf08

mcsf reviewed Aug 8, 2025

View reviewed changes

		// Not needed for OpenAPI documentation
		if ( $include_validation ) {

REST API: Add source parameter for types endpoint #128

Are you sure you want to change the base?

REST API: Add source parameter for types endpoint #128

Conversation

priethor commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

How

Testing Instructions

Potential follow-ups

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cbravobernal left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cbravobernal left a comment

Choose a reason for hiding this comment

Uh oh!

mcsf left a comment

Choose a reason for hiding this comment

Uh oh!

mcsf Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

priethor Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mcsf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

REST API: Add `source` parameter for types endpoint #128

REST API: Add `source` parameter for types endpoint #128

priethor commented May 12, 2025 •

edited

Loading

cbravobernal left a comment •

edited

Loading

mcsf Jun 4, 2025 •

edited

Loading

priethor Aug 6, 2025 •

edited

Loading