Docs: Improve documentation for various option functions.

Props andfinally, david.binda, SergeyBiryukov.
Fixes #49566.

git-svn-id: https://develop.svn.wordpress.org/trunk@48320 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-07-05 14:44:37 +00:00
parent 0df921c96d
commit fcafa02a04
2 changed files with 37 additions and 35 deletions

View File

@@ -398,7 +398,7 @@ function get_blog_option( $id, $option, $default = false ) {
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to add. Expected to not be SQL-escaped.
* @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
* @return bool False if option was not added and true if option was added.
* @return bool True if the option was added, false otherwise.
*/
function add_blog_option( $id, $option, $value ) {
$id = (int) $id;
@@ -425,7 +425,7 @@ function add_blog_option( $id, $option, $value ) {
*
* @param int $id A blog ID. Can be null to refer to the current blog.
* @param string $option Name of option to remove. Expected to not be SQL-escaped.
* @return bool True, if option is successfully deleted. False on failure.
* @return bool True if the option was deleted, false otherwise.
*/
function delete_blog_option( $id, $option ) {
$id = (int) $id;
@@ -454,7 +454,7 @@ function delete_blog_option( $id, $option ) {
* @param string $option The option key.
* @param mixed $value The option value.
* @param mixed $deprecated Not used.
* @return bool True on success, false on failure.
* @return bool True if the value was updated, false otherwise.
*/
function update_blog_option( $id, $option, $value, $deprecated = null ) {
$id = (int) $id;