Latest Posts: add screen reader title text to Read more links and use alternative to excerpt_more filter #55029
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
ramonjd
added
[Type] Regression
ramonjd
added
the
Backport to WP 6.7 Beta/RC
|
Size Change: +67 B (0%) Total Size: 1.64 MB
ℹ️ View Unchanged
|
ramonjd
commented
Oct 4, 2023
| @@ -48,14 +48,6 @@ function render_block_core_latest_posts( $attributes ) { | |||
| $block_core_latest_posts_excerpt_length = $attributes['excerptLength']; | |||
| add_filter( 'excerpt_length', 'block_core_latest_posts_get_excerpt_length', 20 ); | |||
|
|
|||
| $filter_latest_posts_excerpt_more = static function ( $more ) use ( $attributes ) { | |||
| $use_excerpt = 'excerpt' === $attributes['displayPostContentRadio']; | |||
There was a problem hiding this comment.
As mentioned in #55026 (comment)
I think I used this so that choices of the user in the editor were reflected on the frontend, even if those changes overrode theme custom text.
Theme custom excerpt text would still display if displayPostContentRadio was not set to 'excerpt' in the Latest Posts block attributes. However, I believe we were missing the editor's "excerptLength attribute is less than the currently-set excerpt length" condition in index.php.
What should prevail here?
There was a problem hiding this comment.
Great question. The way you're currently handling it in this PR feels natural to me in testing!
|
Flaky tests detected in 36bfd7a563b8c15bb83ec90398be155f5e73ef07. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6412376858
|
andrewserong
reviewed
Oct 5, 2023
| * Adds a "Read more" link with screen reader text. | ||
| * […] is the default excerpt ending from wp_trim_excerpt() in Core. | ||
| */ | ||
| if ( str_ends_with( $trimmed_excerpt, ' […]' ) && 'excerpt' === $attributes['displayPostContentRadio'] ) { |
There was a problem hiding this comment.
I haven't tested this PR yet, so this is just a drive-by comment! 😄
The condition above appears to already check for && 'excerpt' === $attributes['displayPostContentRadio'] ) so I don't think we need that condition in this if statement?
There was a problem hiding this comment.
Did I leave that in there? 😅
Thanks for spotting 🙇🏻
There was a problem hiding this comment.
One more comment here: I'm not 100% convinced of the robustness of this check. We're hard-coding what we expect the default value to be (from Core).
If a theme has added a hook that returns […], which we presume is what they want, then this condition will also overwrite.
andrewserong
reviewed
Oct 5, 2023
There was a problem hiding this comment.
This is testing nicely for me @ramonjd and feels like a natural way to handle it while preserving themes that intentionally override excerpt_more 👍
✅ Themes that override the excerpt now output correctly on the site frontend (tested 2019, and 2021)
✅ Themes that don't override the excerpt correctly output the Read more text along with the screen reader text containing the post title
❓ If there is no post title, then that's flagged in the screen reader text, too on the site frontend. E.g. the following:
However in the editor, it looks like the fallback (no title) isn't being output in the screen reader text. Just left a small comment there and one for the output of the PHP, but otherwise this is looking good to me!
| 2019 before | 2019 after |
|---|---|
 |
 |
| @@ -48,14 +48,6 @@ function render_block_core_latest_posts( $attributes ) { | |||
| $block_core_latest_posts_excerpt_length = $attributes['excerptLength']; | |||
| add_filter( 'excerpt_length', 'block_core_latest_posts_get_excerpt_length', 20 ); | |||
|
|
|||
| $filter_latest_posts_excerpt_more = static function ( $more ) use ( $attributes ) { | |||
| $use_excerpt = 'excerpt' === $attributes['displayPostContentRadio']; | |||
There was a problem hiding this comment.
Great question. The way you're currently handling it in this PR feels natural to me in testing!
costdev
reviewed
Oct 5, 2023
…the i18n interpolator In the frontend: removes excerpt_more filter so we don't override themes and also replaces the default ellipsis with an accessible read more link
|
Thanks @andrewserong and @costdev for helping make this PR better. I think I've addressed all feedback. |
"Read more" is already translated so using a specifier to add it to the string
ramonjd
force-pushed
the
try/latest-posts-revert-excerpt-filter-and-add-screen-reader-text
branch
from
12b6cdf to
0fe587d
Compare
andrewserong
approved these changes
Oct 5, 2023
ramonjd
deleted the
try/latest-posts-revert-excerpt-filter-and-add-screen-reader-text
branch
mikachan
pushed a commit
that referenced
this pull request
Oct 9, 2023
… alternative to excerpt_more filter (#55029) * In the editor: adds a screen reader text span with the post title in the i18n interpolator In the frontend: removes excerpt_more filter so we don't override themes and also replaces the default ellipsis with an accessible read more link * Removing "of" preposition in favour of a semi-colon. "Read more" is already translated so using a specifier to add it to the string
mikachan
removed
the
Backport to WP 6.7 Beta/RC
|
I just cherry-picked this PR to the 6.4-beta3 branch to get it included in the next release: 11f6a6d |
karmatosed
pushed a commit
that referenced
this pull request
Oct 9, 2023
* Add clearer labels and context to BlockPatternsSyncFilter (#54838) * Add help text & clearer labeling * Theme & Plugins * Font Library: use snake_case instead of camelCase on fontFamilies endpoint param (#54977) * use snake_case instead of camelCase on endpoint param * updating test * Fix output of Navigation block classnames in the editor. (#54992) * Block Editor: Avoid double-wrapping selectors when transforming the styles (#54981) * Block Editor: Avoid double-wrapping selectors when transforming the styles * Include space in the check * Don't display the navigation section in template parts details when a menu is missing (#54993) * Scripts: Properly use CommonJS for default Playwright config (#54988) * Fix path to `globalSetup` in default Playwright config Oversight from #54856 * `module.exports` * Fix default export usage * Add template replace flow to template inspector (#54609) * Add a modal to allow template switching * fetch template info * Allow switching to different patterns * Allow switching to different patterns * Add columns * move availble templates to the actions * filter for the correct templates * create the right data structure in the use select * move to a hook * inject theme attribute into pattern again * put the overlay over the top of the dropdown * fix the pattern to templates hook * set the template on click * Also set the blocks * remove calls to set template with the current template, since setting blocks correctly updates the content in the editor * serialize blocks so that we have correctly processed template parts * remove duplicated code * Remove unnecessary mapping * refactor * memoize the patterns * combine the useSelect * Update packages/edit-site/src/components/sidebar-edit-mode/page-panels/hooks.js Co-authored-by: Andrei Draganescu <[email protected]> * Fix ESLint error * Only show the button is there is more than 1 pattern * Copy update * Move the hook to a subdir * check that there are patterns * move the check * remove useCallback * change condition to show the button * change condition * move to use editEntityRecord * combine filters * add comments * Update packages/edit-site/src/components/sidebar-edit-mode/template-panel/replace-template-button.js Co-authored-by: Andrei Draganescu <[email protected]> --------- Co-authored-by: Andrei Draganescu <[email protected]> Co-authored-by: Andrei Draganescu <[email protected]> Co-authored-by: George Mamadashvili <[email protected]> * List View: Fix performance issue when selecting all blocks (#54900) * List View: Fix performance issue when selecting all blocks within the editor canvas in long posts * Add a comment, rename const * Move block focus to be performed only once at the root of the list view, instead of within each block * Fix left and right aligmnent in children of Post Template (#54997) * Fix left and right aligmnent in children of Post Template * Add align center styles * Fix image placeholder disappearing * Site Editor: Avoid stale navigation block values when parsing entity record (#54996) * Removed unwanted space from the string (#54654) * Update styles.js Removed unwanted space with translation * Update deleted-navigation-warning.js Unwanted space at the end of the string shows translation warning. * Update inspector-controls.js Unwanted space at the end of the string shows translation warning * Fix Deleted Navigation Menu warning string (#55033) * [Inserter]: Fix reset of registered media categories (#55012) * [Inserter]: Fix reset of registered media categories * convert `useInserterMediaCategories` to selector and make private * Try fixing the flaky 'Toolbar roving tabindex' e2e test (#54785) * Try fixing the flaky 'Toolbar roving tabindex' e2e test * Add a link in the comment * Fallback to Twitter provider when embedding X URLs (#54876) * Fallback to Twitter provider when embedding X URLs * Avoid processing empty urls when trying a different provider * Update `react-native-editor` changelog # Conflicts: # packages/react-native-editor/CHANGELOG.md * Based on the efforts in #51761, remove caps case from Template Part and prefer sentence case. As all instances of this string are stand alone, it's okay to have Template capitalized as it's the start of a sentence. (#54709) * Update pattern import menu item (#54782) * Update pattern import menuitem * Revert label * Image Block: Fix browser console error when clicking "Expand on Click" (#54938) * Patterns: Remove category description in inserter panel? (#54894) * Media & Text: Fix React warning (#55038) * Block Style: Display default style labels correctly in the block sidebar (#55008) * Site Editor: Do not display 'trashed' navigation menus in Sidebar (#55072) * Site Editor: Do not display 'trashed' navigation menus in Sidebar * Extract selector into a hook Co-authored-by: Aaron Robertshaw <[email protected]> --------- Co-authored-by: Aaron Robertshaw <[email protected]> * Image: Fix Lightbox display bug in Classic Themes. (#54837) * If current theme is not a block theme add a default value for $background_color and $close_button_color. * Set lightbox buttons' background & border to none on hover & focus * Change logic to support lightbox in classic themes * Update logic to avoid unnecessary calls * Add style fixes * Remove unnecessary code * Fix close button color --------- Co-authored-by: Mario Santos <[email protected]> Co-authored-by: Ricardo Artemio Morales <[email protected]> * Latest Posts: add screen reader title text to Read more links and use alternative to excerpt_more filter (#55029) * In the editor: adds a screen reader text span with the post title in the i18n interpolator In the frontend: removes excerpt_more filter so we don't override themes and also replaces the default ellipsis with an accessible read more link * Removing "of" preposition in favour of a semi-colon. "Read more" is already translated so using a specifier to add it to the string * Fix Image block lightbox missing alt attribute and improve accessibility (#55010) * Move lightbox open button after the image. * Fix getting the lightbox image alt attribute. * Improve docblocks. * Do not render empty role attribute. * Remove unnecessary aria-hidden attribute. * Set aria-modal attribute dynamically. * More meaningful and simpler modal dialog aria-label. * Increase Close button target size. * Add enlarged image base64 encoded placeholder. * Better check for alt attribute as a string. * Update changelog. * Move changelog entry to the block library changelog. * Set lightbox dialog aria-label dynamically. * Hide background scrim container from assistive technology. * Remove obsolete code --------- Co-authored-by: Ricardo Artemio Morales <[email protected]> # Conflicts: # packages/block-library/CHANGELOG.md * Patterns: Add category selector to pattern creation modal (#55024) --------- Co-authored-by: Kai Hao <[email protected]> * Iframe: Fix positioning when dragging over an iframe (#55150) * Site Editor: Fix template part area listing when a template has no edits (#55115) * Alternative: Fix template part area listing when a template has no edits * Fix typos --------- Co-authored-by: Rich Tabor <[email protected]> Co-authored-by: Matias Benedetto <[email protected]> Co-authored-by: tellthemachines <[email protected]> Co-authored-by: George Mamadashvili <[email protected]> Co-authored-by: Pascal Birchler <[email protected]> Co-authored-by: Ben Dwyer <[email protected]> Co-authored-by: Andrei Draganescu <[email protected]> Co-authored-by: Andrei Draganescu <[email protected]> Co-authored-by: Andrew Serong <[email protected]> Co-authored-by: mujuonly <[email protected]> Co-authored-by: Dave Smith <[email protected]> Co-authored-by: Nik Tsekouras <[email protected]> Co-authored-by: Carlos Garcia <[email protected]> Co-authored-by: Ramon <[email protected]> Co-authored-by: James Koster <[email protected]> Co-authored-by: Aki Hamano <[email protected]> Co-authored-by: Aaron Robertshaw <[email protected]> Co-authored-by: Michal <[email protected]> Co-authored-by: Mario Santos <[email protected]> Co-authored-by: Ricardo Artemio Morales <[email protected]> Co-authored-by: Andrea Fercia <[email protected]> Co-authored-by: Glen Davies <[email protected]> Co-authored-by: Kai Hao <[email protected]>
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.
Maybe resolves #55026
Follow up to #51190
What?
In the editor: adds a screen reader text span with the post title in the i18n interpolator
In the frontend: removes
excerpt_morefilter so we don't override themes and also replaces the default ellipsis with an accessible read more link. This is done only when the Latest Post attributedisplayPostContentRadiois explicitly set toexcerpt.Also I notices that the frontend didn't match the editor in one respect: the "Read more" default text should only appear when the attribute
excerptLengthis less than the currently-set excerpt length (from any filters etc)❗ It's important to note that themes, such as 2019, that specific a custom excerpt more text will not have that custom text and link reflected in the editor when the
displayPostContentRadiois set toexcerptand the attributeexcerptLengthis less than the currently-set excerpt length. The editor's preferences take precedence here. . "Read more" will always show in this case.Why?
Use of the
excerpt_morefilter was overriding theme defaults, e.g., 2021, 2019The repetition of "Read more" text in the frontend and editor did not provide any context to screen reader users. SeE: https://make.wordpress.org/themes/handbook/review/accessibility/required/#repetitive-link-text
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast
Editor
Frontend