Documentation: add section about the Fields API #66761
Conversation
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
oandregal
added
[Type] Developer Documentation
| @@ -67,7 +67,7 @@ By default, dataviews would use each record's `id` as an unique identifier. If t | |||
|
|
|||
| #### `fields`: `Object[]` | |||
|
|
|||
| The fields describe the visible items for each record in the dataset. | |||
| The fields describe the visible items for each record in the dataset and how they behave (how to sort them, display them, etc.). See "Fields API" as a reference for every property. | |||
There was a problem hiding this comment.
It would help to link to the Fields API section to get there more easily.
|
|
||
| ### `type` | ||
|
|
||
| Field type. One of `text`, `integer`, `datetime`. |
There was a problem hiding this comment.
The list of supported types is interesting. There are differences between block attributes or custom post type meta fields. Where can I learn more about plans related to that?
| Edit: 'radio' | ||
| } | ||
|
|
||
| // Edit is optional when field's type is present. |
There was a problem hiding this comment.
This is cool developer experience 👏
What?
This PR extracts the Fields API to its own section and documents every one of its properties: type, required/optional, example, etc.
Testing Instructions
Read docs.