Add: Footnotes support for other CPT's. #57353
Merged
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
jorgefilipecosta
added
[Type] Enhancement
|
Size Change: +6 B (0%) Total Size: 1.69 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 6648c03. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7302999431
|
jorgefilipecosta
force-pushed
the
add/footnotes-support-for-other-cpts
branch
from
6648c03
to
cba7fc3
Compare
|
Any sense of when this might be added to core (footnote support for other post types)? |
jorgefilipecosta
added
the
Needs Dev Note
ellatrix
reviewed
Jan 18, 2024
| ); | ||
| foreach ( $post_types as $post_type ) { | ||
| // Only register the meta field if the post type supports the editor, custom fields, and revisions. | ||
| if ( post_type_supports( $post_type, 'editor' ) && post_type_supports( $post_type, 'custom-fields' ) && post_type_supports( $post_type, 'revisions' ) ) { |
There was a problem hiding this comment.
Why is custom-fields required?
There was a problem hiding this comment.
@jorgefilipecosta: yeah, is that needed? Looking through Core's source I don't think this is a requirement.
There was a problem hiding this comment.
Oh sorry, I missed the question, without custom-fields support the footnotes are not saved on the REST API.
Assuming it can be merged in the next weeks, it will land in WP 6.5. |
One thing we may want to do, later on, is to materialise footnotes as a proper first-party feature. It could default to true if the post type meets all the necessary conditions (as laid out in this PR), but users could then explicitly opt out with: remove_post_type_support( 'my_type', 'footnotes' ); |
|
For the testing instructions (and pending dev note), the example code to register a CPT should be much more concise: just a name label and the essential args to make it work with footnotes. Also, here's a screenshot if it's helpful for archiving purposes: 
|
This was referenced Feb 1, 2024
32 tasks
|
Dev note: Footnotes support was expanded for all CPT's In WordPress version 6.5, footnotes are now supported on any custom post type that fulfills certain requirements. To be eligible for footnotes, a custom post type must have capabilities like rest API, custom fields, revisions, and editor support. If a post type meets these requirements, footnotes should be available by default without requiring any changes from the developer. However, if a developer wants to remove footnotes support in a specific condition, for example, in a particular post type, they can use the block API like any other block. The following code sample demonstrates how we can remove footnotes support from the "post" post type: |
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.
This pull request adds support for footnotes in all custom post types (CPTs) that meet the following requirements:
Additionally, this pull request allows plugins to remove footnotes support from any post type by removing the footnotes meta key from the post type. For example, to remove footnotes support from pages, use the following code:
Testing
Added the following post type:
I have confirmed that the footnotes are functioning correctly on the specified post type.
Furthermore, I have removed the "custom-fields" support from the post type and confirmed that the footnotes are no longer available on the post type.
In addition, I have verified that the example mentioned earlier successfully removes footnotes support from pages.