\WP_Buoy_User_Settings

__construct()

__construct(integer|\WP_User  $user) : \WP_Buoy_User_Settings

Constructor.

Parameters

Returns

get_defaults()

get_defaults(string  $key = null) : mixed

Gets a user setting default, or all defaults.

Parameters

Returns

get()

get(string  $key, mixed  $default = null) : mixed

Retrieves a user option.

Parameters

Returns

The current option value, or the $default parameter if the option doesn't exist.

set()

set(string  $key, mixed  $value) : \WP_Buoy_User_Settings

Sets a user option.

Returns the current instance for chaining.

Parameters

Returns

has()

has(string  $key) : boolean

Checks whether a given option name is set.

Parameters

Returns

save()

save() : \WP_Buoy_User_Settings

Saves the current options to the database in user meta fields.

If an option doesn't exist in the $options array, after it was deleted with WP_Buoy_User_Settings::delete(), for instance, it will be deleted from the database, too.

Multiple user meta fields are used so that the WP database is more easily queryable to allow, for example, finding all users whose phone company is Verizon. This aids in debugging issues.

Returns

delete()

delete(string  $key) : \WP_Buoy_User_Settings

Removes an option from the current instance's $options array.

Returns the current instance for chaining.

Parameters

Returns

get_options()

get_options() : array

Retrieves user's Buoy settings from the WordPress database.

Returns