WordPress.org

Make WordPress Core

Changeset 43557


Ignore:
Timestamp:
08/08/2018 04:27:34 PM (2 years 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.
Fixes #44751.

Location:
branches/4.9/src/wp-includes
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • branches/4.9/src/wp-includes/class-wp-term-query.php

    r43492 r43557  
    173173     *     @type string       $meta_value             Limit terms to those matching a specific metadata value.
    174174     *                                                Usually used in conjunction with `$meta_key`. Default empty.
    175      *     @type string       $meta_type              Type of object metadata is for (e.g., comment, post, or user).
     175     *     @type string       $meta_type              Type of object metadata is for (e.g., comment, post, term, or user).
    176176     *                                                Default empty.
    177177     *     @type string       $meta_compare           Comparison operator to test the 'meta_value'. Default empty.
  • branches/4.9/src/wp-includes/meta.php

    r43510 r43557  
    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     *
     
    8686     *
    8787     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    88      * object type (comment, post, or user).
     88     * object type (comment, post, term, or user).
    8989     *
    9090     * @since 3.1.0
     
    113113     *
    114114     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    115      * object type (comment, post, or user).
     115     * object type (comment, post, term, or user).
    116116     *
    117117     * @since 2.9.0
     
    135135 * @global wpdb $wpdb WordPress database abstraction object.
    136136 *
    137  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     137 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    138138 * @param int    $object_id  ID of the object metadata is for
    139139 * @param string $meta_key   Metadata key
     
    176176     *
    177177     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    178      * object type (comment, post, or user). Returning a non-null value
     178     * object type (comment, post, term, or user). Returning a non-null value
    179179     * will effectively short-circuit the function.
    180180     *
     
    223223         *
    224224         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    225          * object type (comment, post, or user).
     225         * object type (comment, post, term, or user).
    226226         *
    227227         * @since 2.9.0
     
    260260         *
    261261         * The dynamic portion of the hook, `$meta_type`, refers to the meta
    262          * object type (comment, post, or user).
     262         * object type (comment, post, term, or user).
    263263         *
    264264         * @since 2.9.0
     
    296296 * @global wpdb $wpdb WordPress database abstraction object.
    297297 *
    298  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     298 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    299299 * @param int    $object_id  ID of the object metadata is for
    300300 * @param string $meta_key   Metadata key
     
    336336     *
    337337     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    338      * object type (comment, post, or user). Returning a non-null value
     338     * object type (comment, post, term, or user). Returning a non-null value
    339339     * will effectively short-circuit the function.
    340340     *
     
    380380     *
    381381     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    382      * object type (comment, post, or user).
     382     * object type (comment, post, term, or user).
    383383     *
    384384     * @since 3.1.0
     
    422422     *
    423423     * The dynamic portion of the hook name, `$meta_type`, refers to the meta
    424      * object type (comment, post, or user).
     424     * object type (comment, post, term, or user).
    425425     *
    426426     * @since 2.9.0
     
    453453 * @since 2.9.0
    454454 *
    455  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
     455 * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
    456456 * @param int    $object_id ID of the object metadata is for
    457457 * @param string $meta_key  Optional. Metadata key. If not specified, retrieve all metadata for
     
    476476     *
    477477     * The dynamic portion of the hook, `$meta_type`, refers to the meta
    478      * object type (comment, post, or user). Returning a non-null value
     478     * object type (comment, post, term, or user). Returning a non-null value
    479479     * will effectively short-circuit the function.
    480480     *
     
    524524 * @since 3.3.0
    525525 *
    526  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
     526 * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
    527527 * @param int    $object_id ID of the object metadata is for
    528528 * @param string $meta_key  Metadata key.
     
    605605 * @global wpdb $wpdb WordPress database abstraction object.
    606606 *
    607  * @param string $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     607 * @param string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    608608 * @param int    $meta_id    ID for a specific meta row
    609609 * @param string $meta_value Metadata value
     
    787787 * @global wpdb $wpdb WordPress database abstraction object.
    788788 *
    789  * @param string    $meta_type  Type of object metadata is for (e.g., comment, post, or user)
     789 * @param string    $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
    790790 * @param int|array $object_ids Array or comma delimited list of object IDs to update cache for
    791791 * @return array|false Metadata cache for the specified objects, or false on failure.
     
    900900 * @global wpdb $wpdb WordPress database abstraction object.
    901901 *
    902  * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
     902 * @param string $type Type of object to get metadata table for (e.g., comment, post, term, or user).
    903903 * @return string|false Metadata table name, or false if no metadata table exists
    904904 */
     
    919919 * @since 3.1.3
    920920 *
    921  * @param string      $meta_key Meta key
    922  * @param string|null $meta_type
     921 * @param string      $meta_key  Meta key
     922 * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post,
     923 *                               term, or user).
    923924 * @return bool True if the key is protected, false otherwise.
    924925 */
     
    933934     * @param bool   $protected Whether the key is protected. Default false.
    934935     * @param string $meta_key  Meta key.
    935      * @param string $meta_type Meta type.
     936     * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
    936937     */
    937938    return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
     
    974975     *
    975976     * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
    976      * refer to the metadata object type (comment, post, or user) and the meta
     977     * refer to the metadata object type (comment, post, term, or user) and the meta
    977978     * key value, respectively.
    978979     *
Note: See TracChangeset for help on using the changeset viewer.