phpdoc corrections from jacobsantos. see #7918

git-svn-id: https://develop.svn.wordpress.org/trunk@9243 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Ryan Boren
2008-10-18 20:46:30 +00:00
parent a612119693
commit b406bec607
10 changed files with 110 additions and 44 deletions

View File

@@ -646,12 +646,13 @@ function delete_option( $name ) {
/**
* Saves and restores user interface settings stored in a cookie.
*
* Checks if the current user-settings cookie is updated and stores it. When no
* cookie exists (different browser used), adds the last saved cookie restoring
* the settings.
*
* @package WordPress
* @subpackage Option
* @since 2.7.0
*
* Checks if the current user-settings cookie is updated and stores it.
* When no cookie exists (different browser used), adds the last saved cookie restoring the settings.
*/
function wp_user_settings() {
@@ -690,8 +691,8 @@ function wp_user_settings() {
*
* @package WordPress
* @subpackage Option
* @since 2.7.0
*
* @since 2.7.0
*
* @param string $name The name of the setting.
* @param string $default Optional default value to return when $name is not set.
* @return mixed the last saved user setting or the default value/false if it doesn't exist.
@@ -706,12 +707,12 @@ function get_user_setting( $name, $default = false ) {
/**
* Delete user interface settings.
*
* Deleting settings would reset them to the defaults.
*
* @package WordPress
* @subpackage Option
* @since 2.7.0
*
* Deleting settings would reset them to the defaults.
*
* @param mixed $names The name or array of names of the setting to be deleted.
*/
function delete_user_setting( $names ) {
@@ -763,6 +764,13 @@ function get_all_user_settings() {
return array();
}
/**
* Delete the user settings of the current user.
*
* @package WordPress
* @subpackage Option
* @since 2.7.0
*/
function delete_all_user_settings() {
if ( ! $user = wp_get_current_user() )
return;