vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-07-01 07:40:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Formatting corrections for various docblocks.

Browse Source 
See #54729


git-svn-id: https://develop.svn.wordpress.org/trunk@53317 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2022-04-29 19:22:56 +00:00
parent 08fb48315a
commit 09cdb9a9bf
6 changed files with 35 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
src/wp-includes/option.php
View File

@@ -28,10 +28,11 @@
* as string equivalents.
*
* Exceptions:
*
* 1. When the option has not been saved in the database, the `$default` value
* is returned if provided. If not, boolean `false` is returned.
* 2. When one of the Options API filters is used: {@see 'pre_option_{$option}'},
* {@see 'default_option_{$option}'}, or {@see 'option_{$option}'}, the returned
* 2. When one of the Options API filters is used: {@see 'pre_option_$option'},
* {@see 'default_option_$option'}, or {@see 'option_$option'}, the returned
* value may not match the expected type.
* 3. When the option has just been saved in the database, and get_option()
* is used right after, non-string scalar and null values are not converted to
@@ -39,28 +40,28 @@
*
* Examples:
*
* When adding options like this: `add_option( 'my_option_name', 'value' );`
* and then retrieving them with `get_option( 'my_option_name' );`, the returned
* When adding options like this: `add_option( 'my_option_name', 'value' )`
* and then retrieving them with `get_option( 'my_option_name' )`, the returned
* values will be:
*
* `false` returns `string(0) ""`
* `true` returns `string(1) "1"`
* `0` returns `string(1) "0"`
* `1` returns `string(1) "1"`
* `'0'` returns `string(1) "0"`
* `'1'` returns `string(1) "1"`
* `null` returns `string(0) ""`
* - `false` returns `string(0) ""`
* - `true` returns `string(1) "1"`
* - `0` returns `string(1) "0"`
* - `1` returns `string(1) "1"`
* - `'0'` returns `string(1) "0"`
* - `'1'` returns `string(1) "1"`
* - `null` returns `string(0) ""`
*
* When adding options with non-scalar values like
* `add_option( 'my_array', array( false, 'str', null ) );`, the returned value
* `add_option( 'my_array', array( false, 'str', null ) )`, the returned value
* will be identical to the original as it is serialized before saving
* it in the database:
*
* array(3) {
* [0] => bool(false)
* [1] => string(3) "str"
* [2] => NULL
* }
* array(3) {
* [0] => bool(false)
* [1] => string(3) "str"
* [2] => NULL
* }
*
* @since 1.5.0
*