WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#35289 closed defect (bug) (fixed)

Docs: Fix phpdoc tags for WP Http methods

Reported by: Frozzare Owned by: DrewAPicture
Milestone: 4.5 Priority: normal
Severity: normal Version: 3.2
Component: HTTP API Keywords: has-patch
Focuses: docs Cc:

Description

I notice that _get_first_available_transport method in WP_Http has the wrong access value, it's used public but the access tag says private and that _dispatch_request method has static tag but is not used as a static method.

This patch will change the access value for _get_first_available_transport and remove static from _dispatch_request.

Attachments (1)

35289.patch (630 bytes) - added by Frozzare 6 years ago.

Download all attachments as: .zip

Change History (6)

@Frozzare
6 years ago

#1 @SergeyBiryukov
6 years ago

  • Component changed from General to HTTP API

#2 @Frozzare
6 years ago

  • Keywords has-patch added

#3 @DrewAPicture
6 years ago

  • Milestone changed from Awaiting Review to 4.5
  • Type changed from enhancement to defect (bug)

Hi @Frozzare, thanks for the patch! We'll handle the @access change here, and removal of the @static tag in #32246.

#4 @DrewAPicture
6 years ago

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

In 36367:

Docs: Update the @access tag value for WP_Http::_get_first_available_transport() from private to public.

When the method was introduced in [17914], the name was underscore-prefixed as is core style for private-use, though it was also introduced with a public access modifier for the declaration. Due to core's committment to backward-compatibility, the access modifier overrules in this case, meaning that while the method is underscore-prefixed and was originally-intentioned to be private, it is and always will be a public method, and the documentation should reflect that.

Props Frozzare.
Fixes #35289.

#5 @johnbillion
5 years ago

  • Version changed from trunk to 3.2
Note: See TracTickets for help on using tickets.