Oddities in add(_site)_option

[duck_]

[13139] made a number of changes to standardise the the values returned by the options API. However add_option() will still return null when the option already exists. This should be changed to return false and the @return docs updated.

I then also spotted a difference in the behaviour of add_option() vs. add_site_option(). add_option() will just stop if the option already exists, see above, but add_site_option() will call update_site_option().

On singlesite installs add_site_option() is just a wrapper for add_option() so calling add_site_option() has different behaviour on multisite vs. singlesite.

[duck_]

return false in add_option

[duck_]

Patch attached for always returning a boolean from add_option().

[nacin]

add_site_option() will call update_site_option().

That is terrible.

I'm good on 18422.diff.

[duck_]

In [18567]:

add_option() should always return a boolean, see #18422

[duck_]

Patch attached for the 2nd part of the ticket. add_site_option() shouldn't update_site_option() if it already exists. Thoughts please, aye or nay?

[edwardw]

Replying to duck_:

Patch attached for the 2nd part of the ticket. add_site_option() shouldn't update_site_option() if it already exists. Thoughts please, aye or nay?

According to the ​Codex it says it should overwrite the existing value.

[duck_]

Replying to edwardw:

According to the ​Codex it says it should overwrite the existing value.

Thanks. Though it doesn't say it should rather that it will, this is specifically noted as a warning which also mentions that this behaviour is contrary to that of add_option().

[ryan]

Unit tests: ​http://unit-tests.trac.wordpress.org/browser/wp-testcase/test_option.php

[ryan]

I'm fine with 18422.add-shouldnt-update.diff

[ryan]

Also, add_site_option() returns 1 instead of true when in multisite mode.

[nacin]

Likewise. A note in the phpdoc, codex, and wpdevel would be prudent, as would doing this now rather than later.

Would also be okay with 1 => true.

[ryan]

1 =>true

[ryan]

That returns true instead of 1 and incorporates 18422.add-shouldnt-update.diff. With that patch the unit tests run clean against multisite.

[duck_]

In [18587]:

add_site_option should not update existing options, should return a boolean and should only run actions on success. fixes #18422

[duck_]

Also made a quick modification to the codex to indicate that this change was made.