<!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>[56370] trunk/src/wp-includes/option.php: Options, Meta APIs: Expand `$autoload` parameter documentation.</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/56370">56370</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/56370","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-08-07 19:31:13 +0000 (Mon, 07 Aug 2023)</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'>Options, Meta APIs: Expand `$autoload` parameter documentation.
This changeset expands documentation of the `$autoload` parameter of the `add_option()` and `update_option()` functions, in order to provide more context on what autoloading is and which considerations should go into the decision whether to autoload an option.
Excessive autoloading of options can lead to severe performance problems on some sites, and lack of documentation is a partial cause for the issue.
Props rajinsharwar.
Fixes <a href="https://core.trac.wordpress.org/ticket/58963">#58963</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesoptionphp"></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/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2023-08-07 19:07:20 UTC (rev 56369)
+++ trunk/src/wp-includes/option.php 2023-08-07 19:31:13 UTC (rev 56370)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -428,8 +428,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. For existing options,
</span><span class="cx" style="display: block; padding: 0 10px"> * `$autoload` can only be updated using `update_option()` if `$value` is also changed.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Accepts 'yes'|true to enable or 'no'|false to disable. For non-existent options,
- * the default value is 'yes'. Default null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Accepts 'yes'|true to enable or 'no'|false to disable.
+ * Autoloading too many options can lead to performance problems, especially if the
+ * options are not frequently used. For options which are accessed across several places
+ * in the frontend, it is recommended to autoload them, by using 'yes'|true.
+ * For options which are accessed only on few specific URLs, it is recommended
+ * to not autoload them, by using 'no'|false. For non-existent options, the default value
+ * is 'yes'. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the value was updated, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_option( $option, $value, $autoload = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -615,7 +620,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Expected to not be SQL-escaped.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $deprecated Optional. Description. Not used anymore.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Default is enabled. Accepts 'no' to disable for legacy reasons.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Accepts 'yes'|true to enable or 'no'|false to disable.
+ * Autoloading too many options can lead to performance problems, especially if the
+ * options are not frequently used. For options which are accessed across several places
+ * in the frontend, it is recommended to autoload them, by using 'yes'|true.
+ * For options which are accessed only on few specific URLs, it is recommended
+ * to not autoload them, by using 'no'|false. Default 'yes'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the option was added, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {
</span></span></pre>
</div>
</div>
</body>
</html>