Changeset 46394

Timestamp:

10/05/2019 12:39:04 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for get_theme_mod() and set_theme_mod().

See #47110.

File:

• trunk/src/wp-includes/theme.php (modified) (3 diffs)

trunk/src/wp-includes/theme.php

@@ -906 +906 @@
  *
  * If the modification name does not exist, then the $default will be passed
- * through {@link https://secure.php.net/sprintf sprintf()} PHP function with the first
- * string the template directory URI and the second string the stylesheet
- * directory URI.
+ * through {@link https://secure.php.net/sprintf sprintf()} PHP function with
+ * the template directory URI as the first string and the stylesheet directory URI
+ * as the second string.
  *
  * @since 2.1.0
  *
- * @param string      $name    Theme modification name.
- * @param bool|string $default
- * @return mixed
+ * @param string       $name    Theme modification name.
+ * @param string|false $default Optional. Theme modification default value. Default false.
+ * @return mixed Theme modification value.
  */
 function get_theme_mod( $name, $default = false ) {
@@ -923 +923 @@
          * Filters the theme modification, or 'theme_mod', value.
          *
-         * The dynamic portion of the hook name, `$name`, refers to
-         * the key name of the modification array. For example,
-         * 'header_textcolor', 'header_image', and so on depending
-         * on the theme options.
+         * The dynamic portion of the hook name, `$name`, refers to the key name
+         * of the modification array. For example, 'header_textcolor', 'header_image',
+         * and so on depending on the theme options.
          *
          * @since 2.2.0
@@ -956 +955 @@
 
     /**
-     * Filters the theme mod value on save.
-     *
-     * The dynamic portion of the hook name, `$name`, refers to the key name of
-     * the modification array. For example, 'header_textcolor', 'header_image',
+     * Filters the theme modification, or 'theme_mod', value on save.
+     *
+     * The dynamic portion of the hook name, `$name`, refers to the key name
+     * of the modification array. For example, 'header_textcolor', 'header_image',
      * and so on depending on the theme options.
      *
      * @since 3.9.0
      *
-     * @param string $value     The new value of the theme mod.
-     * @param string $old_value The current value of the theme mod.
+     * @param string $value     The new value of the theme modification.
+     * @param string $old_value The current value of the theme modification.
      */
     $mods[ $name ] = apply_filters( "pre_set_theme_mod_{$name}", $value, $old_value );