Question

delete_user_setting( string $names )

Delete user interface settings.

---

description

Deleting settings would reset them to the defaults.

This function has to be used before any output has started as it calls setcookie().

---

参数

$names

(string) (Required) The name or array of names of the setting to be deleted.

---

返回值

(bool|null) True if deleted successfully, false if not. Null if the current user can't be established.

---

源代码

File: wp-includes/option.php

function delete_user_setting( $names ) {
	if ( headers_sent() ) {
		return false;
	}

	$all_user_settings = get_all_user_settings();
	$names = (array) $names;
	$deleted = false;

	foreach ( $names as $name ) {
		if ( isset( $all_user_settings[$name] ) ) {
			unset( $all_user_settings[$name] );
			$deleted = true;
		}
	}

	if ( $deleted ) {
		return wp_set_all_user_settings( $all_user_settings );
	}

	return false;
}

---

更新日志

Version	description
2.7.0	Introduced.

---

相关函数

Uses

• wp-includes/option.php: get_all_user_settings()
• wp-includes/option.php: wp_set_all_user_settings()

---

Used By

• wp-admin/includes/user.php: default_password_nag_handler()
• wp-admin/includes/user.php: default_password_nag_edit_user()

---

User Contributed Notes