Add a Download row action to the Media List Table

[pbiron]

As a follow-up to #41474, I think it would be useful to add a Download row action to the Media List Table.

Patch and screenshot coming shortly.

[joedolson]

Note: shortens "Copy URL to clipboard" to reduce clutter. This seems like a reasonable change; I'm not sure that "to clipboard" is really very necessary. What else would 'Copy URL' do?

[pbiron]

yes. the only reason the Copy row action said that was that all the other places where there is a Copy URL button (e.g., in the Media Modal) said that.

I think it's fine without `to clipboard' :-)

[kebbet]

Could the same string as in [55156] be used? So the row action link says: Download file.

Then the row actions will be:
Edit | Delete permanantly | View | Copy URL | Download file

Use Download file as text for row action link.

https://core.trac.wordpress.org/ticket/57574

Before:

With patch from @pbiron :

With this patch:

[Mista-Flo]

Hello there,

that's a nice addition to the media library IMO, I have tested the patch and it works fine, I'm able to download the file, and the copy URL update doesn't affect the feature as well, so LGTM, great job :)

[audrasjb]

This looks perfect to me.
I think we can definitely ship it in 6.2.

[audrasjb]

This will probably require an user docs update:
​https://wordpress.org/documentation/article/media-library-screen/#actions

[pbiron]

Replying to kebbet:

Could the same string as in [55156] be used? So the row action link says: Download file.

Then the row actions will be:
Edit | Delete permanantly | View | Copy URL | Download file

Great catch @kebbet! I didn't realize I used a different string.

Latest commit updates updates the help tab.

[kebbet]

The updated help tab texts might need a copy review. Something about the file is being downloaded to the user’s device or computer.

[audrasjb]

Ah good point, indeed we need to update the help tabs.
Removing commit pending copy review.

[costdev]

Great idea! I've looked at the PR that updates the strings and they look good to me - but will leave the copy review to those from the Help/About component.

There are some test failures that are related to an issue with an earlier commit to trunk which has now been fixed. The PR needs a refresh on trunk.

[kebbet]

I've updated the PR against trunk (tests are passing), and adjusted the copy a bit. Any feedback is welcome!

[amin7]

Test Report

---

This report validates that the indicated patch added the enhancement.
Patch tested:
https://core.trac.wordpress.org/attachment/ticket/57574/57574.diff

Environment

---

OS: Windows 10 version 22H2
Web Server: Nginx
PHP: 7.4.30
WordPress: 6.2-alpha-54642-src
Browser: Chrome 109.0.5414.87
Theme: Twenty Twenty-Three
Active Plugins: No plugins activated.

Before Patch

---

Screenshot: ​https://d.pr/i/dvaXYR

After Patch

---

Text Changes: 'Copy URL to Clipboard' to 'Copy URL'
A download option is added and the file can download.

Screencast: ​https://d.pr/v/WmihOz

---

✅ patch is working as per enhancement request.

[kebbet]

Thanks for testing @amin7, could you please test the latest patch found at GitHub linked in this ticket? It also updated the help tab.

[amin7]

Hi @kebbet

I checked and the help tab is also updated, here is a screenshot. ​https://d.pr/i/2JrdeO

Just sharing a thought of mine if I don't bother you, should the text 'Copy URL to clipboard' also be changed to 'Copy URL' in the edit mode? Here is a screencast: ​https://d.pr/v/ivPJjN

Thanks & regards

[kebbet]

First:
Thanks for testing @amin7!

This ticket focus on the action row links, if the button on the edit page that says Copy URL to clipboard should be changed, that's a discussion for another ticket I guess. But the question started me thinking, should the row action for Copy URL to clipboard be left untouched in this ticket, is there really that much visual clutter? Isn't the text there for a reason?
@audrasjb or @pbiron, do you have any opnions on this?

Secondly:
Any feedback on the help tab text is welcome, what should we go for to get this into 6.2?
​https://github.com/WordPress/wordpress-develop/pull/3934#pullrequestreview-1274240130

[audrasjb]

Hey hey,

This patch can replace "Copy URL to clipboard" with "Copy URL" in the row action links as it's better in the context of this ticket, but in my mind it's better to open a follow-up ticket to address other occurrences, once this once is committed.

Concerning copy review, I'd go with @costdev's proposal:

<strong>Download file</strong> downloads the original media file to your device.

[kebbet]

Thanks for swift reply! PR is updated with @costdev's proposal.

Latest text change in the help tab:

[pbiron]

Everything looks great to me.

@audrasjb Can this get committed before Beta 1 (next tues)?

[audrasjb]

yes, definitely!

[audrasjb]

In 55198:

Media: Add a Download row action to the Media List Table.

This changeset makes it easier for users to download their uploaded media by providing a Download row action to the Media List Table. It also rephrases the Copy URL row action for better consistency and to give room for the new Download action.

Follow-up to [55156].

Props pbiron, joedolson, kebbet, Mista-Flo, costdev, amin7, mukesh27.
Fixes #57574.

Committed in https://core.trac.wordpress.org/changeset/55198

[joedolson]

I think wp_get_attachment_url() should probably get escaped, like it is for the copy action.

[pbiron]

Replying to joedolson:

I think wp_get_attachment_url() should probably get escaped, like it is for the copy action.

I'm not sure. The copy action seems to be the only one that escapes the URL in the generated link.

@audrasjb what do you think?

[joedolson]

Yeah, as I've looked through, it seems pretty random; should probably find the commit that added the copy link and if there was any discussion there. One way or the other, we should be consistent.

[pbiron]

The ticket that added the copy action is #54426. The escaping was first done in https://core.trac.wordpress.org/attachment/ticket/54426/54426.3.patch.

[audrasjb]

Indeed, it is recommended to escape use esc_url here, as @costdev pointed out in another ticket, see the function description:

eliminates invalid characters and removes dangerous characters

So, even though esc_url() is mainly used for security, this also helps when extenders return a value that has invalid characters. I guess this is one reason why the pattern exists elsewhere in Core.

[audrasjb]

In 55221:

Media: Properly escape Download row action link in Media List Table.

Props joedolson, pbiron, audrasjb.
Fixes #57574.

[bobbingwide]

While testing 6.2-beta5 I noticed that the Download link is not present if you filter on Unattached items.

It does appear for unattached items in the other modes.

[pbiron]

Thanx for finding that @bobbingwide.

The 6.2 release leads have decided that it's too late in the cycle, and the fix will have to wait until 6.2.1.

I've opened #57890 so this doesn't get lost.