WordPress.org

Make WordPress Core

Opened 2 years ago

Closed 21 months ago

#41379 closed defect (bug) (fixed)

Document $r parameter for 'http_api_debug' action

Reported by: ronakganatra Owned by: SergeyBiryukov
Milestone: 4.9 Priority: normal
Severity: normal Version:
Component: HTTP API Keywords: has-patch
Focuses: docs Cc:

Description

Documentation needs improvement in do_action parameters in class file. parameter is passed in do_action() but not defined in documentation.

Attachments (2)

41379.patch (546 bytes) - added by ronakganatra 2 years ago.
documentation added of parameter
41379_2.patch (689 bytes) - added by bor0 21 months ago.

Download all attachments as: .zip

Change History (7)

@ronakganatra
2 years ago

documentation added of parameter

#1 follow-up: @SergeyBiryukov
2 years ago

  • Milestone changed from Awaiting Review to 4.9

Hi @ronakganatra, welcome to WordPress Trac! Thanks for the patch.

The $r parameter is already documented as $args here.

That said, other filters (http_request_args, pre_http_request, http_response) have it documented as $r, so we could probably change it to $r in http_api_debug as well for consistency.

#2 in reply to: ↑ 1 @ronakganatra
2 years ago

Replying to SergeyBiryukov:
thanx for reviewing.

#3 @SergeyBiryukov
23 months ago

  • Summary changed from Documentation needs improvement in do_action parameters to Document $r parameter for 'http_api_debug' action

@bor0
21 months ago

#4 @bor0
21 months ago

  • Keywords has-patch added

#5 @SergeyBiryukov
21 months ago

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

In 41562:

Docs: Change $args to $r in the DocBlock for http_api_debug filter to match the variable name.

Props bor0, ronakganatra.
Fixes #41379.

Note: See TracTickets for help on using tickets.