Block Editor: Add settings to enable/disable auto anchor generation #38780
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
Mamaduka
changed the title
Mamaduka
added
[Block] Heading
Mamaduka
requested review from
priethor,
mtias,
aristath,
youknowriad and
jasmussen
|
Size Change: +61 B (0%) Total Size: 1.15 MB
ℹ️ View Unchanged
|
|
Do we want to enable this feature in tests, or should I re-generate the fixtures? |
|
I'm still unsure about whether this should be opt-in or opt-out 🤔 |
|
Considering feedback, we might want to make this opt-in in 5.9.x and then opt-out when UX is more polished. @youknowriad, @jasmussen, @priethor What do you think? |
|
Without a UI, it seems safest to start conservative, opt-in by default, and then we can make it opt-out if/when a UI surfaces for it. I want to note that's not at all a strong opinion and I'll defer to someone who has one. |
|
I think that ideally, it would be opt-out for latin languages (with some basic transliteration to remove accents etc), and opt-in for non-latin languages like Mandarin, Greek, Arabic etc where we've seen most issues. |
I think this is the most viable option to be backported into a minor release. We can work on UI and smart default for 6.0. |
aristath
approved these changes
Feb 16, 2022
Mamaduka
force-pushed
the
try/generate-anchors-setting
branch
from
66ad596
to
4d36fc2
Compare
|
Thanks for the feedback, folks. Let's try to polish UI/UX for this feature before 6.0. I'm going to merge this PR and backport it to a minor release. |
Mamaduka
added
the
Backport to WP Minor Release
Mamaduka
removed
the
Backport to WP Minor Release
Mamaduka
added a commit
that referenced
this pull request
Feb 17, 2022
…38780) * Block Editor: Add settings to enable/disable auto anchor generation * Fix deps * Update snapshots
|
Ok so you have gone to opt-out by default. But where do I go to opt in? A feature I liked has been disabled, and I have looked in all the seemingly obvious places to re-enable it. |
|
Hi, @shuttermuse Currently, there's no UI to enable the feature back, but we'll try to ship this in a future version of WordPress. Meanwhile, to enable it, you'll need to place the following snippet in add_filter(
'block_editor_settings_all',
static function( $settings ) {
$settings['__experimentalGenerateAnchors'] = true;
return $settings;
}
); |
|
@Mamaduka Thanks for the code snippet! I was tearing my hair out trying to find the UI option. |
cbravobernal
added
[Package] Block library
|
For future reference: it also seems like it should be turned on automatically in the context of a post that uses the table of contents block. |
Merged
5 tasks
bph
added
the
Needs Dev Note
37 tasks
30 tasks
|
For anyone googling how to turn this back on - add_filter( 'block_editor_settings_all', function( $editor_settings, $editor_context ) {
$editor_settings['generateAnchors'] = true;
return $editor_settings;
}, 10, 2 ); |
RobjS
added a commit
to dxw/long-read-plugin
that referenced
this pull request
May 17, 2022
In WordPress 5.9, auto-generation of anchors for headings was switched on. However, in 5.9.1 this was changed to an option you need to explicitly opt into: WordPress/gutenberg#38780 We need anchors for the heading blocks to always be generated, so that we can use those anchors for in-page nav. The suggestion is that this will become opt-out once a UI is available for these kind of options, probably in WordPress 6.0. So there doesn't seem to be any significant risk of this functionality being removed in future, despite it currently being labelled experimental.
RobjS
added a commit
to dxw/long-read-plugin
that referenced
this pull request
May 17, 2022
In WordPress 5.9, auto-generation of anchors for headings was switched on. However, in 5.9.1 this was changed to an option you need to explicitly opt into: WordPress/gutenberg#38780 We need anchors for the heading blocks to always be generated, so that we can use those anchors for in-page nav. The suggestion is that this will become opt-out once a UI is available for these kind of options, probably in WordPress 6.0. So there doesn't seem to be any significant risk of this functionality being removed in future, despite it currently being labelled experimental.
Thx! |
Mamaduka
removed
the
Needs Dev Note
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.
Description
Resolves #38171.
This PR introduces new block editor settings -
__experimentalGenerateAnchorsand makes automatic anchor generation opt-in.Why use block editor settings instead of Preferences?
Most of the Preferences are saved in the
edit-postpackages store. As we don't want to make theblock-librarypackage dependent onedit-postthis was the most viable option.Testing Instructions
Types of changes
Enhancement
Checklist:
*.native.jsfiles for terms that need renaming or removal).