# woocommerce-pos/1.10.2/includes/Services/Settings.php

WCPOS – Point of Sale (POS) plugin for WooCommerce, version 1.10.2. 674 lines.

- Page: https://pluginprobe.com/plugins/woocommerce-pos/1.10.2/code/includes/Services/Settings.php
- Raw: https://pluginprobe.com/plugins/woocommerce-pos/1.10.2/raw/includes/Services/Settings.php
- Modified: 2026-08-25T07:52:20+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/woocommerce-pos/1.10.2/code/includes/Services/Settings.php#L10-L20`.

```php
<?php
/**
 * Settings.
 *
 * @package WCPOS\WooCommercePOS
 */

namespace WCPOS\WooCommercePOS\Services;

use WP_Error;
use WCPOS\WooCommercePOS\Interfaces\Settings_Section_Interface;
use WCPOS\WooCommercePOS\Services\Settings\Access_Section;
use WCPOS\WooCommercePOS\Services\Settings\Checkout_Section;
use WCPOS\WooCommercePOS\Services\Settings\Cloud_Print_Section;
use WCPOS\WooCommercePOS\Services\Settings\General_Section;
use WCPOS\WooCommercePOS\Services\Settings\License_Section;
use WCPOS\WooCommercePOS\Services\Settings\Section_Registry;
use WCPOS\WooCommercePOS\Services\Settings\Tax_Ids_Section;
use WCPOS\WooCommercePOS\Services\Settings\Tools_Section;
use WCPOS\WooCommercePOS\Services\Settings\Payment_Gateways_Section;
use WCPOS\WooCommercePOS\Services\Settings\Visibility_Section;
use const WCPOS\WooCommercePOS\VERSION;

/**
 * Settings Service class.
 */
class Settings {
	/**
	 * Prefix for the $wpdb->options table.
	 *
	 * @var string
	 */
	protected static $db_prefix = 'woocommerce_pos_settings_';

	/**
	 * The single instance of the class.
	 *
	 * @var null|Settings
	 */
	private static $instance = null;

	/**
	 * The Section Registry. Built lazily on first access so registrants can
	 * hook `woocommerce_pos_register_settings_sections` during plugins_loaded.
	 *
	 * @var null|Section_Registry
	 */
	private $registry = null;

	/**
	 * Get the Section Registry, building and populating it on first access.
	 *
	 * @return Section_Registry
	 */
	public function sections(): Section_Registry {
		if ( null === $this->registry ) {
			// Assign before firing the action: a re-entrant settings read from
			// inside a registration callback gets the partially built registry
			// instead of recursing forever.
			$this->registry = new Section_Registry();

			// All core sections are registered here, before the action fires so
			// extensions can rely on core sections already being present.
			$this->registry->register( new General_Section() );
			$this->registry->register( new Checkout_Section() );
			$this->registry->register( new Tools_Section() );
			$this->registry->register( new Tax_Ids_Section() );
			$this->registry->register( new Visibility_Section() );
			$this->registry->register( new Payment_Gateways_Section() );
			$this->registry->register( new Access_Section() );
			$this->registry->register( new License_Section() );
			$this->registry->register( new Cloud_Print_Section() );

			/**
			 * Fires when the Section Registry is built, letting Pro and
			 * extensions register their own Settings Sections.
			 *
			 * Fires lazily on the FIRST settings read of the request. Hook
			 * this action at plugin file load or early plugins_loaded —
			 * callbacks added after the first read never run.
			 *
			 * @since 1.10.0
			 *
			 * @param Section_Registry $registry The Section Registry.
			 *
			 * @hook woocommerce_pos_register_settings_sections
			 */
			do_action( 'woocommerce_pos_register_settings_sections', $this->registry );
		}

		return $this->registry;
	}

	/**
	 * Drop the built registry so tests can exercise registration. Not for
	 * production use.
	 */
	public function reset_sections_for_testing(): void {
		$this->registry = null;
	}

	/**
	 * Constructor is private to prevent direct instantiation.
	 * Use woocommerce_pos_get_settings() instead.
	 * Or Settings::instance() if you must.
	 */
	private function __construct() {
	}

	/**
	 * Gets the singleton instance.
	 *
	 * @return Settings
	 */
	public static function instance(): self {
		if ( null === self::$instance ) {
			self::$instance = new self();
		}

		return self::$instance;
	}

	/**
	 * Get settings for a specific section.
	 *
	 * @param string     $id  The settings section ID.
	 * @param null|mixed $key The specific setting key.
	 *
	 * @return null|array|mixed|WP_Error
	 */
	public function get_settings( string $id, $key = null ) {
		$section = $this->sections()->get( $id );

		if ( ! $section instanceof Settings_Section_Interface ) {
			return $this->unknown_section_error( $id );
		}

		$settings = $section->read();

		// If key is not provided, return the entire settings.
		if ( ! \is_string( $key ) ) {
			return $settings;
		}

		if ( ! isset( $settings[ $key ] ) ) {
			return new WP_Error(
				'woocommerce_pos_settings_error',
				// translators: 1. %s: Settings group id, 2. %s: Settings key.
				\sprintf( __( 'Settings with id %1$s and key %2$s not found', 'woocommerce-pos' ), $id, $key ),
				array( 'status' => 400 )
			);
		}

		return $settings[ $key ];
	}

	/**
	 * Resolve the URL scheme for POS permalinks.
	 *
	 * Central policy for when POS URLs force https: the force_ssl general
	 * setting (default true) so links work when the site home URL is http
	 * but the POS is served over https, eg: behind an SSL-terminating proxy.
	 *
	 * @return null|string 'https' when force_ssl is enabled, null for the home scheme.
	 */
	public function url_scheme(): ?string {
		return $this->force_ssl_enabled() ? 'https' : null;
	}

	/**
	 * Saves settings for a specific section.
	 *
	 * @param string $id       The ID of the settings section being saved.
	 * @param array  $settings The settings array to be saved.
	 *
	 * @return array|WP_Error Returns the updated settings array on success or WP_Error on failure.
	 */
	public function save_settings( string $id, array $settings ) {
		$section = $this->sections()->get( $id );

		if ( ! $section instanceof Settings_Section_Interface ) {
			return $this->unknown_section_error( $id );
		}

		return $section->write( $settings );
	}

	/**
	 * The error returned for a settings id with no registered Settings Section.
	 *
	 * Registering a section through the
	 * `woocommerce_pos_register_settings_sections` action is the only supported
	 * way to add a settings group; there is no generic option fallback.
	 *
	 * @param string $id The settings section ID.
	 *
	 * @return WP_Error
	 */
	private function unknown_section_error( string $id ): WP_Error {
		return new WP_Error(
			'woocommerce_pos_settings_error',
			// translators: %s: Settings group id, ie: 'general' or 'checkout'.
			\sprintf( __( 'Settings with id %s not found', 'woocommerce-pos' ), $id ),
			array( 'status' => 400 )
		);
	}

	/*
	 * Public get_{id}_settings() delegates are supported read API for Pro and
	 * extensions. Keep them as non-deprecated facades until that public surface
	 * is intentionally replaced.
	 */

	/**
	 * Get general settings.
	 *
	 * @return array
	 */
	public function get_general_settings(): array {
		$section = $this->sections()->get( 'general' );

		return $section ? $section->read() : array();
	}

	/**
	 * Sanitize the additional free-store tax IDs entered in General settings.
	 *
	 * Delegates to General_Section::sanitize_store_tax_ids(). Kept here as a
	 * static façade because Store_Defaults::tax_ids() calls this method.
	 *
	 * @param mixed $tax_ids Raw tax IDs.
	 * @return array<int,array<string,string>>
	 */
	public static function sanitize_store_tax_ids( $tax_ids ): array {
		return General_Section::sanitize_store_tax_ids( $tax_ids );
	}

	/**
	 * Get tax IDs settings.
	 *
	 * @return array
	 */
	public function get_tax_ids_settings(): array {
		$section = $this->sections()->get( 'tax_ids' );

		return $section ? $section->read() : array();
	}

	/**
	 * Get checkout settings.
	 *
	 * @return array
	 */
	public function get_checkout_settings(): array {
		$section = $this->sections()->get( 'checkout' );

		return $section ? $section->read() : array();
	}

	/**
	 * Get access settings with role capabilities.
	 *
	 * @return array
	 */
	public function get_access_settings(): array {
		$section = $this->sections()->get( 'access' );

		return $section ? $section->read() : array();
	}

	/**
	 * Get tools settings.
	 *
	 * @return array
	 *
	 * @hook woocommerce_pos_tools_settings
	 */
	public function get_tools_settings(): array {
		$section = $this->sections()->get( 'tools' );

		return $section ? $section->read() : array();
	}

	/**
	 * Get license settings.
	 *
	 * @return array
	 */
	public function get_license_settings(): array {
		$section = $this->sections()->get( 'license' );

		return $section ? $section->read() : array();
	}

	/**
	 * Get available barcode fields.
	 *
	 * @return array
	 */
	public function get_barcodes(): array {
		global $wpdb;

		// maybe add custom barcode field.
		$custom_field = $this->get_settings( 'general', 'barcode_field' );

		// Prepare the basic query.
		$result = $wpdb->get_col(
			"
			SELECT DISTINCT(pm.meta_key)
			FROM $wpdb->postmeta AS pm
			JOIN $wpdb->posts AS p
			ON p.ID = pm.post_id
			WHERE p.post_type IN ('product', 'product_variation')
			ORDER BY pm.meta_key
			"
		);

		$result = array_merge( $result, Barcode_Field::CORE_FIELDS );

		if ( ! empty( $custom_field ) ) {
			$result[] = $custom_field;
		}

		sort( $result );

		return array_unique( $result );
	}

	/**
	 * Get available order statuses.
	 *
	 * @return array
	 */
	public function get_order_statuses(): array {
		$order_statuses = wc_get_order_statuses();

		return array_map( 'wc_get_order_status_name', $order_statuses );
	}

	/**
	 * Get payment gateways settings.
	 *
	 * @return array
	 */
	public function get_payment_gateways_settings(): array {
		$section = $this->sections()->get( 'payment_gateways' );

		return $section ? $section->read() : array();
	}

	/**
	 * POS Visibility settings.
	 *
	 * @return array
	 */
	public function get_visibility_settings(): array {
		return $this->visibility_section()->get_visibility_settings();
	}

	/**
	 * Update visibility settings.
	 *
	 * @param array $args The visibility settings to update.
	 *
	 * @return bool|WP_Error True on success, WP_Error on failure.
	 */
	public function update_visibility_settings( array $args ) {
		return $this->visibility_section()->update_visibility_settings( $args );
	}

	/**
	 * Get product visibility settings.
	 *
	 * @param string $scope The scope of the settings to get. 'default' or store ID.
	 *
	 * @return array $settings The product visibility settings, eg: { pos_only: { ids: [1, 2, 3] }, online_only: { ids: [4, 5, 6] }
	 */
	public function get_product_visibility_settings( $scope = 'default' ) {
		return $this->visibility_section()->get_product_visibility_settings( $scope );
	}

	/**
	 * Get product visibility settings.
	 *
	 * @param string $scope The scope of the settings to get. 'default' or store ID.
	 *
	 * @return array $settings The product visibility settings, eg: { ids: [1, 2, 3] }
	 */
	public function get_pos_only_product_visibility_settings( $scope = 'default' ) {
		return $this->visibility_section()->get_pos_only_product_visibility_settings( $scope );
	}

	/**
	 * Get product visibility settings.
	 *
	 * @param string $scope The scope of the settings to get. 'default' or store ID.
	 *
	 * @return array $settings The product visibility settings, eg: { ids: [1, 2, 3] }
	 */
	public function get_online_only_product_visibility_settings( $scope = 'default' ) {
		return $this->visibility_section()->get_online_only_product_visibility_settings( $scope );
	}

	/**
	 * Get product visibility settings.
	 *
	 * @param string $scope The scope of the settings to get. 'default' or store ID.
	 *
	 * @return array $settings The product visibility settings, eg: { pos_only: { ids: [1, 2, 3] }, online_only: { ids: [4, 5, 6] }
	 */
	public function get_variations_visibility_settings( $scope = 'default' ) {
		return $this->visibility_section()->get_variations_visibility_settings( $scope );
	}

	/**
	 * Get product visibility settings.
	 *
	 * @param string $scope The scope of the settings to get. 'default' or store ID.
	 *
	 * @return array $settings The product visibility settings, eg: { ids: [1, 2, 3] }
	 */
	public function get_pos_only_variations_visibility_settings( $scope = 'default' ) {
		return $this->visibility_section()->get_pos_only_variations_visibility_settings( $scope );
	}

	/**
	 * Get product visibility settings.
	 *
	 * @param string $scope The scope of the settings to get. 'default' or store ID.
	 *
	 * @return array $settings The product visibility settings, eg: { ids: [1, 2, 3] }
	 */
	public function get_online_only_variations_visibility_settings( $scope = 'default' ) {
		return $this->visibility_section()->get_online_only_variations_visibility_settings( $scope );
	}

	/**
	 * Check if a product is POS only.
	 *
	 * @param int|string $product_id The product ID.
	 *
	 * @return bool
	 */
	public function is_product_pos_only( $product_id ) {
		return $this->visibility_section()->is_product_pos_only( $product_id );
	}

	/**
	 * Check if a product is Online only.
	 *
	 * @param int|string $product_id The product ID.
	 *
	 * @return bool
	 */
	public function is_product_online_only( $product_id ) {
		return $this->visibility_section()->is_product_online_only( $product_id );
	}

	/**
	 * Check if a variation is POS only.
	 *
	 * @param int|string $variation_id The variation ID.
	 *
	 * @return bool
	 */
	public function is_variation_pos_only( $variation_id ) {
		return $this->visibility_section()->is_variation_pos_only( $variation_id );
	}

	/**
	 * Check if a variation is Online only.
	 *
	 * @param int|string $variation_id The variation ID.
	 *
	 * @return bool
	 */
	public function is_variation_online_only( $variation_id ) {
		return $this->visibility_section()->is_variation_online_only( $variation_id );
	}

	/**
	 * Visibility behavior bound to the registered section's storage surface.
	 */
	private function visibility_section(): Visibility_Section {
		$section = $this->sections()->get( 'visibility' );

		return $section instanceof Visibility_Section ? $section : new Visibility_Section( $section );
	}

	/**
	 * Delete settings in WP options table.
	 *
	 * @param string $id The settings section ID.
	 *
	 * @return bool|WP_Error
	 */
	public static function delete_settings( $id ) {
		if ( ! is_super_admin() && ! current_user_can( 'manage_woocommerce_pos' ) ) {
			return new WP_Error( 'unauthorized', 'You do not have permission to delete this option.' );
		}

		return delete_option( self::$db_prefix . $id );
	}

	/**
	 * Get the database version.
	 *
	 * @return string
	 */
	public static function get_db_version() {
		return get_option( 'woocommerce_pos_db_version', '0' );
	}

	/**
	 * Updates db to new version number
	 * bumps the idb version number.
	 */
	public static function bump_versions(): void {
		update_option( 'woocommerce_pos_db_version', VERSION );
	}

	/**
	 * Read one key from a section's filtered view, falling back to the
	 * section default. Never returns WP_Error — typed accessors are the safe
	 * read surface for PHP callers.
	 *
	 * @param string $id  Section id.
	 * @param string $key Setting key.
	 *
	 * @return mixed
	 */
	private function section_value( string $id, string $key ) {
		$settings = $this->get_settings( $id );
		if ( \is_array( $settings ) && \array_key_exists( $key, $settings ) ) {
			return $settings[ $key ];
		}

		$section = $this->sections()->get( $id );
		if ( $section instanceof Settings_Section_Interface ) {
			$defaults = $section->defaults();

			return $defaults[ $key ] ?? null;
		}

		return null;
	}

	/**
	 * Whether the POS-only products feature is enabled.
	 */
	public function pos_only_products_enabled(): bool {
		return (bool) $this->section_value( 'general', 'pos_only_products' );
	}

	/**
	 * Whether decimal stock/cart quantities are enabled.
	 */
	public function decimal_qty_enabled(): bool {
		return (bool) $this->section_value( 'general', 'decimal_qty' );
	}

	/**
	 * Whether the POS frontend forces HTTPS.
	 */
	public function force_ssl_enabled(): bool {
		return wp_validate_boolean( $this->section_value( 'general', 'force_ssl' ) );
	}

	/**
	 * The product meta key used as the barcode field.
	 */
	public function barcode_field(): string {
		return (string) $this->section_value( 'general', 'barcode_field' );
	}

	/**
	 * The default customer id for new POS orders.
	 */
	public function default_customer_id(): int {
		return (int) $this->section_value( 'general', 'default_customer' );
	}

	/**
	 * Whether the logged-in cashier is the default customer.
	 */
	public function default_customer_is_cashier(): bool {
		return (bool) $this->section_value( 'general', 'default_customer_is_cashier' );
	}

	/**
	 * Whether usernames are auto-generated for new customers.
	 */
	public function generate_username_enabled(): bool {
		return (bool) $this->section_value( 'general', 'generate_username' );
	}

	/**
	 * Whether stock is restored when a POS order is deleted.
	 */
	public function restore_stock_on_delete_enabled(): bool {
		return (bool) $this->section_value( 'general', 'restore_stock_on_delete' );
	}

	/**
	 * The analytics tracking consent state: allowed | denied | undecided.
	 */
	public function tracking_consent(): string {
		return (string) $this->section_value( 'general', 'tracking_consent' );
	}

	/**
	 * Whether the JWT may be passed as a query parameter (Tools).
	 */
	public function use_jwt_as_param_enabled(): bool {
		return (bool) $this->section_value( 'tools', 'use_jwt_as_param' );
	}

	/**
	 * Admin email toggles for POS orders.
	 */
	public function admin_emails(): array {
		return (array) $this->section_value( 'checkout', 'admin_emails' );
	}

	/**
	 * Customer email toggles for POS orders.
	 */
	public function customer_emails(): array {
		return (array) $this->section_value( 'checkout', 'customer_emails' );
	}

	/**
	 * Cashier email toggles for POS orders.
	 */
	public function cashier_emails(): array {
		return (array) $this->section_value( 'checkout', 'cashier_emails' );
	}

	/**
	 * Script handles dequeued on the POS checkout pages.
	 */
	public function dequeue_script_handles(): array {
		return (array) $this->section_value( 'checkout', 'dequeue_script_handles' );
	}

	/**
	 * Style handles dequeued on the POS checkout pages.
	 */
	public function dequeue_style_handles(): array {
		return (array) $this->section_value( 'checkout', 'dequeue_style_handles' );
	}

	/**
	 * The default receipt mode: fiscal | live.
	 */
	public function receipt_default_mode(): string {
		return (string) $this->section_value( 'checkout', 'receipt_default_mode' );
	}

	/**
	 * Whether paid POS orders should be rejected when stock is unavailable.
	 */
	public function prevent_overselling_enabled(): bool {
		return (bool) $this->section_value( 'checkout', 'prevent_overselling' );
	}

	/**
	 * The user-override tax-ID write map (type => meta key).
	 */
	public function tax_id_write_map(): array {
		return (array) $this->section_value( 'tax_ids', 'write_map' );
	}
}

```