<!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>[48617] trunk/src/wp-includes/customize: Docs: Add a reference to `WP_Customize_Partial::__construct()` for information on accepted arguments in `WP_Customize_Selective_Refresh::add_partial()`.</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/48617">48617</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/48617","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-07-25 19:38:34 +0000 (Sat, 25 Jul 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_Partial::__construct()` for information on accepted arguments in `WP_Customize_Selective_Refresh::add_partial()`.
Synchronize the documentation between two places, use `WP_Customize_Partial::__construct()` as the canonical source.
Props marekdedic.
See <a href="https://core.trac.wordpress.org/ticket/49572">#49572</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescustomizeclasswpcustomizepartialphp">trunk/src/wp-includes/customize/class-wp-customize-partial.php</a></li>
<li><a href="#trunksrcwpincludescustomizeclasswpcustomizeselectiverefreshphp">trunk/src/wp-includes/customize/class-wp-customize-selective-refresh.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescustomizeclasswpcustomizepartialphp"></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/customize/class-wp-customize-partial.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/customize/class-wp-customize-partial.php 2020-07-25 19:12:15 UTC (rev 48616)
+++ trunk/src/wp-includes/customize/class-wp-customize-partial.php 2020-07-25 19:38:34 UTC (rev 48617)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,7 +68,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * IDs for settings tied to the partial.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @var array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @var string[]
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $settings;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,10 +134,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Selective_Refresh $component Customize Partial Refresh plugin instance.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $id Control ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args {
- * Optional. Arguments to override class property defaults.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * Optional. Array of properties for the new Partials object. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array|string $settings All settings IDs tied to the partial. If undefined, `$id` will be used.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $type Type of the partial to be created.
+ * @type string $selector The jQuery selector to find the container element for the partial, that is,
+ * a partial's placement.
+ * @type string[] $settings IDs for settings tied to the partial. If undefined, `$id` will be used.
+ * @type string $primary_setting The ID for the setting that this partial is primarily responsible for
+ * rendering. If not supplied, it will default to the ID of the first setting.
+ * @type string $capability Capability required to edit this partial.
+ * Normally this is empty and the capability is derived from the capabilities
+ * of the associated `$settings`.
+ * @type callable $render_callback Render callback.
+ * Callback is called with one argument, the instance of WP_Customize_Partial.
+ * The callback can either echo the partial or return the partial as a string,
+ * or return false if error.
+ * @type bool $container_inclusive Whether the container element is included in the partial, or if only
+ * the contents are rendered.
+ * @type bool $fallback_refresh Whether to refresh the entire preview in case a partial cannot be refreshed.
+ * A partial render is considered a failure if the render_callback returns
+ * false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( WP_Customize_Selective_Refresh $component, $id, $args = array() ) {
</span></span></pre></div>
<a id="trunksrcwpincludescustomizeclasswpcustomizeselectiverefreshphp"></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/customize/class-wp-customize-selective-refresh.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/customize/class-wp-customize-selective-refresh.php 2020-07-25 19:12:15 UTC (rev 48616)
+++ trunk/src/wp-includes/customize/class-wp-customize-selective-refresh.php 2020-07-25 19:38:34 UTC (rev 48617)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,29 +83,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Customize_Partial|string $id Customize Partial object, or Panel ID.
- * @param array $args {
- * Optional. Array of properties for the new Partials object. Default empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see WP_Customize_Partial::__construct()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $type Type of the partial to be created.
- * @type string $selector The jQuery selector to find the container element for the partial, that is, a partial's placement.
- * @type array $settings IDs for settings tied to the partial.
- * @type string $primary_setting The ID for the setting that this partial is primarily responsible for
- * rendering. If not supplied, it will default to the ID of the first setting.
- * @type string $capability Capability required to edit this partial.
- * Normally this is empty and the capability is derived from the capabilities
- * of the associated `$settings`.
- * @type callable $render_callback Render callback.
- * Callback is called with one argument, the instance of WP_Customize_Partial.
- * The callback can either echo the partial or return the partial as a string,
- * or return false if error.
- * @type bool $container_inclusive Whether the container element is included in the partial, or if only
- * the contents are rendered.
- * @type bool $fallback_refresh Whether to refresh the entire preview in case a partial cannot be refreshed.
- * A partial render is considered a failure if the render_callback returns
- * false.
- * }
- * @return WP_Customize_Partial The instance of the panel that was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Customize_Partial|string $id Customize Partial object, or Partial ID.
+ * @param array $args Optional. Array of properties for the new Partials object.
+ * See WP_Customize_Partial::__construct() for information
+ * on accepted arguments. Default empty array.
+ * @return WP_Customize_Partial The instance of the partial 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_partial( $id, $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $id instanceof WP_Customize_Partial ) {
</span></span></pre>
</div>
</div>
</body>
</html>