WordPress.org

Make WordPress Core

Opened 8 months ago

Closed 2 months ago

Last modified 3 weeks ago

#53330 closed defect (bug) (fixed)

Update inline documentation for `auto_update_{$type}`

Reported by: desrosj Owned by: desrosj
Milestone: 5.9 Priority: normal
Severity: normal Version: 5.6
Component: Upgrade/Install Keywords: good-first-bug has-patch needs-refresh commit
Focuses: docs Cc:

Description

The inline documentation for the auto_update_{$type} filter says:

Generally speaking, plugins, themes, and major core versions are not updated by default, while translations and minor and development versions for core are updated by default.

This is no longer accurate. As of 5.6, new installations are set to auto-update for major versions as well as minor (see [49581], and the related Making WordPress Core post).

The inline docs here should be updated to state that installs created prior to 5.6 will not auto-update major versions, but new installs on 5.6 and higher will. It would also be good to scan the rest of the update related files and confirm that the inline docs for other filters and actions accurately reflect this change.

Change History (20)

#1 @desrosj
8 months ago

  • Focuses docs added

#2 @desrosj
8 months ago

  • Version set to 5.6

This ticket was mentioned in PR #1438 on WordPress/wordpress-develop by felipelousantos.


7 months ago

  • Keywords has-patch added; needs-patch removed

The inline docs for auto_update_{$type} should be updated to state that installs created prior to 5.6 will not auto-update major versions, but new installs on 5.6 and higher will.

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

#4 @desrosj
7 months ago

  • Milestone changed from Future Release to 5.9

#5 @felipeloureirosantos
7 months ago

Adding the new comment here as well in case there are improvements on the text:

Before version 5.6, the plugins, themes, and major core versions were not updated by default. New installs on 5.6 and higher will only not update plugins and themes by default, while translations and core (minor, major, and development) are updated by default.

#6 @audrasjb
2 months ago

  • Keywords needs-refresh added

I'd suggest this wording:

 * Before version 5.6, plugins, themes, and major core versions were not updated by default.
 * New installs on 5.6 and higher will automatically update translations and core (minor,
 * major, and development versions). Plugins and themes are still updated manually by default.

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


2 months ago

This ticket was mentioned in Slack in #core-auto-updates by afragen. View the logs.


2 months ago

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


2 months ago

#10 @audrasjb
2 months ago

  • Keywords needs-copy-review added

#11 follow-up: @marybaum
2 months ago

Per Slack conversation https://wordpress.slack.com/archives/C02RQBWTW/p1637270022045500

Before version 5.6, someone had to do manual updates to plugins, themes, and major versions of Core. As of version 5.6 and to this day, all those updates can happen automatically, if you choose. All you do is check an action link on the appropriate page in the WordPress Admin.

#12 follow-up: @audrasjb
2 months ago

@marybaum thank you!

However, as it is not a user facing string, but a documentation accessible only to those checking the source code of the function, I don't think we should use "you" (and directly talk to the reader of the docs). It's not an end-user docs but rather an information to bring more context on the default values for these hooks :)

#13 in reply to: ↑ 12 @marybaum
2 months ago

Replying to audrasjb:
So we can say, "All anyone needs to do ..." or "All a site admin needs to do ... "

@marybaum thank you!

However, as it is not a user facing string, but a documentation accessible only to those checking the source code of the function, I don't think we should use "you" (and directly talk to the reader of the docs). It's not an end-user docs but rather an information to bring more context on the default values for these hooks :)

#14 in reply to: ↑ 11 ; follow-up: @desrosj
2 months ago

  • Keywords needs-copy-review removed

Replying to marybaum:

Per Slack conversation https://wordpress.slack.com/archives/C02RQBWTW/p1637270022045500

Before version 5.6, someone had to do manual updates to plugins, themes, and major versions of Core. As of version 5.6 and to this day, all those updates can happen automatically, if you choose. All you do is check an action link on the appropriate page in the WordPress Admin.

I’d also argue that this is inaccurate. Automatic updates for major updates, plugins, themes, and translations have possible since WordPress 3.7 by using filters or constants. The only thing that changed in 5.6 is that an interface was introduced.

How about: “Minor and development versions for Core, as well as translations are auto-updated by default. Starting in WordPress 5.6, major updates are also applied automatically by default, and users can opt-in to auto-updates for plugins and themes.”

Since this is developer documentation, it should be precise and to the point.

#15 in reply to: ↑ 14 @davidbaumwald
2 months ago

Replying to desrosj:

Replying to marybaum:

Per Slack conversation https://wordpress.slack.com/archives/C02RQBWTW/p1637270022045500

Before version 5.6, someone had to do manual updates to plugins, themes, and major versions of Core. As of version 5.6 and to this day, all those updates can happen automatically, if you choose. All you do is check an action link on the appropriate page in the WordPress Admin.

I’d also argue that this is inaccurate. Automatic updates for major updates, plugins, themes, and translations have possible since WordPress 3.7 by using filters or constants. The only thing that changed in 5.6 is that an interface was introduced.

How about: “Minor and development versions for Core, as well as translations are auto-updated by default. Starting in WordPress 5.6, major updates are also applied automatically by default, and users can opt-in to auto-updates for plugins and themes.”

Since this is developer documentation, it should be precise and to the point.

+1 This is for developers and should be very straightforward and technically focused. I think @desrosj 's recommendation is the one that should be used.

#16 @felipeloureirosantos
2 months ago

I added the last comment mentioned, but looks like that I did something wrong, as I see a big diff now with all the changes that were added when I selected to fetch upstream. I would love if you folks could confirm, as I'm not an experienced dev.

* Minor and development versions for Core, as well as translations are
* auto-updated by default. Starting in WordPress 5.6, major updates
* are also applied automatically by default, and users can opt-in to
* auto-updates for plugins and themes.

#17 @desrosj
2 months ago

  • Keywords commit added
  • Owner set to desrosj
  • Status changed from new to assigned

@felipeloureirosantos Did you happen to use rebase? I usually perform a pull into my branches because GitHub will show you the entire diff for PRs after rebasing.

No worries though. I can take the patch for the changed file when committing!

I am going to make one more revision of this before committing. The new description does not indicate that installs created before 5.6 can choose to opt-in to auto-upates for major releases in 5.6 or newer. Going to roll with this:

"Minor and development versions for core, as well as translations have been auto-updated by default since WordPress 3.7. New installs on WordPress 5.6 or higher will also auto-update major versions by default. Starting in 5.6, older sites can opt-in to major version auto-updates and auto-updates for plugins and themes."

#18 @desrosj
2 months ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 52214:

Upgrade/Install: Improve the accuracy of the auto_update_{$type} filter docblock.

This updates the filter documentation for auto_update_{$type} to account for the changes to default auto-update behaviors made in WordPress 5.6.

Starting in WordPress 5.6, all new installs auto-update major versions by default.

Props felipeloureirosantos, audrasjb, marybaum, davidbaumwald.
Fixes #53330.

#19 @desrosj
2 months ago

In 52215:

Docs: Remove instances of the “eg.” abbreviation in favor of “example” or “for example”.

See #53330.

#20 @prbot
3 weeks ago

hellofromtonya commented on PR #1438:

Final implementation was committed in https://core.trac.wordpress.org/changeset/52214.

Note: See TracTickets for help on using tickets.