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

Timestamp:

02/27/2020 08:07:31 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add a reference to WP_Customize_Setting::__construct() for information on accepted arguments in WP_Customize_Manager::add_setting().

Synchronize the documentation between two places, use WP_Customize_Setting::__construct() as the canonical source.

Props tmanoilov, marekdedic.
Fixes #48347.

File:

• trunk/src/wp-includes/class-wp-customize-setting.php (modified) (1 diff)

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

@@ -157 +157 @@
      * @param string               $id      A specific ID of the setting.
      *                                      Can be a theme mod or option name.
-     * @param array                $args    Setting arguments.
+     * @param array                $args    {
+     *  Optional. Array of properties for the new Setting object. Default empty array.
+     *
+     *  @type string       $type                  Type of the setting. Default 'theme_mod'.
+     *  @type string       $capability            Capability required for the setting. Default 'edit_theme_options'
+     *  @type string|array $theme_supports        Theme features required to support the panel. Default is none.
+     *  @type string       $default               Default value for the setting. Default is empty string.
+     *  @type string       $transport             Options for rendering the live preview of changes in Customizer.
+     *                                            Using 'refresh' makes the change visible by reloading the whole preview.
+     *                                            Using 'postMessage' allows a custom JavaScript to handle live changes.
+     *                                            Default is 'refresh'.
+     *  @type callable     $validate_callback     Server-side validation callback for the setting's value.
+     *  @type callable     $sanitize_callback     Callback to filter a Customize setting value in un-slashed form.
+     *  @type callable     $sanitize_js_callback  Callback to convert a Customize PHP setting value to a value that is
+     *                                            JSON serializable.
+     *  @type bool         $dirty                 Whether or not the setting is initially dirty when created.
+     * }
      */
     public function __construct( $manager, $id, $args = array() ) {