Changeset 49935

Timestamp:

01/05/2021 04:46:02 PM (5 years ago)

Author:

SergeyBiryukov

Message:

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

See #51800.

Location:

trunk/src

Files:

• wp-admin/includes/deprecated.php (modified) (1 diff)
• wp-includes/class-wp-customize-setting.php (modified) (1 diff)
• wp-includes/functions.php (modified) (1 diff)
• wp-includes/taxonomy.php (modified) (1 diff)
• wp-includes/theme.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/deprecated.php

@@ -129 +129 @@
  * @param int $level         Optional. Number of levels deep to display. Default 0.
  * @param array $categories  Optional. Categories to include in the control. Default 0.
- * @return void|false False if no categories were found.
+ * @return void|false Void on success, false if no categories were found.
  */
 function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) {

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -514 +514 @@
      * @since 3.4.0
      *
-     * @return void|false False if cap check fails or value isn't set or is invalid.
+     * @return void|false Void on success, false if cap check fails
+     *                    or value isn't set or is invalid.
      */
     final public function save() {

trunk/src/wp-includes/functions.php

@@ -838 +838 @@
  * @param string|null $content Post content. If `null`, the `post_content` field from `$post` is used.
  * @param int|WP_Post $post    Post ID or post object.
- * @return void|false Returns false if post is not found.
+ * @return void|false Void on success, false if the post is not found.
  */
 function do_enclose( $content, $post ) {

trunk/src/wp-includes/taxonomy.php

@@ -3532 +3532 @@
  * @param string|int[]    $object_ids  Comma-separated list or array of term object IDs.
  * @param string|string[] $object_type The taxonomy object type or array of the same.
- * @return void|false False if all of the terms in `$object_ids` are already cached.
+ * @return void|false Void on success or if the `$object_ids` parameter is empty,
+ *                    false if all of the terms in `$object_ids` are already cached.
  */
 function update_object_term_cache( $object_ids, $object_type ) {

trunk/src/wp-includes/theme.php

@@ -2493 +2493 @@
  *                        'editor-styles', 'wp-block-styles', and 'core-block-patterns'.
  * @param mixed  ...$args Optional extra arguments to pass along with certain features.
- * @return void|false False on failure, void otherwise.
+ * @return void|false Void on success, false on failure.
  */
 function add_theme_support( $feature, ...$args ) {

trunk/src/wp-includes/user.php

@@ -1538 +1538 @@
  *
  * @param object|WP_User $user User object or database row to be cached
- * @return void|false Returns false on failure.
+ * @return void|false Void on success, false on failure.
  */
 function update_user_caches( $user ) {