WordPress.org

Make WordPress Core

Opened 4 months ago

Closed 7 weeks ago

#48716 closed enhancement (fixed)

Improve wording for PHP update warning // Part 2

Reported by: grafruessel Owned by: SergeyBiryukov
Milestone: 5.4 Priority: normal
Severity: normal Version: 5.3
Component: Site Health Keywords: has-screenshots has-patch commit
Focuses: ui-copy Cc:

Description

reference to ticket: https://core.trac.wordpress.org/ticket/47644#comment:22

Hi there,
I want to optimise the wording on the following topic.

Right now we have 4 stages on php version warning:

Label for up to date;
Your version of PHP (%s) is up to date
Your version of PHP (%s) is out of date
Your version of PHP (%s) should be updated
Your version of PHP (%s) requires an update

I totally get that, but in my opinion for 7.2.x saying it's out of date is kind of hard and requires more context for non technical users. Is it clear for everybody that there is no need to do anything, when it is "out of date"? In context with all 4 stages, I think that really would help.

As discussed on slack (https://wordpress.slack.com/archives/CKSU841L7/p1574114869070900) with @garrett-eclipse, I suggested to change wording to sth. like and show these stages on the description (toggle):

Your version of PHP (%s) is up to date
Your version of PHP (%s) is out of date
Your version of PHP (%s) is out of date and should be updated
Your version of PHP (%s) is out of date and requires an update

This is why I opened that ticket.

Thanks,
Nikolai

Attachments (9)

48716.patch (1.6 KB) - added by sathyapulse 4 months ago.
48716.patch
48716.1.patch (928 bytes) - added by sathyapulse 4 months ago.
48716.1.patch
48716.diff (962 bytes) - added by wpgurudev 4 months ago.
Update notice wordings.
Screen Shot 2019-11-19 at 10.32.54 AM.png (71.9 KB) - added by garrett-eclipse 4 months ago.
Screen to provide context
48716.2.patch (1.5 KB) - added by sathyapulse 4 months ago.
48716.2.patch
48716.3.patch (1.6 KB) - added by sathyapulse 4 months ago.
48716.3.patch
48716.4.diff (1.5 KB) - added by garrett-eclipse 2 months ago.
Updated verbiage to use older rather than outdated and use which instead of and to place update emphasis on PHP rather than website.
Screen Shot 2020-01-17 at 12.10.11 PM.png (26.5 KB) - added by garrett-eclipse 2 months ago.
Updated verbiage for PHP 7.2.x
48716.2.diff (1.6 KB) - added by Clorith 7 weeks ago.

Download all attachments as: .zip

Change History (28)

@sathyapulse
4 months ago

48716.patch

@sathyapulse
4 months ago

48716.1.patch

@wpgurudev
4 months ago

Update notice wordings.

#1 follow-up: @wpgurudev
4 months ago

Wordings like "Your version of PHP.." also doesn't seem to be correct; rather it should say something like "Your PHP version..."

Adding patch.

#2 @garrett-eclipse
4 months ago

Thanks @sathyapulse & @wpgurudev for the patches.

Both Your version of PHP (%s) and Your PHP version (%s) are valid so I don't have much preference there. I find Your version of PHP (%s) to be more friendly verbiage.

In 48716.diff we're missing the and in the sentence there.

Going to CC @marybaum as she was the wordsmith participating in the original decision.

#3 @marybaum
4 months ago

  • Keywords has-copy-review added

Okey dokey!

The thing we want to keep in mind is that there is action we want users/admins to take and then stay on top of.

So while this may feel like an arcane discussion of semantics and style, the question is -- what's the language that will keep this fire lit under their butts?

With that in mind I propose:

Your site is running the current version of PHP (%s).
Your site is running an outdated version of PHP (%s).
Your site is running an outdated version of PHP (%s). It should be running the current version (%s++).
Your site is running an outdated version of PHP (%s). It requires an update to the current version (%s++) – please update now.

/*Or whatever notation we use for the current. I know it's a fantasy that some of these are only two increments behind! 😜)*/

If there were room, I'd be tempted to add a line about performance and security, but I doubt we have it in these strings.

If we wanted to add a tooltip, we could write the strings like this:

String: Your site is running the current version of PHP (%s)
Tooltip: (🎉 or equivalent)

String: Your site is running an outdated version of PHP (%s).
Tooltip: The current version is (%s++), which will help keep your site more secure and make it run faster, too.

String: Your site is running an outdated version of PHP (%s). It should be running the current version (%s++).
Tooltip: Please update to version (%s++) as soon as you can, for more security and a faster site.

String: Your site is running an outdated version of PHP (%s). It requires an update to the current version (%s++) – please update now.
Tooltip: Version (%s++) addresses several urgent issues. You'll also get more security and a faster site.

Don't get me started on what we could say in a popup. 😜

@garrett-eclipse
4 months ago

Screen to provide context

#4 @garrett-eclipse
4 months ago

Thanks for the input @marybaum I've uploaded a screenshot to illustrate where the string will be placed as it's a heading on an accordion and as such has limited space on mobile so would like to avoid rolling onto two lines.

Also the additional context information about recommended version and security and speed is all present within the contents of the accordion and as such I feel can be avoided in the heading.

With that in mind I feel a combination of the original recommendation and the verbiage you provided would make sense and be succinct;
Your site is running the current version of PHP (%s)
Your site is running an outdated version of PHP (%s)
Your site is running an outdated version of PHP (%s) and should be updated
Your site is running an outdated version of PHP (%s) and requires an update

Thoughts?

@sathyapulse
4 months ago

48716.2.patch

#5 @sathyapulse
4 months ago

@garrett-eclipse Please find the updated patch with your suggestions.

#6 @garrett-eclipse
4 months ago

  • Keywords has-patch added
  • Version set to 5.3

Thanks @sathyapulse you patch looks good there. Going to leave for discussion for a bit before we move it forward.

#7 @Clorith
4 months ago

This seems to be related to #46326 and #48390, where I do make note that I'm vary of adding a lot of numbers to the Site Health check headings, as they're arbitrary to the average user.

Making a mention of it in the expanded section in some manner as part of the explanation I can be more on board with, but I'm still not convinced it's a good idea to add to the headings.

@sathyapulse
4 months ago

48716.3.patch

#8 @sathyapulse
4 months ago

@garrett-eclipse Including the right patch file if in case we are applying this patch.

#9 @Clorith
3 months ago

  • Keywords needs-refresh added; 2nd-opinion has-copy-review has-patch removed
  • Milestone changed from Awaiting Review to 5.4

Let's get this finalized I think :)

I think the strings in 48716.3.patch look good, let's use most of them, but let's also change the one for:

Your version of PHP (%s) is out of date

To something a bit more reflective of what is the current situation:

Your site is running an older version of PHP (%s)

This because WordPress generally recommends the latest-ish version of PHP (depending on timing it may be a version behind), but older versions may still be actively supported, this makes it clearer that you're not on the latest version, but does not claim it is outdated, as that word is also associated with something not being supported.

#10 follow-up: @xkon
3 months ago

48716.3.patch still applies (with an automated offset fix).

@Clorith you got me a bit confused with your comment, the wording is:

Current: Your site is running the current version of PHP (%s)
Supported: Your site is running an outdated version of PHP (%s)
Security fixes: Your site is running an outdated version of PHP (%s) and should be updated
No security: Your site is running an outdated version of PHP (%s) and requires an update

Is a further refresh needed here on wording? :D

#11 in reply to: ↑ 10 @SergeyBiryukov
3 months ago

Replying to xkon:

Security fixes: Your site is running an outdated version of PHP (%s) and should be updated
No security: Your site is running an outdated version of PHP (%s) and requires an update

Maybe it's just me, but these strings read to me as if the site requires an update, not the PHP version:

  • "Your site is running ... and should be updated"
  • "Your site is running ... and requires an update"

Could we make it clear that "should be updated" / "requires an update" refers to the PHP version, not the site?

#12 in reply to: ↑ 1 @marybaum
3 months ago

Replying to wpgurudev:

Wordings like "Your version of PHP.." also doesn't seem to be correct; rather it should say something like "Your PHP version..."

Adding patch.

Agree - "Your PHP version" is clearer.

I think I understand what you're after -- if someone is running 5.x, that's an emergency and they need to update like last week. If someone's running 7.2, they should update and get in the habit of staying that way, but they're not going to blow up a server.

In that case, (Oh could I have fun with this if we weren't being family friendly! Think Holy $#!! -- You've gotta update! But I digress.)

So what do we all think of:

Your site is running on the latest version of PHP, which is (%s).

Your site is running on PHP version (%s), which is a little behind. Please update to (%s++) when you can.

Your site is running on PHP version (%s), which is significantly out of date. Please upgrade to the latest version , (%s + i++), as soon as possible.

Your site is running on PHP version (%s), which is dangerously out of date. Please upgrade to to the latest version , (%s + i++), immediately or risk your site's continued health and security.

If you don't have access to tools that keep your PHP version up to date, please contact your server administrator or your hosting representative.

Thoughts?

@garrett-eclipse
2 months ago

Updated verbiage to use older rather than outdated and use which instead of and to place update emphasis on PHP rather than website.

@garrett-eclipse
2 months ago

Updated verbiage for PHP 7.2.x

#13 @garrett-eclipse
2 months ago

  • Keywords has-patch has-screenshots added; needs-refresh removed

Thanks for the feedback everyone, I've refreshed the patch in 48716.4.diff to accommodate everyone's input.

Current verbiage;

  • Your site is running the current version of PHP (%s)
  • Your site is running an older version of PHP (%s)
  • Your site is running an older version of PHP (%s) which should be updated
  • Your site is running an older version of PHP (%s) which requires an update

The two changes are;

  1. Switching 'outdated' for 'older' due to @Clorith comment
  2. Switching 'and' for 'which' due to @SergeyBiryukov comment, this should hopefully tie the 'should be updated' and 'requires an update' to PHP instead of the site to remove confusion.

@marybaum I didn't adopt your suggestions as this string is to be used as the accordion heading so brevity is key and I wanted to avoid having multiple lines in a heading. For context on placement see this screenshot;
https://core.trac.wordpress.org/raw-attachment/ticket/48716/Screen%20Shot%202019-11-19%20at%2010.32.54%20AM.png

I feel this is ready to commit but would appreciate your blessing @Clorith as you're the maintainer.

This ticket was mentioned in Slack in #core-site-health by clorith. View the logs.


2 months ago

#15 follow-up: @Clorith
7 weeks ago

  • Keywords needs-refresh added; has-patch removed

48716.4.diff looks fairly good, I would possibly change this final string:

Your site is running an older version of PHP (%s) which requires an update

Let's instead use the outdated term I mentioned not wanting previously, older works better in most situations, but this particular one is if the version is not receiving security updates, so it is correct to call that one outdated.

The final string in the patch should then be this instead:

Your site is running an outdated version of PHP (%s) which requires an update

@Clorith
7 weeks ago

#16 @Clorith
7 weeks ago

  • Keywords has-patch commit added; needs-refresh removed

48716.2.diff takes what @garrett-eclipse put together, and emends the final string, this should be good to go.

#17 in reply to: ↑ 15 @grafruessel
7 weeks ago

Replying to Clorith:

The final string in the patch should then be this instead:

Your site is running an outdated version of PHP (%s) which requires an update

makes sense and sounds good. Awesome work.

This ticket was mentioned in Slack in #core by clorith. View the logs.


7 weeks ago

#19 @SergeyBiryukov
7 weeks ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 47254:

Site Health: Improve the wording for PHP update recommendations.

Props Clorith, grafruessel, sathyapulse, wpgurudev, garrett-eclipse, marybaum, xkon, SergeyBiryukov.
Fixes #48716.

Note: See TracTickets for help on using tickets.