[wp-trac] [WordPress Trac] #49566: Change comment on `update_blog_option` to properly describe the return value
WordPress Trac
noreply at wordpress.org
Tue Mar 3 08:54:25 UTC 2020
#49566: Change comment on `update_blog_option` to properly describe the return
value
--------------------------------+------------------------------
Reporter: andfinally | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone: Awaiting Review
Component: Options, Meta APIs | Version: trunk
Severity: normal | Resolution:
Keywords: has-patch | Focuses: docs
--------------------------------+------------------------------
Comment (by david.binda):
The `update_option` function, which return value is used directly as
output from the `update_blog_option` function, uses
[[https://core.trac.wordpress.org/browser/trunk/src/wp-
includes/option.php?rev=47373#L302|following]]:
{{{#!php
@return bool False if value was not updated and true if value was updated.
}}}
Perhaps we could make those the same, since the `update_blog_option` is
kind of a wrapper around the `update_option`?
If even that does not make it clear enough, we, IMHO, should update it in
both places.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/49566#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list