Changeset 51340

Timestamp:

07/06/2021 12:43:21 PM (3 years ago)

Author:

desrosj

Message:

Docs: Correct @see references for hooks in the get_option() description.

Follow-up to [51050].

Props SergeyBiryukov.
Merges [51324] to the 5.8 branch.
See #52628, #53461.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/option.php (modified) (3 diffs)

branches/5.8/src/wp-includes/option.php

@@ -13 +13 @@
  * boolean false is returned. This could be used to check whether you need
  * to initialize an option during installation of a plugin, however that
- * can be done better by using {@see add_option} which will not overwrite
+ * can be done better by using add_option() which will not overwrite
  * existing options.
  *
- * Not initializing an option and using the boolean false as a return value
+ * Not initializing an option and using boolean `false` as a return value
  * is a bad practice as it triggers an additional database query.
  *
@@ -29 +29 @@
  *
  * Exceptions:
- * 1. When the option has not been saved in the database, the default value
- *    {@see get_option} 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}}, and {@see option_{$option}}, the returned
+ * 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
  *    value may not match the expected type.
- * 3. When the option has just been saved in the database, and {@see get_option}
+ * 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
  *    string equivalents and the original type is returned.
@@ -41 +41 @@
  *
  * When adding options like this: `add_option( 'my_option_name', 'value' );`
- * and then retrieving them with `get_option( 'my_option_name' )`, the returned
+ * and then retrieving them with `get_option( 'my_option_name' );`, the returned
  * values will be:
  *