Changeset 30656 for trunk/src/wp-includes/class-wp-customize-setting.php

Timestamp:

11/30/2014 12:09:56 PM (11 years ago)

Author:

DrewAPicture

Message:

Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*.

Affects DocBlocks for the following hooks:

• auth_post_meta_{$meta_key}
• term_links-$taxonomy
• customize_render_control_ . $this->id
• customize_render_panel_{$this->id}
• customize_render_section_{$this->id}
• customize_preview_{$this->id}
• customize_save_ . $this->id_data[ 'base' ]
• customize_update_ . $this->type
• customize_value_ . $this->id_data[ 'base' ]
• customize_sanitize_js_{$this->id}
• comment_form_field_{$name}
• comment_{$old_status}_to_{$new_status}
• comment_{$new_status}_{$comment->comment_type}
• extra_{$context}_headers
• get_template_part_{$slug}
• get_the_generator_{$type}
• get_{$adjacent}_post_join
• get_{$adjacent}_post_where
• get_{$adjacent}_post_sort
• {$adjacent}_post_rel_link
• {$adjacent}_post_link
• {$adjacent}_image_link
• blog_option_{$option}
• $permastructname . _rewrite_rules
• {$type}_template
• theme_mod_{$name}
• pre_set_theme_mod_$name
• current_theme_supports-{$feature}
• get_user_option_{$option}
• edit_user_{$field}
• pre_user_{$field}
• user_{$field}

See #30552.

File:

• trunk/src/wp-includes/class-wp-customize-setting.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -128 +128 @@
                  * not handled as theme_mods or options.
                  *
-                 * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+                 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
                  *
                  * @since 3.4.0
                  *
-                 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+                 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
                  */
                 do_action( "customize_preview_{$this->id}", $this );
@@ -180 +180 @@
          * Fires when the WP_Customize_Setting::save() method is called.
          *
-         * The dynamic portion of the hook name, $this->id_data['base'] refers to
+         * The dynamic portion of the hook name, `$this->id_data['base']` refers to
          * the base slug of the setting name.
          *
          * @since 3.4.0
          *
-         * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+         * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
          */
         do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
@@ -255 +255 @@
 
                 /**
-                 * Fires when the WP_Customize_Setting::update() method is called for settings
+                 * Fires when the {@see WP_Customize_Setting::update()} method is called for settings
                  * not handled as theme_mods or options.
                  *
-                 * The dynamic portion of the hook name, $this->type, refers to the type of setting.
+                 * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
                  *
                  * @since 3.4.0
@@ -330 +330 @@
                  * Filter a Customize setting value not handled as a theme_mod or option.
                  *
-                 * The dynamic portion of the hook name, $this->id_date['base'], refers to
+                 * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
                  * the base slug of the setting name.
                  *
@@ -364 +364 @@
          * Filter a Customize setting value for use in JavaScript.
          *
-         * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+         * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
          *
          * @since 3.4.0
          *
          * @param mixed                $value The setting value.
-         * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+         * @param WP_Customize_Setting $this  {@see WP_Customize_Setting} instance.
          */
         $value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );