[wp-trac] [WordPress Trac] #37340: Clarify inline documentation for object_subtype

[WordPress Trac]

#37340: Clarify inline documentation for object_subtype
--------------------------------+------------------------------------
 Reporter:  johnbillion         |      Owner:
     Type:  task (blessed)      |     Status:  new
 Priority:  normal              |  Milestone:  4.6
Component:  Options, Meta APIs  |    Version:  trunk
 Severity:  normal              |   Keywords:  needs-patch needs-docs
  Focuses:  docs                |
--------------------------------+------------------------------------
 #35658 introduced the concept (or at least the terminology) of an object
 subtype when registering meta fields. Reading the inline documentation,
 it's not at all clear what an object subtype is, or what value should be
 passed to this parameter.

 {{{
  * @param string $object_type    The type of object.
  * @param string $object_subtype The subtype of the object type.
 }}}

 Documentation for the `$object_subtype` parameter for the following
 functions and filters needs to be improved and made consistent:

  * `sanitize_meta()`
  * `register_meta()`
  * `registered_meta_key_exists()`
  * `unregister_meta_key()`
  * `get_registered_meta_keys()`
  * `get_registered_metadata()`
  * `sanitize_{$object_type}_{$object_subtype}_meta_{$meta_key}` filter
  * `sanitize_{$object_type}_meta_{$meta_key}` filter

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