Make WordPress Core


Ignore:
Timestamp:
09/21/2021 06:19:19 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Document some more common names for dynamic hooks and standardise the phrasing used.

Fixes #53581

File:
1 edited

Legend:

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

    r51326 r51837  
    5757     * Short-circuits adding metadata of a specific type.
    5858     *
    59      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     59     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    6060     * (post, comment, term, user, or any other type with an associated meta table).
    6161     * Returning a non-null value will effectively short-circuit the function.
     
    9797     * Fires immediately before meta of a specific type is added.
    9898     *
    99      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     99     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    100100     * (post, comment, term, user, or any other type with an associated meta table).
    101101     *
     
    135135     * Fires immediately after meta of a specific type is added.
    136136     *
    137      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     137     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    138138     * (post, comment, term, user, or any other type with an associated meta table).
    139139     *
     
    210210     * Short-circuits updating metadata of a specific type.
    211211     *
    212      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     212     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    213213     * (post, comment, term, user, or any other type with an associated meta table).
    214214     * Returning a non-null value will effectively short-circuit the function.
     
    269269         * Fires immediately before updating metadata of a specific type.
    270270         *
    271          * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     271         * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    272272         * (post, comment, term, user, or any other type with an associated meta table).
    273273         *
     
    315315         * Fires immediately after updating metadata of a specific type.
    316316         *
    317          * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     317         * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    318318         * (post, comment, term, user, or any other type with an associated meta table).
    319319         *
     
    402402     * Short-circuits deleting metadata of a specific type.
    403403     *
    404      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     404     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    405405     * (post, comment, term, user, or any other type with an associated meta table).
    406406     * Returning a non-null value will effectively short-circuit the function.
     
    457457     * Fires immediately before deleting metadata of a specific type.
    458458     *
    459      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     459     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    460460     * (post, comment, term, user, or any other type with an associated meta table).
    461461     *
     
    507507     * Fires immediately after deleting metadata of a specific type.
    508508     *
    509      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     509     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    510510     * (post, comment, term, user, or any other type with an associated meta table).
    511511     *
     
    609609     * Short-circuits the return value of a meta field.
    610610     *
    611      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     611     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    612612     * (post, comment, term, user, or any other type with an associated meta table).
    613613     * Returning a non-null value will effectively short-circuit the function.
     
    693693     * Filters the default metadata value for a specified meta key and object.
    694694     *
    695      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     695     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    696696     * (post, comment, term, user, or any other type with an associated meta table).
    697697     *
     
    806806     * Short-circuits the return value when fetching a meta field by meta ID.
    807807     *
    808      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     808     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    809809     * (post, comment, term, user, or any other type with an associated meta table).
    810810     * Returning a non-null value will effectively short-circuit the function.
     
    880880     * Short-circuits updating metadata of a specific type by meta ID.
    881881     *
    882      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     882     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    883883     * (post, comment, term, user, or any other type with an associated meta table).
    884884     * Returning a non-null value will effectively short-circuit the function.
     
    10031003     * Short-circuits deleting metadata of a specific type by meta ID.
    10041004     *
    1005      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     1005     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    10061006     * (post, comment, term, user, or any other type with an associated meta table).
    10071007     * Returning a non-null value will effectively short-circuit the function.
     
    10371037             * Fires immediately before deleting post or comment metadata of a specific type.
    10381038             *
    1039              * The dynamic portion of the hook, `$meta_type`, refers to the meta
     1039             * The dynamic portion of the hook name, `$meta_type`, refers to the meta
    10401040             * object type (post or comment).
    10411041             *
     
    10681068             * Fires immediately after deleting post or comment metadata of a specific type.
    10691069             *
    1070              * The dynamic portion of the hook, `$meta_type`, refers to the meta
     1070             * The dynamic portion of the hook name, `$meta_type`, refers to the meta
    10711071             * object type (post or comment).
    10721072             *
     
    11291129     * Short-circuits updating the metadata cache of a specific type.
    11301130     *
    1131      * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
     1131     * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
    11321132     * (post, comment, term, user, or any other type with an associated meta table).
    11331133     * Returning a non-null value will effectively short-circuit the function.
     
    17751775     * Filters the object subtype identifier for a non-standard object type.
    17761776     *
    1777      * The dynamic portion of the hook, `$object_type`, refers to the meta object type
     1777     * The dynamic portion of the hook name, `$object_type`, refers to the meta object type
    17781778     * (post, comment, term, user, or any other type with an associated meta table).
    17791779     *
Note: See TracChangeset for help on using the changeset viewer.