<!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>[54948] trunk/src/wp-includes/option.php: Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.</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/54948">54948</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/54948","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>2022-12-07 21:30:47 +0000 (Wed, 07 Dec 2022)</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'>Code Modernization: Rename parameters that use reserved keywords in `wp-includes/option.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in:
* `get_option()`
* `get_user_setting()`
* `get_site_option()`
* `get_network_option()`
* `filter_default_option()`
Follow-up to <a href="https://core.trac.wordpress.org/changeset/52946">[52946]</a>, <a href="https://core.trac.wordpress.org/changeset/52996">[52996]</a>, <a href="https://core.trac.wordpress.org/changeset/52997">[52997]</a>, <a href="https://core.trac.wordpress.org/changeset/52998">[52998]</a>, <a href="https://core.trac.wordpress.org/changeset/53003">[53003]</a>, <a href="https://core.trac.wordpress.org/changeset/53014">[53014]</a>, <a href="https://core.trac.wordpress.org/changeset/53029">[53029]</a>, <a href="https://core.trac.wordpress.org/changeset/53039">[53039]</a>, <a href="https://core.trac.wordpress.org/changeset/53116">[53116]</a>, <a href="https://core.trac.wordpress.org/changeset/53117">[53117]</a>, <a href="https://core.trac.wordpress.org/changeset/53137">[53137]</a>, <a href="https://core.trac.wordpress.org/changeset/53174">[53174]</a>, <a href="https://core.trac.wordpress.org/changeset/53184">[53184]</a>, <a href="https://core.trac.wordpress.org/changeset/53185">[531
85]</a>, <a href="https://core.trac.wordpress.org/changeset/53192">[53192]</a>, <a href="https://core.trac.wordpress.org/changeset/53193">[53193]</a>, <a href="https://core.trac.wordpress.org/changeset/53198">[53198]</a>, <a href="https://core.trac.wordpress.org/changeset/53203">[53203]</a>, <a href="https://core.trac.wordpress.org/changeset/53207">[53207]</a>, <a href="https://core.trac.wordpress.org/changeset/53215">[53215]</a>, <a href="https://core.trac.wordpress.org/changeset/53216">[53216]</a>, <a href="https://core.trac.wordpress.org/changeset/53220">[53220]</a>, <a href="https://core.trac.wordpress.org/changeset/53230">[53230]</a>, <a href="https://core.trac.wordpress.org/changeset/53232">[53232]</a>, <a href="https://core.trac.wordpress.org/changeset/53236">[53236]</a>, <a href="https://core.trac.wordpress.org/changeset/53239">[53239]</a>, <a href="https://core.trac.wordpress.org/changeset/53240">[53240]</a>, <a href="https://core.trac.wordpress.org/changeset/53242">[53242]
</a>, <a href="https://core.trac.wordpress.org/changeset/53243">[53243]</a>, <a href="https://core.trac.wordpress.org/changeset/53245">[53245]</a>, <a href="https://core.trac.wordpress.org/changeset/53246">[53246]</a>, <a href="https://core.trac.wordpress.org/changeset/53257">[53257]</a>, <a href="https://core.trac.wordpress.org/changeset/53269">[53269]</a>, <a href="https://core.trac.wordpress.org/changeset/53270">[53270]</a>, <a href="https://core.trac.wordpress.org/changeset/53271">[53271]</a>, <a href="https://core.trac.wordpress.org/changeset/53272">[53272]</a>, <a href="https://core.trac.wordpress.org/changeset/53273">[53273]</a>, <a href="https://core.trac.wordpress.org/changeset/53274">[53274]</a>, <a href="https://core.trac.wordpress.org/changeset/53275">[53275]</a>, <a href="https://core.trac.wordpress.org/changeset/53276">[53276]</a>, <a href="https://core.trac.wordpress.org/changeset/53277">[53277]</a>, <a href="https://core.trac.wordpress.org/changeset/53281">[53281]</a
>, <a href="https://core.trac.wordpress.org/changeset/53283">[53283]</a>, <a href="https://core.trac.wordpress.org/changeset/53284">[53284]</a>, <a href="https://core.trac.wordpress.org/changeset/53285">[53285]</a>, <a href="https://core.trac.wordpress.org/changeset/53287">[53287]</a>, <a href="https://core.trac.wordpress.org/changeset/53364">[53364]</a>, <a href="https://core.trac.wordpress.org/changeset/53365">[53365]</a>, <a href="https://core.trac.wordpress.org/changeset/54927">[54927]</a>, <a href="https://core.trac.wordpress.org/changeset/54929">[54929]</a>, <a href="https://core.trac.wordpress.org/changeset/54930">[54930]</a>, <a href="https://core.trac.wordpress.org/changeset/54931">[54931]</a>, <a href="https://core.trac.wordpress.org/changeset/54932">[54932]</a>, <a href="https://core.trac.wordpress.org/changeset/54933">[54933]</a>, <a href="https://core.trac.wordpress.org/changeset/54938">[54938]</a>, <a href="https://core.trac.wordpress.org/changeset/54943">[54943]</a>,
<a href="https://core.trac.wordpress.org/changeset/54944">[54944]</a>, <a href="https://core.trac.wordpress.org/changeset/54945">[54945]</a>, <a href="https://core.trac.wordpress.org/changeset/54946">[54946]</a>, <a href="https://core.trac.wordpress.org/changeset/54947">[54947]</a>.
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/56788">#56788</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 2022-12-07 21:17:52 UTC (rev 54947)
+++ trunk/src/wp-includes/option.php 2022-12-07 21:30:47 UTC (rev 54948)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,7 +29,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Exceptions:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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
</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` value
</ins><span class="cx" style="display: block; padding: 0 10px"> * is returned if provided. If not, boolean `false` is returned.
</span><span class="cx" style="display: block; padding: 0 10px"> * 2. When one of the Options API filters is used: {@see 'pre_option_$option'},
</span><span class="cx" style="display: block; padding: 0 10px"> * {@see 'default_option_$option'}, or {@see 'option_$option'}, the returned
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,8 +67,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</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 string $option Name of the option to retrieve. Expected to not be SQL-escaped.
- * @param mixed $default Optional. Default value to return if the option does not exist.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Name of the option to retrieve. Expected to not be SQL-escaped.
+ * @param mixed $default_value Optional. Default value to return if the option does not exist.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed Value of the option. A value of any type may be returned, including
</span><span class="cx" style="display: block; padding: 0 10px"> * scalar (string, boolean, float, integer), null, array, object.
</span><span class="cx" style="display: block; padding: 0 10px"> * Scalar and null values will be returned as strings as long as they originate
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,7 +75,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * from a database stored option value. If there is no option in the database,
</span><span class="cx" style="display: block; padding: 0 10px"> * boolean `false` is returned.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_option( $option, $default = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_option( $option, $default_value = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_scalar( $option ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,7 +106,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $deprecated_keys[ $option ]
</span><span class="cx" style="display: block; padding: 0 10px"> )
</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 get_option( $deprecated_keys[ $option ], $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return get_option( $deprecated_keys[ $option ], $default_value );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,17 +119,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 The `$option` parameter was added.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.9.0 The `$default` parameter was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.0 The `$default_value` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $pre_option The value to return instead of the option value. This differs
- * from `$default`, which is used as the fallback value in the event
- * the option doesn't exist elsewhere in get_option().
- * Default false (to skip past the short-circuit).
- * @param string $option Option name.
- * @param mixed $default The fallback value to return if the option does not exist.
- * Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $pre_option The value to return instead of the option value. This differs from
+ * `$default_value`, which is used as the fallback value in the event
+ * the option doesn't exist elsewhere in get_option().
+ * Default false (to skip past the short-circuit).
+ * @param string $option Option name.
+ * @param mixed $default_value The fallback value to return if the option does not exist.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $pre = apply_filters( "pre_option_{$option}", false, $option, $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pre = apply_filters( "pre_option_{$option}", false, $option, $default_value );
</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"> * Filters the value of all existing options before it is retrieved.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,15 +139,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.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 mixed $pre_option The value to return instead of the option value. This differs
- * from `$default`, which is used as the fallback value in the event
- * the option doesn't exist elsewhere in get_option().
- * Default false (to skip past the short-circuit).
- * @param string $option Name of the option.
- * @param mixed $default The fallback value to return if the option does not exist.
- * Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $pre_option The value to return instead of the option value. This differs from
+ * `$default_value`, which is used as the fallback value in the event
+ * the option doesn't exist elsewhere in get_option().
+ * Default false (to skip past the short-circuit).
+ * @param string $option Name of the option.
+ * @param mixed $default_value The fallback value to return if the option does not exist.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $pre = apply_filters( 'pre_option', $pre, $option, $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pre = apply_filters( 'pre_option', $pre, $option, $default_value );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $pre ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $pre;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,12 +180,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 The `$option` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value.
</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 mixed $default The default value to return if the option does not exist
- * in the database.
- * @param string $option Option name.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $default_value The default value to return if the option does not exist
+ * in the database.
+ * @param string $option Option name.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param bool $passed_default Was `get_option()` passed a default value?
</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 apply_filters( "default_option_{$option}", $default, $option, $passed_default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
</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"> $alloptions = wp_load_alloptions();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -211,7 +211,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'notoptions', $notoptions, 'options' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/option.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( "default_option_{$option}", $default, $option, $passed_default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
</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"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,7 +224,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $row->option_value;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/option.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( "default_option_{$option}", $default, $option, $passed_default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1145,14 +1145,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.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 string $name The name of the setting.
- * @param string|false $default Optional. Default value to return when $name is not set. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $name The name of the setting.
+ * @param string|false $default_value Optional. Default value to return when $name is not set. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed The last saved user setting or the default value/false if it doesn't exist.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_user_setting( $name, $default = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_user_setting( $name, $default_value = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $all_user_settings = get_all_user_settings();
</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 isset( $all_user_settings[ $name ] ) ? $all_user_settings[ $name ] : $default;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return isset( $all_user_settings[ $name ] ) ? $all_user_settings[ $name ] : $default_value;
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1324,13 +1324,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_network_option()
</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 string $option Name of the option to retrieve. Expected to not be SQL-escaped.
- * @param mixed $default Optional. Value to return if the option doesn't exist. Default false.
- * @param bool $deprecated Whether to use cache. Multisite only. Always set to true.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Name of the option to retrieve. Expected to not be SQL-escaped.
+ * @param mixed $default_value Optional. Value to return if the option doesn't exist. Default false.
+ * @param bool $deprecated Whether to use cache. Multisite only. Always set to true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed Value set for the option.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_site_option( $option, $default = false, $deprecated = true ) {
- return get_network_option( null, $option, $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_site_option( $option, $default_value = false, $deprecated = true ) {
+ return get_network_option( null, $option, $default_value );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1391,12 +1391,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</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 int $network_id ID of the network. Can be null to default to the current network ID.
- * @param string $option Name of the option to retrieve. Expected to not be SQL-escaped.
- * @param mixed $default Optional. Value to return if the option doesn't exist. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $network_id ID of the network. Can be null to default to the current network ID.
+ * @param string $option Name of the option to retrieve. Expected to not be SQL-escaped.
+ * @param mixed $default_value Optional. Value to return if the option doesn't exist. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed Value set for the option.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_network_option( $network_id, $option, $default = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_network_option( $network_id, $option, $default_value = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $network_id && ! is_numeric( $network_id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1422,18 +1422,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 The `$option` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0 The `$network_id` parameter was added.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.9.0 The `$default` parameter was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.0 The `$default_value` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $pre_option The value to return instead of the option value. This differs
- * from `$default`, which is used as the fallback value in the event
- * the option doesn't exist elsewhere in get_network_option().
- * Default false (to skip past the short-circuit).
- * @param string $option Option name.
- * @param int $network_id ID of the network.
- * @param mixed $default The fallback value to return if the option does not exist.
- * Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $pre_option The value to return instead of the option value. This differs from
+ * `$default_value`, which is used as the fallback value in the event
+ * the option doesn't exist elsewhere in get_network_option().
+ * Default false (to skip past the short-circuit).
+ * @param string $option Option name.
+ * @param int $network_id ID of the network.
+ * @param mixed $default_value The fallback value to return if the option does not exist.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $pre ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $pre;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1454,18 +1454,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 The `$option` parameter was added.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0 The `$network_id` parameter was added.
</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 mixed $default The value to return if the site option does not exist
- * in the database.
- * @param string $option Option name.
- * @param int $network_id ID of the network.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $default_value The value to return if the site option does not exist
+ * in the database.
+ * @param string $option Option name.
+ * @param int $network_id ID of the network.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( "default_site_option_{$option}", $default, $option, $network_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( "default_site_option_{$option}", $default_value, $option, $network_id );
</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"> if ( ! is_multisite() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/option.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $default = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id );
- $value = get_option( $option, $default );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $default_value = apply_filters( 'default_site_option_' . $option, $default_value, $option, $network_id );
+ $value = get_option( $option, $default_value );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key = "$network_id:$option";
</span><span class="cx" style="display: block; padding: 0 10px"> $value = wp_cache_get( $cache_key, 'site-options' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1487,7 +1487,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/option.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $value = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = apply_filters( 'default_site_option_' . $option, $default_value, $option, $network_id );
</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"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2554,19 +2554,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.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 mixed $default Existing default value to return.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $default_value Existing default value to return.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $option Option name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $passed_default Was `get_option()` passed a default value?
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed Filtered default value.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function filter_default_option( $default, $option, $passed_default ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function filter_default_option( $default_value, $option, $passed_default ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $passed_default ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $default;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $default_value;
</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"> $registered = get_registered_settings();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $registered[ $option ] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $default;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $default_value;
</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"> return $registered[ $option ]['default'];
</span></span></pre>
</div>
</div>
</body>
</html>