Make WordPress Core

Opened 9 months ago

Last modified 2 months ago

#59006 reviewing enhancement

No title attribute on oEmbed and REST API <link>s

Reported by: edent's profile edent Owned by: audrasjb's profile audrasjb
Milestone: 6.6 Priority: normal
Severity: normal Version: 6.2.2
Component: Embeds Keywords: has-screenshots has-patch has-unit-tests changes-requested
Focuses: accessibility, rest-api Cc:

Description

By default, WordPress adds three <link rel="alternate" ... to the <head> of every post.

These are missing the title="..." attribute. This means that some browsers will announce the links as "alternate" with no explanation of their destination - see screenshot attached.

The three links are:

<link rel="alternate" type="application/json" href="https://example.com/wp-json/wp/v2/posts/123" />
<link rel="alternate" type="application/json+oembed" href="https://sexample.com/wp-json/oembed/1.0/embed?url=https%3A%2F%2Fexample.com%2Fpost%2F" />
<link rel="alternate" type="text/xml+oembed" href="https://example.com/wp-json/oembed/1.0/embed?url=https%3A%2F%2Fexample.com%2Fpost%2F&#038;format=xml" />

Ideally, these would have title="JSON", title="oEmbed (JSON)", title="oEmbed (XML)" or similar.

Attachments (1)

Screenshot from 2023-08-08 19-05-44.png (34.9 KB) - added by edent 9 months ago.
Lynx browser showing the "alternate" link.

Download all attachments as: .zip

Change History (13)

@edent
9 months ago

Lynx browser showing the "alternate" link.

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


8 months ago

#2 @kadamwhite
8 months ago

@TimothyBlynJacobs @rmccue Do you see any reason not to do this? I assume we'd want to translate the title strings

#3 @TimothyBlynJacobs
8 months ago

Yeah seems fine to add. I was unaware lynx was still a thing :)

This ticket was mentioned in PR #5080 on WordPress/wordpress-develop by addisonhardy.


8 months ago
#4

  • Keywords has-patch has-unit-tests added

This PR makes three changes:

Note: The Trac ticket referenced below does not include a consensus discussion around this change. Opening the PR as a proof of concept as part of familiarizing w/ the WP development process as a new contributor at WordCamp US 2023.

Trac ticket: https://core.trac.wordpress.org/ticket/59006

#5 @kadamwhite
8 months ago

@TimothyBlynJacobs Do you think these "title" strings should be translatable?

@TimothyBlynJacobs commented on PR #5080:


8 months ago
#6

Maybe @SergeyBiryukov has some thoughts on localization. My inclination would be that we should still translate it.

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


7 months ago

@joedolson commented on PR #5080:


7 months ago
#8

I'm inclined to think these should be translated, although it does feel a little strange. At least in the case of oEmbed (XML), I think that the structure and order of the text could be variable by language, which is enough to justify it, to me.

#9 @joedolson
7 months ago

  • Milestone changed from Awaiting Review to 6.5

I think this is worth doing, even though it probably only applies in a very small number of cases. A little clarity doesn't hurt!

#10 @audrasjb
3 months ago

  • Keywords changes-requested added
  • Owner set to audrasjb
  • Status changed from new to reviewing

Yes these strings should be translatable: even if it's a edge case, as soon as the title is rendered in the user agent, any language change without information about the language of the string would be a compliance issue.

This ticket was mentioned in Slack in #accessibility by joedolson. View the logs.


3 months ago

#12 @swissspidy
2 months ago

  • Milestone changed from 6.5 to 6.6
  • Type changed from defect (bug) to enhancement

This is really more of an enhancement, so moving out of 6.5.

Not sure about the localization, but if we add it, it should use _x() with proper context.

Note: See TracTickets for help on using tickets.