Changeset 48777

Timestamp:

08/10/2020 03:40:18 PM (4 years ago)

Author:

whyisjake

Message:

Options, Meta APIs: Update the docs around default metadata values.

Add a missing @since value for 5.5 and potential default filter names.

Fixes #50891.
Props johnbillion.

File:

• trunk/src/wp-includes/meta.php (modified) (3 diffs)

trunk/src/wp-includes/meta.php

@@ -591 +591 @@
 
 /**
- * Retrieves default metadata value for the specified object.
+ * Retrieves default metadata value for the specified meta key and object.
  *
  * By default, an empty string is returned if `$single` is true, or an empty array
@@ -614 +614 @@
 
     /**
-     * Filter the default value for a specified object.
+     * Filter the default metadata value for a specified meta key and object.
      *
      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
-     * (post, comment, term, user, or any other type with an associated meta table).
+     * (post, comment, term, user, blog, or any other type with an associated meta
+     * table). Possible filter names include:
+     *
+     *  - `default_post_metadata`
+     *  - `default_comment_metadata`
+     *  - `default_term_metadata`
+     *  - `default_user_metadata`
      *
      * @since 5.5.0
@@ -1228 +1234 @@
  * @since 4.9.8 The `$object_subtype` argument was added to the arguments array.
  * @since 5.3.0 Valid meta types expanded to include "array" and "object".
+ * @since 5.5.0 The `$default` argument was added to the arguments array.
  *
  * @param string       $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',