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

See #51800.

git-svn-id: https://develop.svn.wordpress.org/trunk@49935 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2021-01-05 16:46:02 +00:00
parent 019a261d3f
commit 5c82078df7
6 changed files with 8 additions and 6 deletions

View File

@ -128,7 +128,7 @@ function get_real_file_to_edit( $file ) {
* @param int $parent Optional. Parent ID to retrieve categories for. Default 0.
* @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 ) {
_deprecated_function( __FUNCTION__, '3.0.0', 'wp_dropdown_categories()' );

View File

@ -513,7 +513,8 @@ class WP_Customize_Setting {
*
* @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() {
$value = $this->post_value();

View File

@ -837,7 +837,7 @@ function wp_extract_urls( $content ) {
*
* @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 ) {
global $wpdb;

View File

@ -3531,7 +3531,8 @@ function get_object_term_cache( $id, $taxonomy ) {
*
* @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 ) {
if ( empty( $object_ids ) ) {

View File

@ -2492,7 +2492,7 @@ function get_theme_starter_content() {
* 'disable-custom-font-sizes', 'editor-color-palette', 'editor-font-sizes',
* '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 ) {
global $_wp_theme_features;

View File

@ -1537,7 +1537,7 @@ function sanitize_user_field( $field, $value, $user_id, $context ) {
* @since 3.0.0
*
* @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 ) {
if ( $user instanceof WP_User ) {