WordPress.org

Make WordPress Core

Changeset 45036


Ignore:
Timestamp:
03/27/2019 05:09:35 PM (10 months ago)
Author:
johnbillion
Message:

Docs: Improve the documentation for metadata related filter parameters.

See #46543

File:
1 edited

Legend:

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

    r43982 r45036  
    9696     * @since 3.1.0
    9797     *
    98      * @param int    $object_id  Object ID.
    99      * @param string $meta_key   Meta key.
    100      * @param mixed  $meta_value Meta value.
     98     * @param int    $object_id   Object ID.
     99     * @param string $meta_key    Meta key.
     100     * @param mixed  $_meta_value Meta value.
    101101     */
    102102    do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );
     
    127127     * @since 2.9.0
    128128     *
    129      * @param int    $mid        The meta ID after successful update.
    130      * @param int    $object_id  Object ID.
    131      * @param string $meta_key   Meta key.
    132      * @param mixed  $meta_value Meta value.
     129     * @param int    $mid         The meta ID after successful update.
     130     * @param int    $object_id   Object ID.
     131     * @param string $meta_key    Meta key.
     132     * @param mixed  $_meta_value Meta value.
    133133     */
    134134    do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value );
     
    243243         * @since 2.9.0
    244244         *
    245          * @param int    $meta_id    ID of the metadata entry to update.
    246          * @param int    $object_id  Object ID.
    247          * @param string $meta_key   Meta key.
    248          * @param mixed  $meta_value Meta value.
     245         * @param int    $meta_id     ID of the metadata entry to update.
     246         * @param int    $object_id   Object ID.
     247         * @param string $meta_key    Meta key.
     248         * @param mixed  $_meta_value Meta value.
    249249         */
    250250        do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
     
    257257             *
    258258             * @param int    $meta_id    ID of metadata entry to update.
    259              * @param int    $object_id  Object ID.
     259             * @param int    $object_id  Post ID.
    260260             * @param string $meta_key   Meta key.
    261              * @param mixed  $meta_value Meta value.
     261             * @param mixed  $meta_value Meta value. This will be a PHP-serialized string representation of the value if
     262             *                           the value is an array, an object, or itself a PHP-serialized string.
    262263             */
    263264            do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
     
    281282         * @since 2.9.0
    282283         *
    283          * @param int    $meta_id    ID of updated metadata entry.
    284          * @param int    $object_id  Object ID.
    285          * @param string $meta_key   Meta key.
    286          * @param mixed  $meta_value Meta value.
     284         * @param int    $meta_id     ID of updated metadata entry.
     285         * @param int    $object_id   Object ID.
     286         * @param string $meta_key    Meta key.
     287         * @param mixed  $_meta_value Meta value.
    287288         */
    288289        do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
     
    295296             *
    296297             * @param int    $meta_id    ID of updated metadata entry.
    297              * @param int    $object_id  Object ID.
     298             * @param int    $object_id  Post ID.
    298299             * @param string $meta_key   Meta key.
    299              * @param mixed  $meta_value Meta value.
     300             * @param mixed  $meta_value Meta value. This will be a PHP-serialized string representation of the value if
     301             *                           the value is an array, an object, or itself a PHP-serialized string.
    300302             */
    301303            do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
     
    405407     * @since 3.1.0
    406408     *
    407      * @param array  $meta_ids   An array of metadata entry IDs to delete.
    408      * @param int    $object_id  Object ID.
    409      * @param string $meta_key   Meta key.
    410      * @param mixed  $meta_value Meta value.
     409     * @param array  $meta_ids    An array of metadata entry IDs to delete.
     410     * @param int    $object_id   Object ID.
     411     * @param string $meta_key    Meta key.
     412     * @param mixed  $_meta_value Meta value.
    411413     */
    412414    do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
     
    448450     * @since 2.9.0
    449451     *
    450      * @param array  $meta_ids   An array of deleted metadata entry IDs.
    451      * @param int    $object_id  Object ID.
    452      * @param string $meta_key   Meta key.
    453      * @param mixed  $meta_value Meta value.
     452     * @param array  $meta_ids    An array of deleted metadata entry IDs.
     453     * @param int    $object_id   Object ID.
     454     * @param string $meta_key    Meta key.
     455     * @param mixed  $_meta_value Meta value.
    454456     */
    455457    do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
Note: See TracChangeset for help on using the changeset viewer.