<!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>[51324] trunk/src/wp-includes/option.php: Docs: Correct `@see` references for hooks in the `get_option()` description.</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/51324">51324</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/51324","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>2021-07-03 11:31:00 +0000 (Sat, 03 Jul 2021)</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: Correct `@see` references for hooks in the `get_option()` description.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/51050">[51050]</a>.
See <a href="https://core.trac.wordpress.org/ticket/52628">#52628</a>, <a href="https://core.trac.wordpress.org/ticket/53461">#53461</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 2021-07-03 09:40:51 UTC (rev 51323)
+++ trunk/src/wp-includes/option.php 2021-07-03 11:31:00 UTC (rev 51324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,10 +12,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If the option does not exist, and a default value is not provided,
</span><span class="cx" style="display: block; padding: 0 10px"> * boolean false is returned. This could be used to check whether you need
</span><span class="cx" style="display: block; padding: 0 10px"> * to initialize an option during installation of a plugin, however that
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * can be done better by using {@see add_option} which will not overwrite
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * can be done better by using add_option() which will not overwrite
</ins><span class="cx" style="display: block; padding: 0 10px"> * existing options.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Not initializing an option and using the boolean false as a return value
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Not initializing an option and using boolean `false` as a return value
</ins><span class="cx" style="display: block; padding: 0 10px"> * is a bad practice as it triggers an additional database query.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The type of the returned value can be different from the type that was passed
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,12 +28,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * as string equivalents.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Exceptions:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 1. When the option has not been saved in the database, the default value
- * {@see get_option} is returned if provided. If not, boolean `false` is returned.
- * 2. When one of the Options API filters is used: {@see pre_option_{$option}},
- * {@see default_option_{$option}}, and {@see option_{$option}}, the returned
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 1. When the option has not been saved in the database, the `$default` value
+ * is returned if provided. If not, boolean `false` is returned.
+ * 2. When one of the Options API filters is used: {@see 'pre_option_{$option}'},
+ * {@see 'default_option_{$option}'}, or {@see 'option_{$option}'}, the returned
</ins><span class="cx" style="display: block; padding: 0 10px"> * value may not match the expected type.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 3. When the option has just been saved in the database, and {@see get_option}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 3. When the option has just been saved in the database, and get_option()
</ins><span class="cx" style="display: block; padding: 0 10px"> * is used right after, non-string scalar and null values are not converted to
</span><span class="cx" style="display: block; padding: 0 10px"> * string equivalents and the original type is returned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,7 +40,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Examples:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * When adding options like this: `add_option( 'my_option_name', 'value' );`
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * and then retrieving them with `get_option( 'my_option_name' )`, the returned
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * and then retrieving them with `get_option( 'my_option_name' );`, the returned
</ins><span class="cx" style="display: block; padding: 0 10px"> * values will be:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * `false` returns `string(0) ""`
</span></span></pre>
</div>
</div>
</body>
</html>