Settings

Overview

Read and write AAM settings for a selected access level. Select the subject with AAM::api()->settings($access_level, $settings). Omit $access_level to use the current user or visitor.

PHP class: AAM_Framework_Service_Settings.

Method reference

Method	Purpose
`get_settings()`	Read this level’s settings.
`set_settings(array $settings)`	Replace this level’s settings.
`get_setting($key, $default = null)`	Read one setting.
`set_setting($key, $value)`	Write one setting.
`delete_setting($key)`	Delete one setting.
`reset()`	Remove one rule or all rules for this level.

Return values vary by method. Rule updates usually return bool; reads can return a value, null, or an array. Errors follow the service’s error_handling setting and may produce WP_Error.

Accepted identifiers

This service has no resource identifier. Pass a dot-separated setting key such as 'ui.theme' to get_setting(), set_setting(), or delete_setting(). set_settings() takes the complete settings array for the selected access level.

Example

$settings = AAM::api()->settings('role:subscriber');
$settings->set_setting('example.feature_enabled', true);
$enabled = $settings->get_setting('example.feature_enabled', false);

This writes one nested setting for Subscribers. $enabled reads it back, using false only if the key is missing.

Developer notes

Keys use dot notation for nested values.
set_settings() replaces the selected level’s settings array; set_setting() changes one key.
reset() clears settings for the selected access level.
The selected access level determines whose rules are stored or evaluated. See Access levels.

Behavior and parameters

get_setting($key, $default = null) reads a nested key. set_setting($key, $value) writes one. delete_setting($key) deletes one.
get_settings() returns the selected level’s explicitly stored array. set_settings($settings) replaces it; reset() clears the level’s settings.