author | ymh <ymh.work@gmail.com> |
Mon, 14 Oct 2019 18:28:13 +0200 | |
changeset 9 | 177826044cd9 |
parent 7 | cf61fcea0001 |
child 16 | a86126ab1dd4 |
permissions | -rw-r--r-- |
0 | 1 |
<?php |
2 |
/** |
|
3 |
* Option API |
|
4 |
* |
|
5 |
* @package WordPress |
|
5 | 6 |
* @subpackage Option |
0 | 7 |
*/ |
8 |
||
9 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
10 |
* Retrieves an option value based on an option name. |
0 | 11 |
* |
12 |
* If the option does not exist or does not have a value, then the return value |
|
13 |
* will be false. This is useful to check whether you need to install an option |
|
14 |
* and is commonly used during installation of plugin options and to test |
|
15 |
* whether upgrading is required. |
|
16 |
* |
|
17 |
* If the option was serialized then it will be unserialized when it is returned. |
|
18 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
19 |
* Any scalar values will be returned as strings. You may coerce the return type of |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
20 |
* a given option by registering an {@see 'option_$option'} filter callback. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
21 |
* |
0 | 22 |
* @since 1.5.0 |
23 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
24 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
25 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
26 |
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
27 |
* @param mixed $default Optional. Default value to return if the option does not exist. |
0 | 28 |
* @return mixed Value set for the option. |
29 |
*/ |
|
30 |
function get_option( $option, $default = false ) { |
|
31 |
global $wpdb; |
|
32 |
||
33 |
$option = trim( $option ); |
|
9 | 34 |
if ( empty( $option ) ) { |
0 | 35 |
return false; |
9 | 36 |
} |
0 | 37 |
|
5 | 38 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
39 |
* Filters the value of an existing option before it is retrieved. |
5 | 40 |
* |
41 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
42 |
* |
|
43 |
* Passing a truthy value to the filter will short-circuit retrieving |
|
44 |
* the option value, returning the passed value instead. |
|
45 |
* |
|
46 |
* @since 1.5.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
47 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
48 |
* @since 4.9.0 The `$default` parameter was added. |
5 | 49 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
50 |
* @param bool|mixed $pre_option The value to return instead of the option value. This differs from |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
51 |
* `$default`, which is used as the fallback value in the event the option |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
52 |
* doesn't exist elsewhere in get_option(). Default false (to skip past the |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
53 |
* short-circuit). |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
54 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
55 |
* @param mixed $default The fallback value to return if the option does not exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
56 |
* Default is false. |
5 | 57 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
58 |
$pre = apply_filters( "pre_option_{$option}", false, $option, $default ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
59 |
|
9 | 60 |
if ( false !== $pre ) { |
0 | 61 |
return $pre; |
9 | 62 |
} |
0 | 63 |
|
9 | 64 |
if ( defined( 'WP_SETUP_CONFIG' ) ) { |
0 | 65 |
return false; |
9 | 66 |
} |
0 | 67 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
68 |
// Distinguish between `false` as a default, and not passing one. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
69 |
$passed_default = func_num_args() > 1; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
70 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
71 |
if ( ! wp_installing() ) { |
0 | 72 |
// prevent non-existent options from triggering multiple queries |
73 |
$notoptions = wp_cache_get( 'notoptions', 'options' ); |
|
5 | 74 |
if ( isset( $notoptions[ $option ] ) ) { |
75 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
76 |
* Filters the default value for an option. |
5 | 77 |
* |
78 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
79 |
* |
|
80 |
* @since 3.4.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
81 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
82 |
* @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value. |
5 | 83 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
84 |
* @param mixed $default The default value to return if the option does not exist |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
85 |
* in the database. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
86 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
87 |
* @param bool $passed_default Was `get_option()` passed a default value? |
5 | 88 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
89 |
return apply_filters( "default_option_{$option}", $default, $option, $passed_default ); |
5 | 90 |
} |
0 | 91 |
|
92 |
$alloptions = wp_load_alloptions(); |
|
93 |
||
9 | 94 |
if ( isset( $alloptions[ $option ] ) ) { |
95 |
$value = $alloptions[ $option ]; |
|
0 | 96 |
} else { |
97 |
$value = wp_cache_get( $option, 'options' ); |
|
98 |
||
99 |
if ( false === $value ) { |
|
100 |
$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) ); |
|
101 |
||
102 |
// Has to be get_row instead of get_var because of funkiness with 0, false, null values |
|
103 |
if ( is_object( $row ) ) { |
|
104 |
$value = $row->option_value; |
|
105 |
wp_cache_add( $option, $value, 'options' ); |
|
106 |
} else { // option does not exist, so we must cache its non-existence |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
107 |
if ( ! is_array( $notoptions ) ) { |
9 | 108 |
$notoptions = array(); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
109 |
} |
9 | 110 |
$notoptions[ $option ] = true; |
0 | 111 |
wp_cache_set( 'notoptions', $notoptions, 'options' ); |
5 | 112 |
|
113 |
/** This filter is documented in wp-includes/option.php */ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
114 |
return apply_filters( "default_option_{$option}", $default, $option, $passed_default ); |
0 | 115 |
} |
116 |
} |
|
117 |
} |
|
118 |
} else { |
|
119 |
$suppress = $wpdb->suppress_errors(); |
|
9 | 120 |
$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) ); |
0 | 121 |
$wpdb->suppress_errors( $suppress ); |
5 | 122 |
if ( is_object( $row ) ) { |
0 | 123 |
$value = $row->option_value; |
5 | 124 |
} else { |
125 |
/** This filter is documented in wp-includes/option.php */ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
126 |
return apply_filters( "default_option_{$option}", $default, $option, $passed_default ); |
5 | 127 |
} |
0 | 128 |
} |
129 |
||
130 |
// If home is not set use siteurl. |
|
9 | 131 |
if ( 'home' == $option && '' == $value ) { |
0 | 132 |
return get_option( 'siteurl' ); |
9 | 133 |
} |
0 | 134 |
|
9 | 135 |
if ( in_array( $option, array( 'siteurl', 'home', 'category_base', 'tag_base' ) ) ) { |
0 | 136 |
$value = untrailingslashit( $value ); |
9 | 137 |
} |
0 | 138 |
|
5 | 139 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
140 |
* Filters the value of an existing option. |
5 | 141 |
* |
142 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
143 |
* |
|
144 |
* @since 1.5.0 As 'option_' . $setting |
|
145 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
146 |
* @since 4.4.0 The `$option` parameter was added. |
5 | 147 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
148 |
* @param mixed $value Value of the option. If stored serialized, it will be |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
149 |
* unserialized prior to being returned. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
150 |
* @param string $option Option name. |
5 | 151 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
152 |
return apply_filters( "option_{$option}", maybe_unserialize( $value ), $option ); |
0 | 153 |
} |
154 |
||
155 |
/** |
|
156 |
* Protect WordPress special option from being modified. |
|
157 |
* |
|
158 |
* Will die if $option is in protected list. Protected options are 'alloptions' |
|
159 |
* and 'notoptions' options. |
|
160 |
* |
|
161 |
* @since 2.2.0 |
|
162 |
* |
|
163 |
* @param string $option Option name. |
|
164 |
*/ |
|
165 |
function wp_protect_special_option( $option ) { |
|
9 | 166 |
if ( 'alloptions' === $option || 'notoptions' === $option ) { |
0 | 167 |
wp_die( sprintf( __( '%s is a protected WP option and may not be modified' ), esc_html( $option ) ) ); |
9 | 168 |
} |
0 | 169 |
} |
170 |
||
171 |
/** |
|
172 |
* Print option value after sanitizing for forms. |
|
173 |
* |
|
174 |
* @since 1.5.0 |
|
175 |
* |
|
176 |
* @param string $option Option name. |
|
177 |
*/ |
|
178 |
function form_option( $option ) { |
|
179 |
echo esc_attr( get_option( $option ) ); |
|
180 |
} |
|
181 |
||
182 |
/** |
|
183 |
* Loads and caches all autoloaded options, if available or all options. |
|
184 |
* |
|
185 |
* @since 2.2.0 |
|
186 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
187 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
188 |
* |
0 | 189 |
* @return array List of all options. |
190 |
*/ |
|
191 |
function wp_load_alloptions() { |
|
192 |
global $wpdb; |
|
193 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
194 |
if ( ! wp_installing() || ! is_multisite() ) { |
0 | 195 |
$alloptions = wp_cache_get( 'alloptions', 'options' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
196 |
} else { |
0 | 197 |
$alloptions = false; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
198 |
} |
0 | 199 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
200 |
if ( ! $alloptions ) { |
0 | 201 |
$suppress = $wpdb->suppress_errors(); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
202 |
if ( ! $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) ) { |
0 | 203 |
$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
204 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
205 |
$wpdb->suppress_errors( $suppress ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
206 |
|
0 | 207 |
$alloptions = array(); |
208 |
foreach ( (array) $alloptions_db as $o ) { |
|
9 | 209 |
$alloptions[ $o->option_name ] = $o->option_value; |
0 | 210 |
} |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
211 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
212 |
if ( ! wp_installing() || ! is_multisite() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
213 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
214 |
* Filters all options before caching them. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
215 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
216 |
* @since 4.9.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
217 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
218 |
* @param array $alloptions Array with all options. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
219 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
220 |
$alloptions = apply_filters( 'pre_cache_alloptions', $alloptions ); |
0 | 221 |
wp_cache_add( 'alloptions', $alloptions, 'options' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
222 |
} |
0 | 223 |
} |
224 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
225 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
226 |
* Filters all options after retrieving them. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
227 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
228 |
* @since 4.9.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
229 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
230 |
* @param array $alloptions Array with all options. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
231 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
232 |
return apply_filters( 'alloptions', $alloptions ); |
0 | 233 |
} |
234 |
||
235 |
/** |
|
236 |
* Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used. |
|
237 |
* |
|
238 |
* @since 3.0.0 |
|
239 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
240 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
241 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
242 |
* @param int $network_id Optional site ID for which to query the options. Defaults to the current site. |
0 | 243 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
244 |
function wp_load_core_site_options( $network_id = null ) { |
0 | 245 |
global $wpdb; |
246 |
||
9 | 247 |
if ( ! is_multisite() || wp_using_ext_object_cache() || wp_installing() ) { |
0 | 248 |
return; |
9 | 249 |
} |
0 | 250 |
|
9 | 251 |
if ( empty( $network_id ) ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
252 |
$network_id = get_current_network_id(); |
9 | 253 |
} |
0 | 254 |
|
9 | 255 |
$core_options = array( 'site_name', 'siteurl', 'active_sitewide_plugins', '_site_transient_timeout_theme_roots', '_site_transient_theme_roots', 'site_admins', 'can_compress_scripts', 'global_terms_enabled', 'ms_files_rewriting' ); |
256 |
||
257 |
$core_options_in = "'" . implode( "', '", $core_options ) . "'"; |
|
258 |
$options = $wpdb->get_results( $wpdb->prepare( "SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN ($core_options_in) AND site_id = %d", $network_id ) ); |
|
0 | 259 |
|
260 |
foreach ( $options as $option ) { |
|
9 | 261 |
$key = $option->meta_key; |
262 |
$cache_key = "{$network_id}:$key"; |
|
0 | 263 |
$option->meta_value = maybe_unserialize( $option->meta_value ); |
264 |
||
265 |
wp_cache_set( $cache_key, $option->meta_value, 'site-options' ); |
|
266 |
} |
|
267 |
} |
|
268 |
||
269 |
/** |
|
270 |
* Update the value of an option that was already added. |
|
271 |
* |
|
272 |
* You do not need to serialize values. If the value needs to be serialized, then |
|
273 |
* it will be serialized before it is inserted into the database. Remember, |
|
274 |
* resources can not be serialized or added as an option. |
|
275 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
276 |
* If the option does not exist, then the option will be added with the option value, |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
277 |
* with an `$autoload` value of 'yes'. |
0 | 278 |
* |
279 |
* @since 1.0.0 |
|
5 | 280 |
* @since 4.2.0 The `$autoload` parameter was added. |
0 | 281 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
282 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
283 |
* |
5 | 284 |
* @param string $option Option name. Expected to not be SQL-escaped. |
285 |
* @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped. |
|
286 |
* @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. For existing options, |
|
287 |
* `$autoload` can only be updated using `update_option()` if `$value` is also changed. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
288 |
* Accepts 'yes'|true to enable or 'no'|false to disable. For non-existent options, |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
289 |
* the default value is 'yes'. Default null. |
0 | 290 |
* @return bool False if value was not updated and true if value was updated. |
291 |
*/ |
|
5 | 292 |
function update_option( $option, $value, $autoload = null ) { |
0 | 293 |
global $wpdb; |
294 |
||
9 | 295 |
$option = trim( $option ); |
296 |
if ( empty( $option ) ) { |
|
0 | 297 |
return false; |
9 | 298 |
} |
0 | 299 |
|
300 |
wp_protect_special_option( $option ); |
|
301 |
||
9 | 302 |
if ( is_object( $value ) ) { |
0 | 303 |
$value = clone $value; |
9 | 304 |
} |
0 | 305 |
|
9 | 306 |
$value = sanitize_option( $option, $value ); |
0 | 307 |
$old_value = get_option( $option ); |
5 | 308 |
|
309 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
310 |
* Filters a specific option before its value is (maybe) serialized and updated. |
5 | 311 |
* |
312 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
313 |
* |
|
314 |
* @since 2.6.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
315 |
* @since 4.4.0 The `$option` parameter was added. |
5 | 316 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
317 |
* @param mixed $value The new, unserialized option value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
318 |
* @param mixed $old_value The old option value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
319 |
* @param string $option Option name. |
5 | 320 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
321 |
$value = apply_filters( "pre_update_option_{$option}", $value, $old_value, $option ); |
0 | 322 |
|
5 | 323 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
324 |
* Filters an option before its value is (maybe) serialized and updated. |
5 | 325 |
* |
326 |
* @since 3.9.0 |
|
327 |
* |
|
328 |
* @param mixed $value The new, unserialized option value. |
|
329 |
* @param string $option Name of the option. |
|
330 |
* @param mixed $old_value The old option value. |
|
331 |
*/ |
|
332 |
$value = apply_filters( 'pre_update_option', $value, $option, $old_value ); |
|
333 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
334 |
/* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
335 |
* If the new and old values are the same, no need to update. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
336 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
337 |
* Unserialized values will be adequate in most cases. If the unserialized |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
338 |
* data differs, the (maybe) serialized data is checked to avoid |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
339 |
* unnecessary database calls for otherwise identical object instances. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
340 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
341 |
* See https://core.trac.wordpress.org/ticket/38903 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
342 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
343 |
if ( $value === $old_value || maybe_serialize( $value ) === maybe_serialize( $old_value ) ) { |
0 | 344 |
return false; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
345 |
} |
0 | 346 |
|
5 | 347 |
/** This filter is documented in wp-includes/option.php */ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
348 |
if ( apply_filters( "default_option_{$option}", false, $option, false ) === $old_value ) { |
5 | 349 |
// Default setting for new options is 'yes'. |
350 |
if ( null === $autoload ) { |
|
351 |
$autoload = 'yes'; |
|
352 |
} |
|
353 |
||
354 |
return add_option( $option, $value, '', $autoload ); |
|
355 |
} |
|
0 | 356 |
|
357 |
$serialized_value = maybe_serialize( $value ); |
|
358 |
||
5 | 359 |
/** |
360 |
* Fires immediately before an option value is updated. |
|
361 |
* |
|
362 |
* @since 2.9.0 |
|
363 |
* |
|
364 |
* @param string $option Name of the option to update. |
|
365 |
* @param mixed $old_value The old option value. |
|
366 |
* @param mixed $value The new option value. |
|
367 |
*/ |
|
0 | 368 |
do_action( 'update_option', $option, $old_value, $value ); |
5 | 369 |
|
370 |
$update_args = array( |
|
371 |
'option_value' => $serialized_value, |
|
372 |
); |
|
373 |
||
374 |
if ( null !== $autoload ) { |
|
375 |
$update_args['autoload'] = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes'; |
|
376 |
} |
|
377 |
||
378 |
$result = $wpdb->update( $wpdb->options, $update_args, array( 'option_name' => $option ) ); |
|
9 | 379 |
if ( ! $result ) { |
0 | 380 |
return false; |
9 | 381 |
} |
0 | 382 |
|
383 |
$notoptions = wp_cache_get( 'notoptions', 'options' ); |
|
9 | 384 |
if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { |
385 |
unset( $notoptions[ $option ] ); |
|
0 | 386 |
wp_cache_set( 'notoptions', $notoptions, 'options' ); |
387 |
} |
|
388 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
389 |
if ( ! wp_installing() ) { |
0 | 390 |
$alloptions = wp_load_alloptions(); |
9 | 391 |
if ( isset( $alloptions[ $option ] ) ) { |
0 | 392 |
$alloptions[ $option ] = $serialized_value; |
393 |
wp_cache_set( 'alloptions', $alloptions, 'options' ); |
|
394 |
} else { |
|
395 |
wp_cache_set( $option, $serialized_value, 'options' ); |
|
396 |
} |
|
397 |
} |
|
398 |
||
5 | 399 |
/** |
400 |
* Fires after the value of a specific option has been successfully updated. |
|
401 |
* |
|
402 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
403 |
* |
|
404 |
* @since 2.0.1 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
405 |
* @since 4.4.0 The `$option` parameter was added. |
5 | 406 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
407 |
* @param mixed $old_value The old option value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
408 |
* @param mixed $value The new option value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
409 |
* @param string $option Option name. |
5 | 410 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
411 |
do_action( "update_option_{$option}", $old_value, $value, $option ); |
5 | 412 |
|
413 |
/** |
|
414 |
* Fires after the value of an option has been successfully updated. |
|
415 |
* |
|
416 |
* @since 2.9.0 |
|
417 |
* |
|
418 |
* @param string $option Name of the updated option. |
|
419 |
* @param mixed $old_value The old option value. |
|
420 |
* @param mixed $value The new option value. |
|
421 |
*/ |
|
0 | 422 |
do_action( 'updated_option', $option, $old_value, $value ); |
423 |
return true; |
|
424 |
} |
|
425 |
||
426 |
/** |
|
427 |
* Add a new option. |
|
428 |
* |
|
429 |
* You do not need to serialize values. If the value needs to be serialized, then |
|
430 |
* it will be serialized before it is inserted into the database. Remember, |
|
431 |
* resources can not be serialized or added as an option. |
|
432 |
* |
|
433 |
* You can create options without values and then update the values later. |
|
434 |
* Existing options will not be updated and checks are performed to ensure that you |
|
435 |
* aren't adding a protected WordPress option. Care should be taken to not name |
|
436 |
* options the same as the ones which are protected. |
|
437 |
* |
|
438 |
* @since 1.0.0 |
|
439 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
440 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
441 |
* |
5 | 442 |
* @param string $option Name of option to add. Expected to not be SQL-escaped. |
443 |
* @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped. |
|
444 |
* @param string $deprecated Optional. Description. Not used anymore. |
|
445 |
* @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. |
|
446 |
* Default is enabled. Accepts 'no' to disable for legacy reasons. |
|
0 | 447 |
* @return bool False if option was not added and true if option was added. |
448 |
*/ |
|
449 |
function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) { |
|
450 |
global $wpdb; |
|
451 |
||
9 | 452 |
if ( ! empty( $deprecated ) ) { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
453 |
_deprecated_argument( __FUNCTION__, '2.3.0' ); |
9 | 454 |
} |
0 | 455 |
|
9 | 456 |
$option = trim( $option ); |
457 |
if ( empty( $option ) ) { |
|
0 | 458 |
return false; |
9 | 459 |
} |
0 | 460 |
|
461 |
wp_protect_special_option( $option ); |
|
462 |
||
9 | 463 |
if ( is_object( $value ) ) { |
0 | 464 |
$value = clone $value; |
9 | 465 |
} |
0 | 466 |
|
467 |
$value = sanitize_option( $option, $value ); |
|
468 |
||
469 |
// Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query |
|
470 |
$notoptions = wp_cache_get( 'notoptions', 'options' ); |
|
9 | 471 |
if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) { |
5 | 472 |
/** This filter is documented in wp-includes/option.php */ |
9 | 473 |
if ( apply_filters( "default_option_{$option}", false, $option, false ) !== get_option( $option ) ) { |
0 | 474 |
return false; |
9 | 475 |
} |
476 |
} |
|
0 | 477 |
|
478 |
$serialized_value = maybe_serialize( $value ); |
|
9 | 479 |
$autoload = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes'; |
5 | 480 |
|
481 |
/** |
|
482 |
* Fires before an option is added. |
|
483 |
* |
|
484 |
* @since 2.9.0 |
|
485 |
* |
|
486 |
* @param string $option Name of the option to add. |
|
487 |
* @param mixed $value Value of the option. |
|
488 |
*/ |
|
0 | 489 |
do_action( 'add_option', $option, $value ); |
490 |
||
491 |
$result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $serialized_value, $autoload ) ); |
|
9 | 492 |
if ( ! $result ) { |
0 | 493 |
return false; |
9 | 494 |
} |
0 | 495 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
496 |
if ( ! wp_installing() ) { |
0 | 497 |
if ( 'yes' == $autoload ) { |
9 | 498 |
$alloptions = wp_load_alloptions(); |
0 | 499 |
$alloptions[ $option ] = $serialized_value; |
500 |
wp_cache_set( 'alloptions', $alloptions, 'options' ); |
|
501 |
} else { |
|
502 |
wp_cache_set( $option, $serialized_value, 'options' ); |
|
503 |
} |
|
504 |
} |
|
505 |
||
506 |
// This option exists now |
|
507 |
$notoptions = wp_cache_get( 'notoptions', 'options' ); // yes, again... we need it to be fresh |
|
9 | 508 |
if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { |
509 |
unset( $notoptions[ $option ] ); |
|
0 | 510 |
wp_cache_set( 'notoptions', $notoptions, 'options' ); |
511 |
} |
|
512 |
||
5 | 513 |
/** |
514 |
* Fires after a specific option has been added. |
|
515 |
* |
|
516 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
517 |
* |
|
518 |
* @since 2.5.0 As "add_option_{$name}" |
|
519 |
* @since 3.0.0 |
|
520 |
* |
|
521 |
* @param string $option Name of the option to add. |
|
522 |
* @param mixed $value Value of the option. |
|
523 |
*/ |
|
0 | 524 |
do_action( "add_option_{$option}", $option, $value ); |
5 | 525 |
|
526 |
/** |
|
527 |
* Fires after an option has been added. |
|
528 |
* |
|
529 |
* @since 2.9.0 |
|
530 |
* |
|
531 |
* @param string $option Name of the added option. |
|
532 |
* @param mixed $value Value of the option. |
|
533 |
*/ |
|
0 | 534 |
do_action( 'added_option', $option, $value ); |
535 |
return true; |
|
536 |
} |
|
537 |
||
538 |
/** |
|
539 |
* Removes option by name. Prevents removal of protected WordPress options. |
|
540 |
* |
|
541 |
* @since 1.2.0 |
|
542 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
543 |
* @global wpdb $wpdb WordPress database abstraction object. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
544 |
* |
0 | 545 |
* @param string $option Name of option to remove. Expected to not be SQL-escaped. |
546 |
* @return bool True, if option is successfully deleted. False on failure. |
|
547 |
*/ |
|
548 |
function delete_option( $option ) { |
|
549 |
global $wpdb; |
|
550 |
||
551 |
$option = trim( $option ); |
|
9 | 552 |
if ( empty( $option ) ) { |
0 | 553 |
return false; |
9 | 554 |
} |
0 | 555 |
|
556 |
wp_protect_special_option( $option ); |
|
557 |
||
558 |
// Get the ID, if no ID then return |
|
559 |
$row = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $option ) ); |
|
9 | 560 |
if ( is_null( $row ) ) { |
0 | 561 |
return false; |
9 | 562 |
} |
5 | 563 |
|
564 |
/** |
|
565 |
* Fires immediately before an option is deleted. |
|
566 |
* |
|
567 |
* @since 2.9.0 |
|
568 |
* |
|
569 |
* @param string $option Name of the option to delete. |
|
570 |
*/ |
|
0 | 571 |
do_action( 'delete_option', $option ); |
5 | 572 |
|
0 | 573 |
$result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
574 |
if ( ! wp_installing() ) { |
0 | 575 |
if ( 'yes' == $row->autoload ) { |
576 |
$alloptions = wp_load_alloptions(); |
|
9 | 577 |
if ( is_array( $alloptions ) && isset( $alloptions[ $option ] ) ) { |
578 |
unset( $alloptions[ $option ] ); |
|
0 | 579 |
wp_cache_set( 'alloptions', $alloptions, 'options' ); |
580 |
} |
|
581 |
} else { |
|
582 |
wp_cache_delete( $option, 'options' ); |
|
583 |
} |
|
584 |
} |
|
585 |
if ( $result ) { |
|
5 | 586 |
|
587 |
/** |
|
588 |
* Fires after a specific option has been deleted. |
|
589 |
* |
|
590 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
591 |
* |
|
592 |
* @since 3.0.0 |
|
593 |
* |
|
594 |
* @param string $option Name of the deleted option. |
|
595 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
596 |
do_action( "delete_option_{$option}", $option ); |
5 | 597 |
|
598 |
/** |
|
599 |
* Fires after an option has been deleted. |
|
600 |
* |
|
601 |
* @since 2.9.0 |
|
602 |
* |
|
603 |
* @param string $option Name of the deleted option. |
|
604 |
*/ |
|
0 | 605 |
do_action( 'deleted_option', $option ); |
606 |
return true; |
|
607 |
} |
|
608 |
return false; |
|
609 |
} |
|
610 |
||
611 |
/** |
|
612 |
* Delete a transient. |
|
613 |
* |
|
614 |
* @since 2.8.0 |
|
615 |
* |
|
616 |
* @param string $transient Transient name. Expected to not be SQL-escaped. |
|
617 |
* @return bool true if successful, false otherwise |
|
618 |
*/ |
|
619 |
function delete_transient( $transient ) { |
|
5 | 620 |
|
621 |
/** |
|
622 |
* Fires immediately before a specific transient is deleted. |
|
623 |
* |
|
624 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
625 |
* |
|
626 |
* @since 3.0.0 |
|
627 |
* |
|
628 |
* @param string $transient Transient name. |
|
629 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
630 |
do_action( "delete_transient_{$transient}", $transient ); |
0 | 631 |
|
632 |
if ( wp_using_ext_object_cache() ) { |
|
633 |
$result = wp_cache_delete( $transient, 'transient' ); |
|
634 |
} else { |
|
635 |
$option_timeout = '_transient_timeout_' . $transient; |
|
9 | 636 |
$option = '_transient_' . $transient; |
637 |
$result = delete_option( $option ); |
|
638 |
if ( $result ) { |
|
0 | 639 |
delete_option( $option_timeout ); |
9 | 640 |
} |
0 | 641 |
} |
642 |
||
5 | 643 |
if ( $result ) { |
644 |
||
645 |
/** |
|
646 |
* Fires after a transient is deleted. |
|
647 |
* |
|
648 |
* @since 3.0.0 |
|
649 |
* |
|
650 |
* @param string $transient Deleted transient name. |
|
651 |
*/ |
|
0 | 652 |
do_action( 'deleted_transient', $transient ); |
5 | 653 |
} |
654 |
||
0 | 655 |
return $result; |
656 |
} |
|
657 |
||
658 |
/** |
|
659 |
* Get the value of a transient. |
|
660 |
* |
|
5 | 661 |
* If the transient does not exist, does not have a value, or has expired, |
662 |
* then the return value will be false. |
|
0 | 663 |
* |
664 |
* @since 2.8.0 |
|
665 |
* |
|
5 | 666 |
* @param string $transient Transient name. Expected to not be SQL-escaped. |
667 |
* @return mixed Value of transient. |
|
0 | 668 |
*/ |
669 |
function get_transient( $transient ) { |
|
5 | 670 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
671 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
672 |
* Filters the value of an existing transient. |
5 | 673 |
* |
674 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
675 |
* |
|
676 |
* Passing a truthy value to the filter will effectively short-circuit retrieval |
|
677 |
* of the transient, returning the passed value instead. |
|
678 |
* |
|
679 |
* @since 2.8.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
680 |
* @since 4.4.0 The `$transient` parameter was added |
5 | 681 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
682 |
* @param mixed $pre_transient The default value to return if the transient does not exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
683 |
* Any value other than false will short-circuit the retrieval |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
684 |
* of the transient, and return the returned value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
685 |
* @param string $transient Transient name. |
5 | 686 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
687 |
$pre = apply_filters( "pre_transient_{$transient}", false, $transient ); |
9 | 688 |
if ( false !== $pre ) { |
0 | 689 |
return $pre; |
9 | 690 |
} |
0 | 691 |
|
692 |
if ( wp_using_ext_object_cache() ) { |
|
693 |
$value = wp_cache_get( $transient, 'transient' ); |
|
694 |
} else { |
|
695 |
$transient_option = '_transient_' . $transient; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
696 |
if ( ! wp_installing() ) { |
0 | 697 |
// If option is not in alloptions, it is not autoloaded and thus has a timeout |
698 |
$alloptions = wp_load_alloptions(); |
|
9 | 699 |
if ( ! isset( $alloptions[ $transient_option ] ) ) { |
0 | 700 |
$transient_timeout = '_transient_timeout_' . $transient; |
9 | 701 |
$timeout = get_option( $transient_timeout ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
702 |
if ( false !== $timeout && $timeout < time() ) { |
9 | 703 |
delete_option( $transient_option ); |
0 | 704 |
delete_option( $transient_timeout ); |
705 |
$value = false; |
|
706 |
} |
|
707 |
} |
|
708 |
} |
|
709 |
||
9 | 710 |
if ( ! isset( $value ) ) { |
0 | 711 |
$value = get_option( $transient_option ); |
9 | 712 |
} |
0 | 713 |
} |
714 |
||
5 | 715 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
716 |
* Filters an existing transient's value. |
5 | 717 |
* |
718 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
719 |
* |
|
720 |
* @since 2.8.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
721 |
* @since 4.4.0 The `$transient` parameter was added |
5 | 722 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
723 |
* @param mixed $value Value of transient. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
724 |
* @param string $transient Transient name. |
5 | 725 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
726 |
return apply_filters( "transient_{$transient}", $value, $transient ); |
0 | 727 |
} |
728 |
||
729 |
/** |
|
730 |
* Set/update the value of a transient. |
|
731 |
* |
|
732 |
* You do not need to serialize values. If the value needs to be serialized, then |
|
733 |
* it will be serialized before it is set. |
|
734 |
* |
|
735 |
* @since 2.8.0 |
|
736 |
* |
|
5 | 737 |
* @param string $transient Transient name. Expected to not be SQL-escaped. Must be |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
738 |
* 172 characters or fewer in length. |
5 | 739 |
* @param mixed $value Transient value. Must be serializable if non-scalar. |
740 |
* Expected to not be SQL-escaped. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
741 |
* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration). |
0 | 742 |
* @return bool False if value was not set and true if value was set. |
743 |
*/ |
|
744 |
function set_transient( $transient, $value, $expiration = 0 ) { |
|
5 | 745 |
|
0 | 746 |
$expiration = (int) $expiration; |
747 |
||
5 | 748 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
749 |
* Filters a specific transient before its value is set. |
5 | 750 |
* |
751 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
752 |
* |
|
753 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
754 |
* @since 4.2.0 The `$expiration` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
755 |
* @since 4.4.0 The `$transient` parameter was added. |
5 | 756 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
757 |
* @param mixed $value New value of transient. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
758 |
* @param int $expiration Time until expiration in seconds. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
759 |
* @param string $transient Transient name. |
5 | 760 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
761 |
$value = apply_filters( "pre_set_transient_{$transient}", $value, $expiration, $transient ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
762 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
763 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
764 |
* Filters the expiration for a transient before its value is set. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
765 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
766 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
767 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
768 |
* @since 4.4.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
769 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
770 |
* @param int $expiration Time until expiration in seconds. Use 0 for no expiration. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
771 |
* @param mixed $value New value of transient. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
772 |
* @param string $transient Transient name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
773 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
774 |
$expiration = apply_filters( "expiration_of_transient_{$transient}", $expiration, $value, $transient ); |
5 | 775 |
|
0 | 776 |
if ( wp_using_ext_object_cache() ) { |
777 |
$result = wp_cache_set( $transient, $value, 'transient', $expiration ); |
|
778 |
} else { |
|
779 |
$transient_timeout = '_transient_timeout_' . $transient; |
|
9 | 780 |
$transient_option = '_transient_' . $transient; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
781 |
if ( false === get_option( $transient_option ) ) { |
0 | 782 |
$autoload = 'yes'; |
783 |
if ( $expiration ) { |
|
784 |
$autoload = 'no'; |
|
785 |
add_option( $transient_timeout, time() + $expiration, '', 'no' ); |
|
786 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
787 |
$result = add_option( $transient_option, $value, '', $autoload ); |
0 | 788 |
} else { |
5 | 789 |
// If expiration is requested, but the transient has no timeout option, |
790 |
// delete, then re-create transient rather than update. |
|
791 |
$update = true; |
|
792 |
if ( $expiration ) { |
|
793 |
if ( false === get_option( $transient_timeout ) ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
794 |
delete_option( $transient_option ); |
5 | 795 |
add_option( $transient_timeout, time() + $expiration, '', 'no' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
796 |
$result = add_option( $transient_option, $value, '', 'no' ); |
5 | 797 |
$update = false; |
798 |
} else { |
|
799 |
update_option( $transient_timeout, time() + $expiration ); |
|
800 |
} |
|
801 |
} |
|
802 |
if ( $update ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
803 |
$result = update_option( $transient_option, $value ); |
5 | 804 |
} |
0 | 805 |
} |
806 |
} |
|
5 | 807 |
|
0 | 808 |
if ( $result ) { |
5 | 809 |
|
810 |
/** |
|
811 |
* Fires after the value for a specific transient has been set. |
|
812 |
* |
|
813 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
814 |
* |
|
815 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
816 |
* @since 3.6.0 The `$value` and `$expiration` parameters were added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
817 |
* @since 4.4.0 The `$transient` parameter was added. |
5 | 818 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
819 |
* @param mixed $value Transient value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
820 |
* @param int $expiration Time until expiration in seconds. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
821 |
* @param string $transient The name of the transient. |
5 | 822 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
823 |
do_action( "set_transient_{$transient}", $value, $expiration, $transient ); |
5 | 824 |
|
825 |
/** |
|
826 |
* Fires after the value for a transient has been set. |
|
827 |
* |
|
828 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
829 |
* @since 3.6.0 The `$value` and `$expiration` parameters were added. |
5 | 830 |
* |
831 |
* @param string $transient The name of the transient. |
|
832 |
* @param mixed $value Transient value. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
833 |
* @param int $expiration Time until expiration in seconds. |
5 | 834 |
*/ |
0 | 835 |
do_action( 'setted_transient', $transient, $value, $expiration ); |
836 |
} |
|
837 |
return $result; |
|
838 |
} |
|
839 |
||
840 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
841 |
* Deletes all expired transients. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
842 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
843 |
* The multi-table delete syntax is used to delete the transient record |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
844 |
* from table a, and the corresponding transient_timeout record from table b. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
845 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
846 |
* @since 4.9.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
847 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
848 |
* @param bool $force_db Optional. Force cleanup to run against the database even when an external object cache is used. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
849 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
850 |
function delete_expired_transients( $force_db = false ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
851 |
global $wpdb; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
852 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
853 |
if ( ! $force_db && wp_using_ext_object_cache() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
854 |
return; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
855 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
856 |
|
9 | 857 |
$wpdb->query( |
858 |
$wpdb->prepare( |
|
859 |
"DELETE a, b FROM {$wpdb->options} a, {$wpdb->options} b |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
860 |
WHERE a.option_name LIKE %s |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
861 |
AND a.option_name NOT LIKE %s |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
862 |
AND b.option_name = CONCAT( '_transient_timeout_', SUBSTRING( a.option_name, 12 ) ) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
863 |
AND b.option_value < %d", |
9 | 864 |
$wpdb->esc_like( '_transient_' ) . '%', |
865 |
$wpdb->esc_like( '_transient_timeout_' ) . '%', |
|
866 |
time() |
|
867 |
) |
|
868 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
869 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
870 |
if ( ! is_multisite() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
871 |
// non-Multisite stores site transients in the options table. |
9 | 872 |
$wpdb->query( |
873 |
$wpdb->prepare( |
|
874 |
"DELETE a, b FROM {$wpdb->options} a, {$wpdb->options} b |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
875 |
WHERE a.option_name LIKE %s |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
876 |
AND a.option_name NOT LIKE %s |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
877 |
AND b.option_name = CONCAT( '_site_transient_timeout_', SUBSTRING( a.option_name, 17 ) ) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
878 |
AND b.option_value < %d", |
9 | 879 |
$wpdb->esc_like( '_site_transient_' ) . '%', |
880 |
$wpdb->esc_like( '_site_transient_timeout_' ) . '%', |
|
881 |
time() |
|
882 |
) |
|
883 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
884 |
} elseif ( is_multisite() && is_main_site() && is_main_network() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
885 |
// Multisite stores site transients in the sitemeta table. |
9 | 886 |
$wpdb->query( |
887 |
$wpdb->prepare( |
|
888 |
"DELETE a, b FROM {$wpdb->sitemeta} a, {$wpdb->sitemeta} b |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
889 |
WHERE a.meta_key LIKE %s |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
890 |
AND a.meta_key NOT LIKE %s |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
891 |
AND b.meta_key = CONCAT( '_site_transient_timeout_', SUBSTRING( a.meta_key, 17 ) ) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
892 |
AND b.meta_value < %d", |
9 | 893 |
$wpdb->esc_like( '_site_transient_' ) . '%', |
894 |
$wpdb->esc_like( '_site_transient_timeout_' ) . '%', |
|
895 |
time() |
|
896 |
) |
|
897 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
898 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
899 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
900 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
901 |
/** |
0 | 902 |
* Saves and restores user interface settings stored in a cookie. |
903 |
* |
|
904 |
* Checks if the current user-settings cookie is updated and stores it. When no |
|
905 |
* cookie exists (different browser used), adds the last saved cookie restoring |
|
906 |
* the settings. |
|
907 |
* |
|
908 |
* @since 2.7.0 |
|
909 |
*/ |
|
910 |
function wp_user_settings() { |
|
911 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
912 |
if ( ! is_admin() || wp_doing_ajax() ) { |
0 | 913 |
return; |
5 | 914 |
} |
0 | 915 |
|
5 | 916 |
if ( ! $user_id = get_current_user_id() ) { |
0 | 917 |
return; |
5 | 918 |
} |
0 | 919 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
920 |
if ( ! is_user_member_of_blog() ) { |
0 | 921 |
return; |
5 | 922 |
} |
0 | 923 |
|
924 |
$settings = (string) get_user_option( 'user-settings', $user_id ); |
|
925 |
||
9 | 926 |
if ( isset( $_COOKIE[ 'wp-settings-' . $user_id ] ) ) { |
927 |
$cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE[ 'wp-settings-' . $user_id ] ); |
|
0 | 928 |
|
929 |
// No change or both empty |
|
9 | 930 |
if ( $cookie == $settings ) { |
0 | 931 |
return; |
9 | 932 |
} |
0 | 933 |
|
934 |
$last_saved = (int) get_user_option( 'user-settings-time', $user_id ); |
|
9 | 935 |
$current = isset( $_COOKIE[ 'wp-settings-time-' . $user_id ] ) ? preg_replace( '/[^0-9]/', '', $_COOKIE[ 'wp-settings-time-' . $user_id ] ) : 0; |
0 | 936 |
|
937 |
// The cookie is newer than the saved value. Update the user_option and leave the cookie as-is |
|
938 |
if ( $current > $last_saved ) { |
|
939 |
update_user_option( $user_id, 'user-settings', $cookie, false ); |
|
940 |
update_user_option( $user_id, 'user-settings-time', time() - 5, false ); |
|
941 |
return; |
|
942 |
} |
|
943 |
} |
|
944 |
||
945 |
// The cookie is not set in the current browser or the saved value is newer. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
946 |
$secure = ( 'https' === parse_url( admin_url(), PHP_URL_SCHEME ) ); |
5 | 947 |
setcookie( 'wp-settings-' . $user_id, $settings, time() + YEAR_IN_SECONDS, SITECOOKIEPATH, null, $secure ); |
948 |
setcookie( 'wp-settings-time-' . $user_id, time(), time() + YEAR_IN_SECONDS, SITECOOKIEPATH, null, $secure ); |
|
9 | 949 |
$_COOKIE[ 'wp-settings-' . $user_id ] = $settings; |
0 | 950 |
} |
951 |
||
952 |
/** |
|
953 |
* Retrieve user interface setting value based on setting name. |
|
954 |
* |
|
955 |
* @since 2.7.0 |
|
956 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
957 |
* @param string $name The name of the setting. |
0 | 958 |
* @param string $default Optional default value to return when $name is not set. |
959 |
* @return mixed the last saved user setting or the default value/false if it doesn't exist. |
|
960 |
*/ |
|
961 |
function get_user_setting( $name, $default = false ) { |
|
962 |
$all_user_settings = get_all_user_settings(); |
|
963 |
||
9 | 964 |
return isset( $all_user_settings[ $name ] ) ? $all_user_settings[ $name ] : $default; |
0 | 965 |
} |
966 |
||
967 |
/** |
|
968 |
* Add or update user interface setting. |
|
969 |
* |
|
970 |
* Both $name and $value can contain only ASCII letters, numbers and underscores. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
971 |
* |
0 | 972 |
* This function has to be used before any output has started as it calls setcookie(). |
973 |
* |
|
974 |
* @since 2.8.0 |
|
975 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
976 |
* @param string $name The name of the setting. |
0 | 977 |
* @param string $value The value for the setting. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
978 |
* @return bool|null True if set successfully, false if not. Null if the current user can't be established. |
0 | 979 |
*/ |
980 |
function set_user_setting( $name, $value ) { |
|
5 | 981 |
if ( headers_sent() ) { |
0 | 982 |
return false; |
5 | 983 |
} |
0 | 984 |
|
9 | 985 |
$all_user_settings = get_all_user_settings(); |
986 |
$all_user_settings[ $name ] = $value; |
|
0 | 987 |
|
988 |
return wp_set_all_user_settings( $all_user_settings ); |
|
989 |
} |
|
990 |
||
991 |
/** |
|
992 |
* Delete user interface settings. |
|
993 |
* |
|
994 |
* Deleting settings would reset them to the defaults. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
995 |
* |
0 | 996 |
* This function has to be used before any output has started as it calls setcookie(). |
997 |
* |
|
998 |
* @since 2.7.0 |
|
999 |
* |
|
5 | 1000 |
* @param string $names The name or array of names of the setting to be deleted. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1001 |
* @return bool|null True if deleted successfully, false if not. Null if the current user can't be established. |
0 | 1002 |
*/ |
1003 |
function delete_user_setting( $names ) { |
|
5 | 1004 |
if ( headers_sent() ) { |
0 | 1005 |
return false; |
5 | 1006 |
} |
0 | 1007 |
|
1008 |
$all_user_settings = get_all_user_settings(); |
|
9 | 1009 |
$names = (array) $names; |
1010 |
$deleted = false; |
|
0 | 1011 |
|
1012 |
foreach ( $names as $name ) { |
|
9 | 1013 |
if ( isset( $all_user_settings[ $name ] ) ) { |
1014 |
unset( $all_user_settings[ $name ] ); |
|
0 | 1015 |
$deleted = true; |
1016 |
} |
|
1017 |
} |
|
1018 |
||
5 | 1019 |
if ( $deleted ) { |
0 | 1020 |
return wp_set_all_user_settings( $all_user_settings ); |
5 | 1021 |
} |
0 | 1022 |
|
1023 |
return false; |
|
1024 |
} |
|
1025 |
||
1026 |
/** |
|
1027 |
* Retrieve all user interface settings. |
|
1028 |
* |
|
1029 |
* @since 2.7.0 |
|
1030 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1031 |
* @global array $_updated_user_settings |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1032 |
* |
0 | 1033 |
* @return array the last saved user settings or empty array. |
1034 |
*/ |
|
1035 |
function get_all_user_settings() { |
|
1036 |
global $_updated_user_settings; |
|
1037 |
||
5 | 1038 |
if ( ! $user_id = get_current_user_id() ) { |
0 | 1039 |
return array(); |
5 | 1040 |
} |
0 | 1041 |
|
5 | 1042 |
if ( isset( $_updated_user_settings ) && is_array( $_updated_user_settings ) ) { |
0 | 1043 |
return $_updated_user_settings; |
5 | 1044 |
} |
0 | 1045 |
|
1046 |
$user_settings = array(); |
|
5 | 1047 |
|
9 | 1048 |
if ( isset( $_COOKIE[ 'wp-settings-' . $user_id ] ) ) { |
1049 |
$cookie = preg_replace( '/[^A-Za-z0-9=&_-]/', '', $_COOKIE[ 'wp-settings-' . $user_id ] ); |
|
0 | 1050 |
|
5 | 1051 |
if ( strpos( $cookie, '=' ) ) { // '=' cannot be 1st char |
0 | 1052 |
parse_str( $cookie, $user_settings ); |
5 | 1053 |
} |
0 | 1054 |
} else { |
1055 |
$option = get_user_option( 'user-settings', $user_id ); |
|
5 | 1056 |
|
1057 |
if ( $option && is_string( $option ) ) { |
|
0 | 1058 |
parse_str( $option, $user_settings ); |
5 | 1059 |
} |
0 | 1060 |
} |
1061 |
||
1062 |
$_updated_user_settings = $user_settings; |
|
1063 |
return $user_settings; |
|
1064 |
} |
|
1065 |
||
1066 |
/** |
|
1067 |
* Private. Set all user interface settings. |
|
1068 |
* |
|
1069 |
* @since 2.8.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1070 |
* @access private |
0 | 1071 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1072 |
* @global array $_updated_user_settings |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1073 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1074 |
* @param array $user_settings User settings. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1075 |
* @return bool|null False if the current user can't be found, null if the current |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1076 |
* user is not a super admin or a member of the site, otherwise true. |
0 | 1077 |
*/ |
1078 |
function wp_set_all_user_settings( $user_settings ) { |
|
1079 |
global $_updated_user_settings; |
|
1080 |
||
5 | 1081 |
if ( ! $user_id = get_current_user_id() ) { |
0 | 1082 |
return false; |
5 | 1083 |
} |
0 | 1084 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1085 |
if ( ! is_user_member_of_blog() ) { |
0 | 1086 |
return; |
5 | 1087 |
} |
0 | 1088 |
|
1089 |
$settings = ''; |
|
1090 |
foreach ( $user_settings as $name => $value ) { |
|
9 | 1091 |
$_name = preg_replace( '/[^A-Za-z0-9_-]+/', '', $name ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1092 |
$_value = preg_replace( '/[^A-Za-z0-9_-]+/', '', $value ); |
0 | 1093 |
|
5 | 1094 |
if ( ! empty( $_name ) ) { |
0 | 1095 |
$settings .= $_name . '=' . $_value . '&'; |
5 | 1096 |
} |
0 | 1097 |
} |
1098 |
||
5 | 1099 |
$settings = rtrim( $settings, '&' ); |
0 | 1100 |
parse_str( $settings, $_updated_user_settings ); |
1101 |
||
1102 |
update_user_option( $user_id, 'user-settings', $settings, false ); |
|
1103 |
update_user_option( $user_id, 'user-settings-time', time(), false ); |
|
1104 |
||
1105 |
return true; |
|
1106 |
} |
|
1107 |
||
1108 |
/** |
|
1109 |
* Delete the user settings of the current user. |
|
1110 |
* |
|
1111 |
* @since 2.7.0 |
|
1112 |
*/ |
|
1113 |
function delete_all_user_settings() { |
|
5 | 1114 |
if ( ! $user_id = get_current_user_id() ) { |
0 | 1115 |
return; |
5 | 1116 |
} |
0 | 1117 |
|
1118 |
update_user_option( $user_id, 'user-settings', '', false ); |
|
5 | 1119 |
setcookie( 'wp-settings-' . $user_id, ' ', time() - YEAR_IN_SECONDS, SITECOOKIEPATH ); |
0 | 1120 |
} |
1121 |
||
1122 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1123 |
* Retrieve an option value for the current network based on name of option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1124 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1125 |
* @since 2.8.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1126 |
* @since 4.4.0 The `$use_cache` parameter was deprecated. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1127 |
* @since 4.4.0 Modified into wrapper for get_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1128 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1129 |
* @see get_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1130 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1131 |
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1132 |
* @param mixed $default Optional value to return if option doesn't exist. Default false. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1133 |
* @param bool $deprecated Whether to use cache. Multisite only. Always set to true. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1134 |
* @return mixed Value set for the option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1135 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1136 |
function get_site_option( $option, $default = false, $deprecated = true ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1137 |
return get_network_option( null, $option, $default ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1138 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1139 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1140 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1141 |
* Add a new option for the current network. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1142 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1143 |
* Existing options will not be updated. Note that prior to 3.3 this wasn't the case. |
0 | 1144 |
* |
1145 |
* @since 2.8.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1146 |
* @since 4.4.0 Modified into wrapper for add_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1147 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1148 |
* @see add_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1149 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1150 |
* @param string $option Name of option to add. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1151 |
* @param mixed $value Option value, can be anything. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1152 |
* @return bool False if the option was not added. True if the option was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1153 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1154 |
function add_site_option( $option, $value ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1155 |
return add_network_option( null, $option, $value ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1156 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1157 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1158 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1159 |
* Removes a option by name for the current network. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1160 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1161 |
* @since 2.8.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1162 |
* @since 4.4.0 Modified into wrapper for delete_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1163 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1164 |
* @see delete_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1165 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1166 |
* @param string $option Name of option to remove. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1167 |
* @return bool True, if succeed. False, if failure. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1168 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1169 |
function delete_site_option( $option ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1170 |
return delete_network_option( null, $option ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1171 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1172 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1173 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1174 |
* Update the value of an option that was already added for the current network. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1175 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1176 |
* @since 2.8.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1177 |
* @since 4.4.0 Modified into wrapper for update_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1178 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1179 |
* @see update_network_option() |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1180 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1181 |
* @param string $option Name of option. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1182 |
* @param mixed $value Option value. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1183 |
* @return bool False if value was not updated. True if value was updated. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1184 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1185 |
function update_site_option( $option, $value ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1186 |
return update_network_option( null, $option, $value ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1187 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1188 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1189 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1190 |
* Retrieve a network's option value based on the option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1191 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1192 |
* @since 4.4.0 |
0 | 1193 |
* |
5 | 1194 |
* @see get_option() |
0 | 1195 |
* |
9 | 1196 |
* @global wpdb $wpdb WordPress database abstraction object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1197 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1198 |
* @param int $network_id ID of the network. Can be null to default to the current network ID. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1199 |
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1200 |
* @param mixed $default Optional. Value to return if the option doesn't exist. Default false. |
0 | 1201 |
* @return mixed Value set for the option. |
1202 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1203 |
function get_network_option( $network_id, $option, $default = false ) { |
0 | 1204 |
global $wpdb; |
1205 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1206 |
if ( $network_id && ! is_numeric( $network_id ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1207 |
return false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1208 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1209 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1210 |
$network_id = (int) $network_id; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1211 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1212 |
// Fallback to the current network if a network ID is not specified. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1213 |
if ( ! $network_id ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1214 |
$network_id = get_current_network_id(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1215 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1216 |
|
5 | 1217 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1218 |
* Filters an existing network option before it is retrieved. |
5 | 1219 |
* |
1220 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1221 |
* |
|
1222 |
* Passing a truthy value to the filter will effectively short-circuit retrieval, |
|
1223 |
* returning the passed value instead. |
|
1224 |
* |
|
1225 |
* @since 2.9.0 As 'pre_site_option_' . $key |
|
1226 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1227 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1228 |
* @since 4.7.0 The `$network_id` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1229 |
* @since 4.9.0 The `$default` parameter was added. |
5 | 1230 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1231 |
* @param mixed $pre_option The value to return instead of the option value. This differs from |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1232 |
* `$default`, which is used as the fallback value in the event the |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1233 |
* option doesn't exist elsewhere in get_network_option(). Default |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1234 |
* is false (to skip past the short-circuit). |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1235 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1236 |
* @param int $network_id ID of the network. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1237 |
* @param mixed $default The fallback value to return if the option does not exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1238 |
* Default is false. |
5 | 1239 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1240 |
$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default ); |
5 | 1241 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1242 |
if ( false !== $pre ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1243 |
return $pre; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1244 |
} |
0 | 1245 |
|
1246 |
// prevent non-existent options from triggering multiple queries |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1247 |
$notoptions_key = "$network_id:notoptions"; |
9 | 1248 |
$notoptions = wp_cache_get( $notoptions_key, 'site-options' ); |
5 | 1249 |
|
9 | 1250 |
if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { |
5 | 1251 |
|
1252 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1253 |
* Filters a specific default network option. |
5 | 1254 |
* |
1255 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1256 |
* |
|
1257 |
* @since 3.4.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1258 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1259 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1260 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1261 |
* @param mixed $default The value to return if the site option does not exist |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1262 |
* in the database. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1263 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1264 |
* @param int $network_id ID of the network. |
5 | 1265 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1266 |
return apply_filters( "default_site_option_{$option}", $default, $option, $network_id ); |
5 | 1267 |
} |
0 | 1268 |
|
1269 |
if ( ! is_multisite() ) { |
|
5 | 1270 |
/** This filter is documented in wp-includes/option.php */ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1271 |
$default = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id ); |
9 | 1272 |
$value = get_option( $option, $default ); |
0 | 1273 |
} else { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1274 |
$cache_key = "$network_id:$option"; |
9 | 1275 |
$value = wp_cache_get( $cache_key, 'site-options' ); |
0 | 1276 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1277 |
if ( ! isset( $value ) || false === $value ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1278 |
$row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_value FROM $wpdb->sitemeta WHERE meta_key = %s AND site_id = %d", $option, $network_id ) ); |
0 | 1279 |
|
1280 |
// Has to be get_row instead of get_var because of funkiness with 0, false, null values |
|
1281 |
if ( is_object( $row ) ) { |
|
1282 |
$value = $row->meta_value; |
|
1283 |
$value = maybe_unserialize( $value ); |
|
1284 |
wp_cache_set( $cache_key, $value, 'site-options' ); |
|
1285 |
} else { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1286 |
if ( ! is_array( $notoptions ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1287 |
$notoptions = array(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1288 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1289 |
$notoptions[ $option ] = true; |
5 | 1290 |
wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); |
1291 |
||
1292 |
/** This filter is documented in wp-includes/option.php */ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1293 |
$value = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id ); |
0 | 1294 |
} |
1295 |
} |
|
1296 |
} |
|
1297 |
||
9 | 1298 |
if ( ! is_array( $notoptions ) ) { |
1299 |
$notoptions = array(); |
|
1300 |
wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); |
|
1301 |
} |
|
1302 |
||
5 | 1303 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1304 |
* Filters the value of an existing network option. |
5 | 1305 |
* |
1306 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1307 |
* |
|
1308 |
* @since 2.9.0 As 'site_option_' . $key |
|
1309 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1310 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1311 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1312 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1313 |
* @param mixed $value Value of network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1314 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1315 |
* @param int $network_id ID of the network. |
5 | 1316 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1317 |
return apply_filters( "site_option_{$option}", $value, $option, $network_id ); |
0 | 1318 |
} |
1319 |
||
1320 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1321 |
* Add a new network option. |
0 | 1322 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1323 |
* Existing options will not be updated. |
0 | 1324 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1325 |
* @since 4.4.0 |
0 | 1326 |
* |
5 | 1327 |
* @see add_option() |
0 | 1328 |
* |
9 | 1329 |
* @global wpdb $wpdb WordPress database abstraction object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1330 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1331 |
* @param int $network_id ID of the network. Can be null to default to the current network ID. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1332 |
* @param string $option Name of option to add. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1333 |
* @param mixed $value Option value, can be anything. Expected to not be SQL-escaped. |
0 | 1334 |
* @return bool False if option was not added and true if option was added. |
1335 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1336 |
function add_network_option( $network_id, $option, $value ) { |
0 | 1337 |
global $wpdb; |
1338 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1339 |
if ( $network_id && ! is_numeric( $network_id ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1340 |
return false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1341 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1342 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1343 |
$network_id = (int) $network_id; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1344 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1345 |
// Fallback to the current network if a network ID is not specified. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1346 |
if ( ! $network_id ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1347 |
$network_id = get_current_network_id(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1348 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1349 |
|
0 | 1350 |
wp_protect_special_option( $option ); |
1351 |
||
5 | 1352 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1353 |
* Filters the value of a specific network option before it is added. |
5 | 1354 |
* |
1355 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1356 |
* |
|
1357 |
* @since 2.9.0 As 'pre_add_site_option_' . $key |
|
1358 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1359 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1360 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1361 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1362 |
* @param mixed $value Value of network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1363 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1364 |
* @param int $network_id ID of the network. |
5 | 1365 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1366 |
$value = apply_filters( "pre_add_site_option_{$option}", $value, $option, $network_id ); |
0 | 1367 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1368 |
$notoptions_key = "$network_id:notoptions"; |
5 | 1369 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1370 |
if ( ! is_multisite() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1371 |
$result = add_option( $option, $value, '', 'no' ); |
0 | 1372 |
} else { |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1373 |
$cache_key = "$network_id:$option"; |
0 | 1374 |
|
1375 |
// Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query |
|
5 | 1376 |
$notoptions = wp_cache_get( $notoptions_key, 'site-options' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1377 |
if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1378 |
if ( false !== get_network_option( $network_id, $option, false ) ) { |
0 | 1379 |
return false; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1380 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1381 |
} |
0 | 1382 |
|
1383 |
$value = sanitize_option( $option, $value ); |
|
1384 |
||
1385 |
$serialized_value = maybe_serialize( $value ); |
|
9 | 1386 |
$result = $wpdb->insert( |
1387 |
$wpdb->sitemeta, |
|
1388 |
array( |
|
1389 |
'site_id' => $network_id, |
|
1390 |
'meta_key' => $option, |
|
1391 |
'meta_value' => $serialized_value, |
|
1392 |
) |
|
1393 |
); |
|
0 | 1394 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1395 |
if ( ! $result ) { |
0 | 1396 |
return false; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1397 |
} |
0 | 1398 |
|
1399 |
wp_cache_set( $cache_key, $value, 'site-options' ); |
|
1400 |
||
1401 |
// This option exists now |
|
5 | 1402 |
$notoptions = wp_cache_get( $notoptions_key, 'site-options' ); // yes, again... we need it to be fresh |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1403 |
if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1404 |
unset( $notoptions[ $option ] ); |
5 | 1405 |
wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); |
0 | 1406 |
} |
1407 |
} |
|
1408 |
||
1409 |
if ( $result ) { |
|
5 | 1410 |
|
1411 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1412 |
* Fires after a specific network option has been successfully added. |
5 | 1413 |
* |
1414 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1415 |
* |
|
1416 |
* @since 2.9.0 As "add_site_option_{$key}" |
|
1417 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1418 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1419 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1420 |
* @param string $option Name of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1421 |
* @param mixed $value Value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1422 |
* @param int $network_id ID of the network. |
5 | 1423 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1424 |
do_action( "add_site_option_{$option}", $option, $value, $network_id ); |
5 | 1425 |
|
1426 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1427 |
* Fires after a network option has been successfully added. |
5 | 1428 |
* |
1429 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1430 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1431 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1432 |
* @param string $option Name of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1433 |
* @param mixed $value Value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1434 |
* @param int $network_id ID of the network. |
5 | 1435 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1436 |
do_action( 'add_site_option', $option, $value, $network_id ); |
5 | 1437 |
|
0 | 1438 |
return true; |
1439 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1440 |
|
0 | 1441 |
return false; |
1442 |
} |
|
1443 |
||
1444 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1445 |
* Removes a network option by name. |
0 | 1446 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1447 |
* @since 4.4.0 |
0 | 1448 |
* |
5 | 1449 |
* @see delete_option() |
0 | 1450 |
* |
9 | 1451 |
* @global wpdb $wpdb WordPress database abstraction object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1452 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1453 |
* @param int $network_id ID of the network. Can be null to default to the current network ID. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1454 |
* @param string $option Name of option to remove. Expected to not be SQL-escaped. |
0 | 1455 |
* @return bool True, if succeed. False, if failure. |
1456 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1457 |
function delete_network_option( $network_id, $option ) { |
0 | 1458 |
global $wpdb; |
1459 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1460 |
if ( $network_id && ! is_numeric( $network_id ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1461 |
return false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1462 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1463 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1464 |
$network_id = (int) $network_id; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1465 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1466 |
// Fallback to the current network if a network ID is not specified. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1467 |
if ( ! $network_id ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1468 |
$network_id = get_current_network_id(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1469 |
} |
0 | 1470 |
|
5 | 1471 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1472 |
* Fires immediately before a specific network option is deleted. |
5 | 1473 |
* |
1474 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1475 |
* |
|
1476 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1477 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1478 |
* @since 4.7.0 The `$network_id` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1479 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1480 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1481 |
* @param int $network_id ID of the network. |
5 | 1482 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1483 |
do_action( "pre_delete_site_option_{$option}", $option, $network_id ); |
0 | 1484 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1485 |
if ( ! is_multisite() ) { |
0 | 1486 |
$result = delete_option( $option ); |
1487 |
} else { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1488 |
$row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $network_id ) ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1489 |
if ( is_null( $row ) || ! $row->meta_id ) { |
0 | 1490 |
return false; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1491 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1492 |
$cache_key = "$network_id:$option"; |
0 | 1493 |
wp_cache_delete( $cache_key, 'site-options' ); |
1494 |
||
9 | 1495 |
$result = $wpdb->delete( |
1496 |
$wpdb->sitemeta, |
|
1497 |
array( |
|
1498 |
'meta_key' => $option, |
|
1499 |
'site_id' => $network_id, |
|
1500 |
) |
|
1501 |
); |
|
0 | 1502 |
} |
1503 |
||
1504 |
if ( $result ) { |
|
5 | 1505 |
|
1506 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1507 |
* Fires after a specific network option has been deleted. |
5 | 1508 |
* |
1509 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1510 |
* |
|
1511 |
* @since 2.9.0 As "delete_site_option_{$key}" |
|
1512 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1513 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1514 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1515 |
* @param string $option Name of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1516 |
* @param int $network_id ID of the network. |
5 | 1517 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1518 |
do_action( "delete_site_option_{$option}", $option, $network_id ); |
5 | 1519 |
|
1520 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1521 |
* Fires after a network option has been deleted. |
5 | 1522 |
* |
1523 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1524 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1525 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1526 |
* @param string $option Name of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1527 |
* @param int $network_id ID of the network. |
5 | 1528 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1529 |
do_action( 'delete_site_option', $option, $network_id ); |
5 | 1530 |
|
0 | 1531 |
return true; |
1532 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1533 |
|
0 | 1534 |
return false; |
1535 |
} |
|
1536 |
||
1537 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1538 |
* Update the value of a network option that was already added. |
0 | 1539 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1540 |
* @since 4.4.0 |
5 | 1541 |
* |
0 | 1542 |
* @see update_option() |
1543 |
* |
|
9 | 1544 |
* @global wpdb $wpdb WordPress database abstraction object. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1545 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1546 |
* @param int $network_id ID of the network. Can be null to default to the current network ID. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1547 |
* @param string $option Name of option. Expected to not be SQL-escaped. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1548 |
* @param mixed $value Option value. Expected to not be SQL-escaped. |
0 | 1549 |
* @return bool False if value was not updated and true if value was updated. |
1550 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1551 |
function update_network_option( $network_id, $option, $value ) { |
0 | 1552 |
global $wpdb; |
1553 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1554 |
if ( $network_id && ! is_numeric( $network_id ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1555 |
return false; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1556 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1557 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1558 |
$network_id = (int) $network_id; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1559 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1560 |
// Fallback to the current network if a network ID is not specified. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1561 |
if ( ! $network_id ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1562 |
$network_id = get_current_network_id(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1563 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1564 |
|
0 | 1565 |
wp_protect_special_option( $option ); |
1566 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1567 |
$old_value = get_network_option( $network_id, $option, false ); |
5 | 1568 |
|
1569 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1570 |
* Filters a specific network option before its value is updated. |
5 | 1571 |
* |
1572 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1573 |
* |
|
1574 |
* @since 2.9.0 As 'pre_update_site_option_' . $key |
|
1575 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1576 |
* @since 4.4.0 The `$option` parameter was added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1577 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1578 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1579 |
* @param mixed $value New value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1580 |
* @param mixed $old_value Old value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1581 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1582 |
* @param int $network_id ID of the network. |
5 | 1583 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1584 |
$value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value, $option, $network_id ); |
0 | 1585 |
|
9 | 1586 |
/* |
1587 |
* If the new and old values are the same, no need to update. |
|
1588 |
* |
|
1589 |
* Unserialized values will be adequate in most cases. If the unserialized |
|
1590 |
* data differs, the (maybe) serialized data is checked to avoid |
|
1591 |
* unnecessary database calls for otherwise identical object instances. |
|
1592 |
* |
|
1593 |
* See https://core.trac.wordpress.org/ticket/44956 |
|
1594 |
*/ |
|
1595 |
if ( $value === $old_value || maybe_serialize( $value ) === maybe_serialize( $old_value ) ) { |
|
0 | 1596 |
return false; |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1597 |
} |
0 | 1598 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1599 |
if ( false === $old_value ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1600 |
return add_network_option( $network_id, $option, $value ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1601 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1602 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1603 |
$notoptions_key = "$network_id:notoptions"; |
9 | 1604 |
$notoptions = wp_cache_get( $notoptions_key, 'site-options' ); |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1605 |
if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1606 |
unset( $notoptions[ $option ] ); |
5 | 1607 |
wp_cache_set( $notoptions_key, $notoptions, 'site-options' ); |
0 | 1608 |
} |
1609 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1610 |
if ( ! is_multisite() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1611 |
$result = update_option( $option, $value, 'no' ); |
0 | 1612 |
} else { |
1613 |
$value = sanitize_option( $option, $value ); |
|
1614 |
||
1615 |
$serialized_value = maybe_serialize( $value ); |
|
9 | 1616 |
$result = $wpdb->update( |
1617 |
$wpdb->sitemeta, |
|
1618 |
array( 'meta_value' => $serialized_value ), |
|
1619 |
array( |
|
1620 |
'site_id' => $network_id, |
|
1621 |
'meta_key' => $option, |
|
1622 |
) |
|
1623 |
); |
|
0 | 1624 |
|
1625 |
if ( $result ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1626 |
$cache_key = "$network_id:$option"; |
0 | 1627 |
wp_cache_set( $cache_key, $value, 'site-options' ); |
1628 |
} |
|
1629 |
} |
|
1630 |
||
1631 |
if ( $result ) { |
|
5 | 1632 |
|
1633 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1634 |
* Fires after the value of a specific network option has been successfully updated. |
5 | 1635 |
* |
1636 |
* The dynamic portion of the hook name, `$option`, refers to the option name. |
|
1637 |
* |
|
1638 |
* @since 2.9.0 As "update_site_option_{$key}" |
|
1639 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1640 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1641 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1642 |
* @param string $option Name of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1643 |
* @param mixed $value Current value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1644 |
* @param mixed $old_value Old value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1645 |
* @param int $network_id ID of the network. |
5 | 1646 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1647 |
do_action( "update_site_option_{$option}", $option, $value, $old_value, $network_id ); |
5 | 1648 |
|
1649 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1650 |
* Fires after the value of a network option has been successfully updated. |
5 | 1651 |
* |
1652 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1653 |
* @since 4.7.0 The `$network_id` parameter was added. |
5 | 1654 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1655 |
* @param string $option Name of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1656 |
* @param mixed $value Current value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1657 |
* @param mixed $old_value Old value of the network option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1658 |
* @param int $network_id ID of the network. |
5 | 1659 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1660 |
do_action( 'update_site_option', $option, $value, $old_value, $network_id ); |
5 | 1661 |
|
0 | 1662 |
return true; |
1663 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1664 |
|
0 | 1665 |
return false; |
1666 |
} |
|
1667 |
||
1668 |
/** |
|
1669 |
* Delete a site transient. |
|
1670 |
* |
|
1671 |
* @since 2.9.0 |
|
1672 |
* |
|
1673 |
* @param string $transient Transient name. Expected to not be SQL-escaped. |
|
1674 |
* @return bool True if successful, false otherwise |
|
1675 |
*/ |
|
1676 |
function delete_site_transient( $transient ) { |
|
5 | 1677 |
|
1678 |
/** |
|
1679 |
* Fires immediately before a specific site transient is deleted. |
|
1680 |
* |
|
1681 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
1682 |
* |
|
1683 |
* @since 3.0.0 |
|
1684 |
* |
|
1685 |
* @param string $transient Transient name. |
|
1686 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1687 |
do_action( "delete_site_transient_{$transient}", $transient ); |
5 | 1688 |
|
0 | 1689 |
if ( wp_using_ext_object_cache() ) { |
1690 |
$result = wp_cache_delete( $transient, 'site-transient' ); |
|
1691 |
} else { |
|
1692 |
$option_timeout = '_site_transient_timeout_' . $transient; |
|
9 | 1693 |
$option = '_site_transient_' . $transient; |
1694 |
$result = delete_site_option( $option ); |
|
1695 |
if ( $result ) { |
|
0 | 1696 |
delete_site_option( $option_timeout ); |
9 | 1697 |
} |
0 | 1698 |
} |
5 | 1699 |
if ( $result ) { |
1700 |
||
1701 |
/** |
|
1702 |
* Fires after a transient is deleted. |
|
1703 |
* |
|
1704 |
* @since 3.0.0 |
|
1705 |
* |
|
1706 |
* @param string $transient Deleted transient name. |
|
1707 |
*/ |
|
0 | 1708 |
do_action( 'deleted_site_transient', $transient ); |
5 | 1709 |
} |
1710 |
||
0 | 1711 |
return $result; |
1712 |
} |
|
1713 |
||
1714 |
/** |
|
1715 |
* Get the value of a site transient. |
|
1716 |
* |
|
5 | 1717 |
* If the transient does not exist, does not have a value, or has expired, |
1718 |
* then the return value will be false. |
|
1719 |
* |
|
1720 |
* @since 2.9.0 |
|
0 | 1721 |
* |
1722 |
* @see get_transient() |
|
1723 |
* |
|
1724 |
* @param string $transient Transient name. Expected to not be SQL-escaped. |
|
5 | 1725 |
* @return mixed Value of transient. |
0 | 1726 |
*/ |
1727 |
function get_site_transient( $transient ) { |
|
5 | 1728 |
|
1729 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1730 |
* Filters the value of an existing site transient. |
5 | 1731 |
* |
1732 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
1733 |
* |
|
1734 |
* Passing a truthy value to the filter will effectively short-circuit retrieval, |
|
1735 |
* returning the passed value instead. |
|
1736 |
* |
|
1737 |
* @since 2.9.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1738 |
* @since 4.4.0 The `$transient` parameter was added. |
5 | 1739 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1740 |
* @param mixed $pre_site_transient The default value to return if the site transient does not exist. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1741 |
* Any value other than false will short-circuit the retrieval |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1742 |
* of the transient, and return the returned value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1743 |
* @param string $transient Transient name. |
5 | 1744 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1745 |
$pre = apply_filters( "pre_site_transient_{$transient}", false, $transient ); |
5 | 1746 |
|
9 | 1747 |
if ( false !== $pre ) { |
0 | 1748 |
return $pre; |
9 | 1749 |
} |
0 | 1750 |
|
1751 |
if ( wp_using_ext_object_cache() ) { |
|
1752 |
$value = wp_cache_get( $transient, 'site-transient' ); |
|
1753 |
} else { |
|
1754 |
// Core transients that do not have a timeout. Listed here so querying timeouts can be avoided. |
|
9 | 1755 |
$no_timeout = array( 'update_core', 'update_plugins', 'update_themes' ); |
0 | 1756 |
$transient_option = '_site_transient_' . $transient; |
1757 |
if ( ! in_array( $transient, $no_timeout ) ) { |
|
1758 |
$transient_timeout = '_site_transient_timeout_' . $transient; |
|
9 | 1759 |
$timeout = get_site_option( $transient_timeout ); |
0 | 1760 |
if ( false !== $timeout && $timeout < time() ) { |
9 | 1761 |
delete_site_option( $transient_option ); |
0 | 1762 |
delete_site_option( $transient_timeout ); |
1763 |
$value = false; |
|
1764 |
} |
|
1765 |
} |
|
1766 |
||
9 | 1767 |
if ( ! isset( $value ) ) { |
0 | 1768 |
$value = get_site_option( $transient_option ); |
9 | 1769 |
} |
0 | 1770 |
} |
1771 |
||
5 | 1772 |
/** |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1773 |
* Filters the value of an existing site transient. |
5 | 1774 |
* |
1775 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
1776 |
* |
|
1777 |
* @since 2.9.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1778 |
* @since 4.4.0 The `$transient` parameter was added. |
5 | 1779 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1780 |
* @param mixed $value Value of site transient. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1781 |
* @param string $transient Transient name. |
5 | 1782 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1783 |
return apply_filters( "site_transient_{$transient}", $value, $transient ); |
0 | 1784 |
} |
1785 |
||
1786 |
/** |
|
1787 |
* Set/update the value of a site transient. |
|
1788 |
* |
|
1789 |
* You do not need to serialize values, if the value needs to be serialize, then |
|
1790 |
* it will be serialized before it is set. |
|
1791 |
* |
|
5 | 1792 |
* @since 2.9.0 |
1793 |
* |
|
0 | 1794 |
* @see set_transient() |
1795 |
* |
|
5 | 1796 |
* @param string $transient Transient name. Expected to not be SQL-escaped. Must be |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1797 |
* 167 characters or fewer in length. |
5 | 1798 |
* @param mixed $value Transient value. Expected to not be SQL-escaped. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1799 |
* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration). |
0 | 1800 |
* @return bool False if value was not set and true if value was set. |
1801 |
*/ |
|
1802 |
function set_site_transient( $transient, $value, $expiration = 0 ) { |
|
5 | 1803 |
|
1804 |
/** |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1805 |
* Filters the value of a specific site transient before it is set. |
5 | 1806 |
* |
1807 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
1808 |
* |
|
1809 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1810 |
* @since 4.4.0 The `$transient` parameter was added. |
5 | 1811 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1812 |
* @param mixed $value New value of site transient. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1813 |
* @param string $transient Transient name. |
5 | 1814 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1815 |
$value = apply_filters( "pre_set_site_transient_{$transient}", $value, $transient ); |
5 | 1816 |
|
0 | 1817 |
$expiration = (int) $expiration; |
1818 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1819 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1820 |
* Filters the expiration for a site transient before its value is set. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1821 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1822 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1823 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1824 |
* @since 4.4.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1825 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1826 |
* @param int $expiration Time until expiration in seconds. Use 0 for no expiration. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1827 |
* @param mixed $value New value of site transient. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1828 |
* @param string $transient Transient name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1829 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1830 |
$expiration = apply_filters( "expiration_of_site_transient_{$transient}", $expiration, $value, $transient ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1831 |
|
0 | 1832 |
if ( wp_using_ext_object_cache() ) { |
1833 |
$result = wp_cache_set( $transient, $value, 'site-transient', $expiration ); |
|
1834 |
} else { |
|
1835 |
$transient_timeout = '_site_transient_timeout_' . $transient; |
|
9 | 1836 |
$option = '_site_transient_' . $transient; |
0 | 1837 |
if ( false === get_site_option( $option ) ) { |
9 | 1838 |
if ( $expiration ) { |
0 | 1839 |
add_site_option( $transient_timeout, time() + $expiration ); |
9 | 1840 |
} |
0 | 1841 |
$result = add_site_option( $option, $value ); |
1842 |
} else { |
|
9 | 1843 |
if ( $expiration ) { |
0 | 1844 |
update_site_option( $transient_timeout, time() + $expiration ); |
9 | 1845 |
} |
0 | 1846 |
$result = update_site_option( $option, $value ); |
1847 |
} |
|
1848 |
} |
|
1849 |
if ( $result ) { |
|
5 | 1850 |
|
1851 |
/** |
|
1852 |
* Fires after the value for a specific site transient has been set. |
|
1853 |
* |
|
1854 |
* The dynamic portion of the hook name, `$transient`, refers to the transient name. |
|
1855 |
* |
|
1856 |
* @since 3.0.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1857 |
* @since 4.4.0 The `$transient` parameter was added |
5 | 1858 |
* |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1859 |
* @param mixed $value Site transient value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1860 |
* @param int $expiration Time until expiration in seconds. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1861 |
* @param string $transient Transient name. |
5 | 1862 |
*/ |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1863 |
do_action( "set_site_transient_{$transient}", $value, $expiration, $transient ); |
5 | 1864 |
|
1865 |
/** |
|
1866 |
* Fires after the value for a site transient has been set. |
|
1867 |
* |
|
1868 |
* @since 3.0.0 |
|
1869 |
* |
|
1870 |
* @param string $transient The name of the site transient. |
|
1871 |
* @param mixed $value Site transient value. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1872 |
* @param int $expiration Time until expiration in seconds. |
5 | 1873 |
*/ |
0 | 1874 |
do_action( 'setted_site_transient', $transient, $value, $expiration ); |
1875 |
} |
|
1876 |
return $result; |
|
1877 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1878 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1879 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1880 |
* Register default settings available in WordPress. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1881 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1882 |
* The settings registered here are primarily useful for the REST API, so this |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1883 |
* does not encompass all settings available in WordPress. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1884 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1885 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1886 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1887 |
function register_initial_settings() { |
9 | 1888 |
register_setting( |
1889 |
'general', |
|
1890 |
'blogname', |
|
1891 |
array( |
|
1892 |
'show_in_rest' => array( |
|
1893 |
'name' => 'title', |
|
1894 |
), |
|
1895 |
'type' => 'string', |
|
1896 |
'description' => __( 'Site title.' ), |
|
1897 |
) |
|
1898 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1899 |
|
9 | 1900 |
register_setting( |
1901 |
'general', |
|
1902 |
'blogdescription', |
|
1903 |
array( |
|
1904 |
'show_in_rest' => array( |
|
1905 |
'name' => 'description', |
|
1906 |
), |
|
1907 |
'type' => 'string', |
|
1908 |
'description' => __( 'Site tagline.' ), |
|
1909 |
) |
|
1910 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1911 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1912 |
if ( ! is_multisite() ) { |
9 | 1913 |
register_setting( |
1914 |
'general', |
|
1915 |
'siteurl', |
|
1916 |
array( |
|
1917 |
'show_in_rest' => array( |
|
1918 |
'name' => 'url', |
|
1919 |
'schema' => array( |
|
1920 |
'format' => 'uri', |
|
1921 |
), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1922 |
), |
9 | 1923 |
'type' => 'string', |
1924 |
'description' => __( 'Site URL.' ), |
|
1925 |
) |
|
1926 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1927 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1928 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1929 |
if ( ! is_multisite() ) { |
9 | 1930 |
register_setting( |
1931 |
'general', |
|
1932 |
'admin_email', |
|
1933 |
array( |
|
1934 |
'show_in_rest' => array( |
|
1935 |
'name' => 'email', |
|
1936 |
'schema' => array( |
|
1937 |
'format' => 'email', |
|
1938 |
), |
|
1939 |
), |
|
1940 |
'type' => 'string', |
|
1941 |
'description' => __( 'This address is used for admin purposes, like new user notification.' ), |
|
1942 |
) |
|
1943 |
); |
|
1944 |
} |
|
1945 |
||
1946 |
register_setting( |
|
1947 |
'general', |
|
1948 |
'timezone_string', |
|
1949 |
array( |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1950 |
'show_in_rest' => array( |
9 | 1951 |
'name' => 'timezone', |
1952 |
), |
|
1953 |
'type' => 'string', |
|
1954 |
'description' => __( 'A city in the same timezone as you.' ), |
|
1955 |
) |
|
1956 |
); |
|
1957 |
||
1958 |
register_setting( |
|
1959 |
'general', |
|
1960 |
'date_format', |
|
1961 |
array( |
|
1962 |
'show_in_rest' => true, |
|
1963 |
'type' => 'string', |
|
1964 |
'description' => __( 'A date format for all date strings.' ), |
|
1965 |
) |
|
1966 |
); |
|
1967 |
||
1968 |
register_setting( |
|
1969 |
'general', |
|
1970 |
'time_format', |
|
1971 |
array( |
|
1972 |
'show_in_rest' => true, |
|
1973 |
'type' => 'string', |
|
1974 |
'description' => __( 'A time format for all time strings.' ), |
|
1975 |
) |
|
1976 |
); |
|
1977 |
||
1978 |
register_setting( |
|
1979 |
'general', |
|
1980 |
'start_of_week', |
|
1981 |
array( |
|
1982 |
'show_in_rest' => true, |
|
1983 |
'type' => 'integer', |
|
1984 |
'description' => __( 'A day number of the week that the week should start on.' ), |
|
1985 |
) |
|
1986 |
); |
|
1987 |
||
1988 |
register_setting( |
|
1989 |
'general', |
|
1990 |
'WPLANG', |
|
1991 |
array( |
|
1992 |
'show_in_rest' => array( |
|
1993 |
'name' => 'language', |
|
1994 |
), |
|
1995 |
'type' => 'string', |
|
1996 |
'description' => __( 'WordPress locale code.' ), |
|
1997 |
'default' => 'en_US', |
|
1998 |
) |
|
1999 |
); |
|
2000 |
||
2001 |
register_setting( |
|
2002 |
'writing', |
|
2003 |
'use_smilies', |
|
2004 |
array( |
|
2005 |
'show_in_rest' => true, |
|
2006 |
'type' => 'boolean', |
|
2007 |
'description' => __( 'Convert emoticons like :-) and :-P to graphics on display.' ), |
|
2008 |
'default' => true, |
|
2009 |
) |
|
2010 |
); |
|
2011 |
||
2012 |
register_setting( |
|
2013 |
'writing', |
|
2014 |
'default_category', |
|
2015 |
array( |
|
2016 |
'show_in_rest' => true, |
|
2017 |
'type' => 'integer', |
|
2018 |
'description' => __( 'Default post category.' ), |
|
2019 |
) |
|
2020 |
); |
|
2021 |
||
2022 |
register_setting( |
|
2023 |
'writing', |
|
2024 |
'default_post_format', |
|
2025 |
array( |
|
2026 |
'show_in_rest' => true, |
|
2027 |
'type' => 'string', |
|
2028 |
'description' => __( 'Default post format.' ), |
|
2029 |
) |
|
2030 |
); |
|
2031 |
||
2032 |
register_setting( |
|
2033 |
'reading', |
|
2034 |
'posts_per_page', |
|
2035 |
array( |
|
2036 |
'show_in_rest' => true, |
|
2037 |
'type' => 'integer', |
|
2038 |
'description' => __( 'Blog pages show at most.' ), |
|
2039 |
'default' => 10, |
|
2040 |
) |
|
2041 |
); |
|
2042 |
||
2043 |
register_setting( |
|
2044 |
'discussion', |
|
2045 |
'default_ping_status', |
|
2046 |
array( |
|
2047 |
'show_in_rest' => array( |
|
2048 |
'schema' => array( |
|
2049 |
'enum' => array( 'open', 'closed' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2050 |
), |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2051 |
), |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2052 |
'type' => 'string', |
9 | 2053 |
'description' => __( 'Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.' ), |
2054 |
) |
|
2055 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2056 |
|
9 | 2057 |
register_setting( |
2058 |
'discussion', |
|
2059 |
'default_comment_status', |
|
2060 |
array( |
|
2061 |
'show_in_rest' => array( |
|
2062 |
'schema' => array( |
|
2063 |
'enum' => array( 'open', 'closed' ), |
|
2064 |
), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2065 |
), |
9 | 2066 |
'type' => 'string', |
2067 |
'description' => __( 'Allow people to post comments on new articles.' ), |
|
2068 |
) |
|
2069 |
); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2070 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2071 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2072 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2073 |
* Register a setting and its data. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2074 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2075 |
* @since 2.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2076 |
* @since 4.7.0 `$args` can be passed to set flags on the setting, similar to `register_meta()`. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2077 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2078 |
* @global array $new_whitelist_options |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2079 |
* @global array $wp_registered_settings |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2080 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2081 |
* @param string $option_group A settings group name. Should correspond to a whitelisted option key name. |
9 | 2082 |
* Default whitelisted option key names include "general," "discussion," and "reading," among others. |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2083 |
* @param string $option_name The name of an option to sanitize and save. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2084 |
* @param array $args { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2085 |
* Data used to describe the setting when registered. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2086 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2087 |
* @type string $type The type of data associated with this setting. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2088 |
* Valid values are 'string', 'boolean', 'integer', and 'number'. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2089 |
* @type string $description A description of the data attached to this setting. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2090 |
* @type callable $sanitize_callback A callback function that sanitizes the option's value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2091 |
* @type bool $show_in_rest Whether data associated with this setting should be included in the REST API. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2092 |
* @type mixed $default Default value when calling `get_option()`. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2093 |
* } |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2094 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2095 |
function register_setting( $option_group, $option_name, $args = array() ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2096 |
global $new_whitelist_options, $wp_registered_settings; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2097 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2098 |
$defaults = array( |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2099 |
'type' => 'string', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2100 |
'group' => $option_group, |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2101 |
'description' => '', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2102 |
'sanitize_callback' => null, |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2103 |
'show_in_rest' => false, |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2104 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2105 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2106 |
// Back-compat: old sanitize callback is added. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2107 |
if ( is_callable( $args ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2108 |
$args = array( |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2109 |
'sanitize_callback' => $args, |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2110 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2111 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2112 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2113 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2114 |
* Filters the registration arguments when registering a setting. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2115 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2116 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2117 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2118 |
* @param array $args Array of setting registration arguments. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2119 |
* @param array $defaults Array of default arguments. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2120 |
* @param string $option_group Setting group. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2121 |
* @param string $option_name Setting name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2122 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2123 |
$args = apply_filters( 'register_setting_args', $args, $defaults, $option_group, $option_name ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2124 |
$args = wp_parse_args( $args, $defaults ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2125 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2126 |
if ( ! is_array( $wp_registered_settings ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2127 |
$wp_registered_settings = array(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2128 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2129 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2130 |
if ( 'misc' == $option_group ) { |
9 | 2131 |
_deprecated_argument( |
2132 |
__FUNCTION__, |
|
2133 |
'3.0.0', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2134 |
/* translators: %s: misc */ |
9 | 2135 |
sprintf( |
2136 |
__( 'The "%s" options group has been removed. Use another settings group.' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2137 |
'misc' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2138 |
) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2139 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2140 |
$option_group = 'general'; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2141 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2142 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2143 |
if ( 'privacy' == $option_group ) { |
9 | 2144 |
_deprecated_argument( |
2145 |
__FUNCTION__, |
|
2146 |
'3.5.0', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2147 |
/* translators: %s: privacy */ |
9 | 2148 |
sprintf( |
2149 |
__( 'The "%s" options group has been removed. Use another settings group.' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2150 |
'privacy' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2151 |
) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2152 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2153 |
$option_group = 'reading'; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2154 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2155 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2156 |
$new_whitelist_options[ $option_group ][] = $option_name; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2157 |
if ( ! empty( $args['sanitize_callback'] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2158 |
add_filter( "sanitize_option_{$option_name}", $args['sanitize_callback'] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2159 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2160 |
if ( array_key_exists( 'default', $args ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2161 |
add_filter( "default_option_{$option_name}", 'filter_default_option', 10, 3 ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2162 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2163 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2164 |
$wp_registered_settings[ $option_name ] = $args; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2165 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2166 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2167 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2168 |
* Unregister a setting. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2169 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2170 |
* @since 2.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2171 |
* @since 4.7.0 `$sanitize_callback` was deprecated. The callback from `register_setting()` is now used instead. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2172 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2173 |
* @global array $new_whitelist_options |
9 | 2174 |
* @global array $wp_registered_settings |
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2175 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2176 |
* @param string $option_group The settings group name used during registration. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2177 |
* @param string $option_name The name of the option to unregister. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2178 |
* @param callable $deprecated Deprecated. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2179 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2180 |
function unregister_setting( $option_group, $option_name, $deprecated = '' ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2181 |
global $new_whitelist_options, $wp_registered_settings; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2182 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2183 |
if ( 'misc' == $option_group ) { |
9 | 2184 |
_deprecated_argument( |
2185 |
__FUNCTION__, |
|
2186 |
'3.0.0', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2187 |
/* translators: %s: misc */ |
9 | 2188 |
sprintf( |
2189 |
__( 'The "%s" options group has been removed. Use another settings group.' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2190 |
'misc' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2191 |
) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2192 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2193 |
$option_group = 'general'; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2194 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2195 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2196 |
if ( 'privacy' == $option_group ) { |
9 | 2197 |
_deprecated_argument( |
2198 |
__FUNCTION__, |
|
2199 |
'3.5.0', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2200 |
/* translators: %s: privacy */ |
9 | 2201 |
sprintf( |
2202 |
__( 'The "%s" options group has been removed. Use another settings group.' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2203 |
'privacy' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2204 |
) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2205 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2206 |
$option_group = 'reading'; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2207 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2208 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2209 |
$pos = array_search( $option_name, (array) $new_whitelist_options[ $option_group ] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2210 |
if ( $pos !== false ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2211 |
unset( $new_whitelist_options[ $option_group ][ $pos ] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2212 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2213 |
if ( '' !== $deprecated ) { |
9 | 2214 |
_deprecated_argument( |
2215 |
__FUNCTION__, |
|
2216 |
'4.7.0', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2217 |
/* translators: 1: $sanitize_callback, 2: register_setting() */ |
9 | 2218 |
sprintf( |
2219 |
__( '%1$s is deprecated. The callback from %2$s is used instead.' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2220 |
'<code>$sanitize_callback</code>', |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2221 |
'<code>register_setting()</code>' |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2222 |
) |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2223 |
); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2224 |
remove_filter( "sanitize_option_{$option_name}", $deprecated ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2225 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2226 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2227 |
if ( isset( $wp_registered_settings[ $option_name ] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2228 |
// Remove the sanitize callback if one was set during registration. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2229 |
if ( ! empty( $wp_registered_settings[ $option_name ]['sanitize_callback'] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2230 |
remove_filter( "sanitize_option_{$option_name}", $wp_registered_settings[ $option_name ]['sanitize_callback'] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2231 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2232 |
|
9 | 2233 |
// Remove the default filter if a default was provided during registration. |
2234 |
if ( array_key_exists( 'default', $wp_registered_settings[ $option_name ] ) ) { |
|
2235 |
remove_filter( "default_option_{$option_name}", 'filter_default_option', 10 ); |
|
2236 |
} |
|
2237 |
||
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2238 |
unset( $wp_registered_settings[ $option_name ] ); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2239 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2240 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2241 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2242 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2243 |
* Retrieves an array of registered settings. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2244 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2245 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2246 |
* |
9 | 2247 |
* @global array $wp_registered_settings |
2248 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2249 |
* @return array List of registered settings, keyed by option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2250 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2251 |
function get_registered_settings() { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2252 |
global $wp_registered_settings; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2253 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2254 |
if ( ! is_array( $wp_registered_settings ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2255 |
return array(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2256 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2257 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2258 |
return $wp_registered_settings; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2259 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2260 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2261 |
/** |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2262 |
* Filter the default value for the option. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2263 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2264 |
* For settings which register a default setting in `register_setting()`, this |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2265 |
* function is added as a filter to `default_option_{$option}`. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2266 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2267 |
* @since 4.7.0 |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2268 |
* |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2269 |
* @param mixed $default Existing default value to return. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2270 |
* @param string $option Option name. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2271 |
* @param bool $passed_default Was `get_option()` passed a default value? |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2272 |
* @return mixed Filtered default value. |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2273 |
*/ |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2274 |
function filter_default_option( $default, $option, $passed_default ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2275 |
if ( $passed_default ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2276 |
return $default; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2277 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2278 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2279 |
$registered = get_registered_settings(); |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2280 |
if ( empty( $registered[ $option ] ) ) { |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2281 |
return $default; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2282 |
} |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2283 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2284 |
return $registered[ $option ]['default']; |
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2285 |
} |