WordPress.org
Get WordPress

Make WordPress Core

Ticket #44751: 44751.diff

File 44751.diff, 9.1 KB (added by macbookandrew, 8 years ago)

docblock updates

  • src/wp-includes/class-wp-term-query.php

     
    172172         *                                                Can be used in conjunction with `$meta_value`. Default empty.
    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.
    178178         * }

  • src/wp-includes/meta.php

     
    1717 *
    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
    2323 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
    … …  
    5757         * Filters whether to add metadata of a specific type.
    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         *
    6363         * @since 3.1.0
    … …  
    9090         * Fires immediately before meta of a specific type is added.
    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
    9696         *
    … …  
    120120         * Fires immediately after meta of a specific type is added.
    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
    126126         *
    … …  
    142142 *
    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
    148148 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
    … …  
    183183         * Filters whether to update metadata of a specific type.
    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         *
    189189         * @since 3.1.0
    … …  
    235235                 * Fires immediately before updating metadata of a specific type.
    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
    241241                 *
    … …  
    273273                 * Fires immediately after updating metadata of a specific type.
    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
    279279                 *
    … …  
    309309 *
    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
    315315 * @param mixed  $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete
    … …  
    349349         * Filters whether to delete metadata of a specific type.
    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         *
    355355         * @since 3.1.0
    … …  
    397397         * Fires immediately before deleting metadata of a specific type.
    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
    403403         *
    … …  
    440440         * Fires immediately after deleting metadata of a specific type.
    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
    446446         *
    … …  
    471471 *
    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
    477477 *                          the specified object.
    … …  
    494494         * Filters whether to retrieve metadata of a specific type.
    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         *
    500500         * @since 3.1.0
    … …  
    545545 *
    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.
    551551 * @return bool True of the key is set, false if not.
    … …  
    630630 *
    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
    636636 * @param string $meta_key   Optional, you can provide a meta key to update it
    … …  
    813813 *
    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.
    819819 */
    … …  
    931931 *
    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 */
    937937function _get_meta_table( $type ) {
    … …  
    952952 * @since 3.1.3
    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 */
    958958function is_protected_meta( $meta_key, $meta_type = null ) {
    … …  
    965965         *
    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 );
    971971}
    … …  
    10071007         * Filters the sanitization of a specific meta key of a specific meta type.
    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         *
    10131013         * @since 3.3.0