From a3c31fcebc3849616de5c62e49266a578a6e1ff1 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Mon, 30 Apr 2018 14:38:56 +0000 Subject: [PATCH] Docs: Update the inline docs for `is_protected_meta()`. See #42505 git-svn-id: https://develop.svn.wordpress.org/trunk@43043 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/meta.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/wp-includes/meta.php b/src/wp-includes/meta.php index 010822fdc8..7959be5576 100644 --- a/src/wp-includes/meta.php +++ b/src/wp-includes/meta.php @@ -941,25 +941,25 @@ function _get_meta_table( $type ) { } /** - * 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 ) { $protected = ( '_' == $meta_key[0] ); /** - * 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 ); }