WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#29876 closed defect (bug) (duplicate)

Document default arguments for WP_Meta_Query

Reported by: DrewAPicture Owned by: DrewAPicture
Milestone: Priority: normal
Severity: normal Version:
Component: Options, Meta APIs Keywords: has-patch
Focuses: docs Cc:
PR Number:

Description

The default arguments for WP_Meta_Query need to be documented in the hash notation style. The actual docs would go into the docblock for WP_Meta_Query::__construct().

Here are a couple of good example of documenting default arguments in hash notations:

  • docs for WP_User_Query::prepare_query()
  • docs for WP_Query::parse_query()

If it helps, you can use the WP_Meta_Query Codex article to find more information on the default arguments.

This ticket is reserved for new contributors on the good-first-bug keyword.

Attachments (1)

meta-29876.diff (1.5 KB) - added by Oxymoron 5 years ago.
meta.php patch for #29876

Download all attachments as: .zip

Change History (6)

@Oxymoron
5 years ago

meta.php patch for #29876

#1 @Oxymoron
5 years ago

  • Keywords has-patch added; needs-patch removed

Sorry if the patch isn't exactly right (first attempt at a patch!). I looked at the codex page for the WP_Meta_Query and copied over the arguments using the hash notation style you requested.

Let me know if something's messed up and I can submit an updated patch.

This ticket was mentioned in IRC in #wordpress-dev by DrewAPicture. View the logs.


5 years ago

#3 @boonebgorges
5 years ago

I'm afraid we might have overshot each other a bit here - see [29887].

#4 @DrewAPicture
5 years ago

  • Owner set to DrewAPicture
  • Status changed from new to assigned

#5 @DrewAPicture
5 years ago

  • Keywords good-first-bug removed
  • Milestone Awaiting Review deleted
  • Resolution set to duplicate
  • Status changed from assigned to closed

These arguments were documented in [29887] for #29642. Thanks anyway for the effort @Oxymoron :/

Closing as a duplicate.

Note: See TracTickets for help on using tickets.