Changeset 43043 for trunk

Timestamp:

04/30/2018 02:38:56 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Update the inline docs for is_protected_meta().

See #42505

File:

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

trunk/src/wp-includes/meta.php

@@ -942 +942 @@
 
 /**
- * Determine whether a meta key is protected.
+ * Determines whether a meta key is considered protected.
  *
  * @since 3.1.3
  *
- * @param string      $meta_key Meta key
- * @param string|null $meta_type
- * @return bool True if the key is protected, false otherwise.
+ * @param string      $meta_key  Meta key.
+ * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, or user).
+ * @return bool Whether the meta key is considered protected.
  */
 function is_protected_meta( $meta_key, $meta_type = null ) {
@@ -954 +954 @@
 
     /**
-     * Filters whether a meta key is protected.
+     * Filters whether a meta key is considered protected.
      *
      * @since 3.2.0
      *
-     * @param bool   $protected Whether the key is protected. Default false.
-     * @param string $meta_key  Meta key.
-     * @param string $meta_type Meta type.
+     * @param bool        $protected Whether the key is considered protected.
+     * @param string      $meta_key  Meta key.
+     * @param string|null $meta_type Type of object metadata is for (e.g., comment, post, or user).
      */
     return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );