WordPress.org

Make WordPress Core

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#36205 closed defect (bug) (invalid)

PHPDoc correction for wp-admin/includes/class-wp-upgrader.php

Reported by: JeffMatson Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Upgrade/Install Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

While looking for a hook, I noticed this correction in the docblocks. Simply changed to reflect the correct array key when using the Plugin_Upgrader child class.

Attachments (1)

36205.patch (734 bytes) - added by JeffMatson 4 years ago.

Download all attachments as: .zip

Change History (4)

@JeffMatson
4 years ago

#1 @JeffMatson
4 years ago

  • Keywords has-patch added
  • Version trunk deleted

#2 @swissspidy
4 years ago

  • Milestone Awaiting Review deleted
  • Resolution set to invalid
  • Status changed from new to closed

Hey there, thanks for taking your time to create this ticket!

It may be confusing, but $packages isn't always a list of plugins. Depending on the context (i.e. the $this parameter), it might be a list of theme or core packages to update. Plugin_Upgrader isn't the only upgrader class, there's also Theme_Upgrader and Core_Upgrade.

I think the current DocBlock makes that clear, so I'm closing this ticket.

If you feel the documentation should be improved to better highlight the different contexts, feel free to reopen this ticket.

This ticket was mentioned in Slack in #docs by dd32. View the logs.


4 years ago

Note: See TracTickets for help on using tickets.