<!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>[48320] trunk/src/wp-includes: Docs: Improve documentation for various option functions.</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/48320">48320</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/48320","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-05 14:44:37 +0000 (Sun, 05 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: Improve documentation for various option functions.

Props andfinally, david.binda, SergeyBiryukov.

Fixes <a href="https://core.trac.wordpress.org/ticket/49566">#49566</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesmsblogsphp">trunk/src/wp-includes/ms-blogs.php</a></li>

<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludesmsblogsphp"></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/ms-blogs.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-blogs.php        2020-07-05 13:55:46 UTC (rev 48319)

+++ trunk/src/wp-includes/ms-blogs.php  2020-07-05 14:44:37 UTC (rev 48320)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -398,7 +398,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $id     A blog ID. Can be null to refer to the current blog.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $option Name of option to add. Expected to not be SQL-escaped.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value  Optional. Option value, can be anything. Expected to not be SQL-escaped.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if option was not added and true if option was added.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the option was added, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function add_blog_option( $id, $option, $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $id = (int) $id;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -425,7 +425,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $id     A blog ID. Can be null to refer to the current blog.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $option Name of option to remove. Expected to not be SQL-escaped.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True, if option is successfully deleted. False on failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the option was deleted, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_blog_option( $id, $option ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $id = (int) $id;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -454,7 +454,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param string $option     The option key.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value      The option value.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $deprecated Not used.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True on success, false on failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the value was updated, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function update_blog_option( $id, $option, $value, $deprecated = null ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $id = (int) $id;

</span></span></pre></div>

<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  2020-07-05 13:55:46 UTC (rev 48319)

+++ trunk/src/wp-includes/option.php    2020-07-05 14:44:37 UTC (rev 48320)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +23,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<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">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option  Name of option to retrieve. Expected to not be SQL-escaped.

</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.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $default Optional. Default value to return if the option does not exist.

<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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -297,13 +297,13 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<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">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string      $option   Option name. Expected to not be SQL-escaped.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string      $option   Name of the option to update. Expected to not be SQL-escaped.

</ins><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 class="cx" style="display: block; padding: 0 10px">  *                              `$autoload` can only be updated using `update_option()` if `$value` is also changed.

</span><span class="cx" style="display: block; padding: 0 10px">  *                              Accepts 'yes'|true to enable or 'no'|false to disable. For non-existent options,

<span class="cx" style="display: block; padding: 0 10px">  *                              the default value is 'yes'. Default null.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if value was not updated and true if value was updated.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the value was updated, false otherwise.

</ins><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="cx" style="display: block; padding: 0 10px">        global $wpdb;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -457,13 +457,13 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<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">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string         $option      Name of option to add. Expected to not be SQL-escaped.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string         $option      Name of the option to add. Expected to not be SQL-escaped.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed          $value       Optional. Option value. Must be serializable if non-scalar.

<span class="cx" style="display: block; padding: 0 10px">  *                                    Expected to not be SQL-escaped.

<span class="cx" style="display: block; padding: 0 10px">  * @param string         $deprecated  Optional. Description. Not used anymore.

<span class="cx" style="display: block; padding: 0 10px">  * @param string|bool    $autoload    Optional. Whether to load the option when WordPress starts up.

<span class="cx" style="display: block; padding: 0 10px">  *                                    Default is enabled. Accepts 'no' to disable for legacy reasons.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if option was not added and true if option was added.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the option was added, false otherwise.

</ins><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 class="cx" style="display: block; padding: 0 10px">        global $wpdb;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -565,8 +565,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<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">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option Name of option to remove. Expected to not be SQL-escaped.

- * @return bool True, if option is successfully deleted. False on failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Name of the option to delete. Expected to not be SQL-escaped.

+ * @return bool True if the option was deleted, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_option( $option ) {

</span><span class="cx" style="display: block; padding: 0 10px">        global $wpdb;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -641,7 +641,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.8.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $transient Transient name. Expected to not be SQL-escaped.

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool true if successful, false otherwise

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the transient was deleted, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_transient( $transient ) {

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -768,7 +768,7 @@

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value      Transient value. Must be serializable if non-scalar.

<span class="cx" style="display: block; padding: 0 10px">  *                           Expected to not be SQL-escaped.

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if value was not set and true if value was set.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the value was set, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function set_transient( $transient, $value, $expiration = 0 ) {

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -990,7 +990,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $name    The name of the setting.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $default Optional default value to return when $name is not set.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed the last saved user setting or the default value/false if it doesn't exist.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return mixed The last saved user setting or the default value/false if it doesn't exist.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_user_setting( $name, $default = false ) {

</span><span class="cx" style="display: block; padding: 0 10px">        $all_user_settings = get_all_user_settings();

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1009,7 +1009,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $name  The name of the setting.

<span class="cx" style="display: block; padding: 0 10px">  * @param string $value The value for the setting.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|null True if set successfully, false if not. Null if the current user can't be established.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|null True if set successfully, false otherwise.

+ *                   Null if the current user is not a member of the site.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function set_user_setting( $name, $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">        if ( headers_sent() ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1032,7 +1033,8 @@

</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 class="cx" style="display: block; padding: 0 10px">  * @param string $names The name or array of names of the setting to be deleted.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|null True if deleted successfully, false if not. Null if the current user can't be established.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|null True if deleted successfully, false otherwise.

+ *                   Null if the current user is not a member of the site.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_user_setting( $names ) {

</span><span class="cx" style="display: block; padding: 0 10px">        if ( headers_sent() ) {

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1064,7 +1066,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @global array $_updated_user_settings

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array the last saved user settings or empty array.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array The last saved user settings or empty array.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function get_all_user_settings() {

</span><span class="cx" style="display: block; padding: 0 10px">        global $_updated_user_settings;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1107,8 +1109,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @global array $_updated_user_settings

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param array $user_settings User settings.

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|null False if the current user can't be found, null if the current

- *                   user is not a super admin or a member of the site, otherwise true.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|null True if set successfully, false if the current user could not be found.

+ *                   Null if the current user is not a member of the site.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function wp_set_all_user_settings( $user_settings ) {

</span><span class="cx" style="display: block; padding: 0 10px">        global $_updated_user_settings;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1165,8 +1167,8 @@

</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">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option     Name of option to retrieve. Expected to not be SQL-escaped.

- * @param mixed  $default    Optional value to return if option doesn't exist. Default false.

</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    Optional. Value to return if the option doesn't exist. Default false.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param bool   $deprecated Whether to use cache. Multisite only. Always set to true.

<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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1184,9 +1186,9 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @see add_network_option()

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option Name of option to add. Expected to not be SQL-escaped.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Name of the option to add. Expected to not be SQL-escaped.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value  Option value, can be anything. Expected to not be SQL-escaped.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if the option was not added. True if the option was added.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the option was added, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function add_site_option( $option, $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">        return add_network_option( null, $option, $value );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1200,8 +1202,8 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @see delete_network_option()

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option Name of option to remove. Expected to not be SQL-escaped.

- * @return bool True, if succeed. False, if failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Name of the option to delete. Expected to not be SQL-escaped.

+ * @return bool True if the option was deleted, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_site_option( $option ) {

</span><span class="cx" style="display: block; padding: 0 10px">        return delete_network_option( null, $option );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1215,9 +1217,9 @@

</span><span class="cx" style="display: block; padding: 0 10px">  *

</span><span class="cx" style="display: block; padding: 0 10px">  * @see update_network_option()

</span><span class="cx" style="display: block; padding: 0 10px">  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option Name of option. Expected to not be SQL-escaped.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Name of the option. Expected to not be SQL-escaped.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value  Option value. Expected to not be SQL-escaped.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if value was not updated. True if value was updated.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the value was updated, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function update_site_option( $option, $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">        return update_network_option( null, $option, $value );

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1233,7 +1235,7 @@

<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 class="cx" style="display: block; padding: 0 10px">  * @param int      $network_id ID of the network. Can be null to default to the current network ID.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string   $option     Name of option to retrieve. Expected to not be SQL-escaped.

</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.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed    $default    Optional. Value to return if the option doesn't exist. Default false.

<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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1367,9 +1369,9 @@

<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 class="cx" style="display: block; padding: 0 10px">  * @param int    $network_id ID of the network. Can be null to default to the current network ID.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option     Name of option to add. Expected to not be SQL-escaped.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option     Name of the option to add. Expected to not be SQL-escaped.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value      Option value, can be anything. Expected to not be SQL-escaped.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if option was not added and true if option was added.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the option was added, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function add_network_option( $network_id, $option, $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">        global $wpdb;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1492,8 +1494,8 @@

<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 class="cx" style="display: block; padding: 0 10px">  * @param int    $network_id ID of the network. Can be null to default to the current network ID.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option     Name of option to remove. Expected to not be SQL-escaped.

- * @return bool True, if succeed. False, if failure.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option     Name of the option to delete. Expected to not be SQL-escaped.

+ * @return bool True if the option was deleted, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_network_option( $network_id, $option ) {

</span><span class="cx" style="display: block; padding: 0 10px">        global $wpdb;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1585,9 +1587,9 @@

<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 class="cx" style="display: block; padding: 0 10px">  * @param int      $network_id ID of the network. Can be null to default to the current network ID.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string   $option     Name of option. Expected to not be SQL-escaped.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string   $option     Name of the option. Expected to not be SQL-escaped.

</ins><span class="cx" style="display: block; padding: 0 10px">  * @param mixed    $value      Option value. Expected to not be SQL-escaped.

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if value was not updated and true if value was updated.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the value was updated, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function update_network_option( $network_id, $option, $value ) {

</span><span class="cx" style="display: block; padding: 0 10px">        global $wpdb;

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1713,7 +1715,7 @@

</span><span class="cx" style="display: block; padding: 0 10px">  * @since 2.9.0

</span><span class="cx" style="display: block; padding: 0 10px">  *

<span class="cx" style="display: block; padding: 0 10px">  * @param string $transient Transient name. Expected to not be SQL-escaped.

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True if successful, false otherwise

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the transient was deleted, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function delete_site_transient( $transient ) {

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1841,7 +1843,7 @@

<span class="cx" style="display: block; padding: 0 10px">  *                           167 characters or fewer in length.

<span class="cx" style="display: block; padding: 0 10px">  * @param mixed  $value      Transient value. Expected to not be SQL-escaped.

<span class="cx" style="display: block; padding: 0 10px">  * @param int    $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool False if value was not set and true if value was set.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the value was set, false otherwise.

</ins><span class="cx" style="display: block; padding: 0 10px">  */

</span><span class="cx" style="display: block; padding: 0 10px"> function set_site_transient( $transient, $value, $expiration = 0 ) {

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span></span></pre>

</div>

</div>

</body>

</html>