WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#35962 closed defect (bug) (fixed)

Documentation fix for `get_meta_sql` filter

Reported by: sudar Owned by: DrewAPicture
Milestone: 4.5 Priority: normal
Severity: normal Version: 4.1
Component: Database Keywords: has-patch commit
Focuses: docs Cc:

Description

The get_meta_sql filter has 6 separate parameters, but the phpdoc documentation wrongly documents them as an array.

Because of this, the generated documentation for the filter at https://developer.wordpress.org/reference/hooks/get_meta_sql/ is also wrong.

I am attaching a patch which fixes the phpdocs documentation error. It doesn't have any code changes.

Attachments (1)

35962.patch (1.3 KB) - added by sudar 5 years ago.

Download all attachments as: .zip

Change History (5)

@sudar
5 years ago

#1 @DrewAPicture
5 years ago

  • Keywords has-patch commit added
  • Milestone changed from Awaiting Review to 4.5

@sudar Thanks for the patch, good catch!

#2 @DrewAPicture
5 years ago

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

In 36735:

Docs: Correctly document parameters in the hook doc for the get_meta_sql filter as individual parameters rather than an array.

When an array of parameters is passed to do_action|apply_filters_ref_array, parameters should be documented as individuals instead of as part of the whole.

Props sudar.
Fixes #35962.

#3 @sudar
5 years ago

@DrewAPicture You're welcome :) I just happened to look at the documentation for that hook.

Meanwhile I also found a similar issue with phpdoc and developer docs. I have created #35974 (with patch) for it.

This one affects the documentation about a dozen hooks.

#4 @johnbillion
5 years ago

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