WordPress.org

Make WordPress Core

Opened 10 months ago

Closed 10 months ago

Last modified 9 months ago

#47388 closed defect (bug) (fixed)

Missing docs for filters in site health check

Reported by: johnbillion Owned by: desrosj
Milestone: 5.3 Priority: normal
Severity: normal Version: 5.2
Component: Site Health Keywords: servehappy has-patch
Focuses: Cc:

Description

The site health check implements filters which haven't been documented.

  • automatic_updater_disabled (Ref)
  • automatic_updates_is_vcs_checkout (Ref)
  • allow_dev_auto_core_updates (Ref)
  • allow_minor_auto_core_updates (Ref)

These need to be documented or linked to their canonical documentation.

Attachments (1)

47388.diff (1.5 KB) - added by mukesh27 10 months ago.
Patch.

Download all attachments as: .zip

Change History (9)

#1 @johnbillion
10 months ago

In addition, using these filters instead of appropriate functions or methods doesn't seem correct to me. For example, the WP_Upgrader::is_vcs_checkout() method should probably be used in place of the automatic_updates_is_vcs_checkout filter.

@mukesh27
10 months ago

Patch.

#2 @mukesh27
10 months ago

  • Keywords has-patch added; needs-patch removed

#3 @desrosj
10 months ago

  • Keywords commit added

I agree that the automatic_updates_is_vcs_checkout filter should be replaced by the WP_Upgrader::is_vcs_checkout() as there is a lot of duplicated code, but there are some trade offs. The error message would become much less specific, for example. The checked directory and VCS directory would not be available currently without copying the logic over from the WP_Upgrader method and those are specifically mentioned in the messaging. The filter would also still need to be run to detect a change in value.

Let's add the missing documentation here and open a new ticket to explore ways to remove the duplicated code.

#4 @desrosj
10 months ago

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

In 45459:

Administration: Add missing filter documentation for Site Health auto update tests.

Props johnbillion, mukesh27.
Fixes #47388.

#5 @desrosj
10 months ago

  • Keywords fixed-major added; commit removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

Reopening for backport consideration. Opened #47428 for discussion around improving the version control test.

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


10 months ago

#7 @desrosj
10 months ago

  • Keywords fixed-major removed
  • Milestone changed from 5.2.2 to 5.3
  • Resolution set to fixed
  • Status changed from reopened to closed

Documentation fixes are not usually backported. Let's leave this in 5.3.

#8 @spacedmonkey
9 months ago

  • Component changed from Administration to Site Health
Note: See TracTickets for help on using tickets.