Block Bindings: Use default values in connected custom fields in templates #65128
Conversation
This file contains 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
SantosGuillamot
added
[Type] Enhancement
SantosGuillamot
requested review from
ntwb,
nerrad and
ajitbohra
as code owners
|
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. |
|
This could work well |
gziolo
reviewed
Sep 9, 2024
| if ( isGlobalTemplate && props.object_subtype ) { | ||
| return; | ||
| } | ||
| metaFields[ key ] = props.default; |
There was a problem hiding this comment.
What will happen when the default is undefined or empty?
There was a problem hiding this comment.
It says:
Apart from that, when no default is provided, it should still show the meta key.
I'll test it.
There was a problem hiding this comment.
Registering a field without default value:
is returning the meta key:
There was a problem hiding this comment.
It seems that is returning an empty string, as documented here:
https://developer.wordpress.org/reference/functions/get_metadata_default/#description
There was a problem hiding this comment.
If single is false in register_meta() args. get_meta_data_default() should return an empty array.
When testing, it returned undefined. But still is showing just the key. I should review if we are covering all the cases with tests.
It's a very interesting idea. I'm wondering how it will fit when nested into the Query Loop block. The other edge case I can think of is post meta that skips the default value. |
cbravobernal
force-pushed
the
try/use-default-values-in-templates
branch
from
44cccb1
to
e2fddae
Compare
|
Size Change: -1 B (0%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
cbravobernal
merged commit 434ec40
into
experiment/add-meta-post-type-api
61 checks passed
cbravobernal
added a commit
that referenced
this pull request
Sep 10, 2024
…lates (#65128) * Abstract `getMetadata` and use it in `getValues` * Adapt e2e tests * Update e2e --------- Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org>
cbravobernal
added a commit
that referenced
this pull request
Sep 11, 2024
…lates (#65128) * Abstract `getMetadata` and use it in `getValues` * Adapt e2e tests * Update e2e --------- Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org>
cbravobernal
added a commit
that referenced
this pull request
Sep 17, 2024
* Initial commit. Add meta field to post types. * Add post meta * Add todos * Add fields in all postType * WIP: Add first version to link templates and entities * Revert "WIP: Add first version to link templates and entities" This reverts commit a43e391. * Only expose public fields * Add subtype to meta properties * Render the appropriate fields depending on the postType in templates * Use context postType when available * Fetch the data on render, preventing one click needed * Yoda conditions.. * Try: Expose registered meta fields in schema * Try: Create a resolver to get registered post meta * Use rest namespace * Move actions and selectors to private. * Add unlocking and import * Merge useSelect * Fix duplicated * Add object_subtype to schema * Update docs to object_subtype * Add explanatory comment * Block Bindings: Use default values in connected custom fields in templates (#65128) * Abstract `getMetadata` and use it in `getValues` * Adapt e2e tests * Update e2e --------- Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org> * Try removing all object subtype * Fix e2e * Update code * Fix `useSelect` warning * Remove old comment * Remove support for generic templates * Revert changes to e2e tests --------- Co-authored-by: mtias <matveb@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: TimothyBJacobs <timothyblynjacobs@git.wordpress.org> Co-authored-by: artemiomorales <artemiosans@git.wordpress.org> Co-authored-by: spacedmonkey <spacedmonkey@git.wordpress.org>
SantosGuillamot
added a commit
that referenced
this pull request
Sep 17, 2024
…lates (#65128) * Abstract `getMetadata` and use it in `getValues` * Adapt e2e tests * Update e2e --------- Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org>
SantosGuillamot
added a commit
that referenced
this pull request
Sep 18, 2024
…dings workflows (#65099) * Initial commit. Add meta field to post types. * Add post meta * Add todos * Add fields in all postType * WIP: Add first version to link templates and entities * Revert "WIP: Add first version to link templates and entities" This reverts commit a43e391. * Only expose public fields * Add subtype to meta properties * Render the appropriate fields depending on the postType in templates * Use context postType when available * Fetch the data on render, preventing one click needed * Yoda conditions.. * Try: Expose registered meta fields in schema * Try: Create a resolver to get registered post meta * Use rest namespace * Move actions and selectors to private. * Merge useSelect * Fix duplicated * Add object_subtype to schema * Update docs to object_subtype * Add explanatory comment * Block Bindings: Use default values in connected custom fields in templates (#65128) * Abstract `getMetadata` and use it in `getValues` * Adapt e2e tests * Update e2e --------- Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org> * Try removing all object subtype * Fix e2e * Update code * Fix `useSelect` warning * Remove old comment * Remove support for generic templates * Revert changes to e2e tests * Change the value returned by `getFieldsList` to include label * Use label in bindings panel * Use label in rich text placeholders * Add filter to include `label` * Use title instead of label in schema * Add safety check * Adapt branch after rebase * Remove extra spaces * Don't rely on key outside of post meta * Remove key from bindings component * Read title instead of label * Add backport to changelog * Update translator comment --------- Unlinked contributors: dannyreaktiv. Co-authored-by: cbravobernal <cbravobernal@git.wordpress.org> Co-authored-by: SantosGuillamot <santosguillamot@git.wordpress.org> Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: mtias <matveb@git.wordpress.org>
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?
This PR is built on top of #64072 because it reuses the logic added there.
Basically, I'm exploring the possibility of using the default values of the custom fields in templates instead of the meta keys.
Apart from that, when no default is provided, it should still show the meta key.
Why?
It could make sense to show the default value in templates. First, it looks nicer. Second, it is how the post will look like if the value is not overriden.
How?
I'm reusing the logic introduced in #64072 to get the registered meta fields object, which includes the default value, and use it in
getValuesfunction.Apart from that, while testing it, I realized that
toHaveTextcheck is true when the string is part of the expected value. This means that if the value is "Value of the text_custom_field", and we check `expect( paragraphBlock ).toHaveText( 'text_custom_field ' ), it returns true when that is not expected.For that reason, I changed the text to ensure the key and the value don't overlap.
Testing Instructions