WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#29977 closed defect (bug) (fixed)

Hook doc for xmlrpc_element_limit filter

Reported by: ankit.gade@… Owned by: DrewAPicture
Milestone: 4.1 Priority: normal
Severity: normal Version: 4.0
Component: XML-RPC Keywords: has-patch
Focuses: docs Cc:

Description

xmlrpc_element_limit filter in class-IXR.php in wp-includes is not documented. Attached diff file contains documentation for the hook.

Attachments (3)

class-IXR.diff (729 bytes) - added by ankit.gade@… 6 years ago.
Documentation for xmlrpc_element_limit filter.
class-IXR.2.diff (823 bytes) - added by ankit.gade@… 6 years ago.
Code formatting with revised description for hook.
29977.3.diff (799 bytes) - added by kpdesign 6 years ago.
3rd pass

Download all attachments as: .zip

Change History (9)

@ankit.gade@…
6 years ago

Documentation for xmlrpc_element_limit filter.

#1 @ankit.gade@…
6 years ago

  • Keywords has-patch added

#2 follow-up: @DrewAPicture
6 years ago

  • Keywords needs-patch added; has-patch removed
  • Milestone changed from Awaiting Review to 4.1
  • Owner set to DrewAPicture
  • Status changed from new to reviewing

Hi ankit, thanks for the patch. Couple things:

  • The docblock should align with hook line itself, currently it's indented quite a bit
  • "The limit of elements" is a little ambiguous, maybe change that to something like "Filter the number of elements to parse in an XML-RPC response"
  • The @since tag should use the 3-digit, x.x.x style for the version
  • There should be a period at the end of the @param description

@ankit.gade@…
6 years ago

Code formatting with revised description for hook.

#3 in reply to: ↑ 2 @ankit.gade@…
6 years ago

Replying to DrewAPicture:

Hi ankit, thanks for the patch. Couple things:

  • The docblock should align with hook line itself, currently it's indented quite a bit
  • "The limit of elements" is a little ambiguous, maybe change that to something like "Filter the number of elements to parse in an XML-RPC response"
  • The @since tag should use the 3-digit, x.x.x style for the version
  • There should be a period at the end of the @param description

Thank you Drew, I have attached revised patch file with given points.

#4 @ankit.gade@…
6 years ago

  • Keywords has-patch added; needs-patch removed

@kpdesign
6 years ago

3rd pass

#5 @DrewAPicture
6 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 30744:

Add missing documentation for the xmlrpc_element_limit hook in wp-includes/class-IXR.php.

Props ankitgadertcampcom, kpdesign.
Fixes #29977.

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


6 years ago

Note: See TracTickets for help on using tickets.