WordPress.org

Make WordPress Core

Changeset 49935


Ignore:
Timestamp:
01/05/2021 04:46:02 PM (10 months ago)
Author:
SergeyBiryukov
Message:

Docs: Use more consistent descriptions for void|false return values.

See #51800.

Location:
trunk/src
Files:
6 edited

Legend:

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

    r49929 r49935  
    129129 * @param int $level         Optional. Number of levels deep to display. Default 0.
    130130 * @param array $categories  Optional. Categories to include in the control. Default 0.
    131  * @return void|false False if no categories were found.
     131 * @return void|false Void on success, false if no categories were found.
    132132 */
    133133function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) {
  • trunk/src/wp-includes/class-wp-customize-setting.php

    r48590 r49935  
    514514     * @since 3.4.0
    515515     *
    516      * @return void|false False if cap check fails or value isn't set or is invalid.
     516     * @return void|false Void on success, false if cap check fails
     517     *                    or value isn't set or is invalid.
    517518     */
    518519    final public function save() {
  • trunk/src/wp-includes/functions.php

    r49929 r49935  
    838838 * @param string|null $content Post content. If `null`, the `post_content` field from `$post` is used.
    839839 * @param int|WP_Post $post    Post ID or post object.
    840  * @return void|false Returns false if post is not found.
     840 * @return void|false Void on success, false if the post is not found.
    841841 */
    842842function do_enclose( $content, $post ) {
  • trunk/src/wp-includes/taxonomy.php

    r49929 r49935  
    35323532 * @param string|int[]    $object_ids  Comma-separated list or array of term object IDs.
    35333533 * @param string|string[] $object_type The taxonomy object type or array of the same.
    3534  * @return void|false False if all of the terms in `$object_ids` are already cached.
     3534 * @return void|false Void on success or if the `$object_ids` parameter is empty,
     3535 *                    false if all of the terms in `$object_ids` are already cached.
    35353536 */
    35363537function update_object_term_cache( $object_ids, $object_type ) {
  • trunk/src/wp-includes/theme.php

    r49927 r49935  
    24932493 *                        'editor-styles', 'wp-block-styles', and 'core-block-patterns'.
    24942494 * @param mixed  ...$args Optional extra arguments to pass along with certain features.
    2495  * @return void|false False on failure, void otherwise.
     2495 * @return void|false Void on success, false on failure.
    24962496 */
    24972497function add_theme_support( $feature, ...$args ) {
  • trunk/src/wp-includes/user.php

    r49929 r49935  
    15381538 *
    15391539 * @param object|WP_User $user User object or database row to be cached
    1540  * @return void|false Returns false on failure.
     1540 * @return void|false Void on success, false on failure.
    15411541 */
    15421542function update_user_caches( $user ) {
Note: See TracChangeset for help on using the changeset viewer.