Add entity fields: API, registry, endpoint by oandregal · Pull Request #13911 · WordPress/wordpress-develop

oandregal · 2026-10-01T23:17:54Z

Trac ticket: https://core.trac.wordpress.org/ticket/66229
See: WordPress/gutenberg#74865

What

This PR lands the PHP parts of the entity fields API.

Entity fields API and registry 26167d8
The corresponding endpoint c0f0825
Preloading 4db7bb1

Prerequisites to merge

Updates the view config endpoint with changes for WordPress 7.2 #14495, which merges some utilities. The first two commits in this branch belong to 14495 and can be ignored here: 19ebc1c, f6409b9.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Opus 5.5
Used for: Implementation. Reviewed and edited by me.

github-actions · 2026-10-01T23:20:40Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

github-actions · 2026-10-19T12:49:18Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props oandregal, jorgefilipecosta.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

oandregal · 2026-10-19T14:38:00Z

#14495 was merged and this rebased onto trunk.

jorgefilipecosta · 2026-10-19T15:09:44Z

+			}
+			// The id comes first, like in the fields registered directly.
+			$field                  = array_merge( array( 'id' => basename( dirname( $file ) ) ), $field );
+			$fields[ $field['id'] ] = $field;


Should we validate that $field['id'] is a string? A field.php returning an array id causes a fatal error here.

Ah, that's good thinking, thanks. Related to your comment, I found an edge case and pushed a fix (and tests) at 91fea0c

jorgefilipecosta

Left some comments but they are not blockers.

Adds a registry of the fields of an entity, identified by its kind and name, along with `wp_register_entity_fields()`, `wp_update_entity_fields()`, `wp_unregister_entity_fields()`, and `wp_register_entity_field_collection()`, which only run on the new `wp_entity_fields_api_init` action, and the functions that read the registry. The registry is filled lazily: the action fires the first time the fields are read, once `init` has completed. A field definition is the serializable subset of the DataViews Field API. Its JavaScript parts ship in a script module registered along with the fields. The script modules of the fields are added as dynamic `module_dependencies` of the `wp-editor` script on `admin_footer`, so they reach the import map of the pages that load the editor. The `WP_REST_Entity_Fields_Controller` class is introduced too, as the registry validates the field types against its schema. Its route is registered separately. Synced from WordPress/gutenberg#84078. Synced from WordPress/gutenberg#84168. Synced from WordPress/gutenberg#84691. See #66229. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Registers the `/wp/v2/entity-fields` route, served by `WP_REST_Entity_Fields_Controller`. Given an entity kind and name, it returns the fields registered for the entity with the Entity Fields API, and the script modules providing their JavaScript parts, each with the ids of the fields it applies to. Access mirrors the `/wp/v2/view-config` route: post types require their own `edit_posts` capability, taxonomies their `manage_terms` capability, and root entities `manage_options`. Post types and taxonomies that are not registered or not exposed in the REST API are not found. Synced from WordPress/gutenberg#84078. Synced from WordPress/gutenberg#84691. See #66229. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…ists. The Site Editor reads the fields of the post types it lists from the `/wp/v2/entity-fields` route before it can render them. The fields of the edited post type, if any, and of the post types of the screen the Site Editor opens on, from its `p` query arg, are now added to the preloaded paths. Synced from WordPress/gutenberg#84700. See #66229. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

A `field.php` that returned a non-string `id`, such as an array, caused a fatal error when the id was used as a key in get_collection_fields(). Other non-string ids were silently coerced, and a folder setting the id of an earlier one silently replaced it. Such fields are now reported with _doing_it_wrong() and skipped, along with a `field.php` that does not return an array. The rest of the collection is read, and register_collection() returns false when a field was skipped. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Pass hook names, file names, keys, and method names as placeholders, wrapped in `<code>`, instead of keeping them inside the strings to translate, as core does elsewhere. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

oandregal · 2026-10-19T17:46:43Z

Committed at https://core.trac.wordpress.org/changeset/64528

oandregal changed the title ~~Add/fields api endpoint~~ Register and filter fields for DataViews/DataForm Oct 1, 2026

oandregal mentioned this pull request Oct 1, 2026

