[wp-trac] [WordPress Trac] #55450: WP_Upgrader::run docblock incorrect

WordPress Trac noreply at wordpress.org
Wed Mar 23 18:02:41 UTC 2022


#55450: WP_Upgrader::run docblock incorrect
-----------------------------+----------------------------
 Reporter:  paulkevan        |       Owner:  davidbaumwald
     Type:  defect (bug)     |      Status:  closed
 Priority:  normal           |   Milestone:  6.0
Component:  Upgrade/Install  |     Version:  trunk
 Severity:  normal           |  Resolution:  fixed
 Keywords:  has-patch        |     Focuses:  docs
-----------------------------+----------------------------
Changes (by davidbaumwald):

 * status:  reviewing => closed
 * resolution:   => fixed


Comment:

 In [changeset:"52986" 52986]:
 {{{
 #!CommitTicketReference repository="" revision="52986"
 Upgrade/Install: Fix the docs for the default value of `$clear_working` in
 `WP_Upgrader::run`.

 The current docblock for `WP_Upgrader::run` indicates the default value
 for the `clear_working` key of the `$options` argument is `false`.
 However, in the code directly below, the default is shown to be `true.
 This change updates the docblock to correct the default.

 This commit also reorders the `$defaults` to match the order they appear
 in the docblock.

 Props paulkevan.
 Fixes #55450.
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/55450#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list