WordPress.org

Make WordPress Core

Opened 5 months ago

Last modified 4 months ago

#45464 new defect (bug)

Document some examples of object types accepted by register_meta()

Reported by: DrewAPicture Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version: 3.3
Component: Options, Meta APIs Keywords: good-first-bug
Focuses: docs Cc:

Description

As pointed out in a contributor note by @janwoostendorp, the current description for the $object_type parameter in register_meta() is a little vague: "Type of object this meta is registered to."

We could do better about documenting a few potential object types that it can accept. Obviously it's not limited to core object types, but giving some examples provides insight into what's expected.

Best recommendation for a patch would be to add an open-ended statement to the description along the lines of "Accepts ... or any other object with an associated meta table."

Change History (1)

Note: See TracTickets for help on using tickets.