Drew Jaynes
94980d89e0
Docs: Make the DocBlock summary for `get_option()` more explicit and convert to using a third-person singular verb.
...
See #32246 .
Built from https://develop.svn.wordpress.org/trunk@37876
git-svn-id: http://core.svn.wordpress.org/trunk@37817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-06-26 17:29:30 +00:00
Drew Jaynes
9193013158
Docs: Apply inline `@see` tags to hooks referenced in DocBlocks in a variety of wp-includes/* files.
...
Applying these specially-crafted `@see` tags allows the Code Reference parser to recognize and link these elements as actions and filters.
Fixes #36921 .
Built from https://develop.svn.wordpress.org/trunk@37544
git-svn-id: http://core.svn.wordpress.org/trunk@37512 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-23 19:02:28 +00:00
Drew Jaynes
bde87c6fb2
Docs: Standardize filter docs in wp-includes/option.php to use third-person singular verbs per the inline documentation standards for PHP.
...
See #36913 .
Built from https://develop.svn.wordpress.org/trunk@37507
git-svn-id: http://core.svn.wordpress.org/trunk@37475 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-22 18:34:26 +00:00
Sergey Biryukov
b65cbd6003
Options: After [33738], consistently pass option name as the second parameter to the `'default_option_' . $option` filter in `add_option()` and `update_option()`.
...
Props dlh.
Fixes #36761 .
Built from https://develop.svn.wordpress.org/trunk@37367
git-svn-id: http://core.svn.wordpress.org/trunk@37333 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-05-05 20:24:29 +00:00
Drew Jaynes
ddd3daf5ad
Docs: Clarify return descriptions in the DocBlocks for `set_user_setting()` and `delete_user_setting()`.
...
See [32613]. See #30989 .
Built from https://develop.svn.wordpress.org/trunk@37264
git-svn-id: http://core.svn.wordpress.org/trunk@37230 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-04-20 15:47:26 +00:00
Drew Jaynes
14a399b69a
Docs: Clarify parameter and return descriptions in the DocBlock for `wp_set_all_user_settings()`.
...
See [32613]. See #30989 .
Built from https://develop.svn.wordpress.org/trunk@37263
git-svn-id: http://core.svn.wordpress.org/trunk@37229 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-04-20 15:45:29 +00:00
Jeremy Felt
f6620f7b7f
Options: Do not set network options to autoload in single site
...
When multisite is not configured, the `_site_transient()` and `_site_option()` functions fallback to `_option()` and store network "meta/options" in `wp_options`.
Previously, those calls to `_option()` did not explicitly set the `autoload` parameter and anything assigned as a transient or option at the network level would be set to `autoload` by default, even though autoload is not yet a concept at the network option level.
This changes that behavior and forces the `autoload` setting to `no`. If `autoload` is desired, the single site option functions should be used.
Props thomaswm.
Fixes #22846 .
Built from https://develop.svn.wordpress.org/trunk@37223
git-svn-id: http://core.svn.wordpress.org/trunk@37189 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-04-16 19:48:27 +00:00
Boone Gorges
4ce9b93af9
Clarify return types in `get_option()` documentation.
...
The new note specifies that scalar values will always be returned as strings.
Fixes #31820 .
Built from https://develop.svn.wordpress.org/trunk@36234
git-svn-id: http://core.svn.wordpress.org/trunk@36201 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-01-09 03:12:26 +00:00
Sergey Biryukov
1b0bc28579
Rename internal variable in `set_transient()`.
...
The previous name was inadvertently changing the dynamic part of `set_transient_{transient}` action and the transient name passed to the action since [35082].
Props GregLone.
Fixes #34470 .
Built from https://develop.svn.wordpress.org/trunk@35431
git-svn-id: http://core.svn.wordpress.org/trunk@35395 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-29 11:52:28 +00:00
Drew Jaynes
217b661703
Docs: Add missing descriptions for the `$wpdb` global in DocBlocks all the places.
...
See #32246 .
Built from https://develop.svn.wordpress.org/trunk@35170
git-svn-id: http://core.svn.wordpress.org/trunk@35136 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-14 23:44:25 +00:00
John Blackbourn
537ac4c2ec
Improve the docs for the `$expiration` parameter in `set_transient()`, `set_site_transient()`, and associated filters.
...
See #32246
Built from https://develop.svn.wordpress.org/trunk@35149
git-svn-id: http://core.svn.wordpress.org/trunk@35115 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-13 21:31:25 +00:00
John Blackbourn
a2609c13fa
Add `$transient` as a parameter to the `set_transient_{transient}` action.
...
Props SergeyBiryukov
Fixes #34269
Built from https://develop.svn.wordpress.org/trunk@35082
git-svn-id: http://core.svn.wordpress.org/trunk@35047 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-12 21:02:25 +00:00
Jeremy Felt
364e63b83b
MS: Reject truthy, non-numeric network ids in `_network_option()`.
...
A valid `$network_id` or `null`/`false` is expected as the first parameter for `_network_option()`. If something other than that is passed, we immediately return `false` rather than attempting to guess what network was intended.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@35025
git-svn-id: http://core.svn.wordpress.org/trunk@34990 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-11 23:30:24 +00:00
Jeremy Felt
092478579a
MS: Adjust `_network_option()` parameter order, `$network_id` is first.
...
This better aligns with expectations and matches the structure used by `_blog_option()`. The `_site_option()` functions remain as an appropriate method for working with the current network.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@35024
git-svn-id: http://core.svn.wordpress.org/trunk@34989 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-11 22:44:27 +00:00
John Blackbourn
95045d629b
Correctly set the `secure` flag for the test cookie based on the login URL scheme, and the same for the user settings cookies based on the admin URL scheme.
...
Fixes #34159
Built from https://develop.svn.wordpress.org/trunk@34931
git-svn-id: http://core.svn.wordpress.org/trunk@34896 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-08 03:05:25 +00:00
Jeremy Felt
9926983b66
Revert [34778], continue using `_site_option()` for the current network.
...
The `_network_option()` parameter order will be changing to accept `$network_id` first. The `_site_option()` functions will remain in use throughout core as our way of retrieving a network option for the current network.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@34912
git-svn-id: http://core.svn.wordpress.org/trunk@34877 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-07 17:11:25 +00:00
Sergey Biryukov
2702fd12cf
Transients: Clarify the `expiration_of_site_transient_$transient` filter description.
...
See #21330 .
Built from https://develop.svn.wordpress.org/trunk@34878
git-svn-id: http://core.svn.wordpress.org/trunk@34843 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-06 18:11:24 +00:00
Dominik Schilling
e237e59172
Transients: Rename filters added in [34865].
...
* `expiration_pre_set_transient_$transient` => `expiration_of_transient_$transient`
* `expiration_pre_set_site_transient_$transient` => `expiration_of_site_transient_$transient`
Fix hook docs.
Props chriscct7.
Fixes #21330 .
Built from https://develop.svn.wordpress.org/trunk@34877
git-svn-id: http://core.svn.wordpress.org/trunk@34842 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-06 17:59:25 +00:00
Scott Taylor
1dcc6e1b51
Transients, add filters for `$expiration`:
...
* `'expiration_pre_set_site_transient_' . $transient`
* `'expiration_pre_set_transient_' . $transient`
Props chriscct7, wpsmith, nacin.
Fixes #21330 .
Built from https://develop.svn.wordpress.org/trunk@34865
git-svn-id: http://core.svn.wordpress.org/trunk@34830 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-06 14:10:25 +00:00
Boone Gorges
0e7c1d3b14
Use `wp_installing()` instead of `WP_INSTALLING` constant.
...
The `WP_INSTALLING` constant is a flag that WordPress sets in a number of
places, telling the system that options should be fetched directly from the
database instead of from the cache, that WP should not ping wordpress.org for
updates, that the normal "not installed" checks should be bypassed, and so on.
A constant is generally necessary for this purpose, because the flag is
typically set before the WP bootstrap, meaning that WP functions are not yet
available. However, it is possible - notably, during `wpmu_create_blog()` -
for the "installing" flag to be set after WP has already loaded. In these
cases, `WP_INSTALLING` would be set for the remainder of the process, since
there's no way to change a constant once it's defined. This, in turn, polluted
later function calls that ought to have been outside the scope of site
creation, particularly the non-caching of option data. The problem was
particularly evident in the case of the automated tests, where `WP_INSTALLING`
was set the first time a site was created, and remained set for the rest of the
suite.
The new `wp_installing()` function allows developers to fetch the current
installation status (when called without any arguments) or to set the
installation status (when called with a boolean `true` or `false`). Use of
the `WP_INSTALLING` constant is still supported; `wp_installing()` will default
to `true` if the constant is defined during the bootstrap.
Props boonebgorges, jeremyfelt.
See #31130 .
Built from https://develop.svn.wordpress.org/trunk@34828
git-svn-id: http://core.svn.wordpress.org/trunk@34793 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-05 15:06:28 +00:00
Jeremy Felt
dba5a73119
Docs: Add deprecation note for `$use_cache` in `get_site_option()`.
...
Props johnbillion.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@34779
git-svn-id: http://core.svn.wordpress.org/trunk@34744 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-02 19:32:30 +00:00
Jeremy Felt
54512d64cb
MS: Use `*_network_option()` functions throughout core.
...
Replaces all uses of `*_site_option()` with the corresponding "network" function.
This excludes one usage in `wp-admin/admin-footer.php` that needs more investigation.
Props spacedmonkey.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@34778
git-svn-id: http://core.svn.wordpress.org/trunk@34743 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-02 19:08:26 +00:00
Jeremy Felt
3c2273ef45
MS: Introduce `*_network_option` functions.
...
Introduces `add_network_option()`, `update_network_option()`, `get_network_option()`, and `delete_network_option()`, which use the internals previously found in the `*_site_option()` functions and allow for a network ID to enable cross network storage and retrieval of network options.
* `*_site_option()` functions are now wrappers for `*_network_option()` and will interact with options for the current network in a multisite environment.
* All will continue to fallback to `*_option()` for non-multisite uses.
* Adds basic tests for cross network storage and retrieval.
* Existing tests for `*_site_option()` functions provide coverage for storage and retrieval of current network options.
Props spacedmonkey, DrewAPicture, jeremyfelt.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@34777
git-svn-id: http://core.svn.wordpress.org/trunk@34742 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-02 18:01:27 +00:00
Jeremy Felt
e2c6216b21
MS: Remove `@todo` for `ms_protect_special_option()` from `delete_site_option()`.
...
This todo has been in place since the original merge of MU. At the time of merge, `wpmu_protect_special_option()` protected an empty array, and there has been no noticeable need since. As we introduce `_network_option()`, let's leave this behind. A new ticket can be opened if necessary.
See #28290 .
Built from https://develop.svn.wordpress.org/trunk@34756
git-svn-id: http://core.svn.wordpress.org/trunk@34721 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-10-01 22:46:28 +00:00
Sergey Biryukov
99c85c5b45
Update the length limit in `set_transient()` docs after [34030].
...
Props OriginalEXE.
Fixes #13310 .
Built from https://develop.svn.wordpress.org/trunk@34045
git-svn-id: http://core.svn.wordpress.org/trunk@34013 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-11 15:10:27 +00:00
Scott Taylor
a829ee32ce
User Settings: allow dashes in `get|set_user_setting()` in PHP and `get|setUserSetting()` in JS.
...
Add unit tests - there were none. Mock `set_user_setting()` since it won't run due to `headers_sent()` being `true`.
Fixes #22781 .
Built from https://develop.svn.wordpress.org/trunk@33840
git-svn-id: http://core.svn.wordpress.org/trunk@33808 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-09-01 03:57:21 +00:00
Drew Jaynes
6a839cf091
Docs: Add a changelog entry to the `set_site_transient_$transient` hook doc for the `$transient` parameter, added in [33738].
...
Fixes #28402 .
Built from https://develop.svn.wordpress.org/trunk@33794
git-svn-id: http://core.svn.wordpress.org/trunk@33762 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:41:21 +00:00
Drew Jaynes
0c2d49b844
Docs: Add a changelog entry to the `pre_set_site_transient_$transient` hook doc for the `$transient` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33793
git-svn-id: http://core.svn.wordpress.org/trunk@33761 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:40:21 +00:00
Drew Jaynes
45c5fe16c2
Docs: Add a changelog entry to the `site_transient_$transient` hook doc for the `$transient` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33792
git-svn-id: http://core.svn.wordpress.org/trunk@33760 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:39:21 +00:00
Drew Jaynes
5e8df999b8
Docs: Add a changelog entry to the `pre_site_transient_$transient` hook doc for the `$transient` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33791
git-svn-id: http://core.svn.wordpress.org/trunk@33759 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:37:21 +00:00
Drew Jaynes
2f926931a0
Docs: Add a changelog entry to the `pre_update_site_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33790
git-svn-id: http://core.svn.wordpress.org/trunk@33758 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:36:21 +00:00
Drew Jaynes
9342ae98e9
Docs: Add a changelog entry to the `pre_delete_site_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33789
git-svn-id: http://core.svn.wordpress.org/trunk@33757 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:35:21 +00:00
Drew Jaynes
f62b7a70ba
Docs: Add a changelog entry to the `pre_add_site_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33788
git-svn-id: http://core.svn.wordpress.org/trunk@33756 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:34:21 +00:00
Drew Jaynes
5d1a7579b2
Docs: Add a changelog entry to the `site_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33787
git-svn-id: http://core.svn.wordpress.org/trunk@33755 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:32:21 +00:00
Drew Jaynes
6ec59018cf
Docs: Add a changelog entry to the `default_site_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33786
git-svn-id: http://core.svn.wordpress.org/trunk@33754 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:31:21 +00:00
Drew Jaynes
111559495f
Docs: Add a changelog entry to the `pre_site_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33785
git-svn-id: http://core.svn.wordpress.org/trunk@33753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:30:20 +00:00
Drew Jaynes
94775c9391
Docs: Add a changelog entry to the `pre_set_transient_$transient` hook doc for the `$transient` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33784
git-svn-id: http://core.svn.wordpress.org/trunk@33752 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:29:21 +00:00
Drew Jaynes
df9aa619d7
Docs: Add a changelog entry to the `transient_$transient` hook doc for the `$transient` parameter, introduced in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33783
git-svn-id: http://core.svn.wordpress.org/trunk@33751 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:27:20 +00:00
Drew Jaynes
d850f67df6
Docs: Add a changelog entry to the `pre_transient_$transient` hook doc for the `$transient` parameter, introduced in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33782
git-svn-id: http://core.svn.wordpress.org/trunk@33750 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:25:21 +00:00
Drew Jaynes
7cec289b60
Docs: Add a changelog entry to the `update_option_{$option}` hook doc for the `$option` parameter, introduced in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33781
git-svn-id: http://core.svn.wordpress.org/trunk@33749 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:24:21 +00:00
Drew Jaynes
96cd3a4a3c
Docs: Add a changelog entry to the `pre_update_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33780
git-svn-id: http://core.svn.wordpress.org/trunk@33748 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:22:20 +00:00
Drew Jaynes
e33d5c45bc
Docs: Add a changelog entry to the `option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402 .
Built from https://develop.svn.wordpress.org/trunk@33779
git-svn-id: http://core.svn.wordpress.org/trunk@33747 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:20:20 +00:00
Drew Jaynes
7c02c6b6fb
Docs: Add a changelog entry to the `default_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402
Built from https://develop.svn.wordpress.org/trunk@33778
git-svn-id: http://core.svn.wordpress.org/trunk@33746 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-28 15:18:22 +00:00
Drew Jaynes
4affa545d0
Docs: Add a changelog entry to the `pre_option_$option` hook doc for the `$option` parameter, added in [33738].
...
See #28402
Built from https://develop.svn.wordpress.org/trunk@33768
git-svn-id: http://core.svn.wordpress.org/trunk@33736 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-27 17:00:24 +00:00
Scott Taylor
a13230b93f
Pass option name to option and transient filters with dynamic names.
...
Props Viper007Bond, SergeyBiryukov, MikeHansenMe.
Fixes #28402 .
Built from https://develop.svn.wordpress.org/trunk@33738
git-svn-id: http://core.svn.wordpress.org/trunk@33706 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-08-25 21:42:20 +00:00
Dominik Schilling
92fe9c9649
Transients: If `get_option( $transient_timeout )` returns false, don't bother trying to delete the transient in `get_transient()`.
...
props jamesgol, ericmann.
fixes #30380 .
Built from https://develop.svn.wordpress.org/trunk@33110
git-svn-id: http://core.svn.wordpress.org/trunk@33081 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-07-07 16:45:26 +00:00
Scott Taylor
26855e651b
In `get_site_option()` and `get_option()`, ensure that `$notoptions` is an array before writing to it. Prevents a flood of `Cannot use a scalar value as an array`, because `$notoptions` is otherwise set to the result of `wp_cache_get()`, which returns `mixed`.
...
Props hauvong.
Fixes #31147 .
Built from https://develop.svn.wordpress.org/trunk@32943
git-svn-id: http://core.svn.wordpress.org/trunk@32914 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-25 19:01:26 +00:00
Scott Taylor
ea89aeee0b
Fix doc blocks for `option.php`.
...
See #32444 .
Built from https://develop.svn.wordpress.org/trunk@32613
git-svn-id: http://core.svn.wordpress.org/trunk@32583 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-26 22:17:25 +00:00
Drew Jaynes
73892c112c
Update the DocBlock description for `update_option()` to account for the ability to define the `$autoload` parameter, added in 4.2.
...
Props Clorith for the initial patch.
Fixes #32331 .
Built from https://develop.svn.wordpress.org/trunk@32481
git-svn-id: http://core.svn.wordpress.org/trunk@32451 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-05-10 16:58:27 +00:00
Boone Gorges
305cf8b95e
Allow `$autoload` setting to be changed for existing options using `update_option()`.
...
[31628] made it possible to pass an `$autoload` param to `update_option()` that
applies when the option does not yet exist in the database. The current
changeset introduces parity for existing options: the `$autoload` setting
for existing options can be changed via the `$autoload` parameter. For internal
simplicity, `$autoload` is ignored for existing options when `$value` is not
also changed.
This changeset also moves `update_option()` tests into their own class.
Props dd32.
Fixes #26394 .
Built from https://develop.svn.wordpress.org/trunk@31640
git-svn-id: http://core.svn.wordpress.org/trunk@31621 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-03-06 13:57:26 +00:00