Fields API WordPress/gutenberg#83368

Draft

jorgefilipecosta mentioned this pull request Oct 5, 2026

Fields API: Add the server-side registry and REST route WordPress/gutenberg#84078

Merged

github-actions Bot mentioned this pull request Oct 7, 2026

PHP backports for WP 7.2 WordPress/gutenberg#83761

Open

This was referenced Oct 13, 2026

Register entity actions in the server WordPress/gutenberg#83537

Open

I18N: Print translations for the script modules that classic scripts depend on #14260

Draft

oandregal mentioned this pull request Oct 14, 2026

Rename "fields" to "entity fields" WordPress/gutenberg#84691

Merged

jorgefilipecosta mentioned this pull request Oct 14, 2026

Editor: Add the entity actions API #14276

Closed

oandregal force-pushed the add/fields-api-endpoint branch from e87a741 to 4db7bb1 Compare October 19, 2026 12:46

oandregal self-assigned this Oct 19, 2026

oandregal marked this pull request as ready for review October 19, 2026 12:49

Copilot AI balanced review requested due to automatic review settings October 19, 2026 12:49

Copilot AI reviewed Oct 19, 2026

oandregal requested review from jorgefilipecosta and ntsekouras October 19, 2026 12:49

oandregal changed the title ~~Register and filter fields for DataViews/DataForm~~ Add entity fields API Oct 19, 2026

oandregal changed the title ~~Add entity fields API~~ Add entity fields: API, registry, endpoint Oct 19, 2026

oandregal commented Oct 19, 2026

View reviewed changes

Comment thread src/wp-includes/rest-api/endpoints/class-wp-rest-view-config-controller.php

oandregal commented Oct 19, 2026

View reviewed changes

Comment thread src/wp-includes/view-config.php

oandregal commented Oct 19, 2026

View reviewed changes

Comment thread src/wp-includes/rest-api.php

oandregal force-pushed the add/fields-api-endpoint branch from 4db7bb1 to 5dbb447 Compare October 19, 2026 14:36

jorgefilipecosta reviewed Oct 19, 2026

View reviewed changes

oandregal force-pushed the add/fields-api-endpoint branch from 5dbb447 to 0a5dedd Compare October 19, 2026 15:09

jorgefilipecosta approved these changes Oct 19, 2026

View reviewed changes

oandregal and others added 3 commits October 19, 2026 19:03

oandregal and others added 2 commits October 19, 2026 19:03

Entity Fields: Keep code out of translatable strings.

ff8698d

Pass hook names, file names, keys, and method names as placeholders, wrapped in `<code>`, instead of keeping them inside the strings to translate, as core does elsewhere. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

oandregal force-pushed the add/fields-api-endpoint branch from 788e45c to ff8698d Compare October 19, 2026 17:04

oandregal closed this Oct 19, 2026

oandregal deleted the add/fields-api-endpoint branch October 19, 2026 17:46

Navigation Menu

Repository navigation

Add entity fields: API, registry, endpoint - #13911

Add entity fields: API, registry, endpoint#13911
oandregal wants to merge 5 commits into
WordPress:trunkfrom
oandregal:add/fields-api-endpoint

oandregal commented Oct 1, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 1, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Oct 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oandregal commented Oct 19, 2026

Uh oh!

jorgefilipecosta Oct 19, 2026

Uh oh!

oandregal Oct 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

jorgefilipecosta left a comment

Uh oh!

oandregal commented Oct 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

oandregal commented Oct 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Prerequisites to merge

Use of AI Tools

Uh oh!

github-actions Bot commented Oct 1, 2026

Test using WordPress Playground

Some things to be aware of

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Oct 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oandregal commented Oct 19, 2026

Uh oh!

jorgefilipecosta Oct 19, 2026

Choose a reason for hiding this comment

Uh oh!

oandregal Oct 19, 2026 • 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!

jorgefilipecosta left a comment

Choose a reason for hiding this comment

Uh oh!

oandregal commented Oct 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

oandregal commented Oct 1, 2026 •

edited

Loading

github-actions Bot commented Oct 19, 2026 •

edited

Loading

oandregal Oct 19, 2026 •

edited

Loading