option.php 77 KB

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