Changeset 47347 for trunk/src/wp-includes/option.php

Timestamp:

02/23/2020 01:05:28 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Use third-person singular verbs for function descriptions in wp-includes/option.php, per the documentation standards.

See #48303.

File:

• trunk/src/wp-includes/option.php (modified) (25 diffs)

trunk/src/wp-includes/option.php

@@ -154 +154 @@
 
 /**
- * Protect WordPress special option from being modified.
+ * Protects WordPress special option from being modified.
  *
  * Will die if $option is in protected list. Protected options are 'alloptions'
@@ -176 +176 @@
 
 /**
- * Print option value after sanitizing for forms.
+ * Prints option value after sanitizing for forms.
  *
  * @since 1.5.0
@@ -278 +278 @@
 
 /**
- * Update the value of an option that was already added.
- *
- * You do not need to serialize values. If the value needs to be serialized, then
- * it will be serialized before it is inserted into the database. Remember,
- * resources can not be serialized or added as an option.
+ * Updates the value of an option that was already added.
+ *
+ * You do not need to serialize values. If the value needs to be serialized,
+ * then it will be serialized before it is inserted into the database.
+ * Remember, resources cannot be serialized or added as an option.
  *
  * If the option does not exist, then the option will be added with the option value,
@@ -438 +438 @@
 
 /**
- * Add a new option.
- *
- * You do not need to serialize values. If the value needs to be serialized, then
- * it will be serialized before it is inserted into the database. Remember,
- * resources can not be serialized or added as an option.
+ * Adds a new option.
+ *
+ * You do not need to serialize values. If the value needs to be serialized,
+ * then it will be serialized before it is inserted into the database.
+ * Remember, resources cannot be serialized or added as an option.
  *
  * You can create options without values and then update the values later.
@@ -624 +624 @@
 
 /**
- * Delete a transient.
+ * Deletes a transient.
  *
  * @since 2.8.0
@@ -671 +671 @@
 
 /**
- * Get the value of a transient.
+ * Retrieves the value of a transient.
  *
  * If the transient does not exist, does not have a value, or has expired,
@@ -742 +742 @@
 
 /**
- * Set/update the value of a transient.
- *
- * You do not need to serialize values. If the value needs to be serialized, then
- * it will be serialized before it is set.
+ * Sets/updates the value of a transient.
+ *
+ * You do not need to serialize values. If the value needs to be serialized,
+ * then it will be serialized before it is set.
  *
  * @since 2.8.0
@@ -966 +966 @@
 
 /**
- * Retrieve user interface setting value based on setting name.
+ * Retrieves user interface setting value based on setting name.
  *
  * @since 2.7.0
@@ -981 +981 @@
 
 /**
- * Add or update user interface setting.
+ * Adds or updates user interface setting.
  *
  * Both $name and $value can contain only ASCII letters, numbers, hyphens, and underscores.
@@ -1005 +1005 @@
 
 /**
- * Delete user interface settings.
+ * Deletes user interface settings.
  *
  * Deleting settings would reset them to the defaults.
@@ -1040 +1040 @@
 
 /**
- * Retrieve all user interface settings.
+ * Retrieves all user interface settings.
  *
  * @since 2.7.0
@@ -1081 +1081 @@
 
 /**
- * Private. Set all user interface settings.
+ * Private. Sets all user interface settings.
  *
  * @since 2.8.0
@@ -1124 +1124 @@
 
 /**
- * Delete the user settings of the current user.
+ * Deletes the user settings of the current user.
  *
  * @since 2.7.0
@@ -1157 +1157 @@
 
 /**
- * Add a new option for the current network.
+ * Adds a new option for the current network.
  *
  * Existing options will not be updated. Note that prior to 3.3 this wasn't the case.
@@ -1190 +1190 @@
 
 /**
- * Update the value of an option that was already added for the current network.
+ * Updates the value of an option that was already added for the current network.
  *
  * @since 2.8.0
@@ -1206 +1206 @@
 
 /**
- * Retrieve a network's option value based on the option name.
+ * Retrieves a network's option value based on the option name.
  *
  * @since 4.4.0
@@ -1337 +1337 @@
 
 /**
- * Add a new network option.
+ * Adds a new network option.
  *
  * Existing options will not be updated.
@@ -1555 +1555 @@
 
 /**
- * Update the value of a network option that was already added.
+ * Updates the value of a network option that was already added.
  *
  * @since 4.4.0
@@ -1686 +1686 @@
 
 /**
- * Delete a site transient.
+ * Deletes a site transient.
  *
  * @since 2.9.0
@@ -1732 +1732 @@
 
 /**
- * Get the value of a site transient.
+ * Retrieves the value of a site transient.
  *
  * If the transient does not exist, does not have a value, or has expired,
@@ -1804 +1804 @@
 
 /**
- * Set/update the value of a site transient.
- *
- * You do not need to serialize values, if the value needs to be serialize, then
- * it will be serialized before it is set.
+ * Sets/updates the value of a site transient.
+ *
+ * You do not need to serialize values. If the value needs to be serialized,
+ * then it will be serialized before it is set.
  *
  * @since 2.9.0
@@ -1897 +1897 @@
 
 /**
- * Register default settings available in WordPress.
+ * Registers default settings available in WordPress.
  *
  * The settings registered here are primarily useful for the REST API, so this
@@ -2090 +2090 @@
 
 /**
- * Register a setting and its data.
+ * Registers a setting and its data.
  *
  * @since 2.7.0
@@ -2193 +2193 @@
 
 /**
- * Unregister a setting.
+ * Unregisters a setting.
  *
  * @since 2.7.0
@@ -2287 +2287 @@
 
 /**
- * Filter the default value for the option.
+ * Filters the default value for the option.
  *
  * For settings which register a default setting in `register_setting()`, this