RegisterSettingService.php
3 months ago
SettingService.php
2 days ago
SettingsServiceProvider.php
2 months ago
RegisterSettingService.php
123 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Settings; |
| 4 | |
| 5 | /** |
| 6 | * Settings registration service. |
| 7 | */ |
| 8 | class RegisterSettingService { |
| 9 | /** |
| 10 | * Our setting prefix. |
| 11 | * |
| 12 | * @var string |
| 13 | */ |
| 14 | protected $prefix = 'surecart_'; |
| 15 | |
| 16 | /** |
| 17 | * Holds the option group name. |
| 18 | * |
| 19 | * @var string |
| 20 | */ |
| 21 | protected $option_group; |
| 22 | |
| 23 | /** |
| 24 | * Holds the option name. |
| 25 | * |
| 26 | * @var string |
| 27 | */ |
| 28 | protected $option_name; |
| 29 | |
| 30 | /** |
| 31 | * Holds the options args. |
| 32 | * |
| 33 | * @var array |
| 34 | */ |
| 35 | protected $args = []; |
| 36 | |
| 37 | /** |
| 38 | * The autoload value for this option, or null to use WordPress default. |
| 39 | * |
| 40 | * @var bool|null |
| 41 | */ |
| 42 | protected $autoload; |
| 43 | |
| 44 | /** |
| 45 | * The full prefixed option name. |
| 46 | * |
| 47 | * @var string |
| 48 | */ |
| 49 | protected $full_option_name; |
| 50 | |
| 51 | /** |
| 52 | * Register a setting. |
| 53 | * |
| 54 | * @param string $option_group A settings group name. Should correspond to an allowed option key name. |
| 55 | * Default allowed option key names include 'general', 'discussion', 'media', |
| 56 | * 'reading', 'writing', and 'options'. |
| 57 | * @param string $option_name The name of an option to sanitize and save. |
| 58 | * @param array $args { |
| 59 | * Data used to describe the setting when registered. |
| 60 | * |
| 61 | * @type string $type The type of data associated with this setting. |
| 62 | * Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'. |
| 63 | * @type string $description A description of the data attached to this setting. |
| 64 | * @type callable $sanitize_callback A callback function that sanitizes the option's value. |
| 65 | * @type bool|array $show_in_rest Whether data associated with this setting should be included in the REST API. |
| 66 | * When registering complex settings, this argument may optionally be an |
| 67 | * array with a 'schema' key. |
| 68 | * @type mixed $default Default value when calling `get_option()`. |
| 69 | * @type bool $autoload Whether to autoload this option. Omit to use WordPress default. |
| 70 | */ |
| 71 | public function __construct( $option_group, $option_name, $args = [] ) { |
| 72 | $this->option_group = $option_group; |
| 73 | $this->full_option_name = $this->prefix . $option_name; |
| 74 | $this->option_name = $option_name; |
| 75 | $this->autoload = array_key_exists( 'autoload', $args ) ? $args['autoload'] : null; |
| 76 | $this->args = array_diff_key( $args, [ 'autoload' => '' ] ); |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Call registration hooks. |
| 81 | * |
| 82 | * @return void |
| 83 | */ |
| 84 | public function register() { |
| 85 | add_action( 'admin_init', [ $this, 'registerSetting' ] ); |
| 86 | add_action( 'rest_api_init', [ $this, 'registerSetting' ] ); |
| 87 | |
| 88 | if ( null !== $this->autoload ) { |
| 89 | add_filter( 'wp_default_autoload_value', [ $this, 'filterAutoload' ], 10, 3 ); |
| 90 | } |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Filter the default autoload value for this option. |
| 95 | * |
| 96 | * @param string|null $autoload The default autoload value. |
| 97 | * @param string $option The option name. |
| 98 | * @param mixed $value The option value. |
| 99 | * |
| 100 | * @return string|null |
| 101 | */ |
| 102 | public function filterAutoload( $autoload, $option, $value ) { |
| 103 | if ( $this->full_option_name !== $option ) { |
| 104 | return $autoload; |
| 105 | } |
| 106 | |
| 107 | return $this->autoload ? 'yes' : 'no'; |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * Register the setting |
| 112 | * |
| 113 | * @return void |
| 114 | */ |
| 115 | public function registerSetting() { |
| 116 | register_setting( |
| 117 | $this->option_group, |
| 118 | $this->full_option_name, |
| 119 | $this->args, |
| 120 | ); |
| 121 | } |
| 122 | } |
| 123 |