Make WordPress Core


Ignore:
Timestamp:
04/02/2021 03:47:34 PM (3 years ago)
Author:
davidbaumwald
Message:

Docs: Clarify return results for a non-existing ID in metadata functions.

[48658] documented that various metadata functions return false for an invalid ID. However, that does not clarify what an invalid ID is: a non-numeric, zero, or negative value. This change adds the clarification in all relevant metadata function docblocks.

Props icopydoc, SergeyBiryukov, davidkryzaniak, audrasjb.
Fixes #51797.

File:
1 edited

Legend:

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

    r50565 r50641  
    13251325 *                        returns data for all keys. Default empty.
    13261326 * @param bool   $single  Optional. Whether to return a single value.
    1327  *                        This parameter has no effect if $key is not specified.
     1327 *                        This parameter has no effect if `$key` is not specified.
    13281328 *                        Default false.
    1329  * @return mixed An array if $single is false. The value of the meta field
    1330  *               if $single is true. False for an invalid $term_id.
     1329 * @return mixed An array of values if `$single` is false.
     1330 *               The value of the meta field if `$single` is true.
     1331 *               False for an invalid `$term_id` (non-numeric, zero, or negative value).
     1332 *               An empty string if a valid but non-existing term ID is passed.
    13311333 */
    13321334function get_term_meta( $term_id, $key = '', $single = false ) {
Note: See TracChangeset for help on using the changeset viewer.