Initial commit: WordPress wp-content (themes, plugins, languages)
- Theme: momentry (custom theme with REST API routes) - Plugins: code-snippets (contains all API proxies) - Languages: zh_TW translations - Excludes: cache, backups, uploads, logs
This commit is contained in:
OpenCode
351
plugins/code-snippets/php/settings/settings.php
Normal file
351
plugins/code-snippets/php/settings/settings.php
Normal file
@@ -0,0 +1,351 @@
|
||||
<?php
|
||||
/**
|
||||
* This file registers the settings
|
||||
*
|
||||
* @package Code_Snippets
|
||||
* @subpackage Settings
|
||||
*/
|
||||
|
||||
namespace Code_Snippets\Settings;
|
||||
|
||||
use Code_Snippets\Welcome_API;
|
||||
use function Code_Snippets\clean_snippets_cache;
|
||||
use function Code_Snippets\code_snippets;
|
||||
use const Code_Snippets\CACHE_GROUP;
|
||||
|
||||
const CACHE_KEY = 'code_snippets_settings';
|
||||
const OPTION_GROUP = 'code-snippets';
|
||||
const OPTION_NAME = 'code_snippets_settings';
|
||||
|
||||
/**
|
||||
* Add a new option for either the current site or the current network
|
||||
*
|
||||
* @param bool $network Whether to add a network-wide option.
|
||||
* @param string $option Name of option to add. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Option value, can be anything. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return bool False if the option was not added. True if the option was added.
|
||||
*/
|
||||
function add_self_option( bool $network, string $option, $value ): bool {
|
||||
return $network ? add_site_option( $option, $value ) : add_option( $option, $value );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an option value based on an option name from either the current site or the current network
|
||||
*
|
||||
* @param bool $network Whether to get a network-wide option.
|
||||
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
|
||||
* @param mixed $default_value Optional value to return if option doesn't exist. Default false.
|
||||
*
|
||||
* @return mixed Value set for the option.
|
||||
*/
|
||||
function get_self_option( bool $network, string $option, $default_value = false ) {
|
||||
return $network ? get_site_option( $option, $default_value ) : get_option( $option, $default_value );
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the value of an option that was already added on the current site or the current network
|
||||
*
|
||||
* @param bool $network Whether to update a network-wide option.
|
||||
* @param string $option Name of option. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Option value. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return bool False if value was not updated. True if value was updated.
|
||||
*/
|
||||
function update_self_option( bool $network, string $option, $value ): bool {
|
||||
return $network ? update_site_option( $option, $value ) : update_option( $option, $value );
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns 'true' if plugin settings are unified on a multisite installation
|
||||
* under the Network Admin settings menu
|
||||
*
|
||||
* This option is controlled by the "Enable administration menus" setting on the Network Settings menu
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
function are_settings_unified(): bool {
|
||||
if ( ! is_multisite() ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$menu_perms = get_site_option( 'menu_items', array() );
|
||||
return empty( $menu_perms['snippets_settings'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the setting values from the database.
|
||||
* If a setting does not exist in the database, the default value will be returned.
|
||||
*
|
||||
* @return array<string, array<string, mixed>>
|
||||
*/
|
||||
function get_settings_values(): array {
|
||||
$settings = wp_cache_get( CACHE_KEY, CACHE_GROUP );
|
||||
if ( $settings ) {
|
||||
return $settings;
|
||||
}
|
||||
|
||||
$settings = get_default_settings();
|
||||
$saved = get_self_option( are_settings_unified(), OPTION_NAME, array() );
|
||||
|
||||
foreach ( $settings as $section => $fields ) {
|
||||
if ( isset( $saved[ $section ] ) ) {
|
||||
$settings[ $section ] = array_replace( $fields, $saved[ $section ] );
|
||||
}
|
||||
}
|
||||
|
||||
wp_cache_set( CACHE_KEY, $settings, CACHE_GROUP );
|
||||
return $settings;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an individual setting field value
|
||||
*
|
||||
* @param string $section ID of the section the setting belongs to.
|
||||
* @param string $field ID of the setting field.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
function get_setting( string $section, string $field ) {
|
||||
$settings = get_settings_values();
|
||||
|
||||
return $settings[ $section ][ $field ] ?? null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a single setting to a new value.
|
||||
*
|
||||
* @param string $section ID of the section the setting belongs to.
|
||||
* @param string $field ID of the setting field.
|
||||
* @param mixed $new_value Setting value. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return bool False if value was not updated. True if value was updated.
|
||||
*/
|
||||
function update_setting( string $section, string $field, $new_value ): bool {
|
||||
$settings = get_settings_values();
|
||||
|
||||
$settings[ $section ][ $field ] = $new_value;
|
||||
|
||||
wp_cache_set( CACHE_KEY, $settings, CACHE_GROUP );
|
||||
return update_self_option( are_settings_unified(), OPTION_NAME, $settings );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the settings sections
|
||||
*
|
||||
* @return array<string, string> Settings sections.
|
||||
*/
|
||||
function get_settings_sections(): array {
|
||||
$sections = array(
|
||||
'general' => __( 'General', 'code-snippets' ),
|
||||
'editor' => __( 'Code Editor', 'code-snippets' ),
|
||||
'debug' => __( 'Debug', 'code-snippets' ),
|
||||
);
|
||||
|
||||
// Only show the Version section when the debug setting to enable version changes is enabled.
|
||||
$enable_version = get_setting( 'debug', 'enable_version_change' );
|
||||
if ( $enable_version ) {
|
||||
$sections['version-switch'] = __( 'Version', 'code-snippets' );
|
||||
}
|
||||
|
||||
return apply_filters( 'code_snippets_settings_sections', $sections );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register settings sections, fields, etc
|
||||
*/
|
||||
function register_plugin_settings() {
|
||||
if ( are_settings_unified() ) {
|
||||
if ( ! get_site_option( OPTION_NAME ) ) {
|
||||
add_site_option( OPTION_NAME, get_default_settings() );
|
||||
}
|
||||
} elseif ( ! get_option( OPTION_NAME ) ) {
|
||||
add_option( OPTION_NAME, get_default_settings() );
|
||||
}
|
||||
|
||||
// Register the setting.
|
||||
register_setting(
|
||||
OPTION_GROUP,
|
||||
OPTION_NAME,
|
||||
[ 'sanitize_callback' => __NAMESPACE__ . '\\sanitize_settings' ]
|
||||
);
|
||||
|
||||
// Register settings sections.
|
||||
foreach ( get_settings_sections() as $section_id => $section_name ) {
|
||||
add_settings_section( $section_id, $section_name, '__return_empty_string', 'code-snippets' );
|
||||
}
|
||||
|
||||
// Register settings fields. Only register fields for sections that exist (some sections may be gated by settings).
|
||||
$registered_sections = get_settings_sections();
|
||||
foreach ( get_settings_fields() as $section_id => $fields ) {
|
||||
if ( ! isset( $registered_sections[ $section_id ] ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ( $fields as $field_id => $field ) {
|
||||
$field_object = new Setting_Field( $section_id, $field_id, $field );
|
||||
add_settings_field( $field_id, $field['name'], [ $field_object, 'render' ], 'code-snippets', $section_id );
|
||||
}
|
||||
}
|
||||
|
||||
// Add editor preview as a field.
|
||||
add_settings_field(
|
||||
'editor_preview',
|
||||
__( 'Editor Preview', 'code-snippets' ),
|
||||
__NAMESPACE__ . '\\render_editor_preview',
|
||||
'code-snippets',
|
||||
'editor'
|
||||
);
|
||||
}
|
||||
|
||||
add_action( 'admin_init', __NAMESPACE__ . '\\register_plugin_settings' );
|
||||
|
||||
/**
|
||||
* Sanitize a single setting value.
|
||||
*
|
||||
* @param array<string, mixed> $field Setting field information.
|
||||
* @param mixed $input_value User input setting value, or null if missing.
|
||||
*
|
||||
* @return mixed Sanitized setting value, or null if unset.
|
||||
*/
|
||||
function sanitize_setting_value( array $field, $input_value ) {
|
||||
switch ( $field['type'] ) {
|
||||
|
||||
case 'checkbox':
|
||||
return 'on' === $input_value;
|
||||
|
||||
case 'number':
|
||||
return intval( $input_value );
|
||||
|
||||
case 'select':
|
||||
$select_options = array_map( 'strval', array_keys( $field['options'] ) );
|
||||
return in_array( strval( $input_value ), $select_options, true ) ? $input_value : null;
|
||||
|
||||
case 'checkboxes':
|
||||
$results = [];
|
||||
|
||||
if ( ! empty( $input_value ) ) {
|
||||
foreach ( $field['options'] as $option_id => $option_label ) {
|
||||
if ( isset( $input_value[ $option_id ] ) && 'on' === $input_value[ $option_id ] ) {
|
||||
$results[] = $option_id;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $results;
|
||||
|
||||
case 'text':
|
||||
case 'hidden':
|
||||
return trim( sanitize_text_field( $input_value ) );
|
||||
|
||||
case 'callback':
|
||||
return isset( $field['sanitize_callback'] ) && is_callable( $field['sanitize_callback'] ) ?
|
||||
call_user_func( $field['sanitize_callback'], $input_value ) :
|
||||
null;
|
||||
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Process settings actions.
|
||||
*
|
||||
* @param array $input Provided settings input.
|
||||
*
|
||||
* @return array|null New $input value to return, or null to continue with settings update process.
|
||||
*/
|
||||
function process_settings_actions( array $input ): ?array {
|
||||
|
||||
if ( isset( $input['reset_settings'] ) ) {
|
||||
add_settings_error(
|
||||
OPTION_NAME,
|
||||
'settings_reset',
|
||||
__( 'All settings have been reset to their defaults.', 'code-snippets' ),
|
||||
'updated'
|
||||
);
|
||||
|
||||
delete_option( 'code_snippets_cloud_settings' );
|
||||
return [];
|
||||
}
|
||||
|
||||
if ( isset( $input['debug']['database_update'] ) ) {
|
||||
code_snippets()->db->create_or_upgrade_tables();
|
||||
|
||||
add_settings_error(
|
||||
OPTION_NAME,
|
||||
'database_update_done',
|
||||
__( 'Successfully performed database table upgrade.', 'code-snippets' ),
|
||||
'updated'
|
||||
);
|
||||
}
|
||||
|
||||
if ( isset( $input['debug']['reset_caches'] ) ) {
|
||||
Welcome_API::clear_cache();
|
||||
clean_snippets_cache( code_snippets()->db->get_table_name( false ) );
|
||||
|
||||
if ( is_multisite() ) {
|
||||
clean_snippets_cache( code_snippets()->db->get_table_name( true ) );
|
||||
}
|
||||
|
||||
add_settings_error(
|
||||
OPTION_NAME,
|
||||
'snippet_caches_reset',
|
||||
__( 'Successfully reset snippets caches.', 'code-snippets' ),
|
||||
'updated'
|
||||
);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate the settings
|
||||
*
|
||||
* @param array<string, array<string, mixed>> $input The received settings.
|
||||
*
|
||||
* @return array<string, array<string, mixed>> The validated settings.
|
||||
*/
|
||||
function sanitize_settings( array $input ): array {
|
||||
wp_cache_delete( CACHE_KEY, CACHE_GROUP );
|
||||
$result = process_settings_actions( $input );
|
||||
|
||||
if ( ! is_null( $result ) ) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
$settings = get_settings_values();
|
||||
$updated = false;
|
||||
|
||||
// Don't directly loop through $input as it does not include as deselected checkboxes.
|
||||
foreach ( get_settings_fields() as $section_id => $fields ) {
|
||||
foreach ( $fields as $field_id => $field ) {
|
||||
|
||||
// Fetch the corresponding input value from the posted data.
|
||||
$input_value = $input[ $section_id ][ $field_id ] ?? null;
|
||||
|
||||
// Attempt to sanitize the setting value.
|
||||
$sanitized_value = sanitize_setting_value( $field, $input_value );
|
||||
|
||||
$current_value = $settings[ $section_id ][ $field_id ] ?? null;
|
||||
if ( ! is_null( $sanitized_value ) && $current_value !== $sanitized_value ) {
|
||||
$settings[ $section_id ][ $field_id ] = $sanitized_value;
|
||||
$updated = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Add an updated message.
|
||||
if ( $updated ) {
|
||||
add_settings_error(
|
||||
OPTION_NAME,
|
||||
'settings-saved',
|
||||
__( 'Settings saved.', 'code-snippets' ),
|
||||
'updated'
|
||||
);
|
||||
|
||||
do_action( 'code_snippets/settings_updated', $settings, $input );
|
||||
}
|
||||
|
||||
return $settings;
|
||||
}
|
||||
Reference in New Issue
Block a user