sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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
This commit is contained in:
John Blackbourn 2018-04-30 14:38:56 +00:00
parent 37916c2a5f
commit a3c31fcebc
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/wp-includes/meta.php
View File

@ -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 );
}