WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/28/2020 11:47:45 AM (17 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for optional parameters per the documentation standards.

See #49572.

File:
1 edited

Legend:

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

    r48187 r48197  
    812812 * @param string     $output   Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
    813813 *                             a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
    814  * @param string     $filter   Optional, default is raw or no WordPress defined filter will applied.
     814 * @param string     $filter   Optional. How to sanitize term fields. Default 'raw'.
    815815 * @return WP_Term|array|WP_Error|null Object of the type specified by `$output` on success. When `$output` is 'OBJECT',
    816816 *                                     a WP_Term instance is returned. If taxonomy does not exist, a WP_Error is
     
    923923 * @param string     $output   Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
    924924 *                             a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
    925  * @param string     $filter   Optional, default is raw or no WordPress defined filter will applied.
     925 * @param string     $filter   Optional. How to sanitize term fields. Default 'raw'.
    926926 * @return WP_Term|array|false WP_Term instance (or array) on success. Will return false if `$taxonomy` does not exist
    927927 *                             or `$term` was not found.
     
    10451045 * @param int|WP_Term $term     Term ID or object.
    10461046 * @param string      $taxonomy Optional. Taxonomy Name. Default empty.
    1047  * @param string      $context  Optional, default is display. Look at sanitize_term_field() for available options.
     1047 * @param string      $context  Optional. How to sanitize term fields. Look at sanitize_term_field() for available options.
     1048 *                              Default 'display'.
    10481049 * @return string|int|null|WP_Error Will return an empty string if $term is not an object or if $field is not set in $term.
    10491050 */
Note: See TracChangeset for help on using the changeset viewer.