<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[47384] trunk/src/wp-includes: Docs: Add a reference to `WP_Customize_Setting::__construct()` for information on accepted arguments in `WP_Customize_Manager::add_setting()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/47384">47384</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/47384","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-02-27 20:07:31 +0000 (Thu, 27 Feb 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/48347">#48347</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizecontrolphp">trunk/src/wp-includes/class-wp-customize-control.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizesettingphp">trunk/src/wp-includes/class-wp-customize-setting.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcustomizecontrolphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-control.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-control.php 2020-02-26 15:31:19 UTC (rev 47383)
+++ trunk/src/wp-includes/class-wp-customize-control.php 2020-02-27 20:07:31 UTC (rev 47384)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,7 +174,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Manager $manager Customizer bootstrap instance.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id Control ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Optional. Arguments to override class property defaults.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Optional. Array of properties for the new Control object. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $instance_number Order in which this instance was created in relation
</span><span class="cx" style="display: block; padding: 0 10px"> * to other instances.
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizemanagerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-manager.php 2020-02-26 15:31:19 UTC (rev 47383)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2020-02-27 20:07:31 UTC (rev 47384)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3160,7 +3160,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $cap Capability name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id The user ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Adds the context to the cap. Typically the object ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Capabilities.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array Capabilities.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function grant_edit_post_capability_for_changeset( $caps, $cap, $user_id, $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'edit_post' === $cap && ! empty( $args[0] ) && 'customize_changeset' === get_post_type( $args[0] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3356,7 +3356,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $post_has_changed Whether the post has changed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $last_revision The last revision post object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The post object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether a revision should be made.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function _filter_revision_post_has_changed( $post_has_changed, $last_revision, $post ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3680,27 +3679,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0 Return added WP_Customize_Setting instance.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see WP_Customize_Setting::__construct()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/themes/customize-api
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Setting|string $id Customize Setting object, or ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args {
- * Optional. Array of properties for the new WP_Customize_Setting. 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.
- * }
- * @return WP_Customize_Setting The instance of the setting that was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Array of properties for the new Setting object.
+ * See WP_Customize_Setting::__construct() for information
+ * on accepted arguments. Default empty array.
+ * @return WP_Customize_Setting The instance of the setting that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_setting( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Setting ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3827,7 +3813,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $type Type of the panel.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type callable $active_callback Active callback.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Customize_Panel The instance of the panel that was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Customize_Panel The instance of the panel that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_panel( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Panel ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3925,7 +3911,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type callable $active_callback Active callback.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $description_hidden Hide the description behind a help icon, instead of inline above the first control. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Customize_Section The instance of the section that was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Customize_Section The instance of the section that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_section( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Section ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4004,7 +3990,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Array of properties for the new Control object.
</span><span class="cx" style="display: block; padding: 0 10px"> * See WP_Customize_Control::__construct() for information
</span><span class="cx" style="display: block; padding: 0 10px"> * on accepted arguments. Default empty array.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Customize_Control The instance of the control that was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Customize_Control The instance of the control that was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_control( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Control ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizesettingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-customize-setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-setting.php 2020-02-26 15:31:19 UTC (rev 47383)
+++ trunk/src/wp-includes/class-wp-customize-setting.php 2020-02-27 20:07:31 UTC (rev 47384)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,7 +156,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Manager $manager Customizer bootstrap instance.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id A specific ID of the setting.
</span><span class="cx" style="display: block; padding: 0 10px"> * Can be a theme mod or option name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Setting arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $manager, $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $keys = array_keys( get_object_vars( $this ) );
</span></span></pre>
</div>
</div>
</body>
</html>