WordPress.org

Make WordPress Core

Changeset 43043


Ignore:
Timestamp:
04/30/2018 02:38:56 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Update the inline docs for is_protected_meta().

See #42505

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/meta.php

    r42343 r43043  
    942942
    943943/**
    944  * Determine whether a meta key is protected.
     944 * Determines whether a meta key is considered protected.
    945945 *
    946946 * @since 3.1.3
    947947 *
    948  * @param string      $meta_key Meta key
    949  * @param string|null $meta_type
    950  * @return bool True if the key is protected, false otherwise.
     948 * @param string      $meta_key  Meta key.
     949 * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, or user).
     950 * @return bool Whether the meta key is considered protected.
    951951 */
    952952function is_protected_meta( $meta_key, $meta_type = null ) {
     
    954954
    955955    /**
    956      * Filters whether a meta key is protected.
     956     * Filters whether a meta key is considered protected.
    957957     *
    958958     * @since 3.2.0
    959959     *
    960      * @param bool   $protected Whether the key is protected. Default false.
    961      * @param string $meta_key  Meta key.
    962      * @param string $meta_type Meta type.
     960     * @param bool        $protected Whether the key is considered protected.
     961     * @param string      $meta_key  Meta key.
     962     * @param string|null $meta_type Type of object metadata is for (e.g., comment, post, or user).
    963963     */
    964964    return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
Note: See TracChangeset for help on using the changeset viewer.