[wp-trac] [WordPress Trac] #45464: Document some examples of object types accepted by register_meta()

WordPress Trac noreply at wordpress.org
Mon Dec 3 08:24:07 UTC 2018


#45464: Document some examples of object types accepted by register_meta()
--------------------------------+-----------------------------
 Reporter:  DrewAPicture        |      Owner:  (none)
     Type:  defect (bug)        |     Status:  new
 Priority:  normal              |  Milestone:  Awaiting Review
Component:  Options, Meta APIs  |    Version:  3.3
 Severity:  normal              |   Keywords:  good-first-bug
  Focuses:  docs                |
--------------------------------+-----------------------------
 As pointed out in a
 [https://developer.wordpress.org/reference/functions/register_meta/#comment-2483
 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."

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/45464>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list