Newer
Older
if (!class_exists('\WPCT_ABSTRACT\Settings')) :
abstract class Settings extends Singleton
protected $group_name;
abstract public function register();
public static function get_setting($group_name, $setting, $field = null)
$default = static::get_default($group_name, $setting);
$setting_name = $group_name . '_' . $setting;
$setting = isset(static::$cache[$setting_name]) ? static::$cache[$setting_name] : get_option($setting_name, $default);
return isset($setting[$field]) ? $setting[$field] : null;
public static function get_default($group_name, $setting, $field = null)
$default = isset(static::$defaults[$setting_name]) ? static::$defaults[$setting_name] : [];
$default = apply_filters($setting_name . '_default', $default);
return isset($default[$field]) ? $default[$field] : null;
public static function get_schema($group_name, $setting, $field = null)
$schema = isset(static::$schemas[$setting_name]) ? static::$schemas[$setting_name] : [];
$schema = apply_filters($setting_name . '_schema', $schema);
return isset($schema[$field]) ? $schema[$field] : null;
add_filter('pre_update_option', function ($value, $option, $from) {
return $this->sanitize_option($option, $value);
}, 10, 3);
{
return $this->group_name;
public function get_settings()
{
$settings = [];
foreach (array_keys(self::$defaults) as $setting) {
$settings[] = $setting;
}
}
return $settings;
}
public function register_setting($setting, $schema = null, $default = [])
$setting_name = $this->setting_name($setting);
self::$schemas[$setting_name] = $schema;
self::$defaults[$setting_name] = $default;
$default = self::get_default($this->group_name, $setting);
$schema = self::get_schema($this->group_name, $setting);
'type' => 'object',
'show_in_rest' => $schema ? [
'schema' => [
'type' => 'object',
'properties' => $schema
],
] : false,
'type' => 'object',
'default' => $default,
add_action('add_option', function ($option, $value) use ($setting_name) {
if ($option === $setting_name && !empty($to)) {
static::$cache[$setting_name] = $value;
}
}, 90, 2);
add_action('update_option', function ($option, $from, $to) use ($setting_name) {
if ($option === $setting_name && !empty($to)) {
static::$cache[$setting_name] = $to;
}
}, 90, 3);
add_action('admin_init', function () use ($setting_name, $setting) {
$setting_name . '_section',
__($setting_name . '--title', $this->group_name),
function () use ($setting_name) {
$title = __($setting_name . '--description', $this->group_name);
foreach (array_keys(self::$defaults[$setting_name]) as $field) {
$this->add_settings_field($field, $setting);
private function add_settings_field($field_name, $setting)
$field_id = $setting_name . '__' . $field_name;
add_settings_field(
$field_name,
__($field_id . '--label', $this->group_name),
function () use ($setting, $field_name) {
echo $this->field_render($setting, $field_name);
[
'class' => $field_id,
{
$args = func_get_args();
$setting = $args[0];
$field = $args[1];
if (count($args) >= 3) {
$value = $args[2];
} else {
$value = new Undefined();
return $this->_field_render($setting, $field, $value);
private function _field_render($setting, $field, $value)
{
$is_root = false;
if ($value instanceof Undefined) {
$value = self::get_setting($this->group_name, $setting, $field);
if (!is_array($value)) {
return $this->input_render($setting, $field, $value);
} else {
$fieldset = $this->fieldset_render($setting, $field, $value);
if ($is_root) {
$fieldset = $this->control_style($setting, $field)
. $fieldset . $this->control_render($setting, $field);
}
return $fieldset;
}
protected function input_render($setting, $field, $value)
$setting_name = $this->setting_name($setting);
$schema = self::get_schema($this->group_name, $setting);
$default_value = self::get_default($this->group_name, $setting);
$keys = explode('][', $field);
$is_list = is_list($default_value);
for ($i = 0; $i < count($keys); $i++) {
$key = $keys[$i];
if ($is_list) {
$key = (int) $key;
}
$default_value = $default_value[$key];
if ($i === 0) {
$schema = $schema[$key];
}
$is_list = is_list($default_value);
}
$is_bool = is_bool($default_value);
if ($is_bool) {
$is_bool = true;
$value = 'on' === $value;
}
if ($is_bool) {
return "<input type='checkbox' name='{$setting_name}[{$field}]' " . ($value ? 'checked' : '') . " />";
return "<input type='text' name='{$setting_name}[{$field}]' value='{$value}' />";
private function fieldset_render($setting, $field, $data)
$setting_name = $this->setting_name($setting);
$table_id = $setting_name . '__' . str_replace('][', '_', $field);
$fieldset = "<table id='{$table_id}'>";
$is_list = is_list($data);
foreach (array_keys($data) as $key) {
$fieldset .= '<tr>';
if (!$is_list) {
$fieldset .= "<th>{$key}</th>";
}
$_field = $field . '][' . $key;
$fieldset .= "<td>{$this->field_render($setting, $_field, $data[$key])}</td>";
$fieldset .= '</tr>';
}
$fieldset .= '</table>';
return $fieldset;
}
private function control_render($setting, $field)
$setting_name = $this->setting_name($setting);
$default = self::get_default($this->group_name, $setting);
ob_start();
?>
<div class="<?= $setting_name; ?>__<?= $field ?>--controls">
<button class="button button-primary" data-action="add">Add</button>
<button class="button button-secondary" data-action="remove">Remove</button>
</div>
<?php include 'fieldset-control-js.php' ?>
<?php
return ob_get_clean();
}
$setting_name = $this->setting_name($setting);
return "<style>#{$setting_name}__{$field} td td,#{$setting_name}__{$field} td th{padding:0}#{$setting_name}__{$field} table table{margin-bottom:1rem}</style>";
}
protected function setting_name($setting)
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
private function sanitize_option($option, $value)
{
$settings = $this->get_settings();
if (in_array($option, $settings)) {
[$group, $setting] = explode('_', $option);
$default = Settings::get_default($group, $setting);
if (empty($value)) {
return $default;
}
$schema = Settings::get_schema($group, $setting);
try {
return $this->sanitize_object($schema, $value, $default);
} catch (Error) {
return $default;
}
}
return $value;
}
private function sanitize_object($schema, $value, $default)
{
foreach ($schema as $key => $defn) {
if (empty($value[$key])) {
$value[$key] = $default[$key];
} else {
if ($defn['type'] === 'array') {
$value[$key] = $this->sanitize_array($defn['items'], $value[$key], $default[$key] ?: []);
} elseif ($defn['type'] === 'object') {
$value[$key] = $this->sanitize_object($defn['properties'], $value[$key], $default[$key] ?: []);
} else {
$value[$key] = empty($value[$key]) ? $default[$key] : $value[$key];
}
}
}
foreach (array_keys($value) as $key) {
if (!in_array($key, array_keys($schema))) {
unset($value[$key]);
};
}
return $value;
}
private function sanitize_array($schema, $value, $defaults)
{
$default = null;
for ($i = 0; $i < count($value); $i++) {
$default = count($defaults) > $i ? array_shift($defaults) : $default;
if ($schema['type'] === 'array') {
$value[$i] = $this->sanitize_array($schema['items'], $value[$i], $default ?: []);
} elseif ($schema['type'] === 'object') {
$value[$i] = $this->sanitize_object($schema['properties'], $value[$i], $default ?: []);
} else {
$value[$i] = empty($value[$i]) ? $default[0] : $value[$i];
}
}
return $value;
}
if (!function_exists('\WPCT_ABSTRACT\is_list')) :
function is_list($arr)
{
if (!is_array($arr)) {
return false;
}
if (sizeof($arr) === 0) {
return true;
}
return array_keys($arr) === range(0, count($arr) - 1);