WordPress.org

Make WordPress Core

Changeset 43560 for trunk


Ignore:
Timestamp:
08/08/2018 09:44:31 PM (16 months ago)
Author:
rachelbaker
Message:

Docs: Update $meta_type descriptions to include ’term’ as a valid type in meta.php and class-wp-term-query.php.
Props macbookandrew.
Merges [43557] to trunk.
Fixes #44751.

Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk

  • trunk/src/wp-includes/meta.php

    r43521 r43560  
    1818 * @global wpdb $wpdb WordPress database abstraction object.
    1919 *
    20  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     20 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    2121 * @param int    $object_id  ID of the object metadata is for
    2222 * @param string $meta_key   Metadata key
     
    5858     *
    5959     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    60      * object type (comment, post, or user). Returning a non-null value
     60     * object type (comment, post, term, or user). Returning a non-null value
    6161     * will effectively short-circuit the function.
    6262     *
     
    9191     *
    9292     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    93      * object type (comment, post, or user).
     93     * object type (comment, post, term, or user).
    9494     *
    9595     * @since 3.1.0
     
    121121     *
    122122     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    123      * object type (comment, post, or user).
     123     * object type (comment, post, term, or user).
    124124     *
    125125     * @since 2.9.0
     
    143143 * @global wpdb $wpdb WordPress database abstraction object.
    144144 *
    145  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     145 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    146146 * @param int    $object_id  ID of the object metadata is for
    147147 * @param string $meta_key   Metadata key
     
    184184     *
    185185     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    186      * object type (comment, post, or user). Returning a non-null value
     186     * object type (comment, post, term, or user). Returning a non-null value
    187187     * will effectively short-circuit the function.
    188188     *
     
    236236         *
    237237         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    238          * object type (comment, post, or user).
     238         * object type (comment, post, term, or user).
    239239         *
    240240         * @since 2.9.0
     
    274274         *
    275275         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    276          * object type (comment, post, or user).
     276         * object type (comment, post, term, or user).
    277277         *
    278278         * @since 2.9.0
     
    310310 * @global wpdb $wpdb WordPress database abstraction object.
    311311 *
    312  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     312 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    313313 * @param int    $object_id  ID of the object metadata is for
    314314 * @param string $meta_key   Metadata key
     
    350350     *
    351351     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    352      * object type (comment, post, or user). Returning a non-null value
     352     * object type (comment, post, term, or user). Returning a non-null value
    353353     * will effectively short-circuit the function.
    354354     *
     
    398398     *
    399399     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    400      * object type (comment, post, or user).
     400     * object type (comment, post, term, or user).
    401401     *
    402402     * @since 3.1.0
     
    441441     *
    442442     * The dynamic portion of the hook name, `$meta_type`, refers to the meta
    443      * object type (comment, post, or user).
     443     * object type (comment, post, term, or user).
    444444     *
    445445     * @since 2.9.0
     
    472472 * @since 2.9.0
    473473 *
    474  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
     474 * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
    475475 * @param int    $object_id ID of the object metadata is for
    476476 * @param string $meta_key  Optional. Metadata key. If not specified, retrieve all metadata for
     
    495495     *
    496496     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    497      * object type (comment, post, or user). Returning a non-null value
     497     * object type (comment, post, term, or user). Returning a non-null value
    498498     * will effectively short-circuit the function.
    499499     *
     
    546546 * @since 3.3.0
    547547 *
    548  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
     548 * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
    549549 * @param int    $object_id ID of the object metadata is for
    550550 * @param string $meta_key  Metadata key.
     
    631631 * @global wpdb $wpdb WordPress database abstraction object.
    632632 *
    633  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     633 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    634634 * @param int    $meta_id    ID for a specific meta row
    635635 * @param string $meta_value Metadata value
     
    814814 * @global wpdb $wpdb WordPress database abstraction object.
    815815 *
    816  * @param string    $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     816 * @param string    $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    817817 * @param int|array $object_ids Array or comma delimited list of object IDs to update cache for
    818818 * @return array|false Metadata cache for the specified objects, or false on failure.
     
    932932 * @global wpdb $wpdb WordPress database abstraction object.
    933933 *
    934  * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
     934 * @param string $type Type of object to get metadata table for (e.g., comment, post, term, or user).
    935935 * @return string|false Metadata table name, or false if no metadata table exists
    936936 */
     
    953953 *
    954954 * @param string      $meta_key  Meta key.
    955  * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, or user).
     955 * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, term, or user).
    956956 * @return bool Whether the meta key is considered protected.
    957957 */
     
    966966     * @param bool        $protected Whether the key is considered protected.
    967967     * @param string      $meta_key  Meta key.
    968      * @param string|null $meta_type Type of object metadata is for (e.g., comment, post, or user).
     968     * @param string|null $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
    969969     */
    970970    return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
     
    991991         *
    992992         * The dynamic portions of the hook name, `$object_type`, `$meta_key`,
    993          * and `$object_subtype`, refer to the metadata object type (comment, post, term or user),
     993         * and `$object_subtype`, refer to the metadata object type (comment, post, term, or user),
    994994         * the meta key value, and the object subtype respectively.
    995995         *
     
    10081008     *
    10091009     * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
    1010      * refer to the metadata object type (comment, post, or user) and the meta
     1010     * refer to the metadata object type (comment, post, term, or user) and the meta
    10111011     * key value, respectively.
    10121012     *
Note: See TracChangeset for help on using the changeset viewer.