REST API: Add source parameter for types endpoint
#128
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -3,7 +3,7 @@ | |||
| * REST API | |||
| * | |||
| * @package Secure Custom Fields | |||
| * @since ACF 6.4.0 | |||
| * @since 6.5.0 | |||
There was a problem hiding this comment.
Should we specify SCF 6.5.0 . So LLMs don't mess.
Comment on lines
+90
to
+93
| console.log('All types:', Object.keys(allTypes)); | ||
| console.log('SCF types:', Object.keys(scfTypes)); | ||
| console.log('Core types:', Object.keys(coreTypes)); | ||
| console.log('Other types:', Object.keys(otherTypes)); |
There was a problem hiding this comment.
Let's remove the logs here.
| console.log(`Test post type ${customTestType} not found - skipping SCF single post type tests`); | ||
| } | ||
| } catch (error) { | ||
| console.log(`Error checking SCF test type: ${error.message}`); |
There was a problem hiding this comment.
We are mixing console.error and console.logs in errors :-)
Comment on lines
+275
to
+287
| console.log('SCF post types:', Object.keys(scfTypes)); | ||
|
|
||
| const coreTypes = await requestUtils.rest({ | ||
| path: '/wp/v2/types', | ||
| params: { source: 'core' } | ||
| }); | ||
| console.log('Core post types:', Object.keys(coreTypes)); | ||
|
|
||
| const otherTypes = await requestUtils.rest({ | ||
| path: '/wp/v2/types', | ||
| params: { source: 'other' } | ||
| }); | ||
| console.log('Other post types:', Object.keys(otherTypes)); |
There was a problem hiding this comment.
Let's remove this logs too.
Comment on lines
+325
to
+332
| if (inScf) { | ||
| console.log(`✅ Perfect! Test post type is in SCF source as desired`); | ||
| } else if (inOther) { | ||
| console.log(`⚠️ Acceptable: Test post type in other source (our filter hook didn't work)`); | ||
| } | ||
| } else { | ||
| console.log(`⚠️ Test post type ${customTestType} not found - skipping this part of the test`); | ||
| } |
There was a problem hiding this comment.
We don't need this too.
cbravobernal
requested changes
May 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
/wp/v2/typesREST API endpoint that allows filtering post types by their origin:core(WordPress built-in),scf(for SCF managed types), orotherfor the rest of CPTs./wp/v2/types) and single item (/wp/v2/types/{type}) endpointsWhy
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
sourceparameter is not defined, nothing changes.rest_request_before_callbacksfor the single request, returning 404 if the requested type doesn't meet the criteria.rest_prepare_post_typeto filter each post type by source before WordPress prepares it.rest_pre_echo_responseto removenullvalues returned byrest_prepare_post_typein the response array.rest_prepare_post_typefires once per post type, the Post Types belonging to the requested source are calculated in advance inrest_request_before_callbacksand reused throughout the whole request.Testing Instructions
- Make a GET request to
/wp/v2/typesto see all post types- Add
?source=coreto filter for WordPress built-in post types only- Add ?source=scf to see only post types managed by SCF
- Try
?source=otherto see post types registered from other sources- Test single post type endpoints like
/wp/v2/types/post?source=core- 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
- 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.tsPotential follow-ups
sourceas a field in the response, as there would be no performance loss.