PK [1]L. Integrations/WPConsentAPI.phpnu on_init();
},
20 // After OrderAttributionController.
);
}
/**
* Register our hooks on init.
*
* @return void
*/
protected function on_init() {
// Include integration to WP Consent Level API if available.
if ( ! $this->is_wp_consent_api_active() ) {
return;
}
$plugin = plugin_basename( WC_PLUGIN_FILE );
add_filter( "wp_consent_api_registered_{$plugin}", '__return_true' );
add_action(
'wp_enqueue_scripts',
function() {
$this->enqueue_consent_api_scripts();
}
);
/**
* Modify the "allowTracking" flag consent if the user has consented to marketing.
*
* Wp-consent-api will initialize the modules on "init" with priority 9,
* So this code needs to be run after that.
*/
add_filter(
'wc_order_attribution_allow_tracking',
function() {
return function_exists( 'wp_has_consent' ) && wp_has_consent( self::$consent_category );
}
);
}
/**
* Check if WP Cookie Consent API is active
*
* @return bool
*/
protected function is_wp_consent_api_active() {
return class_exists( WP_CONSENT_API::class );
}
/**
* Enqueue JS for integration with WP Consent Level API
*
* @return void
*/
private function enqueue_consent_api_scripts() {
wp_enqueue_script(
'wp-consent-api-integration',
plugins_url(
"assets/js/frontend/wp-consent-api-integration{$this->get_script_suffix()}.js",
WC_PLUGIN_FILE
),
array( 'wp-consent-api', 'wc-order-attribution' ),
Constants::get_constant( 'WC_VERSION' ),
true
);
// Add data for the script above. `wp_enqueue_script` API does not allow data attributes,
// so we need a separate script tag and pollute the global scope.
wp_add_inline_script(
'wp-consent-api-integration',
sprintf(
'window.wc_order_attribution.params.consentCategory = %s;',
wp_json_encode( self::$consent_category, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
),
'before'
);
}
}
PK [1]E~< Integrations/WPPostsImporter.phpnu $attribute_name,
'slug' => $attribute_name,
'type' => 'select',
'order_by' => 'menu_order',
'has_archives' => false,
)
);
}
// Register the taxonomy so that the import works.
register_taxonomy(
$term['domain'],
// phpcs:ignore
apply_filters( 'woocommerce_taxonomy_objects_' . $term['domain'], array( 'product' ) ),
// phpcs:ignore
apply_filters(
'woocommerce_taxonomy_args_' . $term['domain'],
array(
'hierarchical' => true,
'show_ui' => false,
'query_var' => true,
'rewrite' => false,
)
)
);
}
}
return $posts;
}
}
PK [1]| Utilities/URLException.phpnu installing_plugin = true;
$plugins_being_installed = get_site_option( 'woocommerce_autoinstalling_plugins', array() );
if ( in_array( $plugin_url, $plugins_being_installed, true ) ) {
return array( 'already_installing' => true );
}
$plugins_being_installed[] = $plugin_url;
update_site_option( 'woocommerce_autoinstalling_plugins', $plugins_being_installed );
try {
return $this->install_plugin_core( $plugin_url, $metadata );
} finally {
$plugins_being_installed = array_diff( $plugins_being_installed, array( $plugin_url ) );
if ( empty( $plugins_being_installed ) ) {
delete_site_option( 'woocommerce_autoinstalling_plugins' );
} else {
update_site_option( 'woocommerce_autoinstalling_plugins', $plugins_being_installed );
}
$this->installing_plugin = false;
}
}
/**
* Core version of 'install_plugin' (it doesn't handle the $installing_plugin flag).
*
* @param string $plugin_url URL or file path of the plugin to install.
* @param array $metadata Metadata to store if the installation succeeds.
* @return array Information about the installation result.
* @throws \InvalidArgumentException Source doesn't start with 'https://downloads.wordpress.org/', or installer name is 'WooCommerce' but caller is not WooCommerce core code.
*/
private function install_plugin_core( string $plugin_url, array $metadata ): array {
if ( ! StringUtil::starts_with( $plugin_url, 'https://downloads.wordpress.org/', false ) ) {
throw new \InvalidArgumentException( "Only installs from the WordPress.org plugins directory (plugin URL starting with 'https://downloads.wordpress.org/') are allowed." );
}
$installed_by = $metadata['installed_by'] ?? 'WooCommerce';
if ( 0 === strcasecmp( 'WooCommerce', $installed_by ) ) {
// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_debug_backtrace
$calling_file = StringUtil::normalize_local_path_slashes( debug_backtrace()[1]['file'] ?? '' ); // [1], not [0], because the immediate caller is the install_plugin method.
if ( ! StringUtil::starts_with( $calling_file, StringUtil::normalize_local_path_slashes( WC_ABSPATH . 'includes/' ) ) && ! StringUtil::starts_with( $calling_file, StringUtil::normalize_local_path_slashes( WC_ABSPATH . 'src/' ) ) ) {
throw new \InvalidArgumentException( "If the value of 'installed_by' is 'WooCommerce', the caller of the method must be a WooCommerce core class or function." );
}
}
if ( ! class_exists( \Automatic_Upgrader_Skin::class ) ) {
include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader-skin.php';
include_once ABSPATH . 'wp-admin/includes/class-automatic-upgrader-skin.php';
}
$skin = new \Automatic_Upgrader_Skin();
if ( ! class_exists( \Plugin_Upgrader::class ) ) {
include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
}
$upgrader = new \Plugin_Upgrader( $skin );
$install_ok = $upgrader->install( $plugin_url );
$result = array( 'messages' => $skin->get_upgrade_messages() );
if ( $install_ok ) {
if ( ! function_exists( 'get_plugins' ) ) {
require_once ABSPATH . 'wp-admin/includes/plugin.php';
}
$plugin_name = $upgrader->plugin_info();
$plugin_version = get_plugins()[ $plugin_name ]['Version'];
$result['plugin_name'] = $plugin_name;
$plugin_data = array(
'version' => $plugin_version,
'date' => current_time( 'mysql' ),
);
if ( ! empty( $metadata ) ) {
$plugin_data['metadata'] = $metadata;
}
$auto_installed_plugins = get_site_option( 'woocommerce_autoinstalled_plugins', array() );
$auto_installed_plugins[ $plugin_name ] = $plugin_data;
update_site_option( 'woocommerce_autoinstalled_plugins', $auto_installed_plugins );
$auto_installed_plugins_history = get_site_option( 'woocommerce_history_of_autoinstalled_plugins', array() );
if ( ! isset( $auto_installed_plugins_history[ $plugin_name ] ) ) {
$auto_installed_plugins_history[ $plugin_name ] = $plugin_data;
update_site_option( 'woocommerce_history_of_autoinstalled_plugins', $auto_installed_plugins_history );
}
$post_install = function () use ( $plugin_name, $plugin_version, $installed_by, $plugin_url, $plugin_data ) {
$log_context = array(
'source' => 'plugin_auto_installs',
'recorded_data' => $plugin_data,
);
wc_get_logger()->info( "Plugin $plugin_name v{$plugin_version} installed by $installed_by, source: $plugin_url", $log_context );
};
} else {
$messages = $skin->get_upgrade_messages();
$post_install = function () use ( $plugin_url, $installed_by, $messages ) {
$log_context = array(
'source' => 'plugin_auto_installs',
'installer_messages' => $messages,
);
wc_get_logger()->error( "$installed_by failed to install plugin from source: $plugin_url", $log_context );
};
}
if ( is_multisite() ) {
// We log the install in the main site, unless the main site doesn't have WooCommerce installed;
// in that case we fallback to logging in the current site.
switch_to_blog( get_main_site_id() );
if ( self::woocommerce_is_active_in_current_site() ) {
$post_install();
restore_current_blog();
} else {
restore_current_blog();
$post_install();
}
} else {
$post_install();
}
$result['install_ok'] = $install_ok ?? false;
return $result;
}
/**
* Check if WooCommerce is installed and active in the current blog.
* This is useful for multisite installs when a blog other than the one running this code is selected with 'switch_to_blog'.
*
* @return bool True if WooCommerce is installed and active in the current blog, false otherwise.
*/
private static function woocommerce_is_active_in_current_site(): bool {
$active_valid_plugins = wc_get_container()->get( PluginUtil::class )->get_all_active_valid_plugins();
return ! empty(
array_filter(
$active_valid_plugins,
fn( $plugin ) => substr_compare( $plugin, '/woocommerce.php', -strlen( '/woocommerce.php' ) ) === 0
)
);
}
/**
* Handler for the 'plugin_list_rows' hook, it will display a notice under the name of the plugins
* that have been installed using this class (unless the 'woocommerce_show_autoinstalled_plugin_notices' filter
* returns false) in the plugins list page.
*
* @param string $plugin_file Name of the plugin.
* @param array $plugin_data Plugin data.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function handle_plugin_list_rows( $plugin_file, $plugin_data ) {
global $wp_list_table;
if ( is_null( $wp_list_table ) ) {
return;
}
/**
* Filter to suppress the notice about autoinstalled plugins in the plugins list page.
*
* @since 8.8.0
*
* @param bool $display_notice Whether notices should be displayed or not.
* @returns bool
*/
if ( ! apply_filters( 'woocommerce_show_autoinstalled_plugin_notices', '__return_true' ) ) {
return;
}
$auto_installed_plugins_info = get_site_option( 'woocommerce_autoinstalled_plugins', array() );
$current_plugin_info = $auto_installed_plugins_info[ $plugin_file ] ?? null;
if ( is_null( $current_plugin_info ) || $current_plugin_info['version'] !== $plugin_data['Version'] ) {
return;
}
$installed_by = $current_plugin_info['metadata']['installed_by'] ?? 'WooCommerce';
$info_link = $current_plugin_info['metadata']['info_link'] ?? null;
if ( $info_link ) {
/* translators: 1 = who installed the plugin, 2 = ISO-formatted date and time, 3 = URL */
$message = sprintf( __( 'Plugin installed by %1$s on %2$s. More information', 'woocommerce' ), $installed_by, $current_plugin_info['date'], $info_link );
} else {
/* translators: 1 = who installed the plugin, 2 = ISO-formatted date and time */
$message = sprintf( __( 'Plugin installed by %1$s on %2$s.', 'woocommerce' ), $installed_by, $current_plugin_info['date'] );
}
$columns_count = $wp_list_table->get_column_count();
$is_active = is_plugin_active( $plugin_file );
$is_active_class = $is_active ? 'active' : 'inactive';
$is_active_td_style = $is_active ? "style='border-left: 4px solid #72aee6;'" : '';
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
?>
>
ℹ️
installing_plugin || ! ( $upgrader instanceof \Plugin_Upgrader ) || ( 'plugin' !== ( $hook_extra['type'] ?? null ) ) ) {
return;
}
$auto_installed_plugins = get_site_option( 'woocommerce_autoinstalled_plugins' );
if ( ! $auto_installed_plugins ) {
return;
}
if ( $hook_extra['bulk'] ?? false ) {
$updated_plugin_names = $hook_extra['plugins'] ?? array();
} else {
$updated_plugin_names = array( $upgrader->plugin_info() );
}
$auto_installed_plugin_names = array_keys( $auto_installed_plugins );
$updated_auto_installed_plugin_names = array_intersect( $auto_installed_plugin_names, $updated_plugin_names );
if ( empty( $updated_auto_installed_plugin_names ) ) {
return;
}
$new_auto_installed_plugins = array_diff_key( $auto_installed_plugins, array_flip( $updated_auto_installed_plugin_names ) );
if ( empty( $new_auto_installed_plugins ) ) {
delete_site_option( 'woocommerce_autoinstalled_plugins' );
} else {
update_site_option( 'woocommerce_autoinstalled_plugins', $new_auto_installed_plugins );
}
}
}
PK [1]R ` Utilities/FilesystemUtil.phpnu get( LegacyProxy::class );
if ( ! self::constant_exists( 'FS_METHOD' ) && false === $proxy->call_function( 'get_option', 'ftp_credentials' ) && ! self::constant_exists( 'FTP_HOST' ) ) {
return 'direct';
}
$method = $proxy->call_function( 'get_filesystem_method' );
if ( $method ) {
return $method;
}
return 'direct';
}
/**
* Check if a constant exists and is not null.
*
* @param string $name Constant name.
* @return bool True if the constant exists and its value is not null.
*/
private static function constant_exists( string $name ): bool {
return Constants::is_defined( $name ) && ! is_null( Constants::get_constant( $name ) );
}
/**
* Recursively creates a directory (if it doesn't exist) and adds an empty index.html and a .htaccess to prevent
* directory listing.
*
* @since 9.3.0
*
* @param string $path Directory to create.
* @param bool $allow_file_access Whether to allow file access while preventing directory listing. Default false (deny all access).
* @throws \Exception In case of error.
*/
public static function mkdir_p_not_indexable( string $path, bool $allow_file_access = false ): void {
$wp_fs = self::get_wp_filesystem();
if ( $wp_fs->is_dir( $path ) ) {
return;
}
if ( ! wp_mkdir_p( $path ) ) {
throw new \Exception( esc_html( sprintf( 'Could not create directory: %s.', wp_basename( $path ) ) ) );
}
$htaccess_content = $allow_file_access ? 'Options -Indexes' : 'deny from all';
$files = array(
'.htaccess' => $htaccess_content,
'index.html' => '',
);
foreach ( $files as $name => $content ) {
$wp_fs->put_contents( trailingslashit( $path ) . $name, $content );
}
}
/**
* Wrapper to initialize the WP filesystem with defined credentials if they are available.
*
* @return bool True if the $wp_filesystem global was successfully initialized.
*/
protected static function initialize_wp_filesystem(): bool {
global $wp_filesystem;
if ( $wp_filesystem instanceof WP_Filesystem_Base ) {
return true;
}
require_once ABSPATH . 'wp-admin/includes/file.php';
$method = self::get_wp_filesystem_method_or_direct();
$initialized = false;
if ( 'direct' === $method ) {
$initialized = WP_Filesystem();
} elseif ( false !== $method ) {
// See https://core.trac.wordpress.org/changeset/56341.
ob_start();
$credentials = request_filesystem_credentials( '' );
ob_end_clean();
$initialized = $credentials && WP_Filesystem( $credentials );
}
return is_null( $initialized ) ? false : $initialized;
}
/**
* Validate that a file path is a valid upload path.
*
* @param string $path The path to validate.
* @throws \Exception If the file path is not a valid upload path.
*/
public static function validate_upload_file_path( string $path ): void {
$wp_filesystem = self::get_wp_filesystem();
// File must exist and be readable.
$is_valid_file = $wp_filesystem->is_readable( $path );
// Check that file is within an allowed location.
if ( $is_valid_file ) {
$is_valid_file = self::file_is_in_directory( $path, $wp_filesystem->abspath() );
if ( ! $is_valid_file ) {
$upload_dir = wp_get_upload_dir();
$is_valid_file = false === $upload_dir['error'] && self::file_is_in_directory( $path, $upload_dir['basedir'] );
}
}
if ( ! $is_valid_file ) {
throw new \Exception( esc_html__( 'File path is not a valid upload path.', 'woocommerce' ) );
}
}
/**
* Check if a given file is inside a given directory.
*
* @param string $file_path The full path of the file to check.
* @param string $directory The path of the directory to check.
* @return bool True if the file is inside the directory.
*/
private static function file_is_in_directory( string $file_path, string $directory ): bool {
// Extract protocol if it exists.
$protocol = '';
if ( preg_match( '#^([a-z0-9]+://)#i', $file_path, $matches ) ) {
$protocol = $matches[1];
$file_path = preg_replace( '#^[a-z0-9]+://#i', '', $file_path );
}
$file_path = (string) new URL( $file_path ); // This resolves '/../' sequences.
$file_path = preg_replace( '/^file:\\/\\//', $protocol, $file_path );
$file_path = preg_replace( '/^file:\\/\\//', '', $file_path );
return 0 === stripos( wp_normalize_path( $file_path ), trailingslashit( wp_normalize_path( $directory ) ) );
}
}
PK [1],~ Utilities/LegacyRestApiStub.phpnu api') to an instance of this class.
*
* DO NOT add any additional public method to this class unless the method existed with the same signature in the old WC_API class.
*
* See: https://developer.woocommerce.com/2023/10/03/the-legacy-rest-api-will-move-to-a-dedicated-extension-in-woocommerce-9-0/
*/
class LegacyRestApiStub implements RegisterHooksInterface {
/**
* The instance of RestApiUtil to use.
*
* @var RestApiUtil
*/
private RestApiUtil $rest_api_util;
/**
* Set up the Legacy REST API endpoints stub.
*/
public function register() {
add_action( 'init', array( __CLASS__, 'add_rewrite_rules_for_legacy_rest_api_stub' ), 0 );
add_action( 'query_vars', array( __CLASS__, 'add_query_vars_for_legacy_rest_api_stub' ), 0 );
add_action( 'parse_request', array( __CLASS__, 'parse_legacy_rest_api_request' ), 0 );
}
/**
* Initialize the class dependencies.
*
* @internal
* @param RestApiUtil $rest_api_util The instance of RestApiUtil to use.
*/
final public function init( RestApiUtil $rest_api_util ) {
$this->rest_api_util = $rest_api_util;
}
/**
* Add the necessary rewrite rules for the Legacy REST API
* (either the dedicated extension if it's installed, or the stub otherwise).
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public static function add_rewrite_rules_for_legacy_rest_api_stub() {
add_rewrite_rule( '^wc-api/v([1-3]{1})/?$', 'index.php?wc-api-version=$matches[1]&wc-api-route=/', 'top' );
add_rewrite_rule( '^wc-api/v([1-3]{1})(.*)?', 'index.php?wc-api-version=$matches[1]&wc-api-route=$matches[2]', 'top' );
add_rewrite_endpoint( 'wc-api', EP_ALL );
}
/**
* Add the necessary request query variables for the Legacy REST API
* (either the dedicated extension if it's installed, or the stub otherwise).
*
* @param array $vars The query variables array to extend.
* @return array The extended query variables array.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public static function add_query_vars_for_legacy_rest_api_stub( $vars ) {
$vars[] = 'wc-api-version';
$vars[] = 'wc-api-route';
$vars[] = 'wc-api';
return $vars;
}
/**
* Process an incoming request for the Legacy REST API.
*
* If the dedicated Legacy REST API extension is installed and active, this method does nothing.
* Otherwise it returns a "The WooCommerce API is disabled on this site" error,
* unless the request contains a "wc-api" variable and the appropriate
* "woocommerce_api_*" hook is set.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public static function parse_legacy_rest_api_request() {
global $wp;
// The WC_Legacy_REST_API_Plugin class existence means that the Legacy REST API extension is installed and active.
if ( class_exists( 'WC_Legacy_REST_API_Plugin' ) ) {
return;
}
self::maybe_process_wc_api_query_var();
// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
if ( ! empty( $_GET['wc-api-version'] ) ) {
$wp->query_vars['wc-api-version'] = $_GET['wc-api-version'];
}
if ( ! empty( $_GET['wc-api-route'] ) ) {
$wp->query_vars['wc-api-route'] = $_GET['wc-api-route'];
}
if ( ! empty( $wp->query_vars['wc-api-version'] ) && ! empty( $wp->query_vars['wc-api-route'] ) ) {
header(
sprintf(
'Content-Type: %s; charset=%s',
isset( $_GET['_jsonp'] ) ? 'application/javascript' : 'application/json',
get_option( 'blog_charset' )
)
);
status_header( 404 );
echo wp_json_encode(
array(
'errors' => array(
'code' => 'woocommerce_api_disabled',
'message' => 'The WooCommerce API is disabled on this site',
),
)
);
exit;
}
// phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
}
/**
* Process a "wc-api" variable if present in the query, by triggering the appropriate hooks.
*/
private static function maybe_process_wc_api_query_var() {
global $wp;
// phpcs:disable WordPress.Security.NonceVerification.Recommended
if ( ! empty( $_GET['wc-api'] ) ) {
$wp->query_vars['wc-api'] = sanitize_key( wp_unslash( $_GET['wc-api'] ) );
}
// phpcs:enable WordPress.Security.NonceVerification.Recommended
// wc-api endpoint requests.
if ( ! empty( $wp->query_vars['wc-api'] ) ) {
// Buffer, we won't want any output here.
ob_start();
// No cache headers.
wc_nocache_headers();
// Clean the API request.
$api_request = strtolower( wc_clean( $wp->query_vars['wc-api'] ) );
// Make sure gateways are available for request.
WC()->payment_gateways();
// phpcs:disable WooCommerce.Commenting.CommentHooks.HookCommentWrongStyle
// Trigger generic action before request hook.
do_action( 'woocommerce_api_request', $api_request );
// Is there actually something hooked into this API request? If not trigger 400 - Bad request.
status_header( has_action( 'woocommerce_api_' . $api_request ) ? 200 : 400 );
// Trigger an action which plugins can hook into to fulfill the request.
do_action( 'woocommerce_api_' . $api_request );
// phpcs:enable WooCommerce.Commenting.CommentHooks.HookCommentWrongStyle
// Done, clear buffer and exit.
ob_end_clean();
die( '-1' );
}
}
/**
* Get data from a WooCommerce API endpoint.
* This method used to be part of the WooCommerce Legacy REST API.
*
* @since 9.1.0
*
* @param string $endpoint Endpoint.
* @param array $params Params to pass with request.
* @return array|\WP_Error
*/
public function get_endpoint_data( $endpoint, $params = array() ) {
wc_doing_it_wrong(
'get_endpoint_data',
"'WC()->api->get_endpoint_data' is deprecated, please use the following instead: wc_get_container()->get(Automattic\WooCommerce\Utilities\RestApiUtil::class)->get_endpoint_data",
'9.1.0'
);
return $this->rest_api_util->get_endpoint_data( $endpoint, $params );
}
}
PK [1]= k4 k4 Utilities/URL.phpnu null,
'fragment' => null,
'host' => null,
'pass' => null,
'path' => null,
'port' => null,
'query' => null,
'scheme' => null,
'user' => null,
);
/**
* If the URL (or filepath) is absolute.
*
* @var bool
*/
private $is_absolute;
/**
* If the URL (or filepath) represents a directory other than the root directory.
*
* This is useful at different points in the process, when deciding whether to re-apply
* a trailing slash at the end of processing or when we need to calculate how many
* directory traversals are needed to form a (grand-)parent URL.
*
* @var bool
*/
private $is_non_root_directory;
/**
* The components of the URL's path.
*
* For instance, in the case of "file:///srv/www/wp.site" (noting that a file URL has
* no host component) this would contain:
*
* [ "srv", "www", "wp.site" ]
*
* In the case of a non-file URL such as "https://example.com/foo/bar/baz" (noting the
* host is not part of the path) it would contain:
*
* [ "foo", "bar", "baz" ]
*
* @var array
*/
private $path_parts = array();
/**
* The URL.
*
* @var string
*/
private $url;
/**
* Creates and processes the provided URL (or filepath).
*
* @throws URLException If the URL (or filepath) is seriously malformed.
*
* @param string $url The URL (or filepath).
*/
public function __construct( string $url ) {
$this->url = $url;
$this->preprocess();
$this->process_path();
}
/**
* Makes all slashes forward slashes, converts filepaths to file:// URLs, and
* other processing to help with comprehension of filepaths.
*
* @throws URLException If the URL is seriously malformed.
*/
private function preprocess() {
// For consistency, all slashes should be forward slashes.
$this->url = str_replace( '\\', '/', $this->url );
// Windows: capture the drive letter if provided.
if ( preg_match( '#^(file://)?([a-z]):/(?!/).*#i', $this->url, $matches ) ) {
$this->components['drive'] = $matches[2];
}
/*
* If there is no scheme, assume and prepend "file://". An exception is made for cases where the URL simply
* starts with exactly two forward slashes, which indicates 'any scheme' (most commonly, that is used when
* there is freedom to switch between 'http' and 'https').
*/
if ( ! preg_match( '#^[a-z]+://#i', $this->url ) && ! preg_match( '#^//(?!/)#', $this->url ) ) {
$this->url = 'file://' . $this->url;
}
$parsed_components = wp_parse_url( $this->url );
// If we received a really badly formed URL, let's go no further.
if ( false === $parsed_components ) {
throw new URLException(
sprintf(
/* translators: %s is the URL. */
__( '%s is not a valid URL.', 'woocommerce' ),
$this->url
)
);
}
$this->components = array_merge( $this->components, $parsed_components );
// File URLs cannot have a host. However, the initial path segment *or* the Windows drive letter
// (if present) may be incorrectly be interpreted as the host name.
if ( 'file' === $this->components['scheme'] && ! empty( $this->components['host'] ) ) {
// If we do not have a drive letter, then simply merge the host and the path together.
if ( null === $this->components['drive'] ) {
$this->components['path'] = $this->components['host'] . ( $this->components['path'] ?? '' );
}
// Restore the host to null in this situation.
$this->components['host'] = null;
}
}
/**
* Simplifies the path if possible, by resolving directory traversals to the extent possible
* without touching the filesystem.
*/
private function process_path() {
$segments = explode( '/', $this->components['path'] );
$this->is_absolute = substr( $this->components['path'], 0, 1 ) === '/' || ! empty( $this->components['host'] );
$this->is_non_root_directory = substr( $this->components['path'], -1, 1 ) === '/' && strlen( $this->components['path'] ) > 1;
$resolve_traversals = 'file' !== $this->components['scheme'] || $this->is_absolute;
$retain_traversals = false;
// Clean the path.
foreach ( $segments as $part ) {
// Drop empty segments.
if ( strlen( $part ) === 0 || '.' === $part ) {
continue;
}
// Directory traversals created with percent-encoding syntax should also be detected.
$is_traversal = str_ireplace( '%2e', '.', $part ) === '..';
// Resolve directory traversals (if allowed: see further comment relating to this).
if ( $resolve_traversals && $is_traversal ) {
if ( count( $this->path_parts ) > 0 && ! $retain_traversals ) {
$this->path_parts = array_slice( $this->path_parts, 0, count( $this->path_parts ) - 1 );
continue;
} elseif ( $this->is_absolute ) {
continue;
}
}
/*
* Consider allowing directory traversals to be resolved (ie, the process that converts 'foo/bar/../baz' to
* 'foo/baz').
*
* 1. For this decision point, we are only concerned with relative filepaths (in all other cases,
* $resolve_traversals will already be true).
* 2. This is a 'one time' and unidirectional operation. We only wish to flip from false to true, and we
* never wish to do this more than once.
* 3. We only flip the switch after we have examined all leading '..' traversal segments.
*/
if ( false === $resolve_traversals && '..' !== $part && 'file' === $this->components['scheme'] && ! $this->is_absolute ) {
$resolve_traversals = true;
}
/*
* Set a flag indicating that traversals should be retained. This is done to ensure we don't prematurely
* discard traversals at the start of the path.
*/
$retain_traversals = $resolve_traversals && '..' === $part;
// Retain this part of the path.
$this->path_parts[] = $part;
}
// Protect against empty relative paths.
if ( count( $this->path_parts ) === 0 && ! $this->is_absolute ) {
$this->path_parts = array( '.' );
$this->is_non_root_directory = true;
}
// Reform the path from the processed segments, appending a leading slash if it is absolute and restoring
// the Windows drive letter if we have one.
$this->components['path'] = ( $this->is_absolute ? '/' : '' ) . implode( '/', $this->path_parts ) . ( $this->is_non_root_directory ? '/' : '' );
}
/**
* Returns the processed URL as a string.
*
* @return string
*/
public function __toString(): string {
return $this->get_url();
}
/**
* Returns all possible parent URLs for the current URL.
*
* @return string[]
*/
public function get_all_parent_urls(): array {
$max_parent = count( $this->path_parts );
$parents = array();
/*
* If we are looking at a relative path that begins with at least one traversal (example: "../../foo")
* then we should only return one parent URL (otherwise, we'd potentially have to return an infinite
* number of parent URLs since we can't know how far the tree extends).
*/
if ( $max_parent > 0 && ! $this->is_absolute && '..' === $this->path_parts[0] ) {
$max_parent = 1;
}
for ( $level = 1; $level <= $max_parent; $level++ ) {
$parents[] = $this->get_parent_url( $level );
}
return $parents;
}
/**
* Outputs the parent URL.
*
* For example, if $this->get_url() returns "https://example.com/foo/bar/baz" then
* this method will return "https://example.com/foo/bar/".
*
* When a grand-parent is needed, the optional $level parameter can be used. By default
* this is set to 1 (parent). 2 will yield the grand-parent, 3 will yield the great
* grand-parent, etc.
*
* If a level is specified that exceeds the number of path segments, this method will
* return false.
*
* @param int $level Used to indicate the level of parent.
*
* @return string|false
*/
public function get_parent_url( int $level = 1 ) {
if ( $level < 1 ) {
$level = 1;
}
$parts_count = count( $this->path_parts );
$parent_path_parts_to_keep = $parts_count - $level;
/*
* With the exception of file URLs, we do not allow obtaining (grand-)parent directories that require
* us to describe them using directory traversals. For example, given "http://hostname/foo/bar/baz.png" we do
* not permit determining anything more than 2 levels up (we cannot go beyond "http://hostname/").
*/
if ( 'file' !== $this->components['scheme'] && $parent_path_parts_to_keep < 0 ) {
return false;
}
// In the specific case of an absolute filepath describing the root directory, there can be no parent.
if ( 'file' === $this->components['scheme'] && $this->is_absolute && empty( $this->path_parts ) ) {
return false;
}
// Handle cases where the path starts with one or more 'dot segments'. Since the path has already been
// processed, we can be confident that any such segments are at the start of the path.
if ( $parts_count > 0 && ( '.' === $this->path_parts[0] || '..' === $this->path_parts[0] ) ) {
// Determine the index of the last dot segment (ex: given the path '/../../foo' it would be 1).
$single_dots = array_keys( $this->path_parts, '.', true );
$double_dots = array_keys( $this->path_parts, '..', true );
$max_dot_index = max( array_merge( $single_dots, $double_dots ) );
// Prepend the required number of traversals and discard unnecessary trailing segments.
$last_traversal = $max_dot_index + ( $this->is_non_root_directory ? 1 : 0 );
$parent_path = str_repeat( '../', $level ) . join( '/', array_slice( $this->path_parts, 0, $last_traversal ) );
} elseif ( $parent_path_parts_to_keep < 0 ) {
// For relative filepaths only, we use traversals to describe the requested parent.
$parent_path = untrailingslashit( str_repeat( '../', $parent_path_parts_to_keep * -1 ) );
} else {
// Otherwise, in a very simple case, we just remove existing parts.
$parent_path = implode( '/', array_slice( $this->path_parts, 0, $parent_path_parts_to_keep ) );
}
if ( $this->is_relative() && '' === $parent_path ) {
$parent_path = '.';
}
// Append a trailing slash, since a parent is always a directory. The only exception is the current working directory.
$parent_path .= '/';
// For absolute paths, apply a leading slash (does not apply if we have a root path).
if ( $this->is_absolute && 0 !== strpos( $parent_path, '/' ) ) {
$parent_path = '/' . $parent_path;
}
// Form the parent URL (ditching the query and fragment, if set).
$parent_url = $this->get_url(
array(
'path' => $parent_path,
'query' => null,
'fragment' => null,
)
);
// We process the parent URL through a fresh instance of this class, for consistency.
return ( new self( $parent_url ) )->get_url();
}
/**
* Outputs the processed URL.
*
* Borrows from https://www.php.net/manual/en/function.parse-url.php#106731
*
* @param array $component_overrides If provided, these will override values set in $this->components.
*
* @return string
*/
public function get_url( array $component_overrides = array() ): string {
$components = array_merge( $this->components, $component_overrides );
$scheme = null !== $components['scheme'] ? $components['scheme'] . '://' : '//';
$host = null !== $components['host'] ? $components['host'] : '';
$port = null !== $components['port'] ? ':' . $components['port'] : '';
$path = $this->get_path( $components['path'] );
// Special handling for hostless URLs (typically, filepaths) referencing the current working directory.
if ( '' === $host && ( '' === $path || '.' === $path ) ) {
$path = './';
}
$user = null !== $components['user'] ? $components['user'] : '';
$pass = null !== $components['pass'] ? ':' . $components['pass'] : '';
$user_pass = ( ! empty( $user ) || ! empty( $pass ) ) ? $user . $pass . '@' : '';
$query = null !== $components['query'] ? '?' . $components['query'] : '';
$fragment = null !== $components['fragment'] ? '#' . $components['fragment'] : '';
return $scheme . $user_pass . $host . $port . $path . $query . $fragment;
}
/**
* Outputs the path. Especially useful if it was a a regular filepath that was passed in originally.
*
* @param string|null $path_override If provided this will be used as the URL path. Does not impact drive letter.
*
* @return string
*/
public function get_path( ?string $path_override = null ): string {
return ( $this->components['drive'] ? $this->components['drive'] . ':' : '' ) . ( $path_override ?? $this->components['path'] );
}
/**
* Indicates if the URL or filepath was absolute.
*
* @return bool True if absolute, else false.
*/
public function is_absolute(): bool {
return $this->is_absolute;
}
/**
* Indicates if the URL or filepath was relative.
*
* @return bool True if relative, else false.
*/
public function is_relative(): bool {
return ! $this->is_absolute;
}
}
PK [1])aP% P% Utilities/Users.phpnu has_cap( 'manage_sites' ) : $user->has_cap( 'manage_options' );
}
/**
* Get a user from a valid user ID, but only if the active user is able to see them.
*
* In a multisite context, that may mean that they both must be members of the current blog, or else the active
* user must either have special permissions (manage_network_users) or else a special legacy mode
* (woocommerce_network_wide_customers) is enabled.
*
* @param int $user_id The ID of the desired user.
* @param int|null $requesting_user_id The ID of the user making the request. Optional, defaults to the current user.
*
* @return WP_User|WP_Error
*/
public static function get_user_in_current_site( $user_id, ?int $requesting_user_id = null ) {
// User ID is expected to be an integer. Cast it if we can (avoiding additional runtime warnings), else treat it as 0.
$user_id = is_numeric( $user_id ) ? (int) $user_id : 0;
$legacy_proxy = wc_get_container()->get( LegacyProxy::class );
$requesting_user_id = $requesting_user_id > 0 ? $requesting_user_id : wp_get_current_user()->ID;
$error = new WP_Error( 'wc_user_invalid_id', __( 'Invalid user ID.', 'woocommerce' ) );
if ( $user_id <= 0 ) {
return $error;
}
$user = get_userdata( $user_id );
if ( ! $user instanceof WP_User || ! $user->exists() ) {
return $error;
}
if (
$legacy_proxy->call_function( 'is_multisite' )
&& ! $legacy_proxy->call_function( 'is_user_member_of_blog', $user->ID )
&& ! $legacy_proxy->call_function( 'user_can', $requesting_user_id, 'manage_network_users' )
&& get_site_option( 'woocommerce_network_wide_customers', 'no' ) !== 'yes'
) {
return $error;
}
return $user;
}
/**
* Check if the email is valid.
*
* @param int $order_id Order ID.
* @param string $supplied_email Supplied email.
* @param string $context Context in which we are checking the email.
* @return bool
*/
public static function should_user_verify_order_email( $order_id, $supplied_email = null, $context = 'view' ) {
$order = wc_get_order( $order_id );
$billing_email = $order->get_billing_email();
$customer_id = $order->get_customer_id();
// If we do not have a billing email for the order (could happen in the order is created manually, or if the
// requirement for this has been removed from the checkout flow), email verification does not make sense.
if ( empty( $billing_email ) ) {
return false;
}
// No verification step is needed if the user is logged in and is already associated with the order.
if ( $customer_id && get_current_user_id() === $customer_id ) {
return false;
}
/**
* Controls the grace period within which we do not require any sort of email verification step before rendering
* the 'order received' or 'order pay' pages.
*
* To eliminate the grace period, set to zero (or to a negative value). Note that this filter is not invoked
* at all if email verification is deemed to be unnecessary (in other words, it cannot be used to force
* verification in *all* cases).
*
* @since 8.0.0
*
* @param int $grace_period Time in seconds after an order is placed before email verification may be required.
* @param WC_Order $this The order for which this grace period is being assessed.
* @param string $context Indicates the context in which we might verify the email address. Typically 'order-pay' or 'order-received'.
*/
$verification_grace_period = (int) apply_filters( 'woocommerce_order_email_verification_grace_period', 10 * MINUTE_IN_SECONDS, $order, $context );
$date_created = $order->get_date_created();
// We do not need to verify the email address if we are within the grace period immediately following order creation.
if (
is_a( $date_created, \WC_DateTime::class, true )
&& time() - $date_created->getTimestamp() <= $verification_grace_period
) {
return false;
}
$session = wc()->session;
$session_email = '';
if ( is_a( $session, \WC_Session::class ) ) {
$customer = $session->get( 'customer' );
$session_email = is_array( $customer ) && isset( $customer['email'] ) ? $customer['email'] : '';
}
// Email verification is required if the user cannot be identified, or if they supplied an email address but the nonce check failed.
$can_view_orders = current_user_can( 'read_private_shop_orders' );
$session_email_match = $session_email === $billing_email;
$supplied_email_match = $supplied_email === $billing_email;
$email_verification_required = ! $session_email_match && ! $supplied_email_match && ! $can_view_orders;
/**
* Provides an opportunity to override the (potential) requirement for shoppers to verify their email address
* before we show information such as the order summary, or order payment page.
*
* Note that this hook is not always triggered, therefore it is (for example) unsuitable as a way of forcing
* email verification across all order confirmation/order payment scenarios. Instead, the filter primarily
* exists as a way to *remove* the email verification step.
*
* @since 7.9.0
*
* @param bool $email_verification_required If email verification is required.
* @param WC_Order $order The relevant order.
* @param string $context The context under which we are performing this check.
*/
return (bool) apply_filters( 'woocommerce_order_email_verification_required', $email_verification_required, $order, $context );
}
/**
* Site-specific method of retrieving the requested user meta.
*
* This is a multisite-aware wrapper around WordPress's own `get_user_meta()` function, and works by prefixing the
* supplied meta key with a blog-specific meta key.
*
* @param int $user_id User ID.
* @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
* @param bool $single Optional. Whether to return a single value. This parameter has no effect if `$key` is not
* specified. Default false.
*
* @return mixed An array of values if `$single` is false. The value of meta data field if `$single` is true.
* False for an invalid `$user_id` (non-numeric, zero, or negative value). An empty string if a valid
* but non-existing user ID is passed.
*/
public static function get_site_user_meta( int $user_id, string $key = '', bool $single = false ) {
global $wpdb;
$site_specific_key = $key . '_' . rtrim( $wpdb->get_blog_prefix( get_current_blog_id() ), '_' );
return get_user_meta( $user_id, $site_specific_key, true );
}
/**
* Site-specific means of updating user meta.
*
* This is a multisite-aware wrapper around WordPress's own `update_user_meta()` function, and works by prefixing
* the supplied meta key with a blog-specific meta key.
*
* @param int $user_id User ID.
* @param string $meta_key Metadata key.
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar.
* @param mixed $prev_value Optional. Previous value to check before updating. If specified, only update existing
* metadata entries with this value. Otherwise, update all entries. Default empty.
*
* @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure or if the value
* passed to the function is the same as the one that is already in the database.
*/
public static function update_site_user_meta( int $user_id, string $meta_key, $meta_value, $prev_value = '' ) {
global $wpdb;
$site_specific_key = $meta_key . '_' . rtrim( $wpdb->get_blog_prefix( get_current_blog_id() ), '_' );
return update_user_meta( $user_id, $site_specific_key, $meta_value, $prev_value );
}
/**
* Site-specific means of deleting user meta.
*
* This is a multisite-aware wrapper around WordPress's own `delete_user_meta()` function, and works by prefixing
* the supplied meta key with a blog-specific meta key.
*
* @param int $user_id User ID.
* @param string $meta_key Metadata name.
* @param mixed $meta_value Optional. Metadata value. If provided, rows will only be removed that match the value.
* Must be serializable if non-scalar. Default empty.
*
* @return bool True on success, false on failure.
* /
*/
public static function delete_site_user_meta( $user_id, $meta_key, $meta_value = '' ) {
global $wpdb;
$site_specific_key = $meta_key . '_' . rtrim( $wpdb->get_blog_prefix(), '_' );
return delete_user_meta( $user_id, $site_specific_key, $meta_value );
}
}
PK [1] Utilities/Types.phpnu error(
$summary,
array(
'source' => 'wc-type-check-utility',
'backtrace' => true,
)
);
}
// Invoke the $on_failure handler, if specified.
if ( null !== $on_failure ) {
return $on_failure( $thing, $desired_type );
}
throw new InvalidArgumentException( esc_html( $summary ) );
}
}
PK [1]kc@ c@ Utilities/DatabaseUtil.phpnu suppress_errors( true );
$dbdelta_output = $this->dbdelta( $creation_queries, false );
$wpdb->suppress_errors( $suppress_errors );
$parsed_output = $this->parse_dbdelta_output( $dbdelta_output );
return $parsed_output['created_tables'];
}
/**
* Parses the output given by dbdelta and returns information about it.
*
* @param array $dbdelta_output The output from the execution of dbdelta.
* @return array[] An array containing a 'created_tables' key whose value is an array with the names of the tables that have been (or would have been) created.
*/
public function parse_dbdelta_output( array $dbdelta_output ): array {
$created_tables = array();
foreach ( $dbdelta_output as $table_name => $result ) {
if ( "Created table $table_name" === $result ) {
$created_tables[] = str_replace( '(', '', $table_name );
}
}
return array( 'created_tables' => $created_tables );
}
/**
* Drops a database table.
*
* @param string $table_name The name of the table to drop.
* @param bool $add_prefix True if the table name passed needs to be prefixed with $wpdb->prefix before processing.
* @return bool True on success, false on error.
*/
public function drop_database_table( string $table_name, bool $add_prefix = false ) {
global $wpdb;
if ( $add_prefix ) {
$table_name = $wpdb->prefix . $table_name;
}
//phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->query( "DROP TABLE IF EXISTS `{$table_name}`" );
}
/**
* Drops a table index, if both the table and the index exist.
*
* @param string $table_name The name of the table that contains the index.
* @param string $index_name The name of the index to be dropped.
* @return bool True if the index has been dropped, false if either the table or the index don't exist.
*/
public function drop_table_index( string $table_name, string $index_name ): bool {
global $wpdb;
if ( empty( $this->get_index_columns( $table_name, $index_name ) ) ) {
return false;
}
// phpcs:ignore WordPress.DB.PreparedSQL
$wpdb->query( "ALTER TABLE $table_name DROP INDEX $index_name" );
return true;
}
/**
* Create a primary key for a table, only if the table doesn't have a primary key already.
*
* @param string $table_name Table name.
* @param array $columns An array with the index column names.
* @return bool True if the key has been created, false if the table already had a primary key.
*/
public function create_primary_key( string $table_name, array $columns ) {
global $wpdb;
if ( ! empty( $this->get_index_columns( $table_name ) ) ) {
return false;
}
// phpcs:ignore WordPress.DB.PreparedSQL
$wpdb->query( "ALTER TABLE $table_name ADD PRIMARY KEY(`" . join( '`,`', $columns ) . '`)' );
return true;
}
/**
* Get the columns of a given table index, or of the primary key.
*
* @param string $table_name Table name.
* @param string $index_name Index name, empty string for the primary key.
* @return array The index columns. Empty array if the table or the index don't exist.
*/
public function get_index_columns( string $table_name, string $index_name = '' ): array {
global $wpdb;
if ( empty( $index_name ) ) {
$index_name = 'PRIMARY';
}
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$results = $wpdb->get_results( $wpdb->prepare( "SHOW INDEX FROM $table_name WHERE Key_name = %s", $index_name ) );
if ( empty( $results ) ) {
return array();
}
return array_column( $results, 'Column_name' );
}
/**
* Formats an object value of type `$type` for inclusion in the database.
*
* @param mixed $value Raw value.
* @param string $type Data type.
* @return mixed
* @throws \Exception When an invalid type is passed.
*/
public function format_object_value_for_db( $value, string $type ) {
switch ( $type ) {
case 'decimal':
$value = wc_format_decimal( $value, false, true );
break;
case 'int':
$value = (int) $value;
break;
case 'bool':
$value = wc_string_to_bool( $value );
break;
case 'string':
$value = strval( $value );
break;
case 'date':
// Date properties are converted to the WP timezone (see WC_Data::set_date_prop() method), however
// for our own tables we persist dates in GMT.
$value = $value ? ( new DateTime( $value ) )->setTimezone( new DateTimeZone( '+00:00' ) )->format( 'Y-m-d H:i:s' ) : null;
break;
case 'date_epoch':
$value = $value ? ( new DateTime( "@{$value}" ) )->format( 'Y-m-d H:i:s' ) : null;
break;
default:
throw new \Exception( esc_html( 'Invalid type received: ' . $type ) );
}
return $value;
}
/**
* Returns the `$wpdb` placeholder to use for data type `$type`.
*
* @param string $type Data type.
* @return string
* @throws \Exception When an invalid type is passed.
*/
public function get_wpdb_format_for_type( string $type ) {
static $wpdb_placeholder_for_type = array(
'int' => '%d',
'decimal' => '%f',
'string' => '%s',
'date' => '%s',
'date_epoch' => '%s',
'bool' => '%d',
);
if ( ! isset( $wpdb_placeholder_for_type[ $type ] ) ) {
throw new \Exception( esc_html( 'Invalid column type: ' . $type ) );
}
return $wpdb_placeholder_for_type[ $type ];
}
/**
* Generates ON DUPLICATE KEY UPDATE clause to be used in migration.
*
* @param array $columns List of column names.
*
* @return string SQL clause for INSERT...ON DUPLICATE KEY UPDATE
*/
public function generate_on_duplicate_statement_clause( array $columns ): string {
$update_value_statements = array();
foreach ( $columns as $column ) {
$update_value_statements[] = "`$column` = VALUES( `$column` )";
}
$update_value_clause = implode( ', ', $update_value_statements );
return "ON DUPLICATE KEY UPDATE $update_value_clause";
}
/**
* Hybrid of $wpdb->update and $wpdb->insert. It will try to update a row, and if it doesn't exist, it will insert it. This needs unique constraints to be set on the table on all ID columns.
*
* You can use this function only when:
* 1. There is only one unique constraint on the table. The constraint can contain multiple columns, but it must be the only one unique constraint.
* 2. The complete unique constraint must be part of the $data array.
* 3. You do not need the LAST_INSERT_ID() value.
*
* @param string $table_name Table name.
* @param array $data Unescaped data to update (in column => value pairs).
* @param array $format An array of formats to be mapped to each of the values in $data.
*
* @return int Returns the value of DB's ON DUPLICATE KEY UPDATE clause.
*/
public function insert_on_duplicate_key_update( $table_name, $data, $format ): int {
global $wpdb;
if ( empty( $data ) ) {
return 0;
}
$columns = array_keys( $data );
$value_format = array();
$values = array();
$index = 0;
// Directly use NULL for placeholder if the value is NULL, since otherwise $wpdb->prepare will convert it to empty string.
foreach ( $data as $key => $value ) {
if ( is_null( $value ) ) {
$value_format[] = 'NULL';
} else {
$values[] = $value;
$value_format[] = $format[ $index ];
}
++$index;
}
$column_clause = '`' . implode( '`, `', $columns ) . '`';
$value_format_clause = implode( ', ', $value_format );
$on_duplicate_clause = $this->generate_on_duplicate_statement_clause( $columns );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- Values are escaped in $wpdb->prepare.
$sql = $wpdb->prepare(
"
INSERT INTO $table_name ( $column_clause )
VALUES ( $value_format_clause )
$on_duplicate_clause
",
$values
);
// phpcs:enable
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- $sql is prepared.
return $wpdb->query( $sql );
}
/**
* Hybrid of $wpdb->update and $wpdb->insert. It will try to update a row, and if it doesn't exist, it will insert it. Unlike `insert_on_duplicate_key_update` it does not require a unique constraint, but also does not guarantee uniqueness on its own.
*
* When a unique constraint is present, it will perform better than the `insert_on_duplicate_key_update` since it needs fewer locks.
*
* Note that it will only update at max just 1 database row, unlike `wpdb->update` which updates everything that matches the `$where` criteria. This is also why it needs a primary_key_column.
*
* @param string $table_name Table Name.
* @param array $data Data to insert update in array($column_name => $value) format.
* @param array $where Update conditions in array($column_name => $value) format. Conditions will be joined by AND.
* @param array $format Format strings for data. Unlike $wpdb->update/insert, this method won't guess the format, and has to be provided explicitly.
* @param array $where_format Format strings for where conditions. Unlike $wpdb->update/insert, this method won't guess the format, and has to be provided explicitly.
* @param string $primary_key_column Name of the Primary key column.
* @param string $primary_key_format Format for primary key.
*
* @return bool|int Number of rows affected. Boolean false on error.
*/
public function insert_or_update( $table_name, $data, $where, $format, $where_format, $primary_key_column = 'id', $primary_key_format = '%d' ) {
global $wpdb;
if ( empty( $data ) || empty( $where ) ) {
return 0;
}
// Build select query.
$values = array();
$index = 0;
$conditions = array();
foreach ( $where as $column => $value ) {
if ( is_null( $value ) ) {
$conditions[] = "`$column` IS NULL";
continue;
}
$conditions[] = "`$column` = " . $where_format[ $index ];
$values[] = $value;
++$index;
}
$conditions = implode( ' AND ', $conditions );
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- $primary_key_column and $table_name are hardcoded. $conditions is being prepared.
$query = $wpdb->prepare( "SELECT `$primary_key_column` FROM `$table_name` WHERE $conditions LIMIT 1", $values );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- $query is prepared above.
$row_id = $wpdb->get_var( $query );
if ( $row_id ) {
// Update the row.
$result = $wpdb->update( $table_name, $data, array( $primary_key_column => $row_id ), $format, array( $primary_key_format ) );
} else {
// Insert the row.
$result = $wpdb->insert( $table_name, $data, $format );
}
return $result;
}
/**
* Get max index length.
*
* @return int Max index length.
*/
public function get_max_index_length(): int {
/**
* Filters the maximum index length in the database.
*
* Indexes have a maximum size of 767 bytes. Historically, we haven't need to be concerned about that.
* As of WP 4.2, however, they moved to utf8mb4, which uses 4 bytes per character. This means that an index which
* used to have room for floor(767/3) = 255 characters, now only has room for floor(767/4) = 191 characters.
*
* Additionally, MyISAM engine also limits the index size to 1000 bytes. We add this filter so that interested folks on InnoDB engine can increase the size till allowed 3071 bytes.
*
* @param int $max_index_length Maximum index length. Default 191.
*
* @since 8.0.0
*/
$max_index_length = apply_filters( 'woocommerce_database_max_index_length', 191 );
// Index length cannot be more than 768, which is 3078 bytes in utf8mb4 and max allowed by InnoDB engine.
return min( absint( $max_index_length ), 767 );
}
/**
* Create a fulltext index on order address table.
*
* @return void
*/
public function create_fts_index_order_address_table(): void {
global $wpdb;
$address_table = $wpdb->prefix . 'wc_order_addresses';
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $address_table is hardcoded.
$wpdb->query( "CREATE FULLTEXT INDEX order_addresses_fts ON $address_table (first_name, last_name, company, address_1, address_2, city, state, postcode, country, email, phone)" );
}
/**
* Helper method to drop the fulltext index on order address table.
*
* @since 9.4.0
*
* @return void
*/
public function drop_fts_index_order_address_table(): void {
global $wpdb;
$address_table = $wpdb->prefix . 'wc_order_addresses';
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $address_table is hardcoded.
$wpdb->query( "ALTER TABLE $address_table DROP INDEX order_addresses_fts;" );
}
/**
* Sanitize FTS Search params to remove relevancy operators for performance, and add partial matches. Useful when the sorting is already happening based on some other conditions, so relevancy calculation is not needed.
*
* @since 9.4.0
*
* @param string $param Search term.
*
* @return string Sanitized search term.
*/
public function sanitise_boolean_fts_search_term( string $param ): string {
// Remove any operator to prevent incorrect query and fatals, such as search starting with `++`. We can allow this in the future if we have proper validation for FTS search operators.
// Space is allowed to provide multiple words.
$sanitized_param = preg_replace( '/[^\p{L}\p{N}_]+/u', ' ', $param );
if ( $sanitized_param !== $param ) {
$param = str_replace( '"', '', $param );
return '"' . $param . '"';
}
// Split the search phrase into words so that we can add operators when needed.
$words = explode( ' ', $param );
$sanitized_words = array();
foreach ( $words as $word ) {
// Add `*` as suffix to every term so that partial matches happens.
$word = $word . '*';
$sanitized_words[] = $word;
}
return implode( ' ', $sanitized_words );
}
/**
* Check if fulltext index with key `order_addresses_fts` on order address table exists.
*
* @return bool
*/
public function fts_index_on_order_address_table_exists(): bool {
global $wpdb;
$address_table = $wpdb->prefix . 'wc_order_addresses';
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $address_table is hardcoded.
return ! empty( $wpdb->get_results( "SHOW INDEX FROM $address_table WHERE Key_name = 'order_addresses_fts'" ) );
}
/**
* Create a fulltext index on order item table.
*
* @return void
*/
public function create_fts_index_order_item_table(): void {
global $wpdb;
$order_item_table = $wpdb->prefix . 'woocommerce_order_items';
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $order_item_table is hardcoded.
$wpdb->query( "CREATE FULLTEXT INDEX order_item_fts ON $order_item_table (order_item_name)" );
}
/**
* Check if fulltext index with key `order_item_fts` on order item table exists.
*
* @return bool
*/
public function fts_index_on_order_item_table_exists(): bool {
global $wpdb;
$order_item_table = $wpdb->prefix . 'woocommerce_order_items';
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $order_item_table is hardcoded.
return ! empty( $wpdb->get_results( "SHOW INDEX FROM $order_item_table WHERE Key_name = 'order_item_fts'" ) );
}
}
PK [1]ަC C Utilities/ArrayUtil.phpnu $v ) {
if ( ++$next_key !== $k ) {
return false;
}
}
return true;
}
/**
* Merge two lists of associative arrays by a key.
*
* @param array $arr1 The first array.
* @param array $arr2 The second array.
* @param string $key The key to merge by.
*
* @return array The merged list sorted by the key values.
*/
public static function merge_by_key( array $arr1, array $arr2, string $key ): array {
$merged = array();
// Overwrite items in $arr1 with items in $arr2 if they have the same key entry value.
// The rest of items in $arr1 will be appended.
foreach ( $arr1 as $item1 ) {
$found = false;
foreach ( $arr2 as $item2 ) {
if ( $item1[ $key ] === $item2[ $key ] ) {
$merged[] = array_merge( $item1, $item2 );
$found = true;
break;
}
}
if ( ! $found ) {
$merged[] = $item1;
}
}
// Append items from $arr2 that are don't have a corresponding key entry value in $arr1.
foreach ( $arr2 as $item2 ) {
$found = false;
foreach ( $arr1 as $item1 ) {
if ( $item1[ $key ] === $item2[ $key ] ) {
$found = true;
break;
}
}
if ( ! $found ) {
$merged[] = $item2;
}
}
// Sort the merged list by the key values.
usort(
$merged,
function ( $a, $b ) use ( $key ) {
return $a[ $key ] <=> $b[ $key ];
}
);
return array_values( $merged );
}
/**
* Recursively filters null values from an array.
*
* This method removes all null values from the array, including nested arrays.
* Array keys are preserved for associative arrays. For lists (sequential numeric
* keys starting from 0), the array is reindexed to maintain the list structure.
*
* @param array $arr The array to filter.
*
* @return array The filtered array with null values removed.
*/
public static function filter_null_values_recursive( array $arr ): array {
$is_list = self::array_is_list( $arr );
$filtered = array();
foreach ( $arr as $key => $value ) {
// Skip null values.
if ( is_null( $value ) ) {
continue;
}
// Recursively filter nested arrays.
if ( is_array( $value ) ) {
$filtered[ $key ] = self::filter_null_values_recursive( $value );
} else {
$filtered[ $key ] = $value;
}
}
// Reindex if the original array was a list.
return $is_list ? array_values( $filtered ) : $filtered;
}
}
PK [1]W"o o Utilities/BlocksUtil.phpnu content ) {
return array();
}
$blocks = parse_blocks( $template->content );
$flatten_blocks = self::flatten_blocks( $blocks );
return array_values(
array_filter(
$flatten_blocks,
function ( $block ) use ( $block_name ) {
return ( $block_name === $block['blockName'] );
}
)
);
}
}
PK [1]c c Utilities/HtmlSanitizer.phpnu array(
'stripslashes',
'force_balance_tags',
),
'wp_kses_rules' => array(
'br' => true,
'img' => array(
'alt' => true,
'class' => true,
'src' => true,
'title' => true,
),
'p' => array(
'class' => true,
),
'span' => array(
'class' => true,
'title' => true,
),
),
);
/**
* Sanitizes a chunk of HTML, by following the same rules as `wp_kses_post()` but also allowing
* the style element to be supplied.
*
* @param string $html The HTML to be sanitized.
*
* @return string
*/
public function styled_post_content( string $html ): string {
$rules = wp_kses_allowed_html( 'post' );
$rules['style'] = true;
return wp_kses( $html, $rules );
}
/**
* Sanitizes the HTML according to the provided rules.
*
* @see wp_kses()
*
* @param string $html HTML string to be sanitized.
* @param array $sanitizer_rules {
* Optional and defaults to self::TRIMMED_BALANCED_LOW_HTML_NO_LINKS. Otherwise, one or more of the following
* keys should be set.
*
* @type array $pre_processors Callbacks to run before invoking `wp_kses()`.
* @type array $wp_kses_rules Element names and attributes to allow, per `wp_kses()`.
* }
*
* @return string
*/
public function sanitize( string $html, array $sanitizer_rules = self::LOW_HTML_BALANCED_TAGS_NO_LINKS ): string {
if ( isset( $sanitizer_rules['pre_processors'] ) && is_array( $sanitizer_rules['pre_processors'] ) ) {
$html = $this->apply_string_callbacks( $sanitizer_rules['pre_processors'], $html );
}
// If no KSES rules are specified, assume all HTML should be stripped.
$kses_rules = isset( $sanitizer_rules['wp_kses_rules'] ) && is_array( $sanitizer_rules['wp_kses_rules'] )
? $sanitizer_rules['wp_kses_rules']
: array();
return wp_kses( $html, $kses_rules );
}
/**
* Applies callbacks used to process the string before and after wp_kses().
*
* If a callback is invalid we will short-circuit and return an empty string, on the grounds that it is better to
* output nothing than risky HTML. We also call the problem out via _doing_it_wrong() to highlight the problem (and
* increase the chances of this being caught during development).
*
* @param callable[] $callbacks The callbacks used to mutate the string.
* @param string $string The string being processed.
*
* @return string
*/
private function apply_string_callbacks( array $callbacks, string $string ): string {
foreach ( $callbacks as $callback ) {
if ( ! is_callable( $callback ) ) {
_doing_it_wrong( __CLASS__ . '::apply', esc_html__( 'String processors must be an array of valid callbacks.', 'woocommerce' ), esc_html( WC()->version ) );
return '';
}
$string = (string) $callback( $string );
}
return $string;
}
}
PK [1]^& & Utilities/COTMigrationUtil.phpnu table_controller = $table_controller;
$this->data_synchronizer = $data_synchronizer;
}
/**
* Helper function to get screen name of orders page in wp-admin.
*
* @throws \Exception If called from outside of wp-admin.
*
* @return string
*/
public function get_order_admin_screen() : string {
if ( ! is_admin() ) {
throw new \Exception( 'This function should only be called in admin.' );
}
return $this->custom_orders_table_usage_is_enabled() && function_exists( 'wc_get_page_screen_id' )
? wc_get_page_screen_id( 'shop-order' )
: 'shop_order';
}
/**
* Helper function to get whether custom order tables are enabled or not.
*
* @return bool
*/
private function custom_orders_table_usage_is_enabled() : bool {
return $this->table_controller->custom_orders_table_usage_is_enabled();
}
/**
* Checks if posts and order custom table sync is enabled and there are no pending orders.
*
* @return bool
*/
public function is_custom_order_tables_in_sync() : bool {
if ( ! $this->data_synchronizer->data_sync_is_enabled() ) {
return false;
}
return ! $this->data_synchronizer->has_orders_pending_sync();
}
/**
* Gets value of a meta key from WC_Data object if passed, otherwise from the post object.
* This helper function support backward compatibility for meta box functions, when moving from posts based store to custom tables.
*
* @param WP_Post|null $post Post object, meta will be fetched from this only when `$data` is not passed.
* @param \WC_Data|null $data WC_Data object, will be preferred over post object when passed.
* @param string $key Key to fetch metadata for.
* @param bool $single Whether metadata is single.
*
* @return array|mixed|string Value of the meta key.
*/
public function get_post_or_object_meta( ?WP_Post $post, ?\WC_Data $data, string $key, bool $single ) {
if ( isset( $data ) ) {
if ( method_exists( $data, "get$key" ) ) {
return $data->{"get$key"}();
}
return $data->get_meta( $key, $single );
} else {
return isset( $post->ID ) ? get_post_meta( $post->ID, $key, $single ) : false;
}
}
/**
* Helper function to initialize the global $theorder object, mostly used during order meta boxes rendering.
*
* @param WC_Order|WP_Post $post_or_order_object Post or order object.
*
* @return bool|WC_Order|WC_Order_Refund WC_Order object.
*/
public function init_theorder_object( $post_or_order_object ) {
global $theorder;
if ( $theorder instanceof WC_Order ) {
return $theorder;
}
if ( $post_or_order_object instanceof WC_Order ) {
$theorder = $post_or_order_object;
} else {
$theorder = wc_get_order( $post_or_order_object->ID );
}
return $theorder;
}
/**
* Helper function to get ID from a post or order object.
*
* @param WP_Post/WC_Order $post_or_order_object WP_Post/WC_Order object to get ID for.
*
* @return int Order or post ID.
*/
public function get_post_or_order_id( $post_or_order_object ) : int {
if ( is_numeric( $post_or_order_object ) ) {
return (int) $post_or_order_object;
} elseif ( $post_or_order_object instanceof WC_Order ) {
return $post_or_order_object->get_id();
} elseif ( $post_or_order_object instanceof WP_Post ) {
return $post_or_order_object->ID;
}
return 0;
}
/**
* Checks if passed id, post or order object is a WC_Order object.
*
* @param int|WP_Post|WC_Order $order_id Order ID, post object or order object.
* @param string[] $types Types to match against.
*
* @return bool Whether the passed param is an order.
*/
public function is_order( $order_id, array $types = array( 'shop_order' ) ) : bool {
$order_id = $this->get_post_or_order_id( $order_id );
$order_data_store = \WC_Data_Store::load( 'order' );
return in_array( $order_data_store->get_order_type( $order_id ), $types, true );
}
/**
* Returns type pf passed id, post or order object.
*
* @param int|WP_Post|WC_Order $order_id Order ID, post object or order object.
*
* @return string|null Type of the order.
*/
public function get_order_type( $order_id ) {
$order_id = $this->get_post_or_order_id( $order_id );
$order_data_store = \WC_Data_Store::load( 'order' );
return $order_data_store->get_order_type( $order_id );
}
/**
* Get the name of the database table that's currently in use for orders.
*
* @return string
*/
public function get_table_for_orders() {
if ( $this->custom_orders_table_usage_is_enabled() ) {
$table_name = OrdersTableDataStore::get_orders_table_name();
} else {
global $wpdb;
$table_name = $wpdb->posts;
}
return $table_name;
}
/**
* Get the name of the database table that's currently in use for orders.
*
* @return string
*/
public function get_table_for_order_meta() {
if ( $this->custom_orders_table_usage_is_enabled() ) {
$table_name = OrdersTableDataStore::get_meta_table_name();
} else {
global $wpdb;
$table_name = $wpdb->postmeta;
}
return $table_name;
}
}
PK [1]ZD Utilities/ProductUtil.phpnu get_id();
} else {
$product_id = $product_or_id;
$product = wc_get_product( $product_id );
}
if ( $product instanceof \WC_Product_Variation ) {
$parent_id = $product->get_parent_id();
}
$product_specific_transient_names = array(
'wc_product_children_',
'wc_var_prices_',
'wc_related_',
'wc_child_has_weight_',
'wc_child_has_dimensions_',
);
foreach ( $product_specific_transient_names as $transient ) {
delete_transient( $transient . $product_id );
if ( $parent_id ) {
delete_transient( $transient . $parent_id );
}
}
}
}
PK [1]Йy y Utilities/WebhookUtil.phpnu get_webhook_ids_for_user( $old_user_id );
foreach ( $webhook_ids as $webhook_id ) {
$webhook = new \WC_Webhook( $webhook_id );
$webhook->set_user_id( $new_user_id ?? 0 );
$webhook->save();
}
}
/**
* When users are about to be deleted show an informative text if they have webhooks assigned.
*
* @param \WP_User $current_user The current logged in user.
* @param array $userids Array with the ids of the users that are about to be deleted.
* @return void
* @since 7.8.0
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function maybe_render_user_with_webhooks_warning( \WP_User $current_user, array $userids ): void {
global $wpdb;
$at_least_one_user_with_webhooks = false;
foreach ( $userids as $user_id ) {
$webhook_ids = $this->get_webhook_ids_for_user( $user_id );
if ( empty( $webhook_ids ) ) {
continue;
}
$at_least_one_user_with_webhooks = true;
$user_data = get_userdata( $user_id );
$user_login = false === $user_data ? '' : $user_data->user_login;
$webhooks_count = count( $webhook_ids );
$text = sprintf(
/* translators: 1 = user id, 2 = user login, 3 = webhooks count */
_nx(
'User #%1$s %2$s has created %3$d WooCommerce webhook.',
'User #%1$s %2$s has created %3$d WooCommerce webhooks.',
$webhooks_count,
'user webhook count',
'woocommerce'
),
$user_id,
$user_login,
$webhooks_count
);
echo '
' . esc_html( $text ) . '
';
}
if ( ! $at_least_one_user_with_webhooks ) {
return;
}
$webhooks_settings_url = esc_url_raw( admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=webhooks' ) );
// This block of code is copied from WordPress' users.php.
// phpcs:disable WooCommerce.Commenting.CommentHooks, WordPress.DB.PreparedSQL.NotPrepared
$users_have_content = (bool) apply_filters( 'users_have_additional_content', false, $userids );
if ( ! $users_have_content ) {
if ( $wpdb->get_var( "SELECT ID FROM {$wpdb->posts} WHERE post_author IN( " . implode( ',', $userids ) . ' ) LIMIT 1' ) ) {
$users_have_content = true;
} elseif ( $wpdb->get_var( "SELECT link_id FROM {$wpdb->links} WHERE link_owner IN( " . implode( ',', $userids ) . ' ) LIMIT 1' ) ) {
$users_have_content = true;
}
}
// phpcs:enable WooCommerce.Commenting.CommentHooks, WordPress.DB.PreparedSQL.NotPrepared
if ( $users_have_content ) {
$text = __( 'If the "Delete all content" option is selected, the affected WooCommerce webhooks will not be deleted and will be attributed to user id 0. ', 'woocommerce' );
} else {
$text = __( 'The affected WooCommerce webhooks will not be deleted and will be attributed to user id 0. ', 'woocommerce' );
}
$text .= sprintf(
/* translators: 1 = url of the WooCommerce webhooks settings page */
__( 'After that they can be reassigned to the logged-in user by going to the WooCommerce webhooks settings page and re-saving them.', 'woocommerce' ),
$webhooks_settings_url
);
echo '
' . wp_kses_post( $text ) . '
';
}
/**
* Get the ids of the webhooks assigned to a given user.
*
* @param int $user_id User id.
* @return int[] Array of webhook ids.
*/
private function get_webhook_ids_for_user( int $user_id ): array {
$data_store = \WC_Data_Store::load( 'webhook' );
return $data_store->search_webhooks(
array(
'user_id' => $user_id,
)
);
}
/**
* Gets the count of webhooks that are configured to use the Legacy REST API to compose their payloads.
*
* @param bool $clear_cache If true, the previously cached value of the count will be discarded if it exists.
*
* @return int
*/
public function get_legacy_webhooks_count( bool $clear_cache = false ): int {
global $wpdb;
$cache_key = WC_Cache_Helper::get_cache_prefix( 'webhooks' ) . 'legacy_count';
if ( $clear_cache ) {
wp_cache_delete( $cache_key, 'webhooks' );
}
$count = wp_cache_get( $cache_key, 'webhooks' );
if ( false === $count ) {
$count = absint( $wpdb->get_var( "SELECT count( webhook_id ) FROM {$wpdb->prefix}wc_webhooks WHERE `api_version` < 1;" ) );
wp_cache_add( $cache_key, $count, 'webhooks' );
}
return $count;
}
}
PK [1]u&P! P! OrderCouponDataMigrator.phpnu get_var(
$wpdb->prepare(
"SELECT COUNT(*) FROM {$wpdb->prefix}woocommerce_order_itemmeta WHERE meta_key=%s",
'coupon_data'
)
);
}
/**
* Returns the next batch of items that need to be processed.
* A batch in this context is a list of 'meta_id' values from the wp_woocommerce_order_itemmeta table.
*
* @param int $size Maximum size of the batch to be returned.
*
* @return array Batch of items to process, containing $size or less items.
*/
public function get_next_batch_to_process( int $size ): array {
global $wpdb;
$meta_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT meta_id FROM {$wpdb->prefix}woocommerce_order_itemmeta WHERE meta_key=%s ORDER BY meta_id ASC LIMIT %d",
'coupon_data',
$size
)
);
return array_map( 'absint', $meta_ids );
}
/**
* Process data for the supplied batch. See the convert_item method.
*
* @throw \Exception Something went wrong while processing the batch.
*
* @param array $batch Batch to process, as returned by 'get_next_batch_to_process'.
*/
public function process_batch( array $batch ): void {
global $wpdb;
if ( empty( $batch ) ) {
return;
}
$meta_ids = StringUtil::to_sql_list( $batch );
$meta_ids_and_values = $wpdb->get_results(
//phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
"SELECT meta_id,meta_value FROM {$wpdb->prefix}woocommerce_order_itemmeta WHERE meta_id IN $meta_ids",
ARRAY_N
);
foreach ( $meta_ids_and_values as $meta_id_and_value ) {
try {
$this->convert_item( (int) $meta_id_and_value[0], $meta_id_and_value[1] );
} catch ( Exception $ex ) {
wc_get_logger()->error( StringUtil::class_name_without_namespace( self::class ) . ": when converting meta row with id {$meta_id_and_value[0]}: {$ex->getMessage()}" );
}
}
}
/**
* Convert one verbose 'coupon_data' entry into a simplified 'coupon_info' entry.
*
* The existing database row is updated in place, both the 'meta_key' and the 'meta_value' columns.
*
* @param int $meta_id Value of 'meta_id' of the row being converted.
* @param string $meta_value Value of 'meta_value' of the row being converted.
* @throws Exception Database error.
*/
private function convert_item( int $meta_id, string $meta_value ) {
global $wpdb;
//phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
$coupon_data = unserialize( $meta_value );
$temp_coupon = new \WC_Coupon();
$temp_coupon->set_props( $coupon_data );
//phpcs:disable WordPress.DB.SlowDBQuery
$wpdb->update(
"{$wpdb->prefix}woocommerce_order_itemmeta",
array(
'meta_key' => 'coupon_info',
'meta_value' => $temp_coupon->get_short_info(),
),
array( 'meta_id' => $meta_id )
);
//phpcs:enable WordPress.DB.SlowDBQuery
if ( $wpdb->last_error ) {
throw new Exception( $wpdb->last_error );
}
}
/**
* Default (preferred) batch size to pass to 'get_next_batch_to_process'.
*
* @return int Default batch size.
*/
public function get_default_batch_size(): int {
return 1000;
}
/**
* Add the tool to start or stop the background process that converts order coupon metadata entries.
*
* @param array $tools Old tools array.
* @return array Updated tools array.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function handle_woocommerce_debug_tools( array $tools ): array {
$batch_processor = wc_get_container()->get( BatchProcessingController::class );
$pending_count = $this->get_total_pending_count();
if ( 0 === $pending_count ) {
$tools['start_convert_order_coupon_data'] = array(
'name' => __( 'Start converting order coupon data to the simplified format', 'woocommerce' ),
'button' => __( 'Start converting', 'woocommerce' ),
'disabled' => true,
'desc' => __( 'This will convert coupon_data order item meta entries to simplified coupon_info entries. The conversion will happen overtime in the background (via Action Scheduler). There are currently no entries to convert.', 'woocommerce' ),
);
} elseif ( $batch_processor->is_enqueued( self::class ) ) {
$tools['stop_convert_order_coupon_data'] = array(
'name' => __( 'Stop converting order coupon data to the simplified format', 'woocommerce' ),
'button' => __( 'Stop converting', 'woocommerce' ),
'desc' =>
/* translators: %d=count of entries pending conversion */
sprintf( __( 'This will stop the background process that converts coupon_data order item meta entries to simplified coupon_info entries. There are currently %d entries that can be converted.', 'woocommerce' ), $pending_count ),
'callback' => array( $this, 'dequeue' ),
);
} else {
$tools['start_converting_order_coupon_data'] = array(
'name' => __( 'Convert order coupon data to the simplified format', 'woocommerce' ),
'button' => __( 'Start converting', 'woocommerce' ),
'desc' =>
/* translators: %d=count of entries pending conversion */
sprintf( __( 'This will convert coupon_data order item meta entries to simplified coupon_info entries. The conversion will happen overtime in the background (via Action Scheduler). There are currently %d entries that can be converted.', 'woocommerce' ), $pending_count ),
'callback' => array( $this, 'enqueue' ),
);
}
return $tools;
}
/**
* Start the background process for coupon data conversion.
*
* @return string Informative string to show after the tool is triggered in UI.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function enqueue(): string {
$batch_processor = wc_get_container()->get( BatchProcessingController::class );
if ( $batch_processor->is_enqueued( self::class ) ) {
return __( 'Background process for coupon meta conversion already started, nothing done.', 'woocommerce' );
}
$batch_processor->enqueue_processor( self::class );
return __( 'Background process for coupon meta conversion started', 'woocommerce' );
}
/**
* Stop the background process for coupon data conversion.
*
* @return string Informative string to show after the tool is triggered in UI.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function dequeue(): string {
$batch_processor = wc_get_container()->get( BatchProcessingController::class );
if ( ! $batch_processor->is_enqueued( self::class ) ) {
return __( 'Background process for coupon meta conversion not started, nothing done.', 'woocommerce' );
}
$batch_processor->remove_processor( self::class );
return __( 'Background process for coupon meta conversion stopped', 'woocommerce' );
}
}
PK [1]jMr0 0 + FraudProtection/SessionClearanceManager.phpnu get_session_status();
return self::STATUS_ALLOWED === $status;
}
/**
* Check if the current session is blocked.
*
* @return bool True if session is blocked, false otherwise.
*/
public function is_session_blocked(): bool {
$status = $this->get_session_status();
return self::STATUS_BLOCKED === $status;
}
/**
* Mark the current session as allowed.
*
* @return void
*/
public function allow_session(): void {
$this->set_session_status( self::STATUS_ALLOWED );
$this->log_session_update_event( 'allowed' );
}
/**
* Mark the current session as pending (challenge required).
*
* @return void
*/
public function challenge_session(): void {
$this->set_session_status( self::STATUS_PENDING );
$this->log_session_update_event( 'challenged' );
}
/**
* Mark the current session as blocked.
*
* @return void
*/
public function block_session(): void {
$this->set_session_status( self::STATUS_BLOCKED );
$this->log_session_update_event( 'blocked' );
$this->empty_cart();
}
/**
* Get the current session clearance status.
*
* @return string One of: pending, allowed, blocked.
*/
public function get_session_status(): string {
if ( ! $this->is_session_available() ) {
return self::DEFAULT_STATUS;
}
$status = WC()->session->get( self::SESSION_KEY, self::DEFAULT_STATUS );
// Validate status value - return default for invalid values.
if ( ! in_array( $status, array( self::STATUS_PENDING, self::STATUS_ALLOWED, self::STATUS_BLOCKED ), true ) ) {
return self::DEFAULT_STATUS;
}
return $status;
}
/**
* Set the session clearance status.
*
* @param string $status One of: pending, allowed, blocked.
* @return void
*/
private function set_session_status( string $status ): void {
if ( ! $this->is_session_available() ) {
return;
}
WC()->session->set( self::SESSION_KEY, $status );
// Ensure session cookie is set so the session persists across page loads.
// This is important because fraud protection may set session status before
// any cart action triggers the cookie to be set.
// Skip cookie setting if headers have already been sent (e.g., in test environment).
if ( WC()->session instanceof \WC_Session_Handler ) {
WC()->session->set_customer_session_cookie( true );
}
}
/**
* Reset the session clearance status to default (allowed).
*
* @return void
*/
public function reset_session(): void {
$this->set_session_status( self::DEFAULT_STATUS );
}
/**
* Ensure cart and session are available.
*
* Loads cart if not already loaded, which initializes session for both
* traditional (cookie) and Store API (token) flows.
*
* @return void
*/
public function ensure_cart_loaded(): void {
if ( ! did_action( 'woocommerce_load_cart_from_session' ) && function_exists( 'wc_load_cart' ) ) {
WC()->call_function( 'wc_load_cart' );
}
}
/**
* Check if WooCommerce session is available.
*
* @return bool True if session is available.
*/
private function is_session_available(): bool {
$this->ensure_cart_loaded();
return WC()->session instanceof \WC_Session;
}
/**
* Get a unique identifier for the current session.
*
* @return string Session identifier.
*/
public function get_session_id(): string {
if ( ! $this->is_session_available() ) {
return 'no-session';
}
// Use or generate a stable session ID for tracking consistency.
$fraud_customer_session_id = WC()->session->get( '_fraud_protection_customer_session_id' );
if ( ! $fraud_customer_session_id ) {
$fraud_customer_session_id = WC()->call_function( 'wc_rand_hash', 'customer_', 30 );
WC()->session->set( '_fraud_protection_customer_session_id', $fraud_customer_session_id );
}
return $fraud_customer_session_id;
}
/**
* Empty the cart.
*
* @return void
*/
private function empty_cart(): void {
if ( function_exists( 'WC' ) && WC()->cart ) {
WC()->cart->empty_cart();
}
}
/**
* Log a session update event using FraudProtectionController's logging helper.
*
* @param string $action The action taken (allowed, challenged, or blocked).
* @return void
*/
private function log_session_update_event( string $action ): void {
$session_id = $this->get_session_id();
$user_id = get_current_user_id();
$user_info = $user_id ? "User: {$user_id}" : 'User: guest';
$timestamp = current_time( 'mysql' );
$message = sprintf(
'Session updated: %s | %s | Action: %s | Timestamp: %s',
$session_id,
$user_info,
$action,
$timestamp
);
FraudProtectionController::log( 'info', $message );
}
}
PK [1]U U ( FraudProtection/SessionDataCollector.phpnu session_clearance_manager = $session_clearance_manager;
}
/**
* Collect comprehensive session and order data for fraud protection.
*
* This method is called manually at specific points in the checkout/payment flow
* to gather all relevant data for fraud analysis. It returns data in the nested
* format expected by the WPCOM fraud protection service.
*
* @since 10.5.0
*
* @param string|null $event_type Optional event type identifier (e.g., 'checkout_started', 'payment_attempt').
* @param array $event_data Optional event-specific additional context data (may include 'order_id').
* @return array Nested array containing all collected fraud protection data.
*/
public function collect( ?string $event_type = null, array $event_data = array() ): array {
// Ensure cart and session are loaded.
$this->session_clearance_manager->ensure_cart_loaded();
// Extract order ID from event_data if provided.
// There seem to be no universal way to get order id from session data, so we may start with passing it as a parameter when calling this method.
$order_id_from_event = $event_data['order_id'] ?? null;
return array(
'event_type' => $event_type,
'timestamp' => gmdate( 'Y-m-d H:i:s' ),
'wc_version' => WC()->version,
'session' => $this->get_session_data(),
'customer' => $this->get_customer_data(),
'order' => $this->get_order_data( $order_id_from_event ),
'shipping_address' => $this->get_shipping_address(),
'billing_address' => $this->get_billing_address(),
'event_data' => $event_data,
);
}
/**
* Get current billing country from customer data.
*
* Reuses the same logic as get_billing_address() but returns only the country.
* Tries WC_Customer first, falls back to session data, with graceful error handling.
*
* @since 10.5.0
*
* @return string|null Current billing country code or null if unavailable.
*/
public function get_current_billing_country(): ?string {
try {
if ( WC()->customer instanceof \WC_Customer ) {
$country = WC()->customer->get_billing_country();
return ! empty( $country ) ? \sanitize_text_field( $country ) : null;
} elseif ( WC()->session instanceof \WC_Session ) {
$customer_data = WC()->session->get( 'customer' );
if ( is_array( $customer_data ) && ! empty( $customer_data['country'] ) ) {
return \sanitize_text_field( $customer_data['country'] );
}
}
} catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Graceful degradation.
}
return null;
}
/**
* Get current shipping country from customer data.
*
* Reuses the same logic as get_shipping_address() but returns only the country.
* Tries WC_Customer first, falls back to session data, with graceful error handling.
*
* @since 10.5.0
*
* @return string|null Current shipping country code or null if unavailable.
*/
public function get_current_shipping_country(): ?string {
try {
if ( WC()->customer instanceof \WC_Customer ) {
$country = WC()->customer->get_shipping_country();
return ! empty( $country ) ? \sanitize_text_field( $country ) : null;
} elseif ( WC()->session instanceof \WC_Session ) {
$customer_data = WC()->session->get( 'customer' );
if ( is_array( $customer_data ) && ! empty( $customer_data['shipping_country'] ) ) {
return \sanitize_text_field( $customer_data['shipping_country'] );
}
}
} catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Graceful degradation.
}
return null;
}
/**
* Get session data including session ID, IP address, email, and user agent.
*
* Collects session identification and tracking data with graceful degradation
* for unavailable fields. Email collection follows the fallback chain:
* logged-in user email → session customer data → WC_Customer billing email.
*
* @since 10.5.0
*
* @return array Session data array with 6 keys.
*/
private function get_session_data(): array {
try {
$session_id = $this->session_clearance_manager->get_session_id();
$ip_address = $this->get_ip_address();
$email = $this->get_email();
$user_agent = $this->get_user_agent();
/**
* $is_user_session is flag that we have a real browser session vs API-based interaction.
* We start with a very basic check, but we might need a more sophisticated way to detect it in the future.
*/
$is_user_session = 'no-session' !== $session_id;
return array(
'session_id' => $session_id,
'ip_address' => $ip_address,
'email' => $email,
'ja3_hash' => null,
'user_agent' => $user_agent,
'is_user_session' => $is_user_session,
);
} catch ( \Exception $e ) {
// Graceful degradation - return structure with null values.
return array(
'session_id' => null,
'ip_address' => null,
'email' => null,
'ja3_hash' => null,
'user_agent' => null,
'is_user_session' => false,
);
}
}
/**
* Get customer data including name, billing email, and order history.
*
* Collects customer identification and history data with graceful degradation.
* Tries WC_Customer object first, then falls back to session data if values are empty.
* Includes lifetime_order_count which counts all orders regardless of status.
*
* @since 10.5.0
*
* @return array Customer data array with 4 keys.
*/
private function get_customer_data(): array {
$customer_data = array(
'first_name' => null,
'last_name' => null,
'billing_email' => null,
'lifetime_order_count' => 0,
);
try {
$lifetime_order_count = 0;
// Try WC_Customer object first.
if ( WC()->customer instanceof \WC_Customer ) {
if ( WC()->customer->get_id() > 0 ) {
// We need to reload the customer so it uses the correct data store to count the orders.
$customer = new \WC_Customer( WC()->customer->get_id() );
$lifetime_order_count = $customer->get_order_count();
}
$customer_data = array_merge(
$customer_data,
array(
'first_name' => \sanitize_text_field( WC()->customer->get_billing_first_name() ),
'last_name' => \sanitize_text_field( WC()->customer->get_billing_last_name() ),
'billing_email' => \sanitize_email( \WC()->customer->get_billing_email() ),
'lifetime_order_count' => $lifetime_order_count,
)
);
} elseif ( WC()->session instanceof \WC_Session ) {
// Fallback to session customer data if WC_Customer not available.
$customer_session_data = WC()->session->get( 'customer' );
if ( is_array( $customer_session_data ) ) {
$customer_data = array_merge(
$customer_data,
array(
'first_name' => \sanitize_text_field( $customer_session_data['first_name'] ?? null ),
'last_name' => \sanitize_text_field( $customer_session_data['last_name'] ?? null ),
'billing_email' => \sanitize_email( $customer_session_data['email'] ?? null ),
)
);
}
}
} catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Graceful degradation - return as much data as possible.
}
return $customer_data;
}
/**
* Get order data including totals, currency, cart hash, and cart items.
*
* Collects comprehensive order information from the cart with graceful degradation.
* Calculates shipping_tax_rate from shipping tax and shipping total. Sets customer_id
* to 'guest' for non-logged-in users.
*
* @since 10.5.0
*
* @param int|null $order_id_from_event Optional order ID from event data.
* @return array Order data array with 11 keys including items array.
*/
private function get_order_data( ?int $order_id_from_event = null ): array {
try {
// Initialize default values.
$order_id = $order_id_from_event;
$customer_id = 'guest';
$total = 0;
$items_total = 0;
$shipping_total = 0;
$tax_total = 0;
$shipping_tax_rate = null;
$discount_total = 0;
$currency = WC()->call_function( 'get_woocommerce_currency' );
$cart_hash = null;
$items = array();
// Get customer ID from WooCommerce customer object if available.
// We don't need to fallback to session data here, because customer id won't be stored there.
if ( WC()->customer instanceof \WC_Customer ) {
$id = WC()->customer->get_id();
if ( $id ) {
$customer_id = $id;
}
}
// Get cart data if available.
if ( WC()->cart instanceof \WC_Cart ) {
$items_total = (float) WC()->cart->get_subtotal();
$shipping_total = (float) WC()->cart->get_shipping_total();
$tax_total = (float) WC()->cart->get_cart_contents_tax();
$discount_total = (float) WC()->cart->get_discount_total();
$cart_hash = WC()->cart->get_cart_hash();
$items = $this->get_cart_items();
$total = (float) WC()->cart->get_total( 'edit' );
// Calculate shipping_tax_rate.
$shipping_tax = (float) WC()->cart->get_shipping_tax();
if ( $shipping_total > 0 && $shipping_tax > 0 ) {
$shipping_tax_rate = $shipping_tax / $shipping_total;
}
}
return array(
'order_id' => $order_id,
'customer_id' => $customer_id,
'total' => $total,
'items_total' => $items_total,
'shipping_total' => $shipping_total,
'tax_total' => $tax_total,
'shipping_tax_rate' => $shipping_tax_rate,
'discount_total' => $discount_total,
'currency' => $currency,
'cart_hash' => $cart_hash,
'items' => $items,
);
} catch ( \Exception $e ) {
// Graceful degradation - return structure with default values.
return array(
'order_id' => null,
'customer_id' => 'guest',
'total' => 0,
'items_total' => 0,
'shipping_total' => 0,
'tax_total' => 0,
'shipping_tax_rate' => null,
'discount_total' => 0,
'currency' => WC()->call_function( 'get_woocommerce_currency' ),
'cart_hash' => null,
'items' => array(),
);
}
}
/**
* Get cart items with detailed product information.
*
* Iterates through cart items and extracts comprehensive product data including
* name, description, category, SKU, pricing, quantities, and WooCommerce-specific
* attributes. Returns array of item objects with 12 fields each.
*
* @since 10.5.0
*
* @return array Array of cart item objects with detailed product information.
*/
private function get_cart_items(): array {
$items = array();
try {
if ( ! WC()->cart instanceof \WC_Cart ) {
return $items;
}
foreach ( WC()->cart->get_cart() as $cart_item ) {
try {
$product = $cart_item['data'] ?? null;
if ( ! $product instanceof \WC_Product ) {
continue;
}
$quantity = $cart_item['quantity'] ?? 1;
// Calculate per-unit amounts.
$unit_price = (float) $product->get_price();
$line_tax = $cart_item['line_tax'] ?? 0;
$unit_tax_amount = $quantity > 0 ? ( (float) $line_tax / $quantity ) : 0;
$line_discount = $cart_item['line_subtotal'] - $cart_item['line_total'];
$unit_discount_amount = $quantity > 0 ? ( (float) $line_discount / $quantity ) : 0;
$category = $this->get_product_category_names( $product );
$items[] = array(
'name' => $product->get_name() ? $product->get_name() : null,
'description' => $product->get_description() ? $product->get_description() : null,
'category' => $category,
'sku' => $product->get_sku() ? $product->get_sku() : null,
'quantity' => $quantity,
'unit_price' => $unit_price,
'unit_tax_amount' => $unit_tax_amount,
'unit_discount_amount' => $unit_discount_amount,
'product_type' => $product->get_type() ? $product->get_type() : null,
'is_virtual' => $product->is_virtual(),
'is_downloadable' => $product->is_downloadable(),
'attributes' => $product->get_attributes() ? $product->get_attributes() : array(),
);
} catch ( \Exception $e ) {
// Skip this item if there's an error, continue with next item.
continue;
}
}
} catch ( \Exception $e ) {
// Return empty array on error.
return array();
}
return $items;
}
/**
* Get billing address from customer data.
*
* Collects billing address fields from WC_Customer object with graceful degradation.
* Returns array with 6 address fields, sanitized with sanitize_text_field().
*
* @since 10.5.0
*
* @return array Billing address array with 6 keys.
*/
private function get_billing_address(): array {
$billing_data = array(
'first_name' => null,
'last_name' => null,
'address' => null,
'address_1' => null,
'address_2' => null,
'city' => null,
'state' => null,
'country' => null,
'phone' => null,
'postcode' => null,
);
try {
// Try WC_Customer object first.
if ( WC()->customer instanceof \WC_Customer ) {
$billing_data = array_merge(
$billing_data,
array(
'first_name' => \sanitize_text_field( WC()->customer->get_billing_first_name() ),
'last_name' => \sanitize_text_field( WC()->customer->get_billing_last_name() ),
'address_1' => \sanitize_text_field( WC()->customer->get_billing_address_1() ),
'address_2' => \sanitize_text_field( WC()->customer->get_billing_address_2() ),
'city' => \sanitize_text_field( WC()->customer->get_billing_city() ),
'state' => \sanitize_text_field( WC()->customer->get_billing_state() ),
'country' => \sanitize_text_field( WC()->customer->get_billing_country() ),
'phone' => \sanitize_text_field( WC()->customer->get_billing_phone() ),
'postcode' => \sanitize_text_field( WC()->customer->get_billing_postcode() ),
)
);
} elseif ( WC()->session instanceof \WC_Session ) {
// Fallback to session customer data if WC_Customer not available.
$customer_data = WC()->session->get( 'customer' );
if ( is_array( $customer_data ) ) {
$billing_data = array_merge(
$billing_data,
array(
'first_name' => \sanitize_text_field( $customer_data['first_name'] ?? null ),
'last_name' => \sanitize_text_field( $customer_data['last_name'] ?? null ),
'address' => \sanitize_text_field( $customer_data['address'] ?? null ),
'address_1' => \sanitize_text_field( $customer_data['address_1'] ?? null ),
'address_2' => \sanitize_text_field( $customer_data['address_2'] ?? null ),
'city' => \sanitize_text_field( $customer_data['city'] ?? null ),
'state' => \sanitize_text_field( $customer_data['state'] ?? null ),
'country' => \sanitize_text_field( $customer_data['country'] ?? null ),
'phone' => \sanitize_text_field( $customer_data['phone'] ?? null ),
'postcode' => \sanitize_text_field( $customer_data['postcode'] ?? null ),
)
);
}
}
} catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Graceful degradation - prevents any errors from being thrown.
}
return $billing_data;
}
/**
* Get shipping address from customer data.
*
* Collects shipping address fields from WC_Customer object with graceful degradation.
* Returns array with 6 address fields, sanitized with sanitize_text_field().
*
* @since 10.5.0
*
* @return array Shipping address array with 6 keys.
*/
private function get_shipping_address(): array {
$shipping_data = array(
'first_name' => null,
'last_name' => null,
'address' => null,
'address_1' => null,
'address_2' => null,
'city' => null,
'state' => null,
'postcode' => null,
'country' => null,
);
try {
if ( WC()->customer instanceof \WC_Customer ) {
$shipping_data = array_merge(
$shipping_data,
array(
'first_name' => \sanitize_text_field( WC()->customer->get_shipping_first_name() ),
'last_name' => \sanitize_text_field( WC()->customer->get_shipping_last_name() ),
'address_1' => \sanitize_text_field( WC()->customer->get_shipping_address_1() ),
'address_2' => \sanitize_text_field( WC()->customer->get_shipping_address_2() ),
'city' => \sanitize_text_field( WC()->customer->get_shipping_city() ),
'state' => \sanitize_text_field( WC()->customer->get_shipping_state() ),
'postcode' => \sanitize_text_field( WC()->customer->get_shipping_postcode() ),
'country' => \sanitize_text_field( WC()->customer->get_shipping_country() ),
)
);
} elseif ( WC()->session instanceof \WC_Session ) {
// Fallback to session customer data if WC_Customer not available.
$customer_data = WC()->session->get( 'customer' );
if ( is_array( $customer_data ) ) {
$shipping_data = array_merge(
$shipping_data,
array(
'first_name' => \sanitize_text_field( $customer_data['shipping_first_name'] ?? null ),
'last_name' => \sanitize_text_field( $customer_data['shipping_last_name'] ?? null ),
'address_1' => \sanitize_text_field( $customer_data['shipping_address_1'] ?? null ),
'address_2' => \sanitize_text_field( $customer_data['shipping_address_2'] ?? null ),
'city' => \sanitize_text_field( $customer_data['shipping_city'] ?? null ),
'state' => \sanitize_text_field( $customer_data['shipping_state'] ?? null ),
'postcode' => \sanitize_text_field( $customer_data['shipping_postcode'] ?? null ),
'country' => \sanitize_text_field( $customer_data['shipping_country'] ?? null ),
)
);
}
}
} catch ( \Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Graceful degradation - returns as much data as possible.
}
return $shipping_data;
}
/**
* Get client IP address using WooCommerce geolocation utility.
*
* @since 10.5.0
*
* @return string|null IP address or null if not available.
*/
private function get_ip_address(): ?string {
if ( class_exists( 'WC_Geolocation' ) ) {
$ip = \WC_Geolocation::get_ip_address();
return $ip ? $ip : null;
}
return null;
}
/**
* Get customer email with fallback chain.
*
* Tries logged-in user email first, then WC_Customer billing email,
* then session customer data as fallback.
*
* @since 10.5.0
*
* @return string|null Email address or null if not available.
*/
private function get_email(): ?string {
// Try logged-in user first.
if ( \is_user_logged_in() ) {
$user = \wp_get_current_user();
if ( $user && $user->user_email ) {
return \sanitize_email( $user->user_email );
}
}
// Try WC_Customer object.
if ( WC()->customer instanceof \WC_Customer ) {
$email = WC()->customer->get_billing_email();
if ( $email ) {
return \sanitize_email( $email );
}
}
// Fallback to session customer data if WC_Customer not available.
if ( WC()->session instanceof \WC_Session ) {
$customer_data = WC()->session->get( 'customer' );
if ( is_array( $customer_data ) && ! empty( $customer_data['email'] ) ) {
return \sanitize_email( $customer_data['email'] );
}
}
return null;
}
/**
* Get user agent string from HTTP headers.
*
* @since 10.5.0
*
* @return string|null User agent or null if not available.
*/
private function get_user_agent(): ?string {
if ( isset( $_SERVER['HTTP_USER_AGENT'] ) ) {
return sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) );
}
return null;
}
/**
* Get product category names as comma-separated list.
*
* Uses WooCommerce helper with caching for better performance.
* Returns all categories for the product, not just the primary one.
*
* @since 10.5.0
*
* @param \WC_Product $product The product object.
* @return string|null Comma-separated category names or null if none.
*/
private function get_product_category_names( \WC_Product $product ): ?string {
$terms = WC()->call_function( 'wc_get_product_terms', $product->get_id(), 'product_cat' );
if ( empty( $terms ) || ! is_array( $terms ) ) {
return null;
}
$category_names = array_map(
function ( $term ) {
return $term->name;
},
$terms
);
return implode( ', ', $category_names );
}
}
PK [1]| | , FraudProtection/JetpackConnectionManager.phpnu false,
'error' => '',
'error_code' => '',
'blog_id' => null,
);
// Check if connected.
if ( ! JetpackConnection::get_manager()->is_connected() ) {
$status['error'] = __( 'Site is not connected to WordPress.com. Please connect your site to enable fraud protection.', 'woocommerce' );
$status['error_code'] = 'not_connected';
return $status;
}
// Get blog ID.
$blog_id = $this->get_blog_id();
if ( ! $blog_id ) {
$status['error'] = __( 'Jetpack blog ID not found. Please reconnect your site to WordPress.com.', 'woocommerce' );
$status['error_code'] = 'no_blog_id';
return $status;
}
// All checks passed.
$status['connected'] = true;
$status['blog_id'] = $blog_id;
return $status;
}
/**
* Get the Jetpack authorization URL for connecting the site.
*
* @param string $redirect_url URL to redirect to after authorization.
* @return string|null Authorization URL or null on error.
*/
public function get_authorization_url( string $redirect_url = '' ): ?string {
// If no redirect URL provided, use current admin URL.
if ( empty( $redirect_url ) ) {
$redirect_url = admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=features' );
}
$authorization_data = JetpackConnection::get_authorization_url( $redirect_url, 'woocommerce-fraud-protection' );
if ( ! $authorization_data['success'] ) {
FraudProtectionController::log(
'error',
'Failed to get Jetpack authorization URL.',
$authorization_data['errors']
);
return null;
}
return $authorization_data['url'];
}
}
PK [1]! ( FraudProtection/AdminSettingsHandler.phpnu connection_manager = $connection_manager;
}
/**
* Add Jetpack connection field to fraud protection settings.
*
* @internal
*
* @param array $settings Existing settings.
* @param string $current_section Current section name.
* @return array Modified settings.
*/
public function add_jetpack_connection_field( $settings, $current_section ): array {
// Only add on the features section.
if ( 'features' !== $current_section ) {
return $settings;
}
// Check if field already exists to prevent duplicates.
foreach ( $settings as $setting ) {
if ( isset( $setting['id'] ) && 'woocommerce_fraud_protection_jetpack_connection' === $setting['id'] ) {
return $settings;
}
}
// Find the fraud_protection field and add Jetpack connection field after it.
$new_settings = array();
foreach ( $settings as $setting ) {
$new_settings[] = $setting;
// Add Jetpack connection field after fraud_protection checkbox.
if ( isset( $setting['id'] ) && 'woocommerce_feature_fraud_protection_enabled' === $setting['id'] ) {
$new_settings[] = array(
'id' => 'woocommerce_fraud_protection_jetpack_connection',
'type' => 'jetpack_connection',
'title' => __( 'Jetpack Connection', 'woocommerce' ),
'desc' => __( 'Connect your site to Jetpack to enable fraud protection features.', 'woocommerce' ),
);
}
}
return $new_settings;
}
/**
* Output the Jetpack connection field.
*
* @internal
*
* @param array $value Field configuration.
* @return void
*/
public function handle_output_jetpack_connection_field( $value ): void { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found
// Only show Jetpack connection when fraud protection is enabled.
if ( 'yes' !== get_option( 'woocommerce_feature_fraud_protection_enabled', 'no' ) ) {
return;
}
$this->output_jetpack_connection_status();
}
/**
* Output the Jetpack connection status and button.
*
* @internal
*
* @return void
*/
private function output_jetpack_connection_status(): void {
// Get connection status from connection manager.
$connection_status = $this->connection_manager->get_connection_status();
?>
connection_manager->get_authorization_url( $redirect_url );
// If we couldn't get authorization URL, show error message.
if ( ! $connection_url ) :
?>
get( EventTracker::class );
// $event_tracker->track( $event_type, $collected_data );
//
// For now, log the event for debugging and verification.
FraudProtectionController::log(
'info',
sprintf(
'Fraud protection event tracked: %s | Session ID: %s',
$event_type,
$collected_data['session']['session_id'] ?? 'N/A'
),
array(
'event_type' => $event_type,
'collected_data' => $collected_data,
)
);
} catch ( \Exception $e ) {
// Gracefully handle errors - fraud protection should never break functionality.
FraudProtectionController::log(
'error',
sprintf(
'Failed to track fraud protection event: %s | Error: %s',
$event_type,
$e->getMessage()
),
array(
'event_type' => $event_type,
'exception' => $e,
)
);
}
}
}
PK [1]U FraudProtection/ApiClient.phpnu
*/
public const VALID_DECISIONS = array(
self::DECISION_ALLOW,
self::DECISION_BLOCK,
);
/**
* Send a fraud protection event and get a decision from WPCOM endpoint.
*
* Implements fail-open pattern: if the endpoint is unreachable or times out,
* returns "allow" decision and logs the error.
*
* @since 10.5.0
*
* @param string $event_type Type of event being sent (e.g., 'cart_updated', 'checkout_started').
* @param array $event_data Event data to send to the endpoint.
* @return string Decision: "allow" or "block".
*/
public function send_event( string $event_type, array $event_data ): string {
$payload = array_merge(
array( 'event_type' => $event_type ),
array_filter( $event_data, fn( $value ) => null !== $value )
);
FraudProtectionController::log(
'info',
sprintf( 'Sending fraud protection event: %s', $event_type ),
array( 'payload' => $payload )
);
$response = $this->make_request( 'POST', self::EVENTS_ENDPOINT, $payload );
if ( is_wp_error( $response ) ) {
$error_data = $response->get_error_data() ?? array();
$error_data = is_array( $error_data ) ? $error_data : array( 'error' => $error_data );
FraudProtectionController::log(
'error',
sprintf(
'Event track request failed: %s. Failing open with "allow" decision.',
$response->get_error_message()
),
$error_data
);
return self::DECISION_ALLOW;
}
if ( ! isset( $response['decision'] ) ) {
FraudProtectionController::log(
'error',
'Response missing "decision" field. Failing open with "allow" decision.',
array( 'response' => $response )
);
return self::DECISION_ALLOW;
}
$decision = $response['decision'];
if ( ! in_array( $decision, self::VALID_DECISIONS, true ) ) {
FraudProtectionController::log(
'error',
sprintf(
'Invalid decision value "%s". Failing open with "allow" decision.',
$decision
),
array( 'response' => $response )
);
return self::DECISION_ALLOW;
}
$session = is_array( $event_data['session'] ?? null ) ? $event_data['session'] : array();
$session_id = $session['session_id'] ?? 'unknown';
FraudProtectionController::log(
'info',
sprintf(
'Fraud decision received: %s | Event: %s | Session: %s',
$decision,
$event_type,
$session_id
),
array( 'response' => $response )
);
return $decision;
}
/**
* Make an HTTP request to a WPCOM endpoint via Jetpack Connection.
*
* @param string $method HTTP method (GET, POST, etc.).
* @param string $path Endpoint path (relative to sites/{blog_id}/).
* @param array $payload Request payload.
* @return array|\WP_Error Parsed JSON response or WP_Error on failure.
*/
private function make_request( string $method, string $path, array $payload ) {
if ( ! class_exists( Jetpack_Connection_Client::class ) ) {
return new \WP_Error(
'jetpack_not_available',
'Jetpack Connection is not available'
);
}
$blog_id = $this->get_blog_id();
if ( ! $blog_id ) {
return new \WP_Error(
'no_blog_id',
'Jetpack blog ID not found. Is the site connected to WordPress.com?'
);
}
$full_path = sprintf( 'sites/%d/%s', $blog_id, $path );
$body = \wp_json_encode( $payload );
if ( false === $body ) {
return new \WP_Error(
'json_encode_error',
'Failed to encode payload',
array( 'payload' => $payload )
);
}
$response = Jetpack_Connection_Client::wpcom_json_api_request_as_blog(
$full_path,
self::WPCOM_API_VERSION,
array(
'headers' => array( 'Content-Type' => 'application/json' ),
'method' => $method,
'timeout' => self::DEFAULT_TIMEOUT,
),
$body,
'wpcom'
);
if ( is_wp_error( $response ) ) {
return $response;
}
/**
* Type assertion for PHPStan - Jetpack returns array on success.
*
* @var array $response
*/
$response_code = wp_remote_retrieve_response_code( $response );
$response_body = wp_remote_retrieve_body( $response );
$data = json_decode( $response_body, true );
if ( $response_code >= 300 ) {
return new \WP_Error(
'api_error',
sprintf( 'Endpoint %s returned status code %d', "$method $path", $response_code ),
array( 'response' => JSON_ERROR_NONE === json_last_error() ? $data : $response_body )
);
}
if ( JSON_ERROR_NONE !== json_last_error() || ! is_array( $data ) ) {
return new \WP_Error(
'json_decode_error',
sprintf( 'Failed to decode JSON response: %s', json_last_error_msg() ),
array( 'response' => $response_body )
);
}
return $data;
}
/**
* Get the Jetpack blog ID.
*
* @return int|false Blog ID or false if not available.
*/
private function get_blog_id() {
if ( ! class_exists( \Jetpack_Options::class ) ) {
return false;
}
return \Jetpack_Options::get_option( 'id' );
}
}
PK [1] B7 - FraudProtection/FraudProtectionController.phpnu features_controller = $features_controller;
$this->connection_manager = $connection_manager;
$this->blocked_session_notice = $blocked_session_notice;
}
/**
* Hook into WordPress on init.
*
* @internal
*/
public function on_init(): void {
// Bail if the feature is not enabled.
if ( ! $this->feature_is_enabled() ) {
return;
}
$this->blocked_session_notice->register();
}
/**
* Display admin notice when Jetpack connection is not available.
*
* @internal
*/
public function on_admin_notices(): void {
// Only show if feature is enabled.
if ( ! $this->feature_is_enabled() ) {
return;
}
// Only show on WooCommerce settings page.
$screen = get_current_screen();
if ( ! $screen || 'woocommerce_page_wc-settings' !== $screen->id ) {
return;
}
$connection_status = $this->connection_manager->get_connection_status();
if ( $connection_status['connected'] ) {
return;
}
$settings_url = admin_url( 'admin.php?page=wc-settings&tab=advanced§ion=features' );
?>
PK [1]Z2q q E StockNotifications/Admin/Templates/html-admin-notification-create.phpnu
PK [1]7$%( %( C StockNotifications/Admin/Templates/html-admin-notification-edit.phpnu
PK [1]Αv v ? StockNotifications/Admin/Templates/html-admin-notifications.phpnu
has_stock_notifications ) {
$table->views();
?>
PK [1]=F / StockNotifications/Enums/NotificationStatus.phpnu Notification statuses.
*/
public static function get_valid_statuses(): array {
return array(
self::PENDING,
self::ACTIVE,
self::SENT,
self::CANCELLED,
);
}
}
PK [1]Ͱ ; StockNotifications/Enums/NotificationCancellationSource.phpnu logger = \wc_get_logger();
$this->queue = \WC()->queue();
}
/**
* Schedule a job.
*
* @param int $product_id The product ID.
* @return bool True if the job was scheduled, false otherwise.
*/
public function schedule_initial_job_for_product( int $product_id ): bool {
$args = array( 'product_id' => $product_id );
try {
if ( $this->queue->get_next( self::AS_JOB_SEND_STOCK_NOTIFICATIONS, $args, self::AS_JOB_GROUP ) ) {
return false;
}
/**
* Filter: woocommerce_customer_stock_notifications_first_batch_delay
*
* @since 10.2.0
*
* Schedule the first batch with a delay to prevent overwhelming the system.
*
* @param int $delay Delay time in seconds before first batch.
* @param int $product_id Product ID being scheduled.
*/
$delay = (int) apply_filters( 'woocommerce_customer_stock_notifications_first_batch_delay', MINUTE_IN_SECONDS, $product_id );
$delay = max( 0, $delay );
$action_id = $this->queue->schedule_single(
time() + $delay,
self::AS_JOB_SEND_STOCK_NOTIFICATIONS,
$args,
self::AS_JOB_GROUP
);
if ( ! $action_id ) {
return false;
}
$this->logger->info(
sprintf( 'Scheduled stock notification for product %d', $product_id ),
array( 'source' => 'wc-customer-stock-notifications' )
);
return true;
} catch ( Exception $e ) {
$this->logger->error(
sprintf( 'Failed to schedule stock notification for product %d: %s', $product_id, $e->getMessage() ),
array( 'source' => 'wc-customer-stock-notifications' )
);
return false;
}
}
/**
* Schedule the next batch for a product.
*
* @param int $product_id The product ID.
* @return bool
*/
public function schedule_next_batch_for_product( int $product_id ): bool {
$args = array( 'product_id' => $product_id );
if ( $this->queue->get_next( self::AS_JOB_SEND_STOCK_NOTIFICATIONS, $args, self::AS_JOB_GROUP ) ) {
return false;
}
/**
* Filter: woocommerce_customer_stock_notifications_next_batch_delay
*
* @since 10.2.0
*
* @param int $delay Delay time in seconds before next batch.
* @param int $product_id Product ID being scheduled.
*/
$delay = (int) apply_filters( 'woocommerce_customer_stock_notifications_next_batch_delay', 0, $product_id );
$delay = max( 0, $delay );
if ( 0 === $delay ) {
$action_id = $this->queue->add(
self::AS_JOB_SEND_STOCK_NOTIFICATIONS,
$args,
self::AS_JOB_GROUP
);
} else {
$action_id = $this->queue->schedule_single(
time() + $delay,
self::AS_JOB_SEND_STOCK_NOTIFICATIONS,
$args,
self::AS_JOB_GROUP
);
}
return ! empty( $action_id );
}
}
PK [1] 3 StockNotifications/AsyncTasks/CycleStateService.phpnu logger = \wc_get_logger();
}
/**
* Parse the cycle state for a product.
*
* @param int $product_id The product ID.
* @return array
* @throws \Exception If the cycle state is invalid.
*/
public function get_or_initialize_cycle_state( int $product_id ): array {
if ( $product_id <= 0 ) {
throw new \Exception( 'Product ID is required.' );
}
$default_state = array(
'cycle_start_time' => time(),
'product_ids' => array( $product_id ),
'total_count' => 0,
'skipped_count' => 0,
'sent_count' => 0,
'failed_count' => 0,
'duration' => 0,
);
$cycle_state = $this->get_raw_cycle_state( $product_id );
if ( empty( $cycle_state ) ) {
return $default_state;
}
if ( array_diff_key( $default_state, $cycle_state ) || empty( $cycle_state['cycle_start_time'] ) || ! is_numeric( $cycle_state['cycle_start_time'] ) ) {
throw new \Exception( 'Invalid cycle state.' );
}
$cycle_state = wp_parse_args( $cycle_state, $default_state );
return $cycle_state;
}
/**
* Get the raw cycle state.
*
* @param int $product_id The product ID.
* @return array
*/
private function get_raw_cycle_state( int $product_id ): array {
$cycle_state = get_option( $this->get_option_name( $product_id ), false );
if ( ! is_array( $cycle_state ) ) {
return array();
}
return $cycle_state;
}
/**
* Complete the cycle.
*
* @param int|string $product_id The product ID.
* @param array $cycle_state The cycle state.
* @return void
*/
public function complete_cycle( int $product_id, array $cycle_state ): void {
$cycle_state['duration'] = time() - $cycle_state['cycle_start_time'];
$this->logger->info(
sprintf( 'Completed cycle for product %d. Sent: %d, Skipped: %d, Failed: %d, Duration: %d seconds. Total notifications processed: %d', $product_id, $cycle_state['sent_count'], $cycle_state['skipped_count'], $cycle_state['failed_count'], $cycle_state['duration'], $cycle_state['total_count'] ),
array( 'source' => 'wc-customer-stock-notifications' )
);
$this->save_cycle_state( $product_id, array() );
}
/**
* Save the cycle state.
*
* @param int $product_id The product ID.
* @param array $cycle_state The cycle state.
* @return bool Whether the state was saved.
*/
public function save_cycle_state( int $product_id, array $cycle_state ): bool {
if ( $product_id <= 0 ) {
return false;
}
$current_cycle_state = $this->get_raw_cycle_state( $product_id );
if ( $current_cycle_state === $cycle_state ) {
return false;
}
if ( empty( $cycle_state ) ) {
$result = delete_option( $this->get_option_name( $product_id ) );
} else {
$result = update_option( $this->get_option_name( $product_id ), $cycle_state, false );
}
if ( ! $result ) {
$this->logger->error( sprintf( 'Failed to save cycle state for product %d. Cycle state: %s', $product_id, wc_print_r( $cycle_state, true ) ), array( 'source' => 'wc-customer-stock-notifications' ) );
}
return $result;
}
/**
* Get the option name.
*
* @param int $product_id The product ID.
* @return string
*/
private function get_option_name( int $product_id ): string {
if ( $product_id <= 0 ) {
return '';
}
return self::STATE_OPTION_PREFIX . $product_id;
}
}
PK [1]?^f 8 StockNotifications/AsyncTasks/NotificationsProcessor.phpnu eligibility_service = $eligibility_service;
$this->job_manager = $job_manager;
$this->cycle_state_service = $cycle_state_service;
$this->email_manager = $email_manager;
}
/**
* Constructor.
*/
public function __construct() {
$this->logger = \wc_get_logger();
add_action( JobManager::AS_JOB_SEND_STOCK_NOTIFICATIONS, array( $this, 'process_batch' ) );
}
/**
* Get the batch size for processing notifications.
*
* @return int
*/
private function get_batch_size(): int {
/**
* Filter: woocommerce_customer_stock_notifications_batch_size
*
* @since 10.2.0
*
* Allow customization of batch size for processing notifications.
*
* @param int $batch_size Default batch size.
* @return int
*/
return (int) apply_filters( 'woocommerce_customer_stock_notifications_batch_size', self::BATCH_SIZE );
}
/**
* Parse the product ID from the arguments.
*
* @param int $product_id The product ID.
* @return int
* @throws \Exception If the product is not found.
*/
private function parse_args( $product_id ): int {
if ( empty( $product_id ) || ! is_numeric( $product_id ) ) {
throw new \Exception( 'Invalid arguments.' );
}
$product_id = (int) $product_id;
if ( $product_id <= 0 ) {
throw new \Exception( 'Product ID is required.' );
}
return $product_id;
}
/**
* Parse the product.
*
* @param int $product_id The product ID.
* @return \WC_Product
* @throws \Exception If the product is not valid for notifications.
*/
private function parse_product( int $product_id ): WC_Product {
$product = wc_get_product( $product_id );
if ( ! $product instanceof WC_Product ) {
throw new \Exception( sprintf( 'Product %d not found.', absint( $product_id ) ) );
}
if ( ! $this->eligibility_service->is_product_eligible( $product ) ) {
throw new \Exception( sprintf( 'Product %d is not eligible for notifications.', $product->get_id() ) ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
if ( ! $this->eligibility_service->is_stock_status_eligible( $product->get_stock_status() ) ) {
throw new \Exception( sprintf( 'Product %d stock status is not eligible for notifications (i.e. not in stock).', $product->get_id() ) ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
return $product;
}
/**
* Process a batch of notifications.
*
* @param int $product_id The product ID from AS job args.
* @return void
*/
public function process_batch( $product_id ) {
// Sanity checks.
try {
$product_id = $this->parse_args( $product_id );
$cycle_state = $this->cycle_state_service->get_or_initialize_cycle_state( $product_id );
$product = $this->parse_product( $product_id );
} catch ( \Throwable $e ) {
$product_id = (int) $product_id ?? 0;
$this->logger->error(
sprintf( 'Background process for product %s terminated. Reason: %s', $product_id, $e->getMessage() ),
array(
'source' => 'wc-customer-stock-notifications',
'product_id' => $product_id,
'exception' => get_class( $e ),
)
);
// Clean up the cycle state.
if ( isset( $cycle_state ) ) {
$this->cycle_state_service->complete_cycle( $product_id, $cycle_state );
}
return;
}
$cycle_state['product_ids'] = $this->eligibility_service->get_target_product_ids( $product );
// Get notifications.
$notifications = NotificationQuery::get_notifications(
array(
'status' => NotificationStatus::ACTIVE,
'product_id' => $cycle_state['product_ids'],
'last_attempt_limit' => (int) $cycle_state['cycle_start_time'],
'return' => 'ids',
'limit' => $this->get_batch_size(),
'orderby' => 'id',
'order' => 'ASC',
)
);
if ( empty( $notifications ) ) {
$this->cycle_state_service->complete_cycle( $product_id, $cycle_state );
return;
}
foreach ( $notifications as $notification_id ) {
$notification = Factory::get_notification( $notification_id );
if ( ! $notification instanceof Notification ) {
$this->logger->error(
sprintf( 'Failed to get notification ID: %d', $notification_id ),
array( 'source' => 'wc-customer-stock-notifications' )
);
continue;
}
$notification->set_date_last_attempt( time() );
++$cycle_state['total_count'];
if ( $this->eligibility_service->should_skip_notification( $notification, $product ) ) {
++$cycle_state['skipped_count'];
$notification->save();
continue;
}
$is_sent = true;
try {
$this->email_manager->send_stock_notification_email( $notification );
} catch ( \Throwable $e ) {
$is_sent = false;
}
if ( $is_sent ) {
$notification->set_date_notified( time() );
$notification->set_status( NotificationStatus::SENT );
++$cycle_state['sent_count'];
} else {
$notification->set_status( NotificationStatus::CANCELLED );
$notification->set_cancellation_source( NotificationCancellationSource::SYSTEM );
++$cycle_state['failed_count'];
}
// Always save the notification to reflect last attempt time.
$notification->save();
}
if ( count( $notifications ) === $this->get_batch_size() ) {
$this->cycle_state_service->save_cycle_state( $product_id, $cycle_state );
$this->job_manager->schedule_next_batch_for_product( $product_id );
return;
}
$this->cycle_state_service->complete_cycle( $product_id, $cycle_state );
}
}
PK [1]ڻB4 4 # StockNotifications/Notification.phpnu NotificationStatus::PENDING,
'product_id' => 0,
'user_id' => 0,
'user_email' => '',
'date_created' => null,
'date_confirmed' => null,
'date_modified' => null,
'date_notified' => null,
'date_last_attempt' => null,
'date_cancelled' => null,
'cancellation_source' => null,
);
/**
* Constructor.
*
* @param int|object|array $read ID to load from the DB (optional) or already queried data.
*/
public function __construct( $read = 0 ) {
parent::__construct( $read );
if ( is_numeric( $read ) && $read > 0 ) {
$this->set_id( $read );
} elseif ( $read instanceof self ) {
$this->set_id( $read->get_id() );
} elseif ( ! empty( $read->ID ) ) {
$this->set_id( absint( $read->ID ) );
} elseif ( is_array( $read ) && ! empty( $read['id'] ) ) {
$this->set_props( $read );
$this->set_object_read( true );
} else {
$this->set_object_read( true );
}
$this->data_store = \WC_Data_Store::load( 'stock_notification' );
if ( $this->get_id() > 0 ) {
$this->data_store->read( $this );
}
}
/**
* Get the product ID.
*
* @param string $context Context.
* @return int
*/
public function get_product_id( $context = 'view' ) {
return $this->get_prop( 'product_id', $context );
}
/**
* Get the user ID.
*
* @param string $context Context.
* @return int
*/
public function get_user_id( $context = 'view' ) {
return $this->get_prop( 'user_id', $context );
}
/**
* Get the user email.
*
* @param string $context Context.
* @return string
*/
public function get_user_email( $context = 'view' ) {
return $this->get_prop( 'user_email', $context );
}
/**
* Get the status.
*
* @param string $context Context.
* @return string
*/
public function get_status( $context = 'view' ) {
return $this->get_prop( 'status', $context );
}
/**
* Get the date created.
*
* @param string $context Context.
* @return \WC_DateTime|null Datetime object if the date is set or null if there is no date.
*/
public function get_date_created( $context = 'view' ) {
return $this->get_prop( 'date_created', $context );
}
/**
* Get the date modified.
*
* @param string $context Context.
* @return \WC_DateTime|null Datetime object if the date is set or null if there is no date.
*/
public function get_date_modified( $context = 'view' ) {
return $this->get_prop( 'date_modified', $context );
}
/**
* Get the date confirmed.
*
* @param string $context Context.
* @return \WC_DateTime|null Datetime object if the date is set or null if there is no date.
*/
public function get_date_confirmed( $context = 'view' ) {
return $this->get_prop( 'date_confirmed', $context );
}
/**
* Get the date last attempt.
*
* @param string $context Context.
* @return \WC_DateTime|null Datetime object if the date is set or null if there is no date.
*/
public function get_date_last_attempt( $context = 'view' ) {
return $this->get_prop( 'date_last_attempt', $context );
}
/**
* Get the date notified.
*
* @param string $context Context.
* @return \WC_DateTime|null Datetime object if the date is set or null if there is no date.
*/
public function get_date_notified( $context = 'view' ) {
return $this->get_prop( 'date_notified', $context );
}
/**
* Get the date cancelled.
*
* @param string $context Context.
* @return \WC_DateTime|null Datetime object if the date is set or null if there is no date.
*/
public function get_date_cancelled( $context = 'view' ) {
return $this->get_prop( 'date_cancelled', $context );
}
/**
* Get the cancellation source.
*
* @param string $context Context.
* @return string|null The cancellation source or null if there is no source.
*/
public function get_cancellation_source( $context = 'view' ) {
return $this->get_prop( 'cancellation_source', $context );
}
/**
* Get the product.
*
* @return \WC_Product|false
*/
public function get_product() {
if ( ! empty( $this->product ) ) {
return $this->product;
}
$product = wc_get_product( $this->get_prop( 'product_id' ) );
if ( ! $product ) {
return false;
}
$this->product = $product;
return $product;
}
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
*/
/**
* Set the product ID.
*
* @param int $product_id Product ID.
*/
public function set_product_id( int $product_id ) {
// Reset runtime cache if the product ID has changed.
if ( is_a( $this->product, 'WC_Product' ) && $product_id !== $this->product->get_id() ) {
$this->product = null;
}
$this->set_prop( 'product_id', $product_id );
}
/**
* Set the user ID.
*
* @param int $user_id User ID.
*/
public function set_user_id( int $user_id ) {
$this->set_prop( 'user_id', $user_id );
}
/**
* Set the user email.
*
* @param string $user_email User email.
*/
public function set_user_email( string $user_email ) {
$this->set_prop( 'user_email', $user_email );
}
/**
* Set the status.
*
* @param string $status Status.
*/
public function set_status( string $status ) {
if ( ! in_array( $status, NotificationStatus::get_valid_statuses(), true ) ) {
// Default to pending.
$status = NotificationStatus::PENDING;
}
$this->set_prop( 'status', $status );
}
/**
* Set the date created.
*
* @param string|int $date_created Date created.
*/
public function set_date_created( $date_created ) {
$this->set_date_prop( 'date_created', $date_created );
}
/**
* Set the date modified.
*
* @param string|int $date_modified Date modified.
*/
public function set_date_modified( $date_modified ) {
$this->set_date_prop( 'date_modified', $date_modified );
}
/**
* Set the date confirmed.
*
* @param string|int $date_confirmed Date confirmed.
*/
public function set_date_confirmed( $date_confirmed ) {
$this->set_date_prop( 'date_confirmed', $date_confirmed );
}
/**
* Set the date last attempt.
*
* @param string|int $date_last_attempt Date last attempt.
*/
public function set_date_last_attempt( $date_last_attempt ) {
$this->set_date_prop( 'date_last_attempt', $date_last_attempt );
}
/**
* Set the date notified.
*
* @param string|int $date_notified Date notified.
*/
public function set_date_notified( $date_notified ) {
$this->set_date_prop( 'date_notified', $date_notified );
}
/**
* Set the date cancelled.
*
* @param string|int $date_cancelled Date cancelled.
*/
public function set_date_cancelled( $date_cancelled ) {
$this->set_date_prop( 'date_cancelled', $date_cancelled );
}
/**
* Set the cancellation source.
*
* @param string|null $cancellation_source Cancellation source. Can be null.
*/
public function set_cancellation_source( ?string $cancellation_source ) {
if ( $cancellation_source && ! in_array( $cancellation_source, NotificationCancellationSource::get_valid_cancellation_sources(), true ) ) {
// Default to user.
$cancellation_source = NotificationCancellationSource::USER;
}
$this->set_prop( 'cancellation_source', $cancellation_source );
}
/*
|--------------------------------------------------------------------------
| Other Methods
|--------------------------------------------------------------------------
*/
/**
* Validate the data.
*
* @throws \WC_Data_Exception If the data is invalid.
*/
protected function validate_props() {
if ( empty( $this->get_prop( 'product_id' ) ) ) {
$this->error( 'stock_notification_product_id_required', __( 'Product ID is required.', 'woocommerce' ) );
}
if ( empty( $this->get_prop( 'user_id' ) ) && empty( $this->get_prop( 'user_email' ) ) ) {
$this->error( 'stock_notification_user_id_or_user_email_required', __( 'User ID or User Email is required.', 'woocommerce' ) );
}
if ( ! empty( $this->get_prop( 'user_email' ) ) && ! filter_var( $this->get_prop( 'user_email' ), FILTER_VALIDATE_EMAIL ) ) {
$this->error( 'stock_notification_user_email_invalid', __( 'User Email is invalid.', 'woocommerce' ) );
}
}
/**
* Save the notification.
*
* @return int|\WP_Error The notification ID or a WP_Error if the save failed.
*/
public function save() {
if ( ! $this->data_store ) {
return $this->get_id();
}
try {
$this->validate_props();
} catch ( \WC_Data_Exception $e ) {
return new \WP_Error( 'stock_notification_validation_error', $e->getMessage() );
}
if ( $this->get_id() ) {
$this->data_store->update( $this );
} else {
$this->data_store->create( $this );
}
return $this->get_id();
}
/**
* Retrieves the formatted attributes of the product based on the notification's posted attributes.
*
* Wrapper of the `wc_get_formatted_variation` function.
*
* @param bool $flat Flatten the list.
* @return string
*/
public function get_product_formatted_variation_list( bool $flat = false ) {
$product = $this->get_product();
if ( ! $product || ! $product->is_type( array( 'variation' ) ) ) {
return '';
}
// Replace list with custom data.
$attributes = $this->get_meta( 'posted_attributes' );
if ( ! $attributes ) {
$attributes = $product->get_attributes();
}
if ( empty( $attributes ) ) {
return '';
}
$attrs = array();
foreach ( $attributes as $key => $value ) {
if ( 0 === strpos( $key, 'attribute_pa_' ) ) {
$attrs[ str_replace( 'attribute_', '', $key ) ] = $value;
} else {
// By pass converting global product attributes.
$attrs[ wc_attribute_label( str_replace( 'attribute_', '', $key ), $product ) ] = $value;
}
}
$formatted_variation_list = wc_get_formatted_variation( $attrs, $flat, true, true );
return $formatted_variation_list;
}
/**
* Get product link.
*
* @return string
*/
public function get_product_permalink() {
$product = $this->get_product();
if ( ! $product ) {
return '';
}
if ( $product->is_type( 'variation' ) && ! empty( $this->get_meta( 'posted_attributes' ) ) ) {
return $product->get_permalink( array( 'item_meta_array' => $this->get_meta( 'posted_attributes' ) ) );
} else {
return $product->get_permalink();
}
}
/**
* Get product name.
*
* @return string
*/
public function get_product_name() {
$product = $this->get_product();
if ( ! $product ) {
return '';
}
return $product->get_parent_id() ? $product->get_name() : $product->get_title();
}
/**
* Check if the given key is a valid verification key.
*
* This method checks if the key is valid by verifying the hash and checking the expiration time.
*
* @param string $key The key to check.
* @return bool True if the key is valid, false otherwise.
*/
public function check_verification_key( string $key ): bool {
$action_key = $this->get_meta( 'email_link_action_key' );
if ( ! str_contains( $action_key, ':' ) ) {
return false;
}
list( $timestamp, $hash ) = explode( ':', $action_key, 2 );
$threshold = Config::get_verification_expiration_time_threshold();
if ( time() - (int) $timestamp > $threshold ) {
return false;
}
return HasherHelper::wp_verify_fast_hash( $key, $hash );
}
/**
* Maybe setup verification data for the notification.
*
* This is used to ensure that the notification has valid verification data.
*
* @param bool $persist If true, save the changes to the database.
* @return string The generated verification key.
*/
public function get_verification_key( bool $persist ): string {
$key = wp_generate_password( 20, false );
$this->update_meta_data( 'email_link_action_key', time() . ':' . HasherHelper::wp_fast_hash( $key ) );
if ( $persist ) {
$this->save();
}
return $key;
}
/**
* Check if the given key is a valid unsubscribe key.
*
* @param string $key The key to check.
* @return bool True if the key is valid, false otherwise.
*/
public function check_unsubscribe_key( string $key ): bool {
return HasherHelper::wp_verify_fast_hash( $key, $this->get_meta( 'email_link_action_key' ) );
}
/**
* Maybe setup verification data for the notification.
*
* This is used to ensure that the notification has valid verification data.
*
* @param bool $persist If true, save the changes to the database.
* @return string The generated unsubscribe key.
*/
public function get_unsubscribe_key( bool $persist ): string {
$key = wp_generate_password( 20, false );
$hash = HasherHelper::wp_fast_hash( $key );
$this->update_meta_data( 'email_link_action_key', $hash );
if ( $persist ) {
$this->save();
}
return $key;
}
}
PK [1]YC ( StockNotifications/NotificationQuery.phpnu query( $args );
}
/**
* Check if a product has active notifications.
*
* @param array $product_ids The product IDs to check.
* @return bool True if the product has active notifications, false otherwise.
*/
public static function product_has_active_notifications( array $product_ids ): bool {
return \WC_Data_Store::load( 'stock_notification' )->product_has_active_notifications( $product_ids );
}
/**
* Check if a notification exists by email.
*
* @param int $product_id The product ID.
* @param string $email The email address.
* @return bool True if the notification exists, false otherwise.
*/
public static function notification_exists_by_email( int $product_id, string $email ): bool {
return \WC_Data_Store::load( 'stock_notification' )->notification_exists_by_email( $product_id, $email );
}
/**
* Get a notification by user ID.
*
* @param int $product_id The product ID.
* @param int $user_id The user ID.
* @return bool True if the notification exists, false otherwise.
*/
public static function notification_exists_by_user_id( int $product_id, int $user_id ): bool {
return \WC_Data_Store::load( 'stock_notification' )->notification_exists_by_user_id( $product_id, $user_id );
}
}
PK [1]ar StockNotifications/Factory.phpnu set_name( __( 'Dummy Product', 'woocommerce' ) );
$product->set_price( 25 );
$product->set_image_id( get_option( 'woocommerce_placeholder_image', 0 ) );
// Set required notification data.
$notification->set_product_id( $product->get_id() );
$notification->set_user_email( 'preview@example.com' );
// Store the dummy product in the notification object for preview.
$notification->product = $product;
return $notification;
}
}
PK [1]=qf 6 StockNotifications/Frontend/ProductPageIntegration.phpnu
*/
private array $rendered = array();
/**
* The eligibility service instance.
*
* @var EligibilityService
*/
private EligibilityService $eligibility_service;
/**
* The signup service instance.
*
* @var SignupService
*/
private SignupService $signup_service;
/**
* Init.
*
* @internal
*
* @param EligibilityService $eligibility_service The eligibility service instance.
* @param SignupService $signup_service The signup service instance.
*/
final public function init( EligibilityService $eligibility_service, SignupService $signup_service ): void {
$this->eligibility_service = $eligibility_service;
$this->signup_service = $signup_service;
}
/**
* Constructor.
*/
public function __construct() {
add_action( 'woocommerce_simple_add_to_cart', array( $this, 'maybe_render_form' ), 30 );
add_action( 'woocommerce_after_add_to_cart_form', array( $this, 'maybe_render_form' ), 30 );
}
/**
* Handle BIS form.
*
* @return void
*/
public function maybe_render_form() {
if ( ! Config::allows_signups() ) {
return;
}
global $product;
if ( ! is_product() || ! is_a( $product, 'WC_Product' ) ) {
return;
}
if ( isset( $this->rendered[ $product->get_id() ] ) ) {
return;
}
$this->rendered[ $product->get_id() ] = true;
$is_variable = $product->is_type( 'variable' );
// Check if the product is in stock.
// Hint: This is negative logic. If the product is eligible for notifications, skip rendering.
// We avoid checking for variable products here because we want to render the form for out of stock variations.
if ( ! $is_variable && $this->eligibility_service->is_stock_status_eligible( $product->get_stock_status() ) ) {
return;
}
if ( ! $this->eligibility_service->is_product_eligible( $product ) ) {
return;
}
if ( ! $this->eligibility_service->product_allows_signups( $product ) ) {
return;
}
// Enqueue the script.
wp_enqueue_script( 'wc-back-in-stock-form' );
$this->render_form( $product );
}
/**
* Render the form.
*
* @param WC_Product $product Product object.
* @return void
*/
private function render_form( WC_Product $product ): void {
// Check if requires account.
if ( Config::requires_account() && ! is_user_logged_in() ) {
$this->display_account_required( $product );
return;
}
// Check if already signed up.
if ( $this->is_personalization_enabled() && is_user_logged_in() ) {
$user = \get_user_by( 'id', \get_current_user_id() );
$notification = $this->signup_service->is_already_signed_up( $product->get_id(), $user->ID, $user->user_email );
if ( $notification instanceof Notification ) {
$this->display_already_signed_up( $product, $notification );
return;
}
}
$this->display_form( $product );
}
/**
* Display the account required message.
*
* @param WC_Product $product Product object.
* @return void
*/
public function display_account_required( WC_Product $product ): void {
/**
* Filter the account required message HTML.
*
* @since 10.2.0
*
* @param string|null $pre The message.
* @param WC_Product $product Product object.
* @return string|null The message.
*/
$pre = apply_filters( 'woocommerce_customer_stock_notifications_account_required_message_html', null, $product );
if ( ! is_null( $pre ) ) {
echo wp_kses_post( $pre );
return;
}
$text = __( 'Please {login_link} to sign up for stock notifications.', 'woocommerce' );
$text = str_replace( '{login_link}', '' . _x( 'log in', 'back in stock form', 'woocommerce' ) . '', $text );
wc_print_notice( $text, 'notice' );
}
/**
* Display the already signed up message.
*
* @param WC_Product $product Product object.
* @param Notification $notification Notification object.
* @return void
*/
public function display_already_signed_up( WC_Product $product, Notification $notification ): void {
/**
* Filter the already signed up message HTML.
*
* @since 10.2.0
*
* @param string|null $pre The message.
* @param WC_Product $product Product object.
* @param Notification $notification Notification object.
* @return string|null The message.
*/
$pre = apply_filters( 'woocommerce_customer_stock_notifications_already_signed_up_message_html', null, $product, $notification );
if ( ! is_null( $pre ) ) {
echo wp_kses_post( $pre );
return;
}
$text = __( 'You have already joined the waitlist! Click {manage_account_link} to manage your notifications.', 'woocommerce' );
$text = str_replace( '{manage_account_link}', '' . _x( 'here', 'back in stock form', 'woocommerce' ) . '', $text );
wc_print_notice( $text, 'notice' );
}
/**
* Display the form.
*
* @param WC_Product $product Product object.
* @return void
*/
public function display_form( WC_Product $product ): void {
$button_class = implode(
' ',
array_filter(
array(
'button',
\wc_wp_theme_get_element_class_name( 'button' ),
'wc_bis_form__button',
)
)
);
// When a variable has no purchasable variations, allow for signups on the parent product.
$is_visible = ! $product->is_type( 'variable' ) || ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) && ! $product->has_purchasable_variations() );
wc_get_template(
'single-product/back-in-stock-form.php',
array(
'product_id' => $product->get_parent_id() ? $product->get_parent_id() : $product->get_id(),
'show_checkbox' => ! is_user_logged_in() && Config::creates_account_on_signup() && ! Config::requires_account(),
'show_email_field' => ! is_user_logged_in() && ! Config::requires_account(),
'button_class' => $button_class,
'is_visible' => $is_visible,
)
);
}
/**
* Whether personalization is enabled.
*
* Personalization includes checking if the user is already signed up and displaying the 'already signed up' message.
*
* @return bool True if personalization is enabled, false otherwise.
*/
public static function is_personalization_enabled(): bool {
/**
* Filter whether personalization is enabled while rendering the form.
*
* @since 10.2.0
*
* @param bool $enabled Whether personalization is enabled.
* @return bool
*/
return (bool) apply_filters( 'woocommerce_customer_stock_notifications_personalization_enabled', false );
}
}
PK [1]a^Y = StockNotifications/Frontend/NotificationManagementService.phpnu $notification->get_id(),
),
$notification->get_product_permalink()
);
return wp_nonce_url(
$url,
'wc_bis_resend_verification_email_nonce'
);
}
}
PK [1]TX' , StockNotifications/Frontend/SignupResult.phpnu code = $code;
$this->notification = $notification;
}
/**
* Get the signup code.
*
* @return string
*/
public function get_code(): string {
return $this->code;
}
/**
* Get the notification.
*
* @return Notification|null
*/
public function get_notification(): ?Notification {
return $this->notification;
}
}
PK [1]6[ [ 2 StockNotifications/Frontend/FormHandlerService.phpnu signup_service = $signup_service;
$this->logger = \wc_get_logger();
}
/**
* Constructor.
*/
public function __construct() {
add_action( 'template_redirect', array( $this, 'handle_signup' ) );
}
/**
* Handle the form submit event.
*/
public function handle_signup() {
// Sanity checks.
if ( ! Config::allows_signups() ) {
return;
}
if ( ! isset( $_POST['wc_bis_register'] ) ) { // phpcs:disable WordPress.Security.NonceVerification.Missing, WordPress.Security.NonceVerification.Recommended
return;
}
try {
if ( self::requires_nonce_check() ) {
if ( ! isset( $_POST['wc_bis_nonce'] ) || ! wp_verify_nonce( wp_unslash( $_POST['wc_bis_nonce'] ), 'wc_bis_signup' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
wc_add_notice( $this->signup_service->get_error_message( SignupService::ERROR_INVALID_REQUEST ), 'error' );
return;
}
}
$data = $this->signup_service->parse( $_POST );
if ( \is_wp_error( $data ) ) {
wc_add_notice( $this->signup_service->get_error_message( $data->get_error_code() ), 'error' );
return;
}
$result = $this->signup_service->signup(
$data['product_id'],
$data['user_id'],
$data['user_email'],
$data['posted_attributes'] ?? array()
);
if ( \is_wp_error( $result ) ) {
wc_add_notice( $this->signup_service->get_error_message( $result->get_error_code() ), 'error' );
return;
}
wc_add_notice( $this->signup_service->get_signup_user_message( $result->get_code(), $result->get_notification() ), 'success' );
} catch ( \Throwable $e ) {
wc_add_notice( $this->signup_service->get_error_message( SignupService::ERROR_FAILED ), 'error' );
$this->logger->error( $e->getMessage(), array( 'source' => 'stock-notifications-signup-errors' ) );
return;
}
}
/**
* Whether the form requires a nonce check.
*
* Note: Nonce checks may be disabled for guest signups to support HTML caching.
*
* @return bool True if the form requires a nonce check, false otherwise.
*/
public static function requires_nonce_check(): bool {
$requires_account = ProductPageIntegration::is_personalization_enabled() && ( Config::requires_account() || \is_user_logged_in() );
/**
* Filter to require nonce check.
*
* @since 10.2.0
*
* @param bool $requires_nonce_check Whether to require nonce check.
* @return bool
*/
return (bool) apply_filters( 'woocommerce_customer_stock_notifications_requires_nonce_check', $requires_account );
}
}
PK [1]] _G _G - StockNotifications/Frontend/SignupService.phpnu eligibility_service = $eligibility_service;
$this->notification_management_service = $notification_management_service;
}
/**
* Signup.
*
* @param int $product_id The product ID.
* @param int $user_id The user ID.
* @param string $user_email The user email.
* @param array $posted_attributes The posted attributes (Optional).
* @return SignupResult|\WP_Error The signup result.
*/
public function signup( int $product_id, int $user_id, string $user_email, array $posted_attributes = array() ) {
// Sanity checks.
if ( ! Config::allows_signups() ) {
return new \WP_Error( self::ERROR_FAILED );
}
if ( empty( $user_email ) && empty( $user_id ) ) {
return new \WP_Error( self::ERROR_INVALID_REQUEST );
}
$product = wc_get_product( $product_id );
if ( ! $product ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
if ( ! $this->eligibility_service->is_product_eligible( $product ) ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
if ( $this->eligibility_service->is_stock_status_eligible( $product->get_stock_status() ) ) {
return new \WP_Error( self::ERROR_INVALID_REQUEST );
}
if ( ! $this->eligibility_service->product_allows_signups( $product ) ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
$notification = $this->is_already_signed_up( $product_id, $user_id, $user_email, $posted_attributes );
if ( $notification instanceof Notification ) {
if ( NotificationStatus::ACTIVE === $notification->get_status() ) {
return new SignupResult( self::SIGNUP_ALREADY_JOINED, $notification );
}
if ( NotificationStatus::PENDING === $notification->get_status() ) {
if ( Config::requires_double_opt_in() ) {
return new SignupResult( self::SIGNUP_ALREADY_JOINED_DOUBLE_OPT_IN, $notification );
}
// If the notification is pending and double opt-in is not required, skip and activate the notification.
$notification->set_status( NotificationStatus::ACTIVE );
$notification->save();
/**
* Action: woocommerce_customer_stock_notifications_signup
*
* @since 10.2.0
*
* @param Notification $notification The notification.
*/
do_action( 'woocommerce_customer_stock_notifications_signup', $notification );
return new SignupResult( self::SIGNUP_SUCCESS, $notification );
}
}
$account_created = null;
if ( empty( $user_id ) && Config::creates_account_on_signup() ) {
$account_created = $this->create_customer( $user_email );
$user_id = $account_created ? $account_created : $user_id;
}
$notification = new Notification();
$notification->set_status( NotificationStatus::ACTIVE );
$notification->set_product_id( $product_id );
$notification->set_user_id( $user_id );
$notification->set_user_email( $user_email );
if ( ! empty( $posted_attributes ) ) {
$notification->update_meta_data( 'posted_attributes', $posted_attributes );
}
if ( Config::requires_double_opt_in() ) {
$notification->set_status( NotificationStatus::PENDING );
}
$saved = $notification->save();
if ( ! $saved ) {
return new \WP_Error( self::ERROR_FAILED );
}
/**
* Action: woocommerce_customer_stock_notifications_signup
*
* @since 10.2.0
*
* @param Notification $notification The notification.
*/
do_action( 'woocommerce_customer_stock_notifications_signup', $notification );
$signup_code = self::SIGNUP_SUCCESS;
if ( Config::requires_double_opt_in() ) {
$signup_code = $account_created
? self::SIGNUP_SUCCESS_ACCOUNT_CREATED_DOUBLE_OPT_IN
: self::SIGNUP_SUCCESS_DOUBLE_OPT_IN;
} elseif ( $account_created ) {
$signup_code = self::SIGNUP_SUCCESS_ACCOUNT_CREATED;
}
return new SignupResult( $signup_code, $notification );
}
/**
* Get the active notification for the request data.
*
* @param int $product_id The product ID.
* @param int $user_id The user ID.
* @param string $user_email The user email.
* @param array $posted_attributes The posted attributes (Optional).
* @return Notification|null The notification, or null if it doesn't exist.
*/
public function is_already_signed_up( int $product_id, int $user_id, string $user_email, array $posted_attributes = array() ) {
if ( empty( $product_id ) ) {
return null;
}
if ( empty( $user_id ) && empty( $user_email ) ) {
return null;
}
$found = false;
if ( ! empty( $user_id ) ) {
$found = NotificationQuery::notification_exists_by_user_id( $product_id, $user_id );
} else {
$found = NotificationQuery::notification_exists_by_email( $product_id, $user_email );
}
if ( ! $found ) {
return null;
}
$query_args = array( 'product_id' => $product_id );
if ( ! empty( $user_id ) ) {
$query_args['user_id'] = $user_id;
} else {
$query_args['user_email'] = $user_email;
}
$query_args['return'] = 'ids';
$query_args['limit'] = 1;
if ( ! empty( $posted_attributes ) ) {
// Hint: We need to compare the posted attributes with the stored attributes to handle variations with "any" attributes.
$query_args['meta_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'key' => 'posted_attributes',
'value' => maybe_serialize( $posted_attributes ),
'compare' => '=',
),
);
}
$ids = NotificationQuery::get_notifications( $query_args );
if ( empty( $ids ) || ! is_numeric( $ids[0] ) ) {
return null;
}
$notification = Factory::get_notification( $ids[0] );
if ( ! $notification ) {
return null;
}
return $notification;
}
/**
* Create a new customer.
*
* @param string $user_email The user email.
* @return int|null The user ID if the customer was created, null otherwise.
*/
private function create_customer( string $user_email ) {
if ( empty( $user_email ) || ! is_email( $user_email ) ) {
return null;
}
try {
$username = wc_create_new_customer_username( $user_email );
$username = sanitize_user( $username );
if ( empty( $username ) || ! validate_username( $username ) ) {
return null;
}
$password = 'yes' === get_option( 'woocommerce_registration_generate_password' ) ? '' : wp_generate_password();
$user_id = wc_create_new_customer( $user_email, $username, $password );
if ( is_a( $user_id, 'WP_Error' ) ) {
return null;
}
} catch ( \Throwable $e ) {
return null;
}
return $user_id;
}
/**
* Parse the request data from a given source.
*
* @param array $source The source data, e.g. $_POST or $_REQUEST.
* @return array|\WP_Error {
* The parsed request data, or a WP_Error if the request data is invalid.
*
* @type int $product_id The product ID.
* @type int $user_id The user ID.
* @type string $user_email The user email.
* @type array $posted_attributes The posted attributes (Optional).
* }
*/
public function parse( array $source ) {
$parsed_data = $this->parse_user_data( $source );
if ( \is_wp_error( $parsed_data ) ) {
return $parsed_data;
}
$product = $this->parse_product( $source );
if ( \is_wp_error( $product ) ) {
return $product;
}
$parsed_data['product_id'] = $product->get_id();
if ( $product instanceof \WC_Product_Variation ) {
$posted_attributes = $this->parse_posted_attributes( $source, $product );
if ( ! empty( $posted_attributes ) ) {
$parsed_data['posted_attributes'] = $posted_attributes;
}
}
return $parsed_data;
}
/**
* Parse the user data from the source data.
*
* @param array $source The source data, e.g. $_POST or $_REQUEST.
* @return array|\WP_Error The parsed user data, or a WP_Error if the user data is invalid.
*/
private function parse_user_data( array $source ) {
$data = array();
$is_logged_in = \is_user_logged_in();
if ( ! $is_logged_in && Config::requires_account() ) {
return new \WP_Error( self::ERROR_REQUIRES_ACCOUNT );
}
// Check for valid privacy terms.
if ( ! $is_logged_in && Config::creates_account_on_signup() && ! Config::requires_account() ) {
$opt_in = isset( $source['wc_bis_opt_in'] ) ? wc_clean( wp_unslash( $source['wc_bis_opt_in'] ) ) : false;
if ( 'on' !== $opt_in ) {
return new \WP_Error( self::ERROR_INVALID_OPT_IN );
}
}
if ( ! $is_logged_in ) {
$email = isset( $source['wc_bis_email'] ) ? sanitize_email( wp_unslash( $source['wc_bis_email'] ) ) : false;
if ( ! $email ) {
return new \WP_Error( self::ERROR_INVALID_EMAIL );
}
if ( ! is_email( $email ) ) {
return new \WP_Error( self::ERROR_INVALID_EMAIL );
}
$data['user_id'] = 0;
$data['user_email'] = $email;
// Check if user exists with this email.
$user = get_user_by( 'email', $email );
if ( $user ) {
$data['user_id'] = $user->ID;
}
} else {
$user = wp_get_current_user();
if ( ! $user ) {
return new \WP_Error( self::ERROR_INVALID_USER );
}
$data['user_id'] = $user->ID;
$data['user_email'] = $user->user_email;
}
return $data;
}
/**
* Parse the product from the source data.
*
* @param array $source The source data, e.g. $_POST or $_REQUEST.
* @return \WC_Product|\WP_Error The product, or a WP_Error if the product is invalid.
*/
private function parse_product( array $source ) {
$product_id = isset( $source['wc_bis_product_id'] ) ? absint( wp_unslash( $source['wc_bis_product_id'] ) ) : false;
if ( ! $product_id ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
$product = wc_get_product( $product_id );
if ( ! $product instanceof \WC_Product ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
if ( ! $this->eligibility_service->is_product_eligible( $product ) ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
if ( ! $this->eligibility_service->product_allows_signups( $product ) ) {
return new \WP_Error( self::ERROR_INVALID_PRODUCT );
}
return $product;
}
/**
* Parse variation attributes from source data.
*
* This method extracts attributes that are defined as 'any' in the variation and need to be
* explicitly specified during signup. These attributes cannot be retrieved directly from the variation
* since they are not fixed values.
*
* For example, if a t-shirt variation has 'any' size but a specific color, we need to capture
* the chosen size from the form submission while the color comes from the variation itself.
*
* @see \WC_Cart::add_to_cart() for similar attribute parsing logic.
*
* @param array $source The source data, e.g. $_POST or $_REQUEST.
* @param \WC_Product $variation The variation.
* @return array The posted attributes.
*/
private function parse_posted_attributes( array $source, \WC_Product $variation ): array {
if ( ! $variation instanceof \WC_Product_Variation ) {
return array();
}
$product = wc_get_product( $variation->get_parent_id() );
if ( ! $product ) {
return array();
}
$posted_attributes = array();
foreach ( $product->get_attributes() as $attribute ) {
if ( ! $attribute['is_variation'] ) {
continue;
}
$attribute_key = 'attribute_' . sanitize_title( $attribute['name'] );
if ( isset( $source[ $attribute_key ] ) ) {
if ( $attribute['is_taxonomy'] ) {
$value = sanitize_title( wp_unslash( $source[ $attribute_key ] ) );
} else {
$value = html_entity_decode( wc_clean( wp_unslash( $source[ $attribute_key ] ) ), ENT_QUOTES, get_bloginfo( 'charset' ) );
}
// Don't include if it's empty.
if ( ! empty( $value ) || '0' === $value ) {
$posted_attributes[ $attribute_key ] = $value;
}
}
}
$variation_attributes = $variation->get_variation_attributes();
// Filter out 'any' variations, which are empty.
$variation_attributes = array_filter( $variation_attributes );
$diff = array_diff( $posted_attributes, $variation_attributes );
// Return the posted attributes only if a variation with `any` attribute is detected.
return ! empty( $diff ) ? $diff : array();
}
/**
* Get the error message for the error code.
*
* @param string $error_code The error code.
* @return string The error message.
*/
public function get_error_message( string $error_code ): string {
switch ( $error_code ) {
case self::ERROR_INVALID_PRODUCT:
return wp_kses_post( __( 'Invalid product.', 'woocommerce' ) );
case self::ERROR_INVALID_USER:
return wp_kses_post( __( 'Invalid user.', 'woocommerce' ) );
case self::ERROR_INVALID_EMAIL:
return wp_kses_post( __( 'Invalid email address.', 'woocommerce' ) );
case self::ERROR_INVALID_OPT_IN:
return wp_kses_post( __( 'To proceed, please consent to the creation of a new account with your e-mail.', 'woocommerce' ) );
case self::ERROR_RATE_LIMITED:
return wp_kses_post( __( 'You have already signed up too many times. Please try again later.', 'woocommerce' ) );
default:
return wp_kses_post( __( 'Failed to sign up. Please try again.', 'woocommerce' ) );
}
}
/**
* Get the signup user message for the signup code.
*
* @param string $signup_code The signup code.
* @param Notification $notification The notification.
* @return string The signup user message.
*/
public function get_signup_user_message( string $signup_code, Notification $notification ): string {
$message = '';
$has_action_button = false;
switch ( $signup_code ) {
case self::SIGNUP_SUCCESS:
/* translators: Product name */
$message = sprintf( esc_html__( 'You have successfully signed up! You will be notified when "%s" is back in stock.', 'woocommerce' ), $notification->get_product_name() );
break;
case self::SIGNUP_SUCCESS_DOUBLE_OPT_IN:
$message = esc_html__( 'Thanks for signing up! Please complete the sign-up process by following the verification link sent to your e-mail.', 'woocommerce' );
break;
case self::SIGNUP_SUCCESS_ACCOUNT_CREATED:
/* translators: Product name */
$message = sprintf( esc_html__( 'You have successfully signed up and will be notified when "%s" is back in stock! Note that a new account has been created for you; please check your e-mail for details.', 'woocommerce' ), $notification->get_product_name() );
break;
case self::SIGNUP_SUCCESS_ACCOUNT_CREATED_DOUBLE_OPT_IN:
$message = esc_html__( 'Thanks for signing up! An account has been created for you. Please complete the sign-up process by following the verification link sent to your e-mail.', 'woocommerce' );
break;
case self::SIGNUP_ALREADY_JOINED:
$message = esc_html__( 'You have already joined this waitlist.', 'woocommerce' );
break;
case self::SIGNUP_ALREADY_JOINED_DOUBLE_OPT_IN:
$notice_text = esc_html__( 'You have already joined this waitlist. Please complete the sign-up process by following the verification link sent to your e-mail.', 'woocommerce' );
$url = $this->notification_management_service->get_resend_verification_email_url( $notification );
$button_class = wc_wp_theme_get_element_class_name( 'button' );
$wp_button_class = $button_class ? ' ' . $button_class : '';
$message = sprintf(
'%s %s',
$url,
$wp_button_class,
esc_html_x( 'Resend verification', 'notice action', 'woocommerce' ),
$notice_text
);
$has_action_button = true;
break;
default:
$message = '';
break;
}
if ( is_user_logged_in() && ! $has_action_button ) {
$button_class = \wc_wp_theme_get_element_class_name( 'button' );
$wp_button_class = $button_class ? ' ' . $button_class : '';
$message = sprintf( '%s %s', \wc_get_account_endpoint_url( 'stock-notifications' ), $wp_button_class, esc_html_x( 'Manage notifications', 'notice action', 'woocommerce' ), $message );
}
return $message;
}
}
PK [1]CR ) StockNotifications/StockNotifications.phpnu get( DataRetentionController::class )->on_woo_install_or_update();
}
/**
* Register hooks and services.
*
* @internal
*/
public function init_hooks() {
add_filter( 'woocommerce_data_stores', array( $this, 'register_data_stores' ) );
$container = wc_get_container();
$container->get( EmailManager::class );
$container->get( StockSyncController::class );
$container->get( NotificationsProcessor::class );
$container->get( PrivacyEraser::class );
$container->get( DataRetentionController::class );
$container->get( EmailActionController::class );
$container->get( ProductPageIntegration::class );
$container->get( FormHandlerService::class );
if ( is_admin() ) {
$container->get( AdminManager::class );
}
}
/**
* Register the data stores.
*
* @param array $data_stores Data stores.
* @return array
*/
public function register_data_stores( $data_stores ) {
if ( ! is_array( $data_stores ) ) {
return $data_stores;
}
$data_stores['stock_notification'] = wc_get_container()->get( StockNotificationsDataStore::class );
return $data_stores;
}
}
PK [1]i/-b b . StockNotifications/DataRetentionController.phpnu schedule_or_unschedule_daily_task( null, Config::get_unverified_deletion_days_threshold() );
}
/**
* Responds to changes in the option for deleting unverified notifications.
* If the new value is numeric and greater than zero, it schedules a daily task.
* If the new value is not numeric or is empty, it clears the scheduled tasks.
*
* @param mixed $unused The old option value or option name (not used in this function).
* @param mixed $new_option_value The new value of the option.
* @return void
*/
public function schedule_or_unschedule_daily_task( $unused, $new_option_value ): void {
if ( ! is_numeric( $new_option_value ) || empty( $new_option_value ) ) {
$this->clear_daily_task();
return;
}
if ( ! wp_next_scheduled( self::DAILY_TASK_HOOK ) ) {
wp_schedule_event( time() + 10, 'daily', self::DAILY_TASK_HOOK );
}
}
/**
* Unschedule the daily task when the plugin is deactivated, or the option is set to zero.
*/
public function clear_daily_task() {
wp_clear_scheduled_hook( self::DAILY_TASK_HOOK );
}
/**
* Deletes overdue notifications based on the configured time threshold.
* It retrieves notifications that are pending and past the threshold,
* then deletes them.
*
* @return void
*/
public function do_wc_customer_stock_notifications_daily() {
$time_threshold = Config::get_unverified_deletion_days_threshold();
if ( 0 === $time_threshold ) {
return;
}
$overdue_threshold = time() - $time_threshold * DAY_IN_SECONDS;
$overdue_notifications = NotificationQuery::get_notifications(
array(
'status' => NotificationStatus::PENDING,
'end_date' => gmdate( 'Y-m-d H:i:s', $overdue_threshold ),
)
);
foreach ( $overdue_notifications as $notification_id ) {
$notification = Factory::get_notification( $notification_id );
$notification->delete();
}
}
}
PK [1]?Z` ` 3 StockNotifications/Utilities/EligibilityService.phpnu stock_management_helper = $stock_management_helper;
}
/**
* Validate product type and other basic criteria for notifications.
*
* @param WC_Product|null $product The product to check.
* @return bool True if the product is eligible for notifications, false otherwise.
*/
public function is_product_eligible( ?WC_Product $product ): bool {
if ( ! $product instanceof WC_Product ) {
return false;
}
if ( ! $product->is_type( Config::get_supported_product_types() ) ) {
return false;
}
// Check for invalid product statuses.
if ( in_array( $product->get_status(), array( ProductStatus::TRASH, ProductStatus::AUTO_DRAFT, ProductStatus::PENDING, ProductStatus::FUTURE ), true ) ) {
return false;
}
/**
* Filter: woocommerce_customer_stock_notifications_product_is_valid
* Allows custom validation for whether a product is generally eligible for notifications.
*
* @since 10.2.0
*
* @param bool $is_valid True if the product is valid for notifications, false otherwise.
* @param WC_Product $product The product to check.
* @return bool True if the product is valid for notifications, false otherwise.
*/
return (bool) apply_filters( 'woocommerce_customer_stock_notifications_product_is_valid', true, $product );
}
/**
* Check if a product allows signups.
*
* @param WC_Product $product The product to check.
* @return bool True if the product allows signups, false otherwise.
*/
public function product_allows_signups( WC_Product $product ): bool {
if ( $product->is_type( ProductType::VARIATION ) ) {
$parent_product = wc_get_product( $product->get_parent_id() );
if ( ! $parent_product instanceof WC_Product ) {
return false;
}
return $this->product_allows_signups( $parent_product );
}
return 'no' !== $product->get_meta( Config::get_product_signups_meta_key() );
}
/**
* Check if a stock status is eligible for notifications.
*
* @param string $stock_status The stock status to check.
* @return bool True if the stock status is eligible for notifications, false otherwise.
*/
public function is_stock_status_eligible( string $stock_status ): bool {
return in_array( $stock_status, Config::get_eligible_stock_statuses(), true );
}
/**
* Check if a product (or its relevant variations) has any active notifications.
*
* @param WC_Product $product The product to check.
* @return bool True if the product has active notifications, false otherwise.
*/
public function has_active_notifications( WC_Product $product ): bool {
$lookup_ids = $this->get_target_product_ids( $product );
if ( empty( $lookup_ids ) ) {
return false;
}
return NotificationQuery::product_has_active_notifications( $lookup_ids );
}
/**
* Get the product IDs that need to be checked for stock notifications.
*
* For simple products, this returns just the product ID. For variable products,
* it returns both the parent product ID and the IDs of all variations whose stock
* is managed by the parent product.
*
* This is used in two key scenarios:
* 1. Checking if a product has any active notifications
* 2. Determining which notifications need to be sent during a stock broadcast
*
* @since 10.2.0
*
* @param WC_Product $product The product to check.
* @return array Array of product IDs to check for notifications.
*/
public function get_target_product_ids( WC_Product $product ): array {
$lookup_ids = array( $product->get_id() );
if ( $product->is_type( ProductType::VARIABLE ) ) {
$children_ids = $this->stock_management_helper->get_managed_variations( $product );
$lookup_ids = array_merge( $lookup_ids, $children_ids );
}
return $lookup_ids;
}
/**
* Check if a notification is eligible for sending.
*
* @param Notification $notification The notification to check.
* @param WC_Product $product The product to check.
* @return bool True if the notification is eligible for sending, false otherwise.
*/
public function should_skip_notification( Notification $notification, WC_Product $product ): bool {
$is_throttled = $this->is_notification_throttled( $notification );
$is_product_published = in_array( $product->get_status(), Config::get_supported_product_statuses(), true );
$should_skip = $is_throttled || ! $is_product_published;
// Bypass for privileged users.
if ( $should_skip ) {
$user_id = $notification->get_user_id();
if ( $user_id ) {
$user = get_user_by( 'id', $user_id );
if ( $user && ( user_can( $user, 'manage_woocommerce' ) || user_can( $user, 'manage_options' ) ) ) {
$should_skip = false;
}
}
}
/**
* Filter: woocommerce_customer_stock_notification_should_skip_sending
*
* @since 10.2.0
*
* Prevent or manage sending a specific notification.
*
* @param bool $should_skip Whether to skip sending.
* @param int $notification_id The notification ID.
* @return bool
*/
return (bool) apply_filters( 'woocommerce_customer_stock_notification_should_skip_sending', $should_skip, $notification->get_id() );
}
/**
* Check if notification is throttled.
*
* @param Notification $notification The notification object.
* @return bool
*/
private function is_notification_throttled( Notification $notification ): bool {
/**
* Filter: woocommerce_customer_stock_notification_throttle_threshold
*
* @since 10.2.0
*
* @param int $threshold Throttle time in seconds should pass from the last notification delivery time.
*/
$threshold = (int) apply_filters( 'woocommerce_customer_stock_notification_throttle_threshold', self::SPAM_THRESHOLD );
if ( $threshold <= 0 ) {
return false;
}
$last_notified = $notification->get_date_notified();
$is_throttled = $last_notified instanceof \WC_DateTime && $last_notified->getTimestamp() > ( time() - $threshold );
return $is_throttled;
}
}
PK [1])v - StockNotifications/Utilities/HasherHelper.phpnu >
*/
private array $managed_variations = array();
/**
* Get a list of variations that inherit stock management from the parent.
*
* If the product is a variable product, we need sync the children that don't manage stock.
*
* @param WC_Product $product The product to check.
* @return array Array of variation IDs that inherit stock management from the parent.
*/
public function get_managed_variations( WC_Product $product ): array {
if ( ! $product->is_type( ProductType::VARIABLE ) ) {
return array();
}
$product_id = $product->get_id();
if ( isset( $this->managed_variations[ $product_id ] ) ) {
return $this->managed_variations[ $product_id ];
}
$children = $product->get_children();
if ( empty( $children ) ) {
return array();
}
global $wpdb;
$format = array_fill( 0, count( $children ), '%d' );
$query_in = '(' . implode( ',', $format ) . ')';
$managed_children = $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT post_id FROM $wpdb->postmeta WHERE meta_key = '_manage_stock' AND meta_value != 'yes' AND post_id IN {$query_in}", $children ) ); // @codingStandardsIgnoreLine.
$this->managed_variations[ $product_id ] = array_map( 'intval', $managed_children );
return $this->managed_variations[ $product_id ];
}
}
PK [1]F)6 6 EmailEditor/Integration.phpnu dependency_check = $editor_container->get( Dependency_Check::class );
}
/**
* Initialize the integration.
*
* @internal
*/
final public function init(): void {
if ( ! $this->dependency_check->are_dependencies_met() ) {
// If dependencies are not met, do not initialize the email editor integration.
return;
}
add_action( 'woocommerce_init', array( $this, 'initialize' ) );
}
/**
* Initialize the integration.
*/
public function initialize() {
$this->init_logger();
$this->init_hooks();
$this->extend_post_api();
$this->extend_template_post_api();
$this->register_hooks();
}
/**
* Initialize the logger.
*/
public function init_logger() {
$editor_container = Email_Editor_Container::container();
$logger = $editor_container->get( Email_Editor_Logger::class );
// Register the WooCommerce logger with the email editor package.
$logger->set_logger( new Logger( wc_get_logger() ) );
}
/**
* Initialize hooks for required classes.
*/
public function init_hooks() {
$container = wc_get_container();
$container->get( PatternsController::class );
$container->get( TemplatesController::class );
$container->get( PersonalizationTagManager::class );
$container->get( BlockEmailRenderer::class );
$container->get( WCTransactionalEmails::class );
$this->editor_page_renderer = $container->get( PageRenderer::class );
$this->template_api_controller = $container->get( TemplateApiController::class );
$this->email_api_controller = $container->get( EmailApiController::class );
}
/**
* Register hooks for the integration.
*/
public function register_hooks() {
add_filter( 'woocommerce_email_editor_post_types', array( $this, 'add_email_post_type' ) );
add_filter( 'woocommerce_is_email_editor_page', array( $this, 'is_editor_page' ), 10, 1 );
add_filter( 'replace_editor', array( $this, 'replace_editor' ), 10, 2 );
add_action( 'before_delete_post', array( $this, 'delete_email_template_associated_with_email_editor_post' ), 10, 2 );
add_filter( 'woocommerce_email_editor_send_preview_email_rendered_data', array( $this, 'update_send_preview_email_rendered_data' ), 10, 2 );
add_filter( 'woocommerce_email_editor_send_preview_email_personalizer_context', array( $this, 'update_send_preview_email_personalizer_context' ) );
add_filter( 'woocommerce_email_editor_preview_post_template_html', array( $this, 'update_preview_post_template_html_data' ), 100, 1 );
}
/**
* Add WooCommerce email post type to the list of supported post types.
*
* @param array $post_types List of post types.
* @return array Modified list of post types.
*/
public function add_email_post_type( array $post_types ): array {
$post_types[] = array(
'name' => self::EMAIL_POST_TYPE,
'args' => array(
'labels' => array(
'name' => __( 'Emails', 'woocommerce' ),
'singular_name' => __( 'Email', 'woocommerce' ),
'add_new_item' => __( 'Add Email', 'woocommerce' ),
'edit_item' => __( 'Edit Email', 'woocommerce' ),
'new_item' => __( 'New Email', 'woocommerce' ),
'view_item' => __( 'View Email', 'woocommerce' ),
'search_items' => __( 'Search Emails', 'woocommerce' ),
),
'rewrite' => array( 'slug' => self::EMAIL_POST_TYPE ),
'supports' => array(
'title',
'editor' => array(
'default-mode' => 'template-locked',
),
'excerpt',
),
'capability_type' => self::EMAIL_POST_TYPE,
'capabilities' => array(
'edit_post' => 'manage_woocommerce',
'read_post' => 'manage_woocommerce',
'delete_post' => 'manage_woocommerce',
'edit_posts' => 'manage_woocommerce',
'edit_others_posts' => 'manage_woocommerce',
'delete_posts' => 'manage_woocommerce',
'publish_posts' => 'manage_woocommerce',
'read_private_posts' => 'manage_woocommerce',
'create_posts' => 'manage_woocommerce',
),
'map_meta_cap' => false,
),
);
return $post_types;
}
/**
* Check if current page is email editor page.
*
* @param bool $is_editor_page Current editor page status.
* @return bool Whether current page is email editor page.
*/
public function is_editor_page( bool $is_editor_page ): bool {
if ( $is_editor_page ) {
return $is_editor_page;
}
// We need to check early if we are on the email editor page. The check runs early so we can't use current_screen() here.
if ( is_admin() && isset( $_GET['post'] ) && isset( $_GET['action'] ) && 'edit' === $_GET['action'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are not verifying the nonce here because we are not using the nonce in the function and the data is okay in this context (WP-admin errors out gracefully).
$post = get_post( (int) $_GET['post'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are not verifying the nonce here because we are not using the nonce in the function and the data is okay in this context (WP-admin errors out gracefully).
return $post && self::EMAIL_POST_TYPE === $post->post_type;
}
return false;
}
/**
* Replace the default editor with our custom email editor.
*
* @param bool $replace Whether to replace the editor.
* @param WP_Post $post Post object.
* @return bool Whether the editor was replaced.
*/
public function replace_editor( $replace, $post ) {
$current_screen = get_current_screen();
if ( self::EMAIL_POST_TYPE === $post->post_type && $current_screen ) {
$this->editor_page_renderer->render();
return true;
}
return $replace;
}
/**
* Delete the email template associated with the email editor post when the post is permanently deleted.
*
* @param int $post_id The post ID.
* @param WP_Post $post The post object.
*/
public function delete_email_template_associated_with_email_editor_post( $post_id, $post ) {
if ( self::EMAIL_POST_TYPE !== $post->post_type ) {
return;
}
$post_manager = WCTransactionalEmailPostsManager::get_instance();
$email_type = $post_manager->get_email_type_from_post_id( $post_id, true );
if ( empty( $email_type ) ) {
return;
}
$post_manager->delete_email_template( $email_type );
}
/**
* Extend the post API for the wp_template post type to add and save the woocommerce_data field.
*/
public function extend_template_post_api(): void {
register_rest_field(
'wp_template',
'woocommerce_data',
array(
'get_callback' => array( $this->template_api_controller, 'get_template_data' ),
'update_callback' => array( $this->template_api_controller, 'save_template_data' ),
'schema' => $this->template_api_controller->get_template_data_schema(),
)
);
}
/**
* Filter email preview data to replace placeholders with actual content.
*
* This method retrieves the appropriate email type based on the request,
* generates the email content using the WooContentProcessor, and replaces
* the placeholder in the preview HTML.
*
* @param string $data The preview data.
* @param string $email_type The email type identifier (e.g., 'customer_processing_order').
* @param int $post_id The post ID.
* @return string The updated preview data with placeholders replaced.
*/
private function update_email_preview_data( $data, string $email_type, $post_id = 0 ) {
$type_param = EmailPreview::DEFAULT_EMAIL_TYPE;
if ( ! empty( $post_id ) ) {
$type_param = WCTransactionalEmailPostsManager::get_instance()->get_email_type_class_name_from_post_id( $post_id );
} elseif ( ! empty( $email_type ) ) {
$type_param = WCTransactionalEmailPostsManager::get_instance()->get_email_type_class_name_from_email_id( $email_type );
}
$email_preview = wc_get_container()->get( EmailPreview::class );
try {
$message = $email_preview->generate_placeholder_content( $type_param );
} catch ( \InvalidArgumentException $e ) {
// If the provided type was invalid, fall back to the default.
try {
$message = $email_preview->generate_placeholder_content( EmailPreview::DEFAULT_EMAIL_TYPE );
} catch ( \Throwable $e ) {
return $data;
}
} catch ( \Throwable $e ) {
return $data;
}
return str_replace( BlockEmailRenderer::WOO_EMAIL_CONTENT_PLACEHOLDER, $message, $data );
}
/**
* Filter email preview data used when sending a preview email.
*
* @param string $data The preview data.
* @param WP_Post $post The post object.
* @return string The updated preview data with placeholders replaced.
*/
public function update_send_preview_email_rendered_data( $data, $post ) {
$email_type = '';
$post_body = file_get_contents( 'php://input' );
if ( $post_body ) {
$decoded_body = json_decode( $post_body );
if ( json_last_error() === JSON_ERROR_NONE && isset( $decoded_body->postId ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$post_id = absint( $decoded_body->postId ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
$email_type = WCTransactionalEmailPostsManager::get_instance()->get_email_type_from_post_id( $post_id );
if ( ! empty( $email_type ) ) {
return $this->update_email_preview_data( $data, $email_type );
}
}
} elseif ( ! empty( $post ) && $post instanceof \WP_Post ) {
$email_type = WCTransactionalEmailPostsManager::get_instance()->get_email_type_from_post_id( $post->ID );
if ( ! empty( $email_type ) ) {
return $this->update_email_preview_data( $data, $email_type, $post->ID );
}
}
return $data;
}
/**
* Update the personalizer context for the send preview email.
*
* @param array $context The personalizer context.
* @return array The updated personalizer context.
*/
public function update_send_preview_email_personalizer_context( $context ) {
$post_manager = WCTransactionalEmailPostsManager::get_instance();
$email_id = $post_manager->get_email_type_from_post_id( get_the_ID() );
$email_type = $email_id ? $post_manager->get_email_type_class_name_from_email_id( $email_id ) : EmailPreview::DEFAULT_EMAIL_TYPE;
$email_preview = wc_get_container()->get( EmailPreview::class );
try {
$email_preview->set_email_type( $email_type );
} catch ( \InvalidArgumentException $e ) {
// If the email type is invalid, return the context data as is.
return $context;
}
$email = $email_preview->get_email();
$email->recipient = $context['recipient_email'] ?? '';
$personalizer = wc_get_container()->get( TransactionalEmailPersonalizer::class );
return $personalizer->prepare_context_data( $context, $email );
}
/**
* Filter email preview data used when previewing the email in new tab.
*
* @param string $data The preview HTML string.
* @return string The updated preview HTML with placeholders replaced.
*/
public function update_preview_post_template_html_data( $data ) {
// return early if the data does not contain the placeholder meaning it's already been processed.
if ( ! str_contains( (string) $data, BlockEmailRenderer::WOO_EMAIL_CONTENT_PLACEHOLDER ) ) {
return $data;
}
// phpcs:disable WordPress.Security.NonceVerification.Recommended
// Nonce verification is disabled here because the preview action doesn't modify data,
// and the check caused issues with the 'Preview in new tab' feature due to context changes.
$type_param = isset( $_GET['woo_email'] ) ? sanitize_text_field( wp_unslash( $_GET['woo_email'] ) ) : '';
// check for post id (preview id) in the request.
$post_id = isset( $_REQUEST['preview_id'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['preview_id'] ) ) : '';
// phpcs:enable
return $this->update_email_preview_data( $data, $type_param, $post_id );
}
/**
* Extend the post API for the woo_email post type to add and save the woocommerce_data field.
*/
public function extend_post_api(): void {
register_rest_field(
self::EMAIL_POST_TYPE,
'woocommerce_data',
array(
'get_callback' => array( $this->email_api_controller, 'get_email_data' ),
'update_callback' => array( $this->email_api_controller, 'save_email_data' ),
'schema' => $this->email_api_controller->get_email_data_schema(),
)
);
}
}
PK [1]c f " EmailEditor/BlockEmailRenderer.phpnu renderer = $editor_container->get( EmailRenderer::class );
$this->personalizer = $editor_container->get( Personalizer::class );
$this->template_manager = WCTransactionalEmailPostsManager::get_instance();
}
/**
* Initialize the renderer.
*
* @param WooContentProcessor $woo_content_processor Service for extracting WooCommerce content from WC_Email object.
* @internal
*/
final public function init( WooContentProcessor $woo_content_processor ): void {
$this->woo_content_processor = $woo_content_processor;
add_action( 'woocommerce_email_blocks_renderer_initialized', array( $this, 'register_block_renderers' ) );
}
/**
* Maybe render block-based email content.
*
* @param \WC_Email $wc_email WooCommerce email.
* @return string|null Modified email content
*/
public function maybe_render_block_email( \WC_Email $wc_email ): ?string {
$email_post = $this->get_email_post_by_wc_email( $wc_email );
if ( ! $email_post ) {
return null;
}
$woo_content = $this->woo_content_processor->get_woo_content( $wc_email );
return $this->render_block_email( $email_post, $woo_content, $wc_email );
}
/**
* Maybe render block-based email content.
*
* @param \WP_Post $email_post Email post.
* @param string $woo_content WooCommerce email content.
* @param \WC_Email $wc_email WooCommerce email.
* @return string Modified email content
*/
private function render_block_email( \WP_Post $email_post, string $woo_content, \WC_Email $wc_email ): ?string {
try {
// Set email context before rendering so blocks can access it.
$filter_callback = function ( $context = array() ) use ( $wc_email ) {
return array_merge( $context, $this->build_email_context( $wc_email ) );
};
add_filter( 'woocommerce_email_editor_rendering_email_context', $filter_callback, 10, 1 );
$subject = $wc_email->get_subject(); // We will get subject from $email_post after we add it to the editor.
$preheader = $wc_email->get_preheader();
$rendered_email_data = $this->renderer->render( $email_post, $subject, $preheader, 'en' );
$personalized_email = $this->personalizer->personalize_content( $rendered_email_data['html'] );
$rendered_email = str_replace( self::WOO_EMAIL_CONTENT_PLACEHOLDER, $woo_content, $personalized_email );
// Remove the filter after rendering to prevent context leakage.
remove_filter( 'woocommerce_email_editor_rendering_email_context', $filter_callback );
add_filter( 'woocommerce_email_styles', array( $this->woo_content_processor, 'prepare_css' ), 10, 2 );
return $rendered_email;
} catch ( \Exception $e ) {
wc_caught_exception( $e, __METHOD__, array( $email_post, $woo_content, $wc_email ) );
// Remove the filter in case of exception.
if ( isset( $filter_callback ) ) {
remove_filter( 'woocommerce_email_editor_rendering_email_context', $filter_callback );
}
return null;
}
}
/**
* Get the email post for a given WC_Email.
*
* @param \WC_Email $email WooCommerce email.
* @return \WP_Post|null
*/
private function get_email_post_by_wc_email( \WC_Email $email ): ?\WP_Post {
return $this->template_manager->get_email_post( $email->id );
}
/**
* Build email context from WC_Email object.
*
* Extracts relevant context data from the WC_Email object that can be used
* by blocks during rendering, such as user ID, email address, order information, etc.
*
* Blocks that need cart product information can derive it from the user_id or email
* using CartCheckoutUtils::get_cart_product_ids_for_user().
*
* @param \WC_Email $wc_email WooCommerce email object.
* @return array Email context data.
*/
private function build_email_context( \WC_Email $wc_email ): array {
$recipient_raw = $wc_email->get_recipient();
$emails = array_values( array_filter( array_map( 'sanitize_email', array_map( 'trim', explode( ',', $recipient_raw ) ) ) ) );
$context = array(
'recipient_email' => $emails[0] ?? null,
);
// Extract order-related context if the email object is an order.
if ( isset( $wc_email->object ) && $wc_email->object instanceof \WC_Order ) {
$order = $wc_email->object;
$context['user_id'] = $order->get_customer_id();
}
return $context;
}
}
PK [1]},G 8 EmailEditor/PersonalizationTags/CustomerTagsProvider.phpnu register(
new Personalization_Tag(
__( 'Customer Email', 'woocommerce' ),
'woocommerce/customer-email',
__( 'Customer', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['order'] ) ) {
return $context['order']->get_billing_email() ?? '';
}
return $context['recipient_email'] ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Customer First Name', 'woocommerce' ),
'woocommerce/customer-first-name',
__( 'Customer', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['order'] ) ) {
return $context['order']->get_billing_first_name() ?? '';
} elseif ( isset( $context['wp_user'] ) ) {
return $context['wp_user']->first_name ?? '';
}
return '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Customer Last Name', 'woocommerce' ),
'woocommerce/customer-last-name',
__( 'Customer', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['order'] ) ) {
return $context['order']->get_billing_last_name() ?? '';
} elseif ( isset( $context['wp_user'] ) ) {
return $context['wp_user']->last_name ?? '';
}
return '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Customer Full Name', 'woocommerce' ),
'woocommerce/customer-full-name',
__( 'Customer', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['order'] ) ) {
return $context['order']->get_formatted_billing_full_name() ?? '';
} elseif ( isset( $context['wp_user'] ) ) {
$first_name = $context['wp_user']->first_name ?? '';
$last_name = $context['wp_user']->last_name ?? '';
return trim( "$first_name $last_name" );
}
return '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Customer Username', 'woocommerce' ),
'woocommerce/customer-username',
__( 'Customer', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['wp_user'] ) ) {
return stripslashes( $context['wp_user']->user_login ?? '' );
}
return '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Customer Country', 'woocommerce' ),
'woocommerce/customer-country',
__( 'Customer', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['order'] ) ) {
$country_code = $context['order']->get_billing_country();
return WC()->countries->countries[ $country_code ] ?? $country_code ?? '';
}
return '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
}
}
PK [1]f1NZ' ' 4 EmailEditor/PersonalizationTags/SiteTagsProvider.phpnu register(
new Personalization_Tag(
__( 'Site Title', 'woocommerce' ),
'woocommerce/site-title',
__( 'Site', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['order'] ) && PointOfSaleOrderUtil::is_pos_order( $context['order'] ) ) {
$store_name = get_option( 'woocommerce_pos_store_name' );
return htmlspecialchars_decode( empty( $store_name ) ? PointOfSaleDefaultSettings::get_default_store_name() : $store_name, ENT_QUOTES );
}
return htmlspecialchars_decode( get_bloginfo( 'name' ) );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Homepage URL', 'woocommerce' ),
'woocommerce/site-homepage-url',
__( 'Site', 'woocommerce' ),
function (): string {
return get_bloginfo( 'url' );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
}
}
PK [1]1TKa! a! 5 EmailEditor/PersonalizationTags/OrderTagsProvider.phpnu register(
new Personalization_Tag(
__( 'Order Number', 'woocommerce' ),
'woocommerce/order-number',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_order_number() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Date', 'woocommerce' ),
'woocommerce/order-date',
__( 'Order', 'woocommerce' ),
function ( array $context, array $parameters = array() ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
$format = isset( $parameters['format'] ) && is_string( $parameters['format'] ) ? $parameters['format'] : wc_date_format();
$date_created = $context['order']->get_date_created();
if ( ! $date_created ) {
return '';
}
return wc_format_datetime( $date_created, $format );
},
array(
'format' => wc_date_format(),
),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Items', 'woocommerce' ),
'woocommerce/order-items',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
$items = array();
foreach ( $context['order']->get_items() as $item ) {
$items[] = $item->get_name();
}
return implode( ', ', $items );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Subtotal', 'woocommerce' ),
'woocommerce/order-subtotal',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return (string) $context['order']->get_subtotal() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Tax', 'woocommerce' ),
'woocommerce/order-tax',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return (string) $context['order']->get_total_tax() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Discount', 'woocommerce' ),
'woocommerce/order-discount',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return wc_price( $context['order']->get_discount_total(), array( 'currency' => $context['order']->get_currency() ) );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Shipping', 'woocommerce' ),
'woocommerce/order-shipping',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return wc_price( $context['order']->get_shipping_total(), array( 'currency' => $context['order']->get_currency() ) );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Total', 'woocommerce' ),
'woocommerce/order-total',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return (string) $context['order']->get_total() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Payment Method', 'woocommerce' ),
'woocommerce/order-payment-method',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_payment_method_title() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Payment URL', 'woocommerce' ),
'woocommerce/order-payment-url',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_checkout_payment_url() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Transaction ID', 'woocommerce' ),
'woocommerce/order-transaction-id',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_transaction_id() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Shipping Method', 'woocommerce' ),
'woocommerce/order-shipping-method',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_shipping_method() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Shipping Address', 'woocommerce' ),
'woocommerce/order-shipping-address',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_formatted_shipping_address() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Billing Address', 'woocommerce' ),
'woocommerce/order-billing-address',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_formatted_billing_address() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order View URL', 'woocommerce' ),
'woocommerce/order-view-url',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_view_order_url() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Admin URL', 'woocommerce' ),
'woocommerce/order-admin-url',
__( 'Order', 'woocommerce' ),
function ( array $context ): string {
if ( ! isset( $context['order'] ) ) {
return '';
}
return $context['order']->get_edit_order_url() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Order Custom Field', 'woocommerce' ),
'woocommerce/order-custom-field',
__( 'Order', 'woocommerce' ),
function ( array $context, array $parameters = array() ): string {
if ( ! isset( $context['order'] ) || ! isset( $parameters['key'] ) ) {
return '';
}
$field_key = sanitize_text_field( $parameters['key'] );
return $context['order']->get_meta( $field_key ) ?? '';
},
array(
'key' => '',
),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
}
}
PK [1]ʺSM M 5 EmailEditor/PersonalizationTags/StoreTagsProvider.phpnu register(
new Personalization_Tag(
__( 'Store Email', 'woocommerce' ),
'woocommerce/store-email',
__( 'Store', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['wc_email'], $context['wc_email']->get_from_address ) ) {
return $context['wc_email']->get_from_address();
}
return get_option( 'admin_email' );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Store URL', 'woocommerce' ),
'woocommerce/store-url',
__( 'Store', 'woocommerce' ),
function (): string {
return esc_attr( wc_get_page_permalink( 'shop' ) );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Store Name', 'woocommerce' ),
'woocommerce/store-name',
__( 'Store', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['wc_email'] ) && ! empty( $context['wc_email']->get_from_name() ) ) {
return $context['wc_email']->get_from_name();
}
return wp_specialchars_decode( get_bloginfo( 'name' ), ENT_QUOTES );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Store Address', 'woocommerce' ),
'woocommerce/store-address',
__( 'Store', 'woocommerce' ),
function (): string {
return WC()->mailer->get_store_address() ?? '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'My Account URL', 'woocommerce' ),
'woocommerce/my-account-url',
__( 'Store', 'woocommerce' ),
function (): string {
return esc_attr( wc_get_page_permalink( 'myaccount' ) );
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
$registry->register(
new Personalization_Tag(
__( 'Admin Order Note', 'woocommerce' ),
'woocommerce/admin-order-note',
__( 'Store', 'woocommerce' ),
function ( array $context ): string {
if ( isset( $context['wc_email'], $context['wc_email']->customer_note ) ) {
return wptexturize( $context['wc_email']->customer_note );
}
return '';
},
array(),
null,
array( Integration::EMAIL_POST_TYPE ),
)
);
}
}
PK [1],G99 9 7 EmailEditor/PersonalizationTags/AbstractTagProvider.phpnu post_manager = WCTransactionalEmailPostsManager::get_instance();
}
/**
* Returns the data from wp_options table for the given post.
*
* @param array $post_data - Post data.
* @return array - The email data.
*/
public function get_email_data( $post_data ): array {
$email_type = $this->post_manager->get_email_type_from_post_id( $post_data['id'] );
$email = $this->get_email_by_type( $email_type ?? '' );
// When the email type is not found, it means that the email type is not supported.
if ( ! $email ) {
return array(
'subject' => null,
'subject_full' => null,
'subject_partial' => null,
'preheader' => null,
'default_subject' => null,
'email_type' => null,
'recipient' => null,
'cc' => null,
'bcc' => null,
);
}
$form_fields = $email->get_form_fields();
$enabled = $email->get_option( 'enabled' );
return array(
'enabled' => is_null( $enabled ) ? $email->is_enabled() : 'yes' === $enabled,
'is_manual' => $email->is_manual(),
'subject' => $email->get_option( 'subject' ),
'subject_full' => $email->get_option( 'subject_full' ), // For customer_refunded_order email type because it has two different subjects.
'subject_partial' => $email->get_option( 'subject_partial' ),
'preheader' => $email->get_option( 'preheader' ),
'default_subject' => $email->get_default_subject(),
'email_type' => $email_type,
// Recipient is possible to set only for the specific type of emails. When the field `recipient` is set in the form fields, it means that the email type has a recipient field.
'recipient' => array_key_exists( 'recipient', $form_fields ) ? $email->get_option( 'recipient', get_option( 'admin_email' ) ) : null,
'cc' => $email->get_option( 'cc' ),
'bcc' => $email->get_option( 'bcc' ),
);
}
/**
* Update WooCommerce specific option data by post name.
*
* @param array $data - Data that are stored in the wp_options table.
* @param \WP_Post $post - WP_Post object.
* @return \WP_Error|null Returns WP_Error if email validation fails, null otherwise.
*/
public function save_email_data( array $data, \WP_Post $post ): ?\WP_Error {
$error = $this->validate_email_data( $data );
if ( is_wp_error( $error ) ) {
return new \WP_Error( 'invalid_email_data', implode( ' ', $error->get_error_messages() ), array( 'status' => 400 ) );
}
if ( ! array_key_exists( 'subject', $data ) && ! array_key_exists( 'preheader', $data ) ) {
return null;
}
$email_type = $this->post_manager->get_email_type_from_post_id( $post->ID );
$email = $this->get_email_by_type( $email_type ?? '' );
if ( ! $email ) {
return null; // not saving of type wc_email. Allow process to continue.
}
// Handle customer_refunded_order email type because it has two different subjects.
if ( 'customer_refunded_order' === $email_type ) {
if ( array_key_exists( 'subject_full', $data ) ) {
$email->update_option( 'subject_full', $data['subject_full'] );
}
if ( array_key_exists( 'subject_partial', $data ) ) {
$email->update_option( 'subject_partial', $data['subject_partial'] );
}
} elseif ( array_key_exists( 'subject', $data ) ) {
$email->update_option( 'subject', $data['subject'] );
}
if ( array_key_exists( 'preheader', $data ) ) {
$email->update_option( 'preheader', $data['preheader'] );
}
if ( array_key_exists( 'enabled', $data ) ) {
$email->update_option( 'enabled', $data['enabled'] ? 'yes' : 'no' );
}
if ( array_key_exists( 'recipient', $data ) ) {
$email->update_option( 'recipient', $data['recipient'] );
}
if ( array_key_exists( 'cc', $data ) ) {
$email->update_option( 'cc', $data['cc'] );
}
if ( array_key_exists( 'bcc', $data ) ) {
$email->update_option( 'bcc', $data['bcc'] );
}
return null;
}
/**
* Validate the email data.
*
* @param array $data - The email data.
* @return \WP_Error|null Returns WP_Error if email validation fails, null otherwise.
*/
private function validate_email_data( array $data ) {
$error = new \WP_Error();
// Validate 'recipient' email(s) field.
$invalid_recipients = $this->filter_invalid_email_addresses( $data['recipient'] ?? '' );
if ( ! empty( $invalid_recipients ) ) {
$error_message = sprintf(
// translators: %s will be replaced by comma-separated email addresses. For example, "invalidemail1@example.com,invalidemail2@example.com".
__( 'One or more Recipient email addresses are invalid: “%s”. Please enter valid email addresses separated by commas.', 'woocommerce' ),
implode( ',', $invalid_recipients )
);
$error->add( 'invalid_recipient_email_address', $error_message );
}
// Validate 'cc' email(s) field.
$invalid_cc = $this->filter_invalid_email_addresses( $data['cc'] ?? '' );
if ( ! empty( $invalid_cc ) ) {
$error_message = sprintf(
// translators: %s will be replaced by comma-separated email addresses. For example, "invalidemail1@example.com,invalidemail2@example.com".
__( 'One or more CC email addresses are invalid: “%s”. Please enter valid email addresses separated by commas.', 'woocommerce' ),
implode( ',', $invalid_cc )
);
$error->add( 'invalid_cc_email_address', $error_message );
}
// Validate 'bcc' email(s) field.
$invalid_bcc = $this->filter_invalid_email_addresses( $data['bcc'] ?? '' );
if ( ! empty( $invalid_bcc ) ) {
$error_message = sprintf(
// translators: %s will be replaced by comma-separated email addresses. For example, "invalidemail1@example.com,invalidemail2@example.com".
__( 'One or more BCC email addresses are invalid: “%s”. Please enter valid email addresses separated by commas.', 'woocommerce' ),
implode( ',', $invalid_bcc )
);
$error->add( 'invalid_bcc_email_address', $error_message );
}
if ( $error->has_errors() ) {
return $error;
}
return null;
}
/**
* Filter in invalid email addresses from a comma-separated string.
*
* @param string $comma_separated_email_addresses - A comma-separated string of email addresses.
* @return array - An array of invalid email addresses.
*/
private function filter_invalid_email_addresses( $comma_separated_email_addresses ) {
$invalid_email_addresses = array();
if ( empty( trim( $comma_separated_email_addresses ) ) ) {
return $invalid_email_addresses;
}
foreach ( explode( ',', $comma_separated_email_addresses ) as $email_address ) {
if ( ! filter_var( trim( $email_address ), FILTER_VALIDATE_EMAIL ) ) {
$invalid_email_addresses[] = trim( $email_address );
}
}
return $invalid_email_addresses;
}
/**
* Get the schema for the WooCommerce email post data.
*
* @return array
*/
public function get_email_data_schema(): array {
return Builder::object(
array(
'subject' => Builder::string()->nullable(),
'subject_full' => Builder::string()->nullable(), // For customer_refunded_order email type because it has two different subjects.
'subject_partial' => Builder::string()->nullable(),
'preheader' => Builder::string()->nullable(),
'default_subject' => Builder::string()->nullable(),
'email_type' => Builder::string()->nullable(),
'recipient' => Builder::string()->nullable(),
'cc' => Builder::string()->nullable(),
'bcc' => Builder::string()->nullable(),
)
)->to_array();
}
/**
* Get all WooCommerce emails.
*
* @return \WC_Email[]
*/
protected function get_emails(): array {
return WC()->mailer()->get_emails();
}
/**
* Get the email object by ID.
*
* @param string $id - The email ID.
* @return \WC_Email|null - The email object or null if not found.
*/
private function get_email_by_type( ?string $id ): ?WC_Email {
foreach ( $this->get_emails() as $email ) {
if ( $email->id === $id ) {
return $email;
}
}
return null;
}
}
PK [1]w5jaF F 4 EmailEditor/EmailTemplates/TemplateApiController.phpnu array(
'from_name' => get_option( 'woocommerce_email_from_name', get_bloginfo( 'name', 'display' ) ),
'from_address' => get_option( 'woocommerce_email_from_address' ),
),
);
}
/**
* Update WooCommerce specific data we store with Template.
*
* @param array $data - WP_Block_Template data.
* @param \WP_Block_Template $template_post - WP_Block_Template object.
* @return \WP_Error|null Returns WP_Error if email validation fails, null otherwise.
*/
public function save_template_data( array $data, \WP_Block_Template $template_post ): ?\WP_Error {
if ( WooEmailTemplate::TEMPLATE_SLUG === $template_post->slug && isset( $data['sender_settings'] ) ) {
$new_from_name = $data['sender_settings']['from_name'] ?? null;
if ( null !== $new_from_name ) {
update_option( 'woocommerce_email_from_name', $new_from_name );
}
$new_from_address = $data['sender_settings']['from_address'] ?? null;
if ( null === $new_from_address || ! filter_var( $new_from_address, FILTER_VALIDATE_EMAIL ) ) {
return new \WP_Error( 'invalid_email_address', __( 'Invalid email address provided for sender settings', 'woocommerce' ), array( 'status' => 400 ) );
}
update_option( 'woocommerce_email_from_address', $new_from_address );
}
return null;
}
/**
* Get the schema for the template data.
*
* @return array
*/
public function get_template_data_schema(): array {
return Builder::object(
array(
'sender_settings' => Builder::object(
array(
'preheader' => Builder::string(),
'preview_url' => Builder::string(),
)
),
)
)->to_array();
}
}
PK [1]+( ( / EmailEditor/EmailTemplates/WooEmailTemplate.phpnu
' . $this->get_site_logo_or_title() . '
You received this email because you shopped at
';
}
/**
* Get the site logo or title.
*
* This is used to display the site logo or title in the email template.
*
* @return string HTML content for the site logo or title.
*/
private function get_site_logo_or_title(): string {
$custom_logo = get_custom_logo();
if ( ! empty( $custom_logo ) ) {
// Use Site logo if available.
return '';
}
return '';
}
}
PK [1]8 2 EmailEditor/EmailTemplates/TemplatesController.phpnu id ) {
$templates = array_filter(
$templates,
function ( $template ) {
return WooEmailTemplate::TEMPLATE_SLUG !== $template->slug;
}
);
}
return $templates;
}
/**
* Register WooCommerce email templates with the template registry.
*
* @param Templates_Registry $templates_registry The template registry instance.
* @return Templates_Registry
*/
public function register_templates( Templates_Registry $templates_registry ) {
$templates = array();
$templates[] = new WooEmailTemplate();
foreach ( $templates as $template ) {
$the_template = new Template(
$this->template_prefix,
$template->get_slug(),
$template->get_title(),
$template->get_description(),
$template->get_content(),
array( Integration::EMAIL_POST_TYPE )
);
$templates_registry->register( $the_template );
}
return $templates_registry;
}
}
PK [1]8l=[R R # EmailEditor/WooContentProcessor.phpnu theme_controller = Email_Editor_Container::container()->get( Theme_Controller::class );
$this->css_inliner = new Email_Css_Inliner();
}
/**
* Get the WooCommerce content excluding headers and footers.
*
* @param \WC_Email $wc_email WooCommerce email.
* @return string
*/
public function get_woo_content( \WC_Email $wc_email ): string {
$woo_content = $this->capture_woo_content( $wc_email );
$woo_content_with_css = $this->inline_css( $woo_content );
return $this->get_html_body_content( $woo_content_with_css );
}
/**
* Filter CSS for the email.
* The CSS was from email editor was already inlined.
* The method hookes to woocommerce_email_styles and removes CSS rules that we don't want to apply to the email.
*
* @param string $css CSS.
* @return string
*/
public function prepare_css( string $css ): string {
remove_filter( 'woocommerce_email_styles', array( $this, 'prepare_css' ) );
// Remove color and font-family declarations from WooCommerce CSS.
$css = preg_replace( '/color\s*:\s*[^;]+;/', '', $css );
$css = preg_replace( '/font-family\s*:\s*[^;]+;/', '', $css );
return $css;
}
/**
* Get the content of the body tag from the HTML.
*
* @param string $html HTML.
* @return string
*/
private function get_html_body_content( string $html ): string {
// Extract content between and tags using regex.
if ( preg_match( '/]*>(.*?)<\/body>/is', $html, $matches ) ) {
return $matches[1];
}
return $html;
}
/**
* Inline the CSS from the email theme and user email settings.
*
* @param string $woo_content WooCommerce content.
* @return string
*/
private function inline_css( string $woo_content ): string {
if ( empty( $woo_content ) ) {
return '';
}
$css = $this->theme_controller->get_stylesheet_for_rendering();
return $this->css_inliner->from_html( $woo_content )->inline_css( $css )->render();
}
/**
* Capture the WooCommerce content excluding headers and footers.
*
* @param \WC_Email $wc_email WooCommerce email.
* @return string
*/
private function capture_woo_content( \WC_Email $wc_email ): string {
return $wc_email->get_block_editor_email_template_content();
}
}
PK [1]^U< ) EmailEditor/PersonalizationTagManager.phpnu customer_tags_provider = new CustomerTagsProvider();
$this->order_tags_provider = new OrderTagsProvider();
$this->site_tags_provider = new SiteTagsProvider();
$this->store_tags_provider = new StoreTagsProvider();
}
/**
* Initialize the personalization tag manager.
*
* @internal
* @return void
*/
final public function init(): void {
add_filter( 'woocommerce_email_editor_register_personalization_tags', array( $this, 'register_personalization_tags' ) );
}
/**
* Register WooCommerce personalization tags with the registry.
*
* @param Personalization_Tags_Registry $registry The personalization tags registry.
* @return Personalization_Tags_Registry
*/
public function register_personalization_tags( Personalization_Tags_Registry $registry ) {
$this->customer_tags_provider->register_tags( $registry );
$this->order_tags_provider->register_tags( $registry );
$this->site_tags_provider->register_tags( $registry );
$this->store_tags_provider->register_tags( $registry );
return $registry;
}
}
PK [1] " " H EmailEditor/WCTransactionalEmails/WCTransactionalEmailPostsGenerator.phpnu
*/
private $default_templates = array();
/**
* Transient name.
*
* @var string
*/
private $transient_name = 'wc_email_editor_initial_templates_generated';
/**
* Constructor.
*
* Initializes the WCTransactionalEmailPostsGenerator by setting up the template manager.
*/
public function __construct() {
$this->template_manager = WCTransactionalEmailPostsManager::get_instance();
}
/**
* Initialize the email template generator.
*
* This function initializes the email template generator by loading the default templates
* and generating initial email templates if needed.
*
* @internal
*/
public function initialize() {
if ( Constants::get_constant( 'WC_VERSION' ) === get_transient( $this->transient_name ) ) {
// if templates are already generated, we don't need to run this function again.
return true;
}
$this->init_default_transactional_emails();
$this->generate_initial_email_templates();
}
/**
* Initialize the default WooCommerce Transactional Emails.
*
* This function initializes the default templates for the core transactional emails.
* It fetches all the emails from WooCommerce and filters them to include only the core transactional emails.
*/
public function init_default_transactional_emails() {
if ( ! empty( $this->default_templates ) ) {
// If the default templates are already initialized, we don't need to run this function again.
return;
}
$core_transactional_emails = WCTransactionalEmails::get_transactional_emails();
$wc_emails = \WC_Emails::instance();
/**
* WooCommerce Transactional Emails instance.
*
* @var \WC_Email[]
*/
$email_types = $wc_emails->get_emails();
// Filter the emails to include only the core transactional emails.
$email_types = array_filter(
$email_types,
function ( $email ) use ( $core_transactional_emails ) {
return in_array( $email->id, $core_transactional_emails, true );
}
);
$this->default_templates = array_reduce(
$email_types,
function ( $acc, $email ) {
$acc[ $email->id ] = $email;
return $acc;
},
array()
);
}
/**
* Get the email template for the given email.
*
* Looks for the initial email block content in plugins/woocommerce/templates/emails/block.
*
* @param \WC_Email $email The email object.
* @return string The email template.
*/
public function get_email_template( $email ) {
$template_name = ! empty( $email->template_block ) ? $email->template_block : str_replace( 'plain', 'block', $email->template_plain );
try {
$template_html = wc_get_template_html(
$template_name,
array(),
'',
$email->template_base ?? ''
);
} catch ( \Exception $e ) {
// wc_get_template_html() uses ob_start(), so we need to clean the output buffer if an exception is thrown.
if ( ob_get_level() > 0 ) {
ob_end_clean();
}
$template_html = '';
}
// wc_get_template_html does not throw an error when the template is not found.
// We need to check if the template is not found by checking the template_html content.
$has_template_error =
StringUtil::contains( $template_html, 'No such file or directory', false ) ||
StringUtil::contains( $template_html, 'Failed to open stream', false ) ||
StringUtil::contains( $template_html, 'Warning: include', false );
if ( is_wp_error( $template_html ) || empty( $template_html ) || $has_template_error ) {
$default_template_name = 'emails/block/default-block-content.php';
$template_html = wc_get_template_html(
$default_template_name,
array()
);
}
return $template_html;
}
/**
* Generate initial email templates.
*
* This function generates the initial email templates for the core transactional emails.
* It checks if the templates are already generated and if not, it generates them.
*
* @return bool True if the templates are generated, false otherwise.
*/
public function generate_initial_email_templates() {
$core_transactional_emails = WCTransactionalEmails::get_transactional_emails();
$templates_to_generate = array();
foreach ( $core_transactional_emails as $email_type ) {
if ( empty( $this->template_manager->get_email_template_post_id( $email_type ) ) ) {
$templates_to_generate[] = $email_type;
}
}
if ( empty( $templates_to_generate ) ) {
return;
}
$result = $this->generate_email_templates( $templates_to_generate );
if ( is_wp_error( $result ) ) {
return false;
}
set_transient( $this->transient_name, Constants::get_constant( 'WC_VERSION' ), WEEK_IN_SECONDS );
// Flush rewrite rules to ensure the new templates are loaded.
flush_rewrite_rules();
return true;
}
/**
* Generate email template if it doesn't exist.
*
* This function generates an email template if it doesn't exist.
*
* @param string $email_type The email type.
* @return int The post ID of the generated template.
* @throws \Exception When post creation fails.
*/
public function generate_email_template_if_not_exists( $email_type ) {
$email_data = $this->default_templates[ $email_type ];
if ( $this->template_manager->get_email_template_post_id( $email_type ) || empty( $email_data ) ) {
return $this->template_manager->get_email_template_post_id( $email_type );
}
return $this->generate_single_template( $email_type, $email_data );
}
/**
* Generate email templates.
*
* This function generates the email templates for the given email types.
*
* @param array $templates_to_generate The email types to generate.
*/
public function generate_email_templates( $templates_to_generate ) {
global $wpdb;
$core_emails = array_filter(
$this->default_templates,
function ( $email_id ) use ( $templates_to_generate ) {
return in_array( $email_id, $templates_to_generate, true );
},
ARRAY_FILTER_USE_KEY
);
if ( empty( $core_emails ) ) {
return false;
}
// Start transaction.
$wpdb->query( 'START TRANSACTION' );
try {
foreach ( $core_emails as $email_type => $email_data ) {
$this->generate_single_template( $email_type, $email_data );
}
$wpdb->query( 'COMMIT' );
return true;
} catch ( \Exception $e ) {
$wpdb->query( 'ROLLBACK' );
return new \WP_Error( 'email_generation_failed', $e->getMessage() );
}
}
/**
* Generate a single email template.
*
* This function generates a single email template post and sets its postmeta association.
*
* @param string $email_type The email type.
* @param \WC_Email $email_data The transactional email data.
* @return int The post ID of the generated template.
* @throws \Exception When post creation fails.
*/
private function generate_single_template( $email_type, $email_data ) {
$post_data = array(
'post_type' => Integration::EMAIL_POST_TYPE,
'post_status' => 'publish',
'post_name' => $email_type,
'post_title' => $email_data->get_title(),
'post_excerpt' => $email_data->get_description(),
'post_content' => $this->get_email_template( $email_data ),
'meta_input' => array(
'_wp_page_template' => ( new WooEmailTemplate() )->get_slug(),
),
);
/**
* Filter the email content post data before creating the post.
*
* Allows third-party integrators to modify the post data (title, content, meta, etc.)
* before the email content post is created.
*
* @since 10.5.0
* @param array $post_data The post data array to be used for wp_insert_post().
* @param string $email_type The email type identifier (e.g., 'customer_processing_order').
* @param \WC_Email $email_data The WooCommerce email object.
*/
$post_data = apply_filters( 'woocommerce_email_content_post_data', $post_data, $email_type, $email_data );
$post_id = wp_insert_post( $post_data, true );
if ( is_wp_error( $post_id ) ) {
throw new \Exception( esc_html( $post_id->get_error_message() ) );
}
$this->template_manager->save_email_template_post_id( $email_type, $post_id );
return $post_id;
}
}
PK [1] ( ( F EmailEditor/WCTransactionalEmails/WCTransactionalEmailPostsManager.phpnu
*/
private $post_id_to_email_type_cache = array();
/**
* In-memory cache for email class name (e.g. 'WC_Email_Customer_New_Account') lookups within the same request.
*
* @var array
*/
private $email_class_name_cache = array();
/**
* Gets the singleton instance of the class.
*
* @return WCTransactionalEmailPostsManager Instance of the class.
*/
public static function get_instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Retrieves the email post by its type.
*
* Type here refers to the email type, e.g. 'customer_new_account' from the WC_Email->id property.
*
* @param string $email_type The type of email to retrieve.
* @return \WP_Post|null The email post if found, null otherwise.
*/
public function get_email_post( $email_type ) {
$post_id = $this->get_email_template_post_id( $email_type );
if ( ! $post_id ) {
return null;
}
$post = get_post( $post_id );
if ( ! $post instanceof \WP_Post ) {
return null;
}
return $post;
}
/**
* Retrieves the WooCommerce email type from the options table when post ID is provided.
*
* Uses multi-level caching:
* 1. In-memory cache for the same request
* 2. WordPress object cache for cross-request caching
* 3. Database query if cache is not available.
*
* @param int|string $post_id The post ID.
* @param bool $skip_cache Whether to skip the cache. Defaults to false.
* @return string|null The WooCommerce email type if found, null otherwise.
*/
public function get_email_type_from_post_id( $post_id, $skip_cache = false ) {
// Early return if post_id is invalid.
if ( empty( $post_id ) ) {
return null;
}
$post_id = (int) $post_id;
$cache_key = $this->get_cache_key_for_post_id( $post_id );
if ( ! $skip_cache ) {
// Check in-memory cache first (fastest).
if ( array_key_exists( $post_id, $this->post_id_to_email_type_cache ) ) {
return $this->post_id_to_email_type_cache[ $post_id ];
}
// Check WordPress object cache.
$email_type = wp_cache_get( $cache_key, self::CACHE_GROUP );
if ( ! empty( $email_type ) ) {
$this->post_id_to_email_type_cache[ $post_id ] = $email_type;
return $email_type;
}
}
// Cache miss - perform database query.
global $wpdb;
$option_name = $wpdb->get_var(
$wpdb->prepare(
"SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE %s AND option_value = %s LIMIT 1",
self::WC_OPTION_NAME,
$post_id
)
);
if ( empty( $option_name ) ) {
return null;
}
$email_type = $this->get_email_type_from_option_name( $option_name );
// Store in both caches.
$this->post_id_to_email_type_cache[ $post_id ] = $email_type;
wp_cache_set( $cache_key, $email_type, self::CACHE_GROUP, self::CACHE_EXPIRATION );
return $email_type;
}
/**
* Checks if an email template exists for the given type.
*
* Type here refers to the email type, e.g. 'customer_new_account' from the WC_Email->id property.
*
* @param string $email_type The type of email to check.
* @return bool True if the template exists, false otherwise.
*/
public function template_exists( $email_type ) {
return null !== $this->get_email_post( $email_type );
}
/**
* Saves the post ID for a specific email template type.
*
* @param string $email_type The type of email template e.g. 'customer_new_account' from the WC_Email->id property.
* @param int $post_id The post ID to save.
*/
public function save_email_template_post_id( $email_type, $post_id ) {
$option_name = $this->get_option_name( $email_type );
$previous_id = get_option( $option_name );
update_option( $option_name, $post_id );
// Invalidate caches for the previous mapping (if any).
if ( ! empty( $previous_id ) ) {
$this->invalidate_cache_for_template( (int) $previous_id, 'post_id' );
}
// Invalidate cache for the new post_id.
$this->invalidate_cache_for_template( $email_type, 'email_type' );
// Update in-memory caches with the new values.
$this->post_id_to_email_type_cache[ $post_id ] = $email_type;
wp_cache_set( $this->get_cache_key_for_post_id( $post_id ), $email_type, self::CACHE_GROUP, self::CACHE_EXPIRATION );
}
/**
* Gets the post ID for a specific email template type.
*
* Uses multi-level caching for improved performance.
*
* @param string $email_type The type of email template e.g. 'customer_new_account' from the WC_Email->id property.
* @return int|false The post ID if found, false otherwise.
*/
public function get_email_template_post_id( $email_type ) {
// Check in-memory cache first.
$post_id_from_cache = array_search( $email_type, $this->post_id_to_email_type_cache, true );
if ( false !== $post_id_from_cache ) {
return $post_id_from_cache;
}
$option_name = $this->get_option_name( $email_type );
$post_id = get_option( $option_name );
if ( ! empty( $post_id ) ) {
$post_id = (int) $post_id;
// Store in in-memory cache.
$this->post_id_to_email_type_cache[ $post_id ] = $email_type;
}
return $post_id;
}
/**
* Deletes the post ID for a specific email template type.
*
* @param string $email_type The type of email template e.g. 'customer_new_account' from the WC_Email->id property.
*/
public function delete_email_template( $email_type ) {
$option_name = $this->get_option_name( $email_type );
$post_id = get_option( $option_name );
if ( ! $post_id ) {
return;
}
delete_option( $option_name );
// Invalidate cache.
$this->invalidate_cache_for_template( $post_id, 'post_id' );
}
/**
* Invalidates cache entries for a specific post ID or email type.
*
* @param int|string $value The value to invalidate cache for.
* @param string $type The type of value to invalidate cache for. Can be 'post_id' or 'email_type'.
* @return void
*/
private function invalidate_cache_for_template( $value, $type = 'post_id' ) {
$post_id_array = array();
if ( 'post_id' === $type ) {
$post_id_array[] = (int) $value;
} elseif ( 'email_type' === $type ) {
// Get all the post IDs that map to the email type.
$post_id_array = array_merge( $post_id_array, array_unique( array_keys( $this->post_id_to_email_type_cache, $value, true ) ) );
}
foreach ( $post_id_array as $post_id ) {
unset( $this->post_id_to_email_type_cache[ $post_id ] );
// Delete from WordPress object cache.
$cache_key = $this->get_cache_key_for_post_id( $post_id );
wp_cache_delete( $cache_key, self::CACHE_GROUP );
}
}
/**
* Clears all in-memory caches.
*
* Useful for testing and debugging. Note that this only clears in-memory caches,
* not the WordPress object cache entries (which will expire naturally).
*/
public function clear_caches() {
$this->post_id_to_email_type_cache = array();
$this->email_class_name_cache = array();
}
/**
* Gets the cache key for a specific post ID.
*
* @param int $post_id The post ID.
* @return string The cache key e.g. 'post_id_to_email_type_123'.
*/
public function get_cache_key_for_post_id( $post_id ) {
return 'post_id_to_email_type_' . $post_id;
}
/**
* Gets the option name for a specific email type.
*
* @param string $email_type The type of email template e.g. 'customer_new_account' from the WC_Email->id property.
* @return string The option name e.g. 'woocommerce_email_templates_customer_new_account_post_id'
*/
private function get_option_name( $email_type ) {
return str_replace( '%', $email_type, self::WC_OPTION_NAME );
}
/**
* Gets the email type from the option name.
*
* @param string $option_name The option name e.g. 'woocommerce_email_templates_customer_new_account_post_id'.
* @return string The email type e.g. 'customer_new_account'
*/
private function get_email_type_from_option_name( $option_name ) {
return str_replace(
array(
'woocommerce_email_templates_',
'_post_id',
),
'',
$option_name
);
}
/**
* Gets the email type class name, e.g. 'WC_Email_Customer_New_Account' from the email ID (e.g. 'customer_new_account' from the WC_Email->id property).
*
* Uses in-memory caching to avoid repeated iterations through all registered emails.
*
* @param string $email_id The email ID.
* @return string|null The email type class name.
*/
public function get_email_type_class_name_from_email_id( $email_id ) {
// Early return if email_id is invalid.
if ( empty( $email_id ) ) {
return null;
}
// Check in-memory cache first.
if ( isset( $this->email_class_name_cache[ $email_id ] ) ) {
return $this->email_class_name_cache[ $email_id ];
}
/**
* Get all the emails registered in WooCommerce.
*
* @var \WC_Email[]
*/
$emails = WC()->mailer()->get_emails();
// Build the cache for all emails at once to avoid repeated iterations.
foreach ( $emails as $email ) {
$this->email_class_name_cache[ $email->id ] = get_class( $email );
}
// Return the requested email class name if it exists.
return $this->email_class_name_cache[ $email_id ] ?? null;
}
/**
* Gets the email type class name, e.g. 'WC_Email_Customer_New_Account' from the post ID.
*
* @param int $post_id The post ID.
* @return string|null The email type class name.
*/
public function get_email_type_class_name_from_post_id( $post_id ) {
// Early return if post_id is invalid.
if ( empty( $post_id ) ) {
return null;
}
return $this->get_email_type_class_name_from_email_id( $this->get_email_type_from_post_id( $post_id ) );
}
}
PK [1]bG ; EmailEditor/WCTransactionalEmails/WCTransactionalEmails.phpnu email_template_generator = new WCTransactionalEmailPostsGenerator();
}
/**
* Initialize the class.
*
* @internal
*/
final public function init() {
add_action( 'current_screen', array( $this, 'init_email_templates' ), 50 );
}
/**
* Get the Core WooCommerce transactional emails for the block editor.
*
* @return array
*/
public static function get_transactional_emails() {
$emails = self::$core_transactional_emails;
if ( FeaturesUtil::feature_is_enabled( 'point_of_sale' ) ) {
$emails[] = 'customer_pos_completed_order';
$emails[] = 'customer_pos_refunded_order';
}
if ( FeaturesUtil::feature_is_enabled( 'fulfillments' ) ) {
$fulfillment_emails = array(
'customer_fulfillment_created',
'customer_fulfillment_updated',
'customer_fulfillment_deleted',
);
$emails = array_merge( $emails, $fulfillment_emails );
}
/**
* Filter the transactional emails for the block editor.
*
* @param array $transactional_emails The transactional emails.
* @return array
* @since 9.9.0
*/
return apply_filters( 'woocommerce_transactional_emails_for_block_editor', $emails );
}
/**
* Initialize email templates on WooCommerce admin pages.
*/
public function init_email_templates() {
if ( ! function_exists( 'wc_get_screen_ids' ) ) {
return;
}
$screen = get_current_screen();
$wc_screen_ids = array_merge(
wc_get_screen_ids(),
array(
'woocommerce_page_wc-admin',
'edit-woo_email',
)
);
if ( ! $screen || ! in_array( $screen->id, $wc_screen_ids, true ) ) {
return;
}
// run only on WooCommerce admin pages.
$this->email_template_generator->initialize();
}
}
PK [1]&cEl
l
4 EmailEditor/EmailPatterns/WooEmailContentPattern.phpnu
Woo Email Content
Here comes content composed of supported core blocks and Woo transactional email block(s).
';
}
/**
* Get the pattern title.
*
* @return string Localized pattern title.
*/
public function get_title(): string {
/* translators: Name of a content pattern used as starting content of an email */
return __( 'Woo Email Content Pattern', 'woocommerce' );
}
}
PK [1]Bm 0 EmailEditor/EmailPatterns/PatternsController.phpnu register_patterns();
}
/**
* Register all email editor block patterns.
*/
public function register_patterns(): void {
$patterns = array();
$patterns[] = new WooEmailContentPattern();
foreach ( $patterns as $pattern ) {
register_block_pattern( $pattern->get_namespace() . '/' . $pattern->get_name(), $pattern->get_properties() );
}
}
}
PK [1]Yx x EmailEditor/PageRenderer.phpnu template_registry = $editor_container->get( Templates_Registry::class );
$assets_manager = $editor_container->get( Assets_Manager::class );
$assets_manager->set_assets_path( WC_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . 'email-editor/' );
$assets_manager->set_assets_url( WC()->plugin_url() . '/' . WC_ADMIN_DIST_JS_FOLDER . 'email-editor/' );
$this->assets_manager = $assets_manager;
}
/**
* Render the email editor page.
*/
public function render() {
$post_id = isset( $_GET['post'] ) ? intval( $_GET['post'] ) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are not verifying the nonce here because we are not using the nonce in the function and the data is okay in this context (WP-admin errors out gracefully).
$template_id = isset( $_GET['template'] ) ? sanitize_text_field( wp_unslash( $_GET['template'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We are not verifying the nonce here because we are not using the nonce in the function and the data is okay in this context (WP-admin errors out gracefully).
$post_type = $template_id ? 'wp_template' : Integration::EMAIL_POST_TYPE;
$post_id = $template_id ? $template_id : $post_id;
$edited_item = $this->get_edited_item( $post_id, $post_type );
if ( ! $edited_item ) {
return;
}
add_filter( 'woocommerce_email_editor_script_localization_data', array( $this, 'update_localized_data' ) );
// Load the email editor integration script.
// The JS file is located in plugins/woocommerce/client/admin/client/wp-admin-scripts/email-editor-integration/index.ts.
WCAdminAssets::register_script( 'wp-admin-scripts', 'email-editor-integration', true );
WCAdminAssets::register_style( 'email-editor-integration', 'style', true );
$this->assets_manager->load_editor_assets( $edited_item, 'wc-admin-email-editor-integration' );
$this->assets_manager->render_email_editor_html();
remove_filter(
'woocommerce_email_editor_script_localization_data',
array( $this, 'update_localized_data' ),
10
);
}
/**
* Update localized script data.
*
* @param array $localized_data Original localized data.
* @return array
*/
public function update_localized_data( array $localized_data ): array {
// Fetch all email types from WooCommerce including those added by other plugins.
$wc_emails = \WC_Emails::instance();
$email_types = $wc_emails->get_emails();
$email_types = array_values(
array_map(
function ( $email ) {
return array(
'value' => $email->id,
'label' => $email->title,
'id' => get_class( $email ),
);
},
$email_types
)
);
$localized_data['email_types'] = $email_types;
// Modify email editor settings.
$localized_data['editor_settings']['isFullScreenForced'] = true;
$localized_data['editor_settings']['displaySendEmailButton'] = false;
return $localized_data;
}
/**
* Check if the post can be edited in the email editor.
*
* @param int|string $id The post ID.
* @param string $type The post type.
* @return \WP_Post|\WP_Block_Template|null Edited item or null if the item is not found.
*/
private function get_edited_item( $id, string $type ) {
// When we pass template we need to verify that the template is registered in the email template registry.
if ( 'wp_template' === $type ) {
$wp_template = get_block_template( $id );
if ( ! $wp_template ) {
return null;
}
$email_template = $this->template_registry->get_by_slug( $wp_template->slug );
return $email_template instanceof Template ? $wp_template : null;
}
// For post we need to verify that the post is of the email type.
$post = get_post( $id );
if ( $post instanceof \WP_Post && $type === $post->post_type ) {
return $post;
}
return null;
}
}
PK [1]N6 EmailEditor/Package.phpnu get( Integration::class );
}
}
PK [1]"3 . EmailEditor/TransactionalEmailPersonalizer.phpnu personalizer = $editor_container->get( Personalizer::class );
}
/**
* Personalize transactional email content with specific handling.
*
* @param string $content The content to personalize.
* @param \WC_Email $email The WooCommerce email object.
* @return string The personalized content.
*/
public function personalize_transactional_content( string $content, \WC_Email $email ): string {
$this->configure_context_by_email( $email );
return $this->personalizer->personalize_content( $content );
}
/**
* Configure personalization context based on WooCommerce email object.
*
* @param \WC_Email $email The WooCommerce email object.
* @return void
*/
public function configure_context_by_email( \WC_Email $email ): void {
$prepared_context = $this->prepare_context_data( $this->personalizer->get_context(), $email );
$this->personalizer->set_context( $prepared_context );
}
/**
* Prepare context data for email personalization.
* Adds new order specific context data.
*
* @param array $previous_context Previous version of context data.
* @param \WC_Email $email The WooCommerce email object.
* @return array Context data for personalization
*/
public function prepare_context_data( array $previous_context, \WC_Email $email ): array {
$context = $previous_context;
/**
* Filters the context data for email personalization.
*
* @since 10.5.0
* @param array $context Previous version of context data.
* @param \WC_Email $email The WooCommerce email object.
* @return array Context data for personalization
*/
$context = apply_filters( 'woocommerce_email_editor_integration_personalizer_context_data', $context, $email );
if ( ! is_array( $context ) ) {
$context = $previous_context;
}
$context['recipient_email'] = $email->get_recipient();
$context['order'] = $email->object instanceof \WC_Order ? $email->object : null;
// For emails of type new_user or reset_password we want to set user directly from the object.
if ( $email->object instanceof \WP_User ) {
$context['wp_user'] = $email->object;
} elseif ( $email->object instanceof \WC_Order ) {
$context['wp_user'] = $email->object->get_user();
} else {
$context['wp_user'] = null;
}
$context['wc_email'] = $email;
return $context;
}
}
PK [1]^Pi i EmailEditor/Logger.phpnu wc_logger = $wc_logger;
}
/**
* Checks if the log level should be handled.
*
* @param string $level The log level.
* @return bool Whether the log level should be handled.
*/
private function should_handle( string $level ): bool {
/**
* Controls the logging threshold for the email editor.
*
* @param string $threshold The log level threshold.
*
* @since 10.2.0
*/
$logging_threshold = apply_filters( 'woocommerce_email_editor_logging_threshold', WC_Log_Levels::WARNING );
return WC_Log_Levels::get_level_severity( $logging_threshold ) <= WC_Log_Levels::get_level_severity( $level );
}
/**
* Adds emergency level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function emergency( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::EMERGENCY, $message, $context );
}
/**
* Adds alert level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function alert( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::ALERT, $message, $context );
}
/**
* Adds critical level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function critical( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::CRITICAL, $message, $context );
}
/**
* Adds error level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function error( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::ERROR, $message, $context );
}
/**
* Adds warning level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function warning( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::WARNING, $message, $context );
}
/**
* Adds notice level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function notice( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::NOTICE, $message, $context );
}
/**
* Adds info level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function info( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::INFO, $message, $context );
}
/**
* Adds debug level log message.
*
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function debug( string $message, array $context = array() ): void {
$this->log( WC_Log_Levels::DEBUG, $message, $context );
}
/**
* Logs with an arbitrary level.
*
* @param string $level The log level.
* @param string $message The log message.
* @param array $context The log context.
* @return void
*/
public function log( string $level, string $message, array $context = array() ): void {
if ( $this->should_handle( $level ) ) {
$this->wc_logger->log( $level, $message, $context );
}
}
}
PK [1] 9B B + ReceiptRendering/ReceiptRenderingEngine.phpnu transient_files_engine = $transient_files_engine;
$this->legacy_proxy = $legacy_proxy;
}
/**
* Get the (transient) file name of the receipt for an order, creating a new file if necessary.
*
* If $force_new is false, and a receipt file for the order already exists (as pointed by order meta key
* RECEIPT_FILE_NAME_META_KEY), then the name of the already existing receipt file is returned.
*
* If $force_new is true, OR if it's false but no receipt file for the order exists (no order meta with key
* RECEIPT_FILE_NAME_META_KEY exists, OR it exists but the file it points to doesn't), then a new receipt
* transient file is created with the supplied expiration date (defaulting to "tomorrow"), and the new file name
* is stored as order meta with the key RECEIPT_FILE_NAME_META_KEY.
*
* @param int|WC_Abstract_Order $order The order object or order id to get the receipt for.
* @param string|int|null $expiration_date GMT expiration date formatted as yyyy-mm-dd, or as a timestamp, or null for "tomorrow".
* @param bool $force_new If true, creates a new receipt file even if one already exists for the order.
* @return string|null The file name of the new or already existing receipt file, null if an order id is passed and the order doesn't exist.
* @throws InvalidArgumentException Invalid expiration date (wrongly formatted, or it's a date in the past).
* @throws Exception The directory to store the file doesn't exist and can't be created.
*/
public function generate_receipt( $order, $expiration_date = null, bool $force_new = false ): ?string {
if ( ! $order instanceof WC_Abstract_Order ) {
$order = wc_get_order( $order );
if ( false === $order ) {
return null;
}
}
if ( ! $force_new ) {
$existing_receipt_filename = $this->get_existing_receipt( $order );
if ( ! is_null( $existing_receipt_filename ) ) {
return $existing_receipt_filename;
}
}
$expiration_date ??=
$this->legacy_proxy->call_function(
'gmdate',
'Y-m-d',
$this->legacy_proxy->call_function(
'strtotime',
'+1 days'
)
);
/**
* Filter to customize the set of data that is used to render the receipt.
* The formatted line items aren't included, use the woocommerce_printable_order_receipt_formatted_line_item
* filter to customize those.
*
* See the value returned by the 'get_order_data' and 'get_woo_pay_data' methods for a reference of
* the structure of the data.
*
* See the template file, Templates/order-receipt.php, for reference on how the data is used.
*
* @param array $data The original set of data.
* @param WC_Abstract_Order $order The order for which the receipt is being generated.
* @returns array The updated set of data.
*
* @since 9.0.0
*/
$data = apply_filters( 'woocommerce_printable_order_receipt_data', $this->get_order_data( $order ), $order );
$formatted_line_items = array();
$row_index = 0;
foreach ( $data['line_items'] as $line_item_data ) {
$quantity_data = isset( $line_item_data['quantity'] ) ? " × {$line_item_data['quantity']}" : '';
$line_item_display_data = array(
'inner_html' => "
{$line_item_data['title']}$quantity_data
{$line_item_data['amount']}
",
'tr_attributes' => array(),
'row_index' => $row_index++,
);
/**
* Filter to customize the HTML that gets rendered for each order line item in the receipt.
*
* $line_item_display_data will be passed (and must be returned) with the following keys:
*
* - inner_html: the HTML text that will go inside a
element, note that
* wp_kses_post will be applied to this text before actual rendering.
* - tr_attributes: attributes (e.g. 'class', 'data', 'style') that will be applied to the
element,
* as an associative array of attribute name => value.
* - row_index: a number that starts at 0 and increases by one for each processed line item.
*
* $line_item_data will contain the following keys:
*
* - type: One of 'product', 'subtotal', 'discount', 'fee', 'shipping_total', 'taxes_total', 'amount_paid'
* - title
* - amount (formatted with wc_price)
* - item (only when type is 'product'), and instance of WC_Order_Item
* - quantity (only when type is 'product')
*
* @param string $line_item_display_data Data to use to generate the HTML table row to be rendered for the line item.
* @param array $line_item_data The relevant data for the line item for which the HTML table row is being generated.
* @param WC_Abstract_Order $order The order for which the receipt is being generated.
* @return string The actual data to use to generate the HTML for the line item.
*
* @since 9.0.0
*/
$line_item_display_data = apply_filters( 'woocommerce_printable_order_receipt_line_item_display_data', $line_item_display_data, $line_item_data, $order );
$attributes = '';
foreach ( $line_item_display_data['tr_attributes'] as $attribute_name => $attribute_value ) {
$attribute_value = esc_attr( $attribute_value );
$attributes .= " $attribute_name=\"$attribute_value\"";
}
$formatted_line_items[] = wp_kses_post( "{$line_item_display_data['inner_html']}
" );
}
$data['formatted_line_items'] = $formatted_line_items;
ob_start();
$css = include __DIR__ . '/Templates/order-receipt-css.php';
$css = ob_get_contents();
ob_end_clean();
/**
* Filter to customize the CSS styles used to render the receipt.
*
* See Templates/order-receipt.php for guidance on the existing HTMl elements and their ids.
* See Templates/order-receipt-css.php for the original CSS styles.
*
* @param string $css The original CSS styles to use.
* @param WC_Abstract_Order $order The order for which the receipt is being generated.
* @return string The actual CSS styles that will be used.
*
* @since 9.0.0
*/
$data['css'] = apply_filters( 'woocommerce_printable_order_receipt_css', $css, $order );
$default_template_path = __DIR__ . '/Templates/order-receipt.php';
/**
* Filter the order receipt template path.
*
* @since 9.2.0
* @hook wc_get_template
* @param string $template The template path.
* @param string $template_name The template name.
* @param array $args The available data for the template.
* @param string $template_path The template path.
* @param string $default_path The default template path.
*/
$template_path = apply_filters(
'wc_get_template',
$default_template_path,
'ReceiptRendering/order-receipt.php',
$data,
$default_template_path,
$default_template_path
);
if ( ! file_exists( $template_path ) ) {
$template_path = $default_template_path;
}
ob_start();
include $template_path;
$rendered_template = ob_get_contents();
ob_end_clean();
$file_name = $this->transient_files_engine->create_transient_file( $rendered_template, $expiration_date );
$order->update_meta_data( self::RECEIPT_FILE_NAME_META_KEY, $file_name );
$order->save_meta_data();
return $file_name;
}
/**
* Get the file name of an existing receipt file for an order.
*
* A receipt is considered to be available for the order if there's an order meta entry with key
* RECEIPT_FILE_NAME_META_KEY AND the transient file it points to exists AND it has not expired.
*
* @param WC_Abstract_Order $order The order object or order id to get the receipt for.
* @return string|null The receipt file name, or null if no receipt is currently available for the order.
* @throws Exception Thrown if a wrong file path is passed.
*/
public function get_existing_receipt( $order ): ?string {
if ( ! $order instanceof WC_Abstract_Order ) {
$order = wc_get_order( $order );
if ( false === $order ) {
return null;
}
}
$existing_receipt_filename = $order->get_meta( self::RECEIPT_FILE_NAME_META_KEY, true );
if ( '' === $existing_receipt_filename ) {
return null;
}
$file_path = $this->transient_files_engine->get_transient_file_path( $existing_receipt_filename );
if ( is_null( $file_path ) ) {
return null;
}
return $this->transient_files_engine->file_has_expired( $file_path ) ? null : $existing_receipt_filename;
}
/**
* Get the order data that the receipt template will use.
*
* @param WC_Abstract_Order $order The order to get the data from.
* @return array The order data as an associative array.
*/
private function get_order_data( WC_Abstract_Order $order ): array {
$store_name = get_bloginfo( 'name' );
if ( $store_name ) {
/* translators: %s = store name */
$receipt_title = sprintf( __( 'Receipt from %s', 'woocommerce' ), $store_name );
} else {
$receipt_title = __( 'Receipt', 'woocommerce' );
}
$order_id = $order->get_id();
if ( $order_id ) {
/* translators: %d = order id */
$summary_title = sprintf( __( 'Summary: Order #%d', 'woocommerce' ), $order->get_id() );
} else {
$summary_title = __( 'Summary', 'woocommerce' );
}
$get_price_args = array( 'currency' => $order->get_currency() );
$line_items_info = array();
$line_items = $order->get_items( 'line_item' );
foreach ( $line_items as $line_item ) {
$line_item_product = $line_item->get_product();
if ( false === $line_item_product ) {
$line_item_title = $line_item->get_name();
} else {
$line_item_title =
( $line_item_product instanceof \WC_Product_Variation ) ?
( wc_get_product( $line_item_product->get_parent_id() )->get_name() ) . '. ' . $line_item_product->get_attribute_summary() :
$line_item_product->get_name();
}
$line_items_info[] = array(
'type' => 'product',
'item' => $line_item,
'title' => wp_kses( $line_item_title, array() ),
'quantity' => $line_item->get_quantity(),
'amount' => wc_price( $line_item->get_subtotal(), $get_price_args ),
);
}
$line_items_info[] = array(
'type' => 'subtotal',
'title' => __( 'Subtotal', 'woocommerce' ),
'amount' => wc_price( $order->get_subtotal(), $get_price_args ),
);
$coupon_names = ArrayUtil::select( $order->get_coupons(), 'get_name', ArrayUtil::SELECT_BY_OBJECT_METHOD );
if ( ! empty( $coupon_names ) ) {
$line_items_info[] = array(
'type' => 'discount',
/* translators: %s = comma-separated list of coupon codes */
'title' => sprintf( __( 'Discount (%s)', 'woocommerce' ), join( ', ', $coupon_names ) ),
'amount' => wc_price( -$order->get_total_discount(), $get_price_args ),
);
}
foreach ( $order->get_fees() as $fee ) {
$name = $fee->get_name();
$line_items_info[] = array(
'type' => 'fee',
'title' => '' === $name ? __( 'Fee', 'woocommerce' ) : $name,
'amount' => wc_price( $fee->get_total(), $get_price_args ),
);
}
$shipping_total = (float) $order->get_shipping_total();
if ( $shipping_total ) {
$line_items_info[] = array(
'type' => 'shipping_total',
'title' => __( 'Shipping', 'woocommerce' ),
'amount' => wc_price( $order->get_shipping_total(), $get_price_args ),
);
}
$total_taxes = 0;
foreach ( $order->get_taxes() as $tax ) {
$total_taxes += (float) $tax->get_tax_total() + (float) $tax->get_shipping_tax_total();
}
if ( $total_taxes ) {
$line_items_info[] = array(
'type' => 'taxes_total',
'title' => __( 'Taxes', 'woocommerce' ),
'amount' => wc_price( $total_taxes, $get_price_args ),
);
}
$is_order_failed = $order->has_status( 'failed' );
$line_items_info[] = array(
'type' => 'amount_paid',
'title' => $is_order_failed ? __( 'Amount', 'woocommerce' ) : __( 'Amount Paid', 'woocommerce' ),
'amount' => wc_price( $order->get_total(), $get_price_args ),
);
$payment_info = $this->get_woo_pay_data( $order );
return array(
'order' => $order,
'constants' => array(
'font_size' => self::FONT_SIZE,
'margin' => self::MARGIN,
'title_font_size' => self::TITLE_FONT_SIZE,
'footer_font_size' => self::FOOTER_FONT_SIZE,
'line_height' => self::LINE_HEIGHT,
'icon_height' => self::ICON_HEIGHT,
'icon_width' => self::ICON_WIDTH,
),
'texts' => array(
'receipt_title' => $receipt_title,
'amount_paid_section_title' => $is_order_failed ? __( 'Order Total', 'woocommerce' ) : __( 'Amount Paid', 'woocommerce' ),
'date_paid_section_title' => $is_order_failed ? __( 'Order Date', 'woocommerce' ) : __( 'Date Paid', 'woocommerce' ),
'payment_method_section_title' => __( 'Payment method', 'woocommerce' ),
'payment_status_section_title' => __( 'Payment status', 'woocommerce' ),
'payment_status' => $is_order_failed ? __( 'Failed', 'woocommerce' ) : __( 'Success', 'woocommerce' ),
'summary_section_title' => $summary_title,
'order_notes_section_title' => __( 'Notes', 'woocommerce' ),
'app_name' => __( 'Application Name', 'woocommerce' ),
'aid' => __( 'AID', 'woocommerce' ),
'account_type' => __( 'Account Type', 'woocommerce' ),
),
'formatted_amount' => wc_price( $order->get_total(), $get_price_args ),
'formatted_date' => wc_format_datetime( $order->get_date_paid() ?? $order->get_date_created() ),
'line_items' => $line_items_info,
'payment_method' => $order->get_payment_method_title(),
'show_payment_method_title' => empty( $payment_info['card_last4'] ) && empty( $payment_info['brand'] ),
'notes' => array_map( 'get_comment_text', $order->get_customer_order_notes() ),
'payment_info' => $payment_info,
);
}
/**
* Get the order data related to WooCommerce Payments.
*
* It will return null if any of these is true:
*
* - Payment method is not "woocommerce_payments".
* - WooCommerce Payments is not installed.
* - No intent id is stored for the order.
* - Retrieving the payment information from Stripe API (providing the intent id) fails.
* - The received data set doesn't contain the expected information.
*
* @param WC_Abstract_Order $order The order to get the data from.
* @return array|null An array of payment information for the order, or null if not available.
*/
private function get_woo_pay_data( WC_Abstract_Order $order ): ?array {
$card_info = PaymentInfo::get_card_info( $order );
if ( empty( $card_info ) ) {
return null;
}
// Backcompat for custom templates.
$card_info['card_icon'] = $card_info['icon'];
$card_info['card_last4'] = $card_info['last4'];
return $card_info;
}
}
PK [1]70ݟ 3 ReceiptRendering/ReceiptRenderingRestController.phpnu route_namespace,
'/orders/(?P[\d]+)/receipt',
array(
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'create_order_receipt' ),
'permission_callback' => fn( $request ) => $this->check_permission( $request, 'read_shop_order', $request->get_param( 'id' ) ),
'args' => $this->get_args_for_create_order_receipt(),
'schema' => $this->get_schema_for_get_and_post_order_receipt(),
),
)
);
register_rest_route(
$this->route_namespace,
'/orders/(?P[\d]+)/receipt',
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_order_receipt' ),
'permission_callback' => fn( $request ) => $this->check_permission( $request, 'read_shop_order', $request->get_param( 'id' ) ),
'args' => $this->get_args_for_get_order_receipt(),
'schema' => $this->get_schema_for_get_and_post_order_receipt(),
),
)
);
}
/**
* Handle the GET /orders/id/receipt:
*
* Return the data for a receipt if it exists, or a 404 error if it doesn't.
*
* @param WP_REST_Request $request The received request.
* @return array|WP_Error
*/
public function get_order_receipt( WP_REST_Request $request ) {
$order_id = $request->get_param( 'id' );
$filename = wc_get_container()->get( ReceiptRenderingEngine::class )->get_existing_receipt( $order_id );
return is_null( $filename ) ?
new WP_Error( 'woocommerce_rest_not_found', __( 'Receipt not found', 'woocommerce' ), array( 'status' => 404 ) ) :
$this->get_response_for_file( $filename );
}
/**
* Handle the POST /orders/id/receipt:
*
* Return the data for a receipt if it exists, or create a new receipt and return its data otherwise.
*
* Optional query string arguments:
*
* expiration_date: formatted as yyyy-mm-dd.
* expiration_days: a number, 0 is today, 1 is tomorrow, etc.
* force_new: defaults to false, if true, create a new receipt even if one already exists for the order.
*
* If neither expiration_date nor expiration_days are supplied, the default is expiration_days = 1.
*
* @param WP_REST_Request $request The received request.
* @return array|WP_Error Request response or an error.
*/
public function create_order_receipt( WP_REST_Request $request ) {
$expiration_date =
$request->get_param( 'expiration_date' ) ??
gmdate( 'Y-m-d', strtotime( "+{$request->get_param('expiration_days')} days" ) );
$order_id = $request->get_param( 'id' );
$filename = wc_get_container()->get( ReceiptRenderingEngine::class )->generate_receipt( $order_id, $expiration_date, $request->get_param( 'force_new' ) );
return is_null( $filename ) ?
new WP_Error( 'woocommerce_rest_not_found', __( 'Order not found', 'woocommerce' ), array( 'status' => 404 ) ) :
$this->get_response_for_file( $filename );
}
/**
* Formats the response for both the GET and POST endpoints.
*
* @param string $filename The filename to return the information for.
* @return array The data for the actual response to be returned.
*/
private function get_response_for_file( string $filename ): array {
$expiration_date = TransientFilesEngine::get_expiration_date( $filename );
$public_url = wc_get_container()->get( TransientFilesEngine::class )->get_public_url( $filename );
return array(
'receipt_url' => $public_url,
'expiration_date' => $expiration_date,
);
}
/**
* Get the accepted arguments for the GET request.
*
* @return array[] The accepted arguments for the GET request.
*/
private function get_args_for_get_order_receipt(): array {
return array(
'id' => array(
'description' => __( 'Unique identifier of the order.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
);
}
/**
* Get the schema for both the GET and the POST requests.
*
* @return array[]
*/
private function get_schema_for_get_and_post_order_receipt(): array {
$schema = $this->get_base_schema();
$schema['properties'] = array(
'receipt_url' => array(
'description' => __( 'Public url of the receipt.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'expiration_date' => array(
'description' => __( 'Expiration date of the receipt, formatted as yyyy-mm-dd.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
);
return $schema;
}
/**
* Get the accepted arguments for the POST request.
*
* @return array[]
*/
private function get_args_for_create_order_receipt(): array {
return array(
'id' => array(
'description' => __( 'Unique identifier of the order.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'expiration_date' => array(
'description' => __( 'Expiration date formatted as yyyy-mm-dd.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'default' => null,
),
'expiration_days' => array(
'description' => __( 'Number of days to be added to the current date to get the expiration date.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'default' => 1,
),
'force_new' => array(
'description' => __( 'True to force the creation of a new receipt even if one already exists and has not expired yet.', 'woocommerce' ),
'type' => 'boolean',
'required' => false,
'context' => array( 'view', 'edit' ),
'readonly' => true,
'default' => false,
),
);
}
}
PK [1].5 0 ReceiptRendering/Templates/order-receipt-css.phpnu
html { font-family: "Helvetica Neue", sans-serif; font-size: pt; }
header { margin-top: ; }
h1 { font-size: pt; font-weight: 500; text-align: center; }
h3 { color: #707070; margin:0; }
table {
background-color:#F5F5F5;
width:100%;
color: #707070;
margin: pt 0;
padding: pt;
}
table td:last-child { width: 30%; text-align: right; }
table tr:last-child { color: #000000; font-weight: bold; }
footer {
font-size: pt;
border-top: 1px solid #707070;
margin-top: pt;
padding-top: pt;
}
p { line-height: pt; margin: 0 0 0; }
.card-icon {
width: pt;
height: pt;
vertical-align: top;
background-repeat: no-repeat;
background-position-y: center;
display: inline-block;
background-image: url("data:image/svg+xml;base64,");
}
PK [1]a
, ReceiptRendering/Templates/order-receipt.phpnu
-
PK [1]K
I Features/ProductBlockEditor/ProductTemplates/DownloadableProductTrait.phpnu add_section(
array(
'id' => 'product-downloads-section-group',
'order' => 50,
'attributes' => array(
'blockGap' => 'unit-40',
),
'hideConditions' => array(
array(
'expression' => 'postType === "product" && editedProduct.type !== "simple"',
),
),
)
);
$product_downloads_section_group->add_block(
array(
'id' => 'product-downloadable',
'blockName' => 'woocommerce/product-toggle-field',
'order' => 10,
'attributes' => array(
'property' => 'downloadable',
'label' => __( 'Include downloads', 'woocommerce' ),
'checkedHelp' => __( 'Add any files you\'d like to make available for the customer to download after purchasing, such as instructions or warranty info.', 'woocommerce' ),
'uncheckedHelp' => __( 'Add any files you\'d like to make available for the customer to download after purchasing, such as instructions or warranty info.', 'woocommerce' ),
),
)
);
$product_downloads_section_group->add_subsection(
array(
'id' => 'product-downloads-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Downloads', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: Downloads settings link opening tag. %2$s: Downloads settings link closing tag. */
__( 'Add any files you\'d like to make available for the customer to download after purchasing, such as instructions or warranty info. Store-wide updates can be managed in your %1$sproduct settings%2$s.', 'woocommerce' ),
'',
''
),
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.downloadable !== true',
),
),
)
)->add_block(
array(
'id' => 'product-downloads',
'blockName' => 'woocommerce/product-downloads-field',
'order' => 10,
)
);
}
}
PK [1]а F Features/ProductBlockEditor/ProductTemplates/SimpleProductTemplate.phpnu 'general',
'ORGANIZATION' => 'organization',
'INVENTORY' => 'inventory',
'SHIPPING' => 'shipping',
'VARIATIONS' => 'variations',
'LINKED_PRODUCTS' => 'linked-products',
);
/**
* SimpleProductTemplate constructor.
*/
public function __construct() {
$this->add_group_blocks();
$this->add_general_group_blocks();
$this->add_organization_group_blocks();
$this->add_inventory_group_blocks();
$this->add_shipping_group_blocks();
$this->add_variation_group_blocks();
$this->add_linked_products_group_blocks();
}
/**
* Get the template ID.
*/
public function get_id(): string {
return 'simple-product';
}
/**
* Get the template title.
*/
public function get_title(): string {
return __( 'Simple Product Template', 'woocommerce' );
}
/**
* Get the template description.
*/
public function get_description(): string {
return __( 'Template for the simple product form', 'woocommerce' );
}
/**
* Adds the group blocks to the template.
*/
private function add_group_blocks() {
$this->add_group(
array(
'id' => $this::GROUP_IDS['GENERAL'],
'order' => 10,
'attributes' => array(
'title' => __( 'General', 'woocommerce' ),
),
)
);
// Variations tab.
$variations_hide_conditions = array();
$variations_hide_conditions[] = array(
'expression' => 'editedProduct.type === "grouped"',
);
$variations_hide_conditions[] = array(
'expression' => 'editedProduct.type === "external"',
);
$this->add_group(
array(
'id' => $this::GROUP_IDS['VARIATIONS'],
'order' => 20,
'attributes' => array(
'title' => __( 'Variations', 'woocommerce' ),
),
'hideConditions' => $variations_hide_conditions,
)
);
$this->add_group(
array(
'id' => $this::GROUP_IDS['ORGANIZATION'],
'order' => 30,
'attributes' => array(
'title' => __( 'Organization', 'woocommerce' ),
),
)
);
$this->add_group(
array(
'id' => $this::GROUP_IDS['INVENTORY'],
'order' => 50,
'attributes' => array(
'title' => __( 'Inventory', 'woocommerce' ),
),
)
);
$shipping_hide_conditions = array();
$shipping_hide_conditions[] = array(
'expression' => 'editedProduct.type === "grouped"',
);
$shipping_hide_conditions[] = array(
'expression' => 'editedProduct.type === "external"',
);
$this->add_group(
array(
'id' => $this::GROUP_IDS['SHIPPING'],
'order' => 60,
'attributes' => array(
'title' => __( 'Shipping', 'woocommerce' ),
),
'hideConditions' => $shipping_hide_conditions,
)
);
// Linked Products tab.
$this->add_group(
array(
'id' => $this::GROUP_IDS['LINKED_PRODUCTS'],
'order' => 70,
'attributes' => array(
'title' => __( 'Linked products', 'woocommerce' ),
),
)
);
}
/**
* Adds the general group blocks to the template.
*/
private function add_general_group_blocks() {
$is_calc_taxes_enabled = wc_tax_enabled();
$general_group = $this->get_group_by_id( $this::GROUP_IDS['GENERAL'] );
$general_group->add_block(
array(
'id' => 'product_variation_notice_general_tab',
'blockName' => 'woocommerce/product-has-variations-notice',
'order' => 10,
'attributes' => array(
'content' => __( 'This product has options, such as size or color. You can manage each variation\'s images, downloads, and other details individually.', 'woocommerce' ),
'buttonText' => __( 'Go to Variations', 'woocommerce' ),
'type' => 'info',
),
)
);
// Basic Details Section.
$basic_details = $general_group->add_section(
array(
'id' => 'basic-details',
'order' => 10,
'attributes' => array(
'title' => __( 'Basic details', 'woocommerce' ),
'description' => __( 'This info will be displayed on the product page, category pages, social media, and search results.', 'woocommerce' ),
),
)
);
$basic_details->add_block(
array(
'id' => 'product-details-section-description',
'blockName' => 'woocommerce/product-details-section-description',
'order' => 10,
)
);
$basic_details->add_block(
array(
'id' => 'product-name',
'blockName' => 'woocommerce/product-name-field',
'order' => 10,
'attributes' => array(
'name' => 'Product name',
'autoFocus' => true,
'metadata' => array(
'bindings' => array(
'value' => array(
'source' => 'woocommerce/entity-product',
'args' => array(
'prop' => 'name',
),
),
),
),
),
)
);
// Product Pricing columns.
$pricing_columns = $basic_details->add_block(
array(
'id' => 'product-pricing-group-pricing-columns',
'blockName' => 'core/columns',
'order' => 10,
)
);
$pricing_column_1 = $pricing_columns->add_block(
array(
'id' => 'product-pricing-group-pricing-column-1',
'blockName' => 'core/column',
'order' => 10,
'attributes' => array(
'templateLock' => 'all',
),
)
);
$pricing_column_1->add_block(
array(
'id' => 'product-pricing-regular-price',
'blockName' => 'woocommerce/product-regular-price-field',
'order' => 10,
'attributes' => array(
'name' => 'regular_price',
'label' => __( 'Regular price', 'woocommerce' ),
'help' => $is_calc_taxes_enabled ? null : sprintf(
/* translators: %1$s: store settings link opening tag. %2$s: store settings link closing tag.*/
__( 'Per your %1$sstore settings%2$s, taxes are not enabled.', 'woocommerce' ),
'',
''
),
),
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
array(
'expression' => 'editedProduct.type === "grouped"',
),
),
)
);
$pricing_column_2 = $pricing_columns->add_block(
array(
'id' => 'product-pricing-group-pricing-column-2',
'blockName' => 'core/column',
'order' => 20,
'attributes' => array(
'templateLock' => 'all',
),
)
);
$pricing_column_2->add_block(
array(
'id' => 'product-pricing-sale-price',
'blockName' => 'woocommerce/product-sale-price-field',
'order' => 10,
'attributes' => array(
'label' => __( 'Sale price', 'woocommerce' ),
),
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
array(
'expression' => 'editedProduct.type === "grouped"',
),
),
)
);
$basic_details->add_block(
array(
'id' => 'product-pricing-schedule-sale-fields',
'blockName' => 'woocommerce/product-schedule-sale-fields',
'order' => 20,
)
);
if ( $is_calc_taxes_enabled ) {
$basic_details->add_block(
array(
'id' => 'product-sale-tax',
'blockName' => 'woocommerce/product-radio-field',
'order' => 30,
'attributes' => array(
'title' => __( 'Charge sales tax on', 'woocommerce' ),
'property' => 'tax_status',
'options' => array(
array(
'label' => __( 'Product and shipping', 'woocommerce' ),
'value' => ProductTaxStatus::TAXABLE,
),
array(
'label' => __( 'Only shipping', 'woocommerce' ),
'value' => 'shipping',
),
array(
'label' => __( "Don't charge tax", 'woocommerce' ),
'value' => 'none',
),
),
),
)
);
$pricing_advanced_block = $basic_details->add_block(
array(
'id' => 'product-pricing-advanced',
'blockName' => 'woocommerce/product-collapsible',
'order' => 40,
'attributes' => array(
'toggleText' => __( 'Advanced', 'woocommerce' ),
'initialCollapsed' => true,
'persistRender' => true,
),
)
);
$pricing_advanced_block->add_block(
array(
'id' => 'product-tax-class',
'blockName' => 'woocommerce/product-select-field',
'order' => 10,
'attributes' => array(
'label' => __( 'Tax class', 'woocommerce' ),
'help' => sprintf(
/* translators: %1$s: Learn more link opening tag. %2$s: Learn more link closing tag.*/
__( 'Apply a tax rate if this product qualifies for tax reduction or exemption. %1$sLearn more%2$s', 'woocommerce' ),
'',
''
),
'property' => 'tax_class',
'options' => self::get_tax_classes(),
),
)
);
}
$basic_details->add_block(
array(
'id' => 'product-summary',
'blockName' => 'woocommerce/product-text-area-field',
'order' => 50,
'attributes' => array(
'label' => __( 'Summary', 'woocommerce' ),
'help' => __(
"Summarize this product in 1-2 short sentences. We'll show it at the top of the page.",
'woocommerce'
),
'property' => 'short_description',
'lock' => array(
'move' => true,
),
),
)
);
// Description section.
$description_section = $general_group->add_section(
array(
'id' => 'product-description-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Description', 'woocommerce' ),
'description' => __( 'What makes this product unique? What are its most important features? Enrich the product page by adding rich content using blocks.', 'woocommerce' ),
),
)
);
$description_field_block = $description_section->add_block(
array(
'id' => 'product-description',
'blockName' => 'woocommerce/product-description-field',
'order' => 10,
)
);
$description_field_block->add_block(
array(
'id' => 'product-description__content',
'blockName' => 'woocommerce/product-summary-field',
'order' => 10,
'attributes' => array(
'helpText' => null,
'label' => null,
'property' => 'description',
'lock' => array(
'move' => true,
),
),
)
);
// External/Affiliate section.
$buy_button_section = $general_group->add_section(
array(
'id' => 'product-buy-button-section',
'order' => 30,
'attributes' => array(
'title' => __( 'Buy button', 'woocommerce' ),
'description' => __( 'Add a link and choose a label for the button linked to a product sold elsewhere.', 'woocommerce' ),
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.type !== "external"',
),
),
)
);
$buy_button_section->add_block(
array(
'id' => 'product-external-url',
'blockName' => 'woocommerce/product-text-field',
'order' => 10,
'attributes' => array(
'property' => 'external_url',
'label' => __( 'Link to the external product', 'woocommerce' ),
'placeholder' => __( 'Enter the external URL to the product', 'woocommerce' ),
'suffix' => true,
'type' => array(
'value' => 'url',
'message' => __( 'Link to the external product is an invalid URL.', 'woocommerce' ),
),
),
)
);
$button_text_columns = $buy_button_section->add_block(
array(
'id' => 'product-button-text-columns',
'blockName' => 'core/columns',
'order' => 20,
)
);
$button_text_columns->add_block(
array(
'id' => 'product-button-text-column1',
'blockName' => 'core/column',
'order' => 10,
)
)->add_block(
array(
'id' => 'product-button-text',
'blockName' => 'woocommerce/product-text-field',
'order' => 10,
'attributes' => array(
'property' => 'button_text',
'label' => __( 'Buy button text', 'woocommerce' ),
),
)
);
$button_text_columns->add_block(
array(
'id' => 'product-button-text-column2',
'blockName' => 'core/column',
'order' => 20,
)
);
// Product list section.
$product_list_section = $general_group->add_section(
array(
'id' => 'product-list-section',
'order' => 35,
'attributes' => array(
'title' => __( 'Products in this group', 'woocommerce' ),
'description' => __( 'Make a collection of related products, enabling customers to purchase multiple items together.', 'woocommerce' ),
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.type !== "grouped"',
),
),
)
);
$product_list_section->add_block(
array(
'id' => 'product-list',
'blockName' => 'woocommerce/product-list-field',
'order' => 10,
'attributes' => array(
'property' => 'grouped_products',
),
)
);
// Images section.
$images_section = $general_group->add_section(
array(
'id' => 'product-images-section',
'order' => 40,
'attributes' => array(
'title' => __( 'Images', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: Images guide link opening tag. %2$s: Images guide link closing tag. */
__( 'Drag images, upload new ones or select files from your library. For best results, use JPEG files that are 1000 by 1000 pixels or larger. %1$sHow to prepare images?%2$s', 'woocommerce' ),
'',
''
),
),
)
);
$images_section->add_block(
array(
'id' => 'product-images',
'blockName' => 'woocommerce/product-images-field',
'order' => 10,
'attributes' => array(
'images' => array(),
'property' => 'images',
),
)
);
// Downloads section.
$this->add_downloadable_product_blocks( $general_group );
}
/**
* Adds the organization group blocks to the template.
*/
private function add_organization_group_blocks() {
$organization_group = $this->get_group_by_id( $this::GROUP_IDS['ORGANIZATION'] );
// Product Catalog Section.
$product_catalog_section = $organization_group->add_section(
array(
'id' => 'product-catalog-section',
'order' => 10,
'attributes' => array(
'title' => __( 'Product catalog', 'woocommerce' ),
'description' => __( 'Help customers find this product by assigning it to categories, adding extra details, and managing its visibility in your store and other channels.', 'woocommerce' ),
),
)
);
$product_catalog_section->add_block(
array(
'id' => 'product-categories',
'blockName' => 'woocommerce/product-taxonomy-field',
'order' => 10,
'attributes' => array(
'slug' => 'product_cat',
'property' => 'categories',
'label' => __( 'Categories', 'woocommerce' ),
'createTitle' => __( 'Create new category', 'woocommerce' ),
'dialogNameHelpText' => __( 'Shown to customers on the product page.', 'woocommerce' ),
'parentTaxonomyText' => __( 'Parent category', 'woocommerce' ),
'placeholder' => __( 'Search or create categories…', 'woocommerce' ),
),
)
);
$product_catalog_section->add_block(
array(
'id' => 'product-tags',
'blockName' => 'woocommerce/product-tag-field',
'attributes' => array(
'name' => 'tags',
),
)
);
$product_catalog_section->add_block(
array(
'id' => 'product-catalog-search-visibility',
'blockName' => 'woocommerce/product-catalog-visibility-field',
'order' => 20,
'attributes' => array(
'label' => __( 'Hide in product catalog', 'woocommerce' ),
'visibility' => CatalogVisibility::SEARCH,
),
)
);
$product_catalog_section->add_block(
array(
'id' => 'product-catalog-catalog-visibility',
'blockName' => 'woocommerce/product-catalog-visibility-field',
'order' => 30,
'attributes' => array(
'label' => __( 'Hide from search results', 'woocommerce' ),
'visibility' => CatalogVisibility::CATALOG,
),
)
);
$product_catalog_section->add_block(
array(
'id' => 'product-enable-product-reviews',
'blockName' => 'woocommerce/product-checkbox-field',
'order' => 40,
'attributes' => array(
'label' => __( 'Enable product reviews', 'woocommerce' ),
'property' => 'reviews_allowed',
),
)
);
$product_catalog_section->add_block(
array(
'id' => 'product-post-password',
'blockName' => 'woocommerce/product-password-field',
'order' => 50,
'attributes' => array(
'label' => __( 'Require a password', 'woocommerce' ),
),
)
);
// Attributes section.
$product_attributes_section = $organization_group->add_section(
array(
'id' => 'product-attributes-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Attributes', 'woocommerce' ),
'description' => __( 'Use global attributes to allow shoppers to filter and search for this product. Use custom attributes to provide detailed product information.', 'woocommerce' ),
'blockGap' => 'unit-40',
),
)
);
$product_attributes_section->add_block(
array(
'id' => 'product-attributes',
'blockName' => 'woocommerce/product-attributes-field',
'order' => 10,
)
);
if ( Features::is_enabled( 'product-custom-fields' ) ) {
$organization_group->add_section(
array(
'id' => 'product-custom-fields-wrapper-section',
'order' => 30,
)
)->add_block(
array(
'id' => 'product-custom-fields-toggle',
'blockName' => 'woocommerce/product-custom-fields-toggle-field',
'order' => 10,
'attributes' => array(
'label' => __( 'Show custom fields', 'woocommerce' ),
),
)
)->add_block(
array(
'id' => 'product-custom-fields-section',
'blockName' => 'woocommerce/product-section',
'order' => 10,
'attributes' => array(
'blockGap' => 'unit-30',
'title' => __( 'Custom fields', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: Custom fields guide link opening tag. %2$s: Custom fields guide link closing tag. */
__( 'Custom fields can be used in a variety of ways, such as sharing more detailed product information, showing more input fields, or for internal inventory organization. %1$sRead more about custom fields%2$s', 'woocommerce' ),
'',
''
),
),
)
)->add_block(
array(
'id' => 'product-custom-fields',
'blockName' => 'woocommerce/product-custom-fields',
'order' => 10,
)
);
}
}
/**
* Get the tax classes as select options.
*
* @param string $post_type The post type.
* @return array Array of options.
*/
public static function get_tax_classes( $post_type = 'product' ) {
$tax_classes = array();
if ( 'product_variation' === $post_type ) {
$tax_classes[] = array(
'label' => __( 'Same as main product', 'woocommerce' ),
'value' => 'parent',
);
}
// Add standard class.
$tax_classes[] = array(
'label' => __( 'Standard rate', 'woocommerce' ),
'value' => '',
);
$classes = WC_Tax::get_tax_rate_classes();
foreach ( $classes as $tax_class ) {
$tax_classes[] = array(
'label' => $tax_class->name,
'value' => $tax_class->slug,
);
}
return $tax_classes;
}
/**
* Adds the inventory group blocks to the template.
*/
private function add_inventory_group_blocks() {
$inventory_group = $this->get_group_by_id( $this::GROUP_IDS['INVENTORY'] );
$inventory_group->add_block(
array(
'id' => 'product_variation_notice_inventory_tab',
'blockName' => 'woocommerce/product-has-variations-notice',
'order' => 10,
'attributes' => array(
'content' => __( 'This product has options, such as size or color. You can now manage each variation\'s inventory and other details individually.', 'woocommerce' ),
'buttonText' => __( 'Go to Variations', 'woocommerce' ),
'type' => 'info',
),
)
);
// Product Inventory Section.
$product_inventory_section = $inventory_group->add_section(
array(
'id' => 'product-inventory-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Inventory', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: Inventory settings link opening tag. %2$s: Inventory settings link closing tag.*/
__( 'Set up and manage inventory for this product, including status and available quantity. %1$sManage store inventory settings%2$s', 'woocommerce' ),
'',
''
),
'blockGap' => 'unit-40',
),
)
);
$product_inventory_inner_section = $product_inventory_section->add_subsection(
array(
'id' => 'product-inventory-inner-section',
'order' => 10,
)
);
$inventory_columns = $product_inventory_inner_section->add_block(
array(
'id' => 'product-inventory-inner-columns',
'blockName' => 'core/columns',
)
);
$inventory_columns->add_block(
array(
'id' => 'product-inventory-inner-column1',
'blockName' => 'core/column',
)
)->add_block(
array(
'id' => 'product-sku-field',
'blockName' => 'woocommerce/product-sku-field',
'order' => 10,
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
),
)
);
$inventory_columns->add_block(
array(
'id' => 'product-inventory-inner-column2',
'blockName' => 'core/column',
)
)->add_block(
array(
'id' => 'product-unique-id-field',
'blockName' => 'woocommerce/product-text-field',
'order' => 20,
'attributes' => array(
'property' => 'global_unique_id',
// translators: %1$s GTIN %2$s UPC %3$s EAN %4$s ISBN.
'label' => sprintf( __( '%1$s, %2$s, %3$s, or %4$s', 'woocommerce' ), '' . esc_html__( 'GTIN', 'woocommerce' ) . '', '' . esc_html__( 'UPC', 'woocommerce' ) . '', '' . esc_html__( 'EAN', 'woocommerce' ) . '', '' . esc_html__( 'ISBN', 'woocommerce' ) . '' ),
'tooltip' => __( 'Enter a barcode or any other identifier unique to this product. It can help you list this product on other channels or marketplaces.', 'woocommerce' ),
'pattern' => array(
'value' => '[0-9\-]*',
'message' => __( 'Please enter only numbers and hyphens (-).', 'woocommerce' ),
),
),
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
),
)
);
$manage_stock = 'yes' === get_option( 'woocommerce_manage_stock' );
$product_inventory_inner_section->add_block(
array(
'id' => 'product-track-stock',
'blockName' => 'woocommerce/product-toggle-field',
'order' => 20,
'attributes' => array(
'label' => __( 'Track inventory', 'woocommerce' ),
'property' => 'manage_stock',
'disabled' => ! $manage_stock,
'disabledCopy' => ! $manage_stock ? sprintf(
/* translators: %1$s: Learn more link opening tag. %2$s: Learn more link closing tag.*/
__( 'Per your %1$sstore settings%2$s, inventory management is disabled.', 'woocommerce' ),
'',
''
) : null,
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.type === "external" || editedProduct.type === "grouped"',
),
),
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
),
)
);
$product_inventory_quantity_hide_conditions = array(
array(
'expression' => 'editedProduct.manage_stock === false',
),
);
$product_inventory_quantity_hide_conditions[] = array(
'expression' => 'editedProduct.type === "grouped"',
);
$product_inventory_inner_section->add_block(
array(
'id' => 'product-inventory-quantity',
'blockName' => 'woocommerce/product-inventory-quantity-field',
'order' => 30,
'hideConditions' => $product_inventory_quantity_hide_conditions,
)
);
$product_stock_status_hide_conditions = array(
array(
'expression' => 'editedProduct.manage_stock === true',
),
);
$product_stock_status_hide_conditions[] = array(
'expression' => 'editedProduct.type === "grouped"',
);
$product_inventory_section->add_block(
array(
'id' => 'product-stock-status',
'blockName' => 'woocommerce/product-radio-field',
'order' => 10,
'attributes' => array(
'title' => __( 'Stock status', 'woocommerce' ),
'property' => 'stock_status',
'options' => array(
array(
'label' => __( 'In stock', 'woocommerce' ),
'value' => ProductStockStatus::IN_STOCK,
),
array(
'label' => __( 'Out of stock', 'woocommerce' ),
'value' => ProductStockStatus::OUT_OF_STOCK,
),
array(
'label' => __( 'On backorder', 'woocommerce' ),
'value' => ProductStockStatus::ON_BACKORDER,
),
),
),
'hideConditions' => $product_stock_status_hide_conditions,
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
),
)
);
$product_inventory_section->add_block(
array(
'id' => 'product-purchase-note',
'blockName' => 'woocommerce/product-text-area-field',
'order' => 20,
'attributes' => array(
'property' => 'purchase_note',
'label' => __( 'Post-purchase note', 'woocommerce' ),
'placeholder' => __( 'Enter an optional note attached to the order confirmation message sent to the shopper.', 'woocommerce' ),
'lock' => array(
'move' => true,
),
),
)
);
$product_inventory_advanced = $product_inventory_section->add_block(
array(
'id' => 'product-inventory-advanced',
'blockName' => 'woocommerce/product-collapsible',
'order' => 30,
'attributes' => array(
'toggleText' => __( 'Advanced', 'woocommerce' ),
'initialCollapsed' => true,
'persistRender' => true,
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.type === "grouped"',
),
),
)
);
$product_inventory_advanced_wrapper = $product_inventory_advanced->add_block(
array(
'blockName' => 'woocommerce/product-section',
'order' => 10,
'attributes' => array(
'blockGap' => 'unit-40',
),
)
);
$product_inventory_advanced_wrapper->add_block(
array(
'id' => 'product-out-of-stock',
'blockName' => 'woocommerce/product-radio-field',
'order' => 10,
'attributes' => array(
'title' => __( 'When out of stock', 'woocommerce' ),
'property' => 'backorders',
'options' => array(
array(
'label' => __( 'Allow purchases', 'woocommerce' ),
'value' => 'yes',
),
array(
'label' => __(
'Allow purchases, but notify customers',
'woocommerce'
),
'value' => 'notify',
),
array(
'label' => __( "Don't allow purchases", 'woocommerce' ),
'value' => 'no',
),
),
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.manage_stock === false',
),
),
)
);
$product_inventory_advanced_wrapper->add_block(
array(
'id' => 'product-inventory-email',
'blockName' => 'woocommerce/product-inventory-email-field',
'order' => 20,
'hideConditions' => array(
array(
'expression' => 'editedProduct.manage_stock === false',
),
),
)
);
$product_inventory_advanced_wrapper->add_block(
array(
'id' => 'product-limit-purchase',
'blockName' => 'woocommerce/product-checkbox-field',
'order' => 20,
'attributes' => array(
'title' => __(
'Restrictions',
'woocommerce'
),
'label' => __(
'Limit purchases to 1 item per order',
'woocommerce'
),
'property' => 'sold_individually',
'tooltip' => __(
'When checked, customers will be able to purchase only 1 item in a single order. This is particularly useful for items that have limited quantity, like art or handmade goods.',
'woocommerce'
),
),
)
);
}
/**
* Adds the shipping group blocks to the template.
*/
private function add_shipping_group_blocks() {
$shipping_group = $this->get_group_by_id( $this::GROUP_IDS['SHIPPING'] );
$shipping_group->add_block(
array(
'id' => 'product_variation_notice_shipping_tab',
'blockName' => 'woocommerce/product-has-variations-notice',
'order' => 10,
'attributes' => array(
'content' => __( 'This product has options, such as size or color. You can now manage each variation\'s shipping settings and other details individually.', 'woocommerce' ),
'buttonText' => __( 'Go to Variations', 'woocommerce' ),
'type' => 'info',
),
)
);
// Virtual section.
$shipping_group->add_section(
array(
'id' => 'product-virtual-section',
'order' => 10,
'hideConditions' => array(
array(
'expression' => 'editedProduct.type !== "simple"',
),
),
)
)->add_block(
array(
'id' => 'product-virtual',
'blockName' => 'woocommerce/product-toggle-field',
'order' => 10,
'attributes' => array(
'property' => 'virtual',
'checkedValue' => false,
'uncheckedValue' => true,
'label' => __( 'This product requires shipping or pickup', 'woocommerce' ),
'uncheckedHelp' => __( 'This product will not trigger your customer\'s shipping calculator in cart or at checkout. This product also won\'t require your customers to enter their shipping details at checkout. Read more about virtual products.', 'woocommerce' ),
),
)
);
// Product Shipping Section.
$product_fee_and_dimensions_section = $shipping_group->add_section(
array(
'id' => 'product-fee-and-dimensions-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Fees & dimensions', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: How to get started? link opening tag. %2$s: How to get started? link closing tag.*/
__( 'Set up shipping costs and enter dimensions used for accurate rate calculations. %1$sHow to get started?%2$s', 'woocommerce' ),
'',
''
),
),
)
);
$product_fee_and_dimensions_section->add_block(
array(
'id' => 'product-shipping-class',
'blockName' => 'woocommerce/product-shipping-class-field',
'order' => 10,
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
),
)
);
$product_fee_and_dimensions_section->add_block(
array(
'id' => 'product-shipping-dimensions',
'blockName' => 'woocommerce/product-shipping-dimensions-fields',
'order' => 20,
'disableConditions' => array(
array(
'expression' => 'editedProduct.type === "variable"',
),
),
)
);
}
/**
* Adds the variation group blocks to the template.
*/
private function add_variation_group_blocks() {
$variation_group = $this->get_group_by_id( $this::GROUP_IDS['VARIATIONS'] );
if ( ! $variation_group ) {
return;
}
$variation_group->add_section(
array(
'id' => 'product-variation-options-section',
'order' => 10,
'attributes' => array(
'title' => __( 'Variation options', 'woocommerce' ),
'description' => __( 'Add and manage attributes used for product options, such as size and color.', 'woocommerce' ),
),
)
)->add_block(
array(
'id' => 'product-variation-options',
'blockName' => 'woocommerce/product-variations-options-field',
'order' => 10,
)
);
$variation_group->add_section(
array(
'id' => 'product-variation-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Variations', 'woocommerce' ),
'description' => __( 'Manage individual product combinations created from options.', 'woocommerce' ),
),
)
)->add_block(
array(
'id' => 'product-variation-items',
'blockName' => 'woocommerce/product-variation-items-field',
'order' => 10,
)
);
}
/**
* Adds the linked products group blocks to the template.
*/
private function add_linked_products_group_blocks() {
$linked_products_group = $this->get_group_by_id( $this::GROUP_IDS['LINKED_PRODUCTS'] );
if ( ! isset( $linked_products_group ) ) {
return;
}
$linked_products_group->add_section(
array(
'id' => 'product-linked-upsells-section',
'order' => 10,
'attributes' => array(
'title' => __( 'Upsells', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: "Learn more about linked products" link opening tag. %2$s: "Learn more about linked products" link closing tag. */
__( 'Upsells are typically products that are extra profitable or better quality or more expensive. Experiment with combinations to boost sales. %1$sLearn more about linked products%2$s', 'woocommerce' ),
' ',
''
),
),
)
)->add_block(
array(
'id' => 'product-linked-upsells',
'blockName' => 'woocommerce/product-linked-list-field',
'order' => 10,
'attributes' => array(
'property' => 'upsell_ids',
'emptyState' => array(
'image' => 'ShoppingBags',
'tip' => __(
'Tip: Upsells are products that are extra profitable or better quality or more expensive. Experiment with combinations to boost sales.',
'woocommerce'
),
'isDismissible' => true,
),
),
)
);
$linked_products_group->add_section(
array(
'id' => 'product-linked-cross-sells-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Cross-sells', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: "Learn more about linked products" link opening tag. %2$s: "Learn more about linked products" link closing tag. */
__( 'By suggesting complementary products in the cart using cross-sells, you can significantly increase the average order value. %1$sLearn more about linked products%2$s', 'woocommerce' ),
' ',
''
),
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.type === "external" || editedProduct.type === "grouped"',
),
),
)
)->add_block(
array(
'id' => 'product-linked-cross-sells',
'blockName' => 'woocommerce/product-linked-list-field',
'order' => 10,
'attributes' => array(
'property' => 'cross_sell_ids',
'emptyState' => array(
'image' => 'CashRegister',
'tip' => __(
'Tip: By suggesting complementary products in the cart using cross-sells, you can significantly increase the average order value.',
'woocommerce'
),
'isDismissible' => true,
),
),
)
);
}
}
PK [1] ; Features/ProductBlockEditor/ProductTemplates/Subsection.phpnu 'woocommerce/product-subsection' ), $config ), $root_template, $parent );
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
}
PK [1]QM͈ 8 Features/ProductBlockEditor/ProductTemplates/Section.phpnu 'woocommerce/product-section' ), $config ), $root_template, $parent );
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
/**
* Add a sub-section block type to this template.
*
* @param array $block_config The block data.
*/
public function add_subsection( array $block_config ): SubsectionInterface {
$block = new Subsection( $block_config, $this->get_root_template(), $this );
return $this->add_inner_block( $block );
}
/**
* Add a sub-section block type to this template.
*
* @deprecated 8.6.0
*
* @param array $block_config The block data.
*/
public function add_section( array $block_config ): SubsectionInterface {
wc_deprecated_function( 'add_section', '8.6.0', 'add_subsection' );
return $this->add_subsection( $block_config );
}
}
PK [1]Vؚ L Features/ProductBlockEditor/ProductTemplates/AbstractProductFormTemplate.phpnu get_block( $group_id );
if ( $group && ! $group instanceof GroupInterface ) {
throw new \UnexpectedValueException( 'Block with specified ID is not a group.' );
}
return $group;
}
/**
* Get a section block by ID.
*
* @param string $section_id The section block ID.
* @throws \UnexpectedValueException If block is not of type SectionInterface.
*/
public function get_section_by_id( string $section_id ): ?SectionInterface {
$section = $this->get_block( $section_id );
if ( $section && ! $section instanceof SectionInterface ) {
throw new \UnexpectedValueException( 'Block with specified ID is not a section.' );
}
return $section;
}
/**
* Get a subsection block by ID.
*
* @param string $subsection_id The subsection block ID.
* @throws \UnexpectedValueException If block is not of type SubsectionInterface.
*/
public function get_subsection_by_id( string $subsection_id ): ?SubsectionInterface {
$subsection = $this->get_block( $subsection_id );
if ( $subsection && ! $subsection instanceof SubsectionInterface ) {
throw new \UnexpectedValueException( 'Block with specified ID is not a subsection.' );
}
return $subsection;
}
/**
* Get a block by ID.
*
* @param string $block_id The block block ID.
*/
public function get_block_by_id( string $block_id ): ?BlockInterface {
return $this->get_block( $block_id );
}
/**
* Add a custom block type to this template.
*
* @param array $block_config The block data.
*/
public function add_group( array $block_config ): GroupInterface {
$block = new Group( $block_config, $this->get_root_template(), $this );
return $this->add_inner_block( $block );
}
}
PK [1]P;V V = Features/ProductBlockEditor/ProductTemplates/ProductBlock.phpnu get_root_template(), $this );
return $this->add_inner_block( $block );
}
}
PK [1]MeA A I Features/ProductBlockEditor/ProductTemplates/ProductVariationTemplate.phpnu 'general',
'PRICING' => 'pricing',
'INVENTORY' => 'inventory',
'SHIPPING' => 'shipping',
);
/**
* The option name used check whether the single variation notice has been dismissed.
*/
const SINGLE_VARIATION_NOTICE_DISMISSED_OPTION = 'woocommerce_single_variation_notice_dismissed';
/**
* ProductVariationTemplate constructor.
*/
public function __construct() {
$this->add_group_blocks();
$this->add_general_group_blocks();
$this->add_inventory_group_blocks();
$this->add_shipping_group_blocks();
}
/**
* Get the template ID.
*/
public function get_id(): string {
return 'product-variation';
}
/**
* Get the template title.
*/
public function get_title(): string {
return __( 'Product Variation Template', 'woocommerce' );
}
/**
* Get the template description.
*/
public function get_description(): string {
return __( 'Template for the product variation form', 'woocommerce' );
}
/**
* Adds the group blocks to the template.
*/
protected function add_group_blocks() {
$this->add_group(
array(
'id' => $this::GROUP_IDS['GENERAL'],
'order' => 10,
'attributes' => array(
'title' => __( 'General', 'woocommerce' ),
),
)
);
$this->add_group(
array(
'id' => $this::GROUP_IDS['INVENTORY'],
'order' => 30,
'attributes' => array(
'title' => __( 'Inventory', 'woocommerce' ),
),
)
);
$this->add_group(
array(
'id' => $this::GROUP_IDS['SHIPPING'],
'order' => 40,
'attributes' => array(
'title' => __( 'Shipping', 'woocommerce' ),
),
)
);
}
/**
* Adds the general group blocks to the template.
*/
protected function add_general_group_blocks() {
$is_calc_taxes_enabled = wc_tax_enabled();
$general_group = $this->get_group_by_id( $this::GROUP_IDS['GENERAL'] );
$general_group->add_block(
array(
'id' => 'general-single-variation-notice',
'blockName' => 'woocommerce/product-single-variation-notice',
'order' => 10,
'attributes' => array(
'content' => __( 'You’re editing details specific to this variation. Some information, like description and images, will be inherited from the main product, .', 'woocommerce' ),
'type' => 'info',
'isDismissible' => true,
'name' => $this::SINGLE_VARIATION_NOTICE_DISMISSED_OPTION,
),
)
);
// Basic Details Section.
$basic_details = $general_group->add_section(
array(
'id' => 'product-variation-details-section',
'order' => 10,
'attributes' => array(
'title' => __( 'Variation details', 'woocommerce' ),
'description' => __( 'This info will be displayed on the product page, category pages, social media, and search results.', 'woocommerce' ),
),
)
);
// Product Pricing columns.
$pricing_columns = $basic_details->add_block(
array(
'id' => 'product-pricing-group-pricing-columns',
'blockName' => 'core/columns',
'order' => 10,
)
);
$pricing_column_1 = $pricing_columns->add_block(
array(
'id' => 'product-pricing-group-pricing-column-1',
'blockName' => 'core/column',
'order' => 10,
'attributes' => array(
'templateLock' => 'all',
),
)
);
$pricing_column_1->add_block(
array(
'id' => 'product-pricing-regular-price',
'blockName' => 'woocommerce/product-regular-price-field',
'order' => 10,
'attributes' => array(
'name' => 'regular_price',
'label' => __( 'Regular price', 'woocommerce' ),
'isRequired' => true,
'help' => $is_calc_taxes_enabled ? null : sprintf(
/* translators: %1$s: store settings link opening tag. %2$s: store settings link closing tag.*/
__( 'Per your %1$sstore settings%2$s, taxes are not enabled.', 'woocommerce' ),
'',
''
),
),
)
);
$pricing_column_2 = $pricing_columns->add_block(
array(
'id' => 'product-pricing-group-pricing-column-2',
'blockName' => 'core/column',
'order' => 20,
'attributes' => array(
'templateLock' => 'all',
),
)
);
$pricing_column_2->add_block(
array(
'id' => 'product-pricing-sale-price',
'blockName' => 'woocommerce/product-sale-price-field',
'order' => 10,
'attributes' => array(
'label' => __( 'Sale price', 'woocommerce' ),
),
)
);
$basic_details->add_block(
array(
'id' => 'product-pricing-schedule-sale-fields',
'blockName' => 'woocommerce/product-schedule-sale-fields',
'order' => 20,
)
);
if ( $is_calc_taxes_enabled ) {
$basic_details->add_block(
array(
'id' => 'product-tax-class',
'blockName' => 'woocommerce/product-select-field',
'order' => 40,
'attributes' => array(
'label' => __( 'Tax class', 'woocommerce' ),
'help' => sprintf(
/* translators: %1$s: Learn more link opening tag. %2$s: Learn more link closing tag.*/
__( 'Apply a tax rate if this product qualifies for tax reduction or exemption. %1$sLearn more%2$s', 'woocommerce' ),
'',
''
),
'property' => 'tax_class',
'options' => SimpleProductTemplate::get_tax_classes( 'product_variation' ),
),
)
);
}
$basic_details->add_block(
array(
'id' => 'product-variation-note',
'blockName' => 'woocommerce/product-text-area-field',
'order' => 20,
'attributes' => array(
'property' => 'description',
'label' => __( 'Note', 'woocommerce' ),
'help' => 'Enter an optional note displayed on the product page when customers select this variation.',
'lock' => array(
'move' => true,
),
),
)
);
$basic_details->add_block(
array(
'id' => 'product-variation-visibility',
'blockName' => 'woocommerce/product-checkbox-field',
'order' => 30,
'attributes' => array(
'property' => 'status',
'label' => __( 'Hide in product catalog', 'woocommerce' ),
'checkedValue' => 'private',
'uncheckedValue' => 'publish',
),
)
);
// Images section.
$images_section = $general_group->add_section(
array(
'id' => 'product-variation-images-section',
'order' => 30,
'attributes' => array(
'title' => __( 'Image', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: Images guide link opening tag. %2$s: Images guide link closing tag. */
__( 'Drag images, upload new ones or select files from your library. For best results, use JPEG files that are 1000 by 1000 pixels or larger. %1$sHow to prepare images?%2$s', 'woocommerce' ),
'',
''
),
),
)
);
$images_section->add_block(
array(
'id' => 'product-variation-image',
'blockName' => 'woocommerce/product-images-field',
'order' => 10,
'attributes' => array(
'property' => 'image',
'multiple' => false,
),
)
);
// Downloads section.
$this->add_downloadable_product_blocks( $general_group );
}
/**
* Adds the inventory group blocks to the template.
*/
protected function add_inventory_group_blocks() {
$inventory_group = $this->get_group_by_id( $this::GROUP_IDS['INVENTORY'] );
$inventory_group->add_block(
array(
'id' => 'inventory-single-variation-notice',
'blockName' => 'woocommerce/product-single-variation-notice',
'order' => 10,
'attributes' => array(
'content' => __( 'You’re editing details specific to this variation. Some information, like description and images, will be inherited from the main product, .', 'woocommerce' ),
'type' => 'info',
'isDismissible' => true,
'name' => $this::SINGLE_VARIATION_NOTICE_DISMISSED_OPTION,
),
)
);
// Product Inventory Section.
$product_inventory_section = $inventory_group->add_section(
array(
'id' => 'product-variation-inventory-section',
'order' => 20,
'attributes' => array(
'title' => __( 'Inventory', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: Inventory settings link opening tag. %2$s: Inventory settings link closing tag.*/
__( 'Set up and manage inventory for this product, including status and available quantity. %1$sManage store inventory settings%2$s', 'woocommerce' ),
'',
''
),
'blockGap' => 'unit-40',
),
)
);
$product_inventory_inner_section = $product_inventory_section->add_subsection(
array(
'id' => 'product-variation-inventory-inner-section',
'order' => 10,
)
);
$inventory_columns = $product_inventory_inner_section->add_block(
array(
'id' => 'product-inventory-inner-columns',
'blockName' => 'core/columns',
)
);
$inventory_columns->add_block(
array(
'id' => 'product-inventory-inner-column1',
'blockName' => 'core/column',
)
)->add_block(
array(
'id' => 'product-variation-sku-field',
'blockName' => 'woocommerce/product-sku-field',
'order' => 10,
)
);
$inventory_columns->add_block(
array(
'id' => 'product-inventory-inner-column2',
'blockName' => 'core/column',
)
)->add_block(
array(
'id' => 'product-unique-id-field',
'blockName' => 'woocommerce/product-text-field',
'order' => 20,
'attributes' => array(
'property' => 'global_unique_id',
// translators: %1$s GTIN %2$s UPC %3$s EAN %4$s ISBN.
'label' => sprintf( __( '%1$s, %2$s, %3$s, or %4$s', 'woocommerce' ), '' . esc_html__( 'GTIN', 'woocommerce' ) . '', '' . esc_html__( 'UPC', 'woocommerce' ) . '', '' . esc_html__( 'EAN', 'woocommerce' ) . '', '' . esc_html__( 'ISBN', 'woocommerce' ) . '' ),
'tooltip' => __( 'Enter a barcode or any other identifier unique to this product. It can help you list this product on other channels or marketplaces.', 'woocommerce' ),
'pattern' => array(
'value' => '[0-9\-]*',
'message' => __( 'Please enter only numbers and hyphens (-).', 'woocommerce' ),
),
),
)
);
$product_inventory_inner_section->add_block(
array(
'id' => 'product-variation-track-stock',
'blockName' => 'woocommerce/product-toggle-field',
'order' => 20,
'attributes' => array(
'label' => __( 'Track inventory', 'woocommerce' ),
'property' => 'manage_stock',
'disabled' => 'yes' !== get_option( 'woocommerce_manage_stock' ),
'disabledCopy' => sprintf(
/* translators: %1$s: Learn more link opening tag. %2$s: Learn more link closing tag.*/
__( 'Per your %1$sstore settings%2$s, inventory management is disabled.', 'woocommerce' ),
'',
''
),
),
)
);
$product_inventory_inner_section->add_block(
array(
'id' => 'product-variation-inventory-quantity',
'blockName' => 'woocommerce/product-inventory-quantity-field',
'order' => 10,
'hideConditions' => array(
array(
'expression' => 'editedProduct.manage_stock === false',
),
),
)
);
$product_inventory_section->add_block(
array(
'id' => 'product-variation-stock-status',
'blockName' => 'woocommerce/product-radio-field',
'order' => 10,
'attributes' => array(
'title' => __( 'Stock status', 'woocommerce' ),
'property' => 'stock_status',
'options' => array(
array(
'label' => __( 'In stock', 'woocommerce' ),
'value' => ProductStockStatus::IN_STOCK,
),
array(
'label' => __( 'Out of stock', 'woocommerce' ),
'value' => ProductStockStatus::OUT_OF_STOCK,
),
array(
'label' => __( 'On backorder', 'woocommerce' ),
'value' => ProductStockStatus::ON_BACKORDER,
),
),
),
'hideConditions' => array(
array(
'expression' => 'editedProduct.manage_stock === true',
),
),
)
);
}
/**
* Adds the shipping group blocks to the template.
*/
protected function add_shipping_group_blocks() {
$shipping_group = $this->get_group_by_id( $this::GROUP_IDS['SHIPPING'] );
$shipping_group->add_block(
array(
'id' => 'shipping-single-variation-notice',
'blockName' => 'woocommerce/product-single-variation-notice',
'order' => 10,
'attributes' => array(
'content' => __( 'You’re editing details specific to this variation. Some information, like description and images, will be inherited from the main product, .', 'woocommerce' ),
'type' => 'info',
'isDismissible' => true,
'name' => $this::SINGLE_VARIATION_NOTICE_DISMISSED_OPTION,
),
)
);
// Virtual section.
$shipping_group->add_section(
array(
'id' => 'product-variation-virtual-section',
'order' => 20,
)
)->add_block(
array(
'id' => 'product-variation-virtual',
'blockName' => 'woocommerce/product-toggle-field',
'order' => 10,
'attributes' => array(
'property' => 'virtual',
'checkedValue' => false,
'uncheckedValue' => true,
'label' => __( 'This variation requires shipping or pickup', 'woocommerce' ),
'uncheckedHelp' => __( 'This variation will not trigger your customer\'s shipping calculator in cart or at checkout. This product also won\'t require your customers to enter their shipping details at checkout. Read more about virtual products.', 'woocommerce' ),
),
)
);
// Product Shipping Section.
$product_fee_and_dimensions_section = $shipping_group->add_section(
array(
'id' => 'product-variation-fee-and-dimensions-section',
'order' => 30,
'attributes' => array(
'title' => __( 'Fees & dimensions', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: How to get started? link opening tag. %2$s: How to get started? link closing tag.*/
__( 'Set up shipping costs and enter dimensions used for accurate rate calculations. %1$sHow to get started?%2$s', 'woocommerce' ),
'',
''
),
),
)
);
$product_fee_and_dimensions_section->add_block(
array(
'id' => 'product-variation-shipping-class',
'blockName' => 'woocommerce/product-shipping-class-field',
'order' => 10,
)
);
$product_fee_and_dimensions_section->add_block(
array(
'id' => 'product-variation-shipping-dimensions',
'blockName' => 'woocommerce/product-shipping-dimensions-fields',
'order' => 20,
)
);
}
}
PK [1]xB 6 Features/ProductBlockEditor/ProductTemplates/Group.phpnu 'woocommerce/product-tab' ), $config ), $root_template, $parent );
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
/**
* Add a section block type to this template.
*
* @param array $block_config The block data.
*/
public function add_section( array $block_config ): SectionInterface {
$block = new Section( $block_config, $this->get_root_template(), $this );
return $this->add_inner_block( $block );
}
}
PK [1][P P Features/FeaturesController.phpnu registered_additional_features_via_action ) {
if ( did_action( 'before_woocommerce_init' ) ) {
// Needed for unit tests, where 'before_woocommerce_init' will have been fired already at this point.
$this->register_additional_features();
} else {
// This needs to have a higher $priority than the 'before_woocommerce_init' hooked by plugins that declare compatibility.
add_filter( 'before_woocommerce_init', array( $this, 'register_additional_features' ), -9999, 0 );
}
}
if ( did_action( 'init' ) ) {
// Needed for unit tests, where 'init' will have been fired already at this point.
$this->start_listening_for_option_changes();
} else {
add_filter( 'init', array( $this, 'start_listening_for_option_changes' ), 10, 0 );
}
add_filter( 'woocommerce_get_sections_advanced', array( $this, 'add_features_section' ), 10, 1 );
add_filter( 'woocommerce_get_settings_advanced', array( $this, 'add_feature_settings' ), 10, 2 );
add_filter( 'deactivated_plugin', array( $this, 'handle_plugin_deactivation' ), 10, 1 );
add_filter( 'all_plugins', array( $this, 'filter_plugins_list' ), 10, 1 );
add_action( 'admin_notices', array( $this, 'display_notices_in_plugins_page' ), 10, 0 );
add_action( 'load-plugins.php', array( $this, 'maybe_invalidate_cached_plugin_data' ) );
add_action( 'after_plugin_row', array( $this, 'handle_plugin_list_rows' ), 10, 2 );
add_action( 'current_screen', array( $this, 'enqueue_script_to_fix_plugin_list_html' ), 10, 1 );
add_filter( 'views_plugins', array( $this, 'handle_plugins_page_views_list' ), 10, 1 );
add_filter( 'woocommerce_admin_shared_settings', array( $this, 'set_change_feature_enable_nonce' ), 20, 1 );
add_action( 'admin_init', array( $this, 'change_feature_enable_from_query_params' ), 20, 0 );
add_action( self::FEATURE_ENABLED_CHANGED_ACTION, array( $this, 'display_email_improvements_feedback_notice' ), 10, 2 );
}
/**
* Register a feature.
*
* This used to be called during the `woocommerce_register_feature_definitions` action hook,
* now it's called directly from get_feature_definitions as needed.
*
* @param string $slug The ID slug of the feature.
* @param string $name The name of the feature that will appear on the Features screen and elsewhere.
* @param array $args {
* Properties that make up the feature definition. Each of these properties can also be set as a
* callback function, as long as that function returns the specified type.
*
* @type string $default_plugin_compatibility The default plugin compatibility for the feature: either 'compatible' or 'incompatible'. Required.
* @type array[] $additional_settings An array of definitions for additional settings controls related to
* the feature that will display on the Features screen. See the Settings API
* for the schema of these props.
* @type string $description A brief description of the feature, used as an input label if the feature
* setting is a checkbox.
* @type bool $disabled True to disable the setting field for this feature on the Features screen,
* so it can't be changed.
* @type bool $disable_ui Set to true to hide the setting field for this feature on the
* Features screen. Defaults to false.
* @type bool $enabled_by_default Set to true to have this feature by opt-out instead of opt-in.
* Defaults to false.
* @type bool $is_experimental Set to true to display this feature under the "Experimental" heading on
* the Features screen. Features set to experimental are also omitted from
* the features list in some cases. Defaults to true.
* @type bool $skip_compatibility_checks Set to true if the feature should not produce warnings about incompatible plugins.
* Defaults to false.
* @type string $learn_more_url The URL to the learn more page for the feature.
* @type string $option_key The key name for the option that enables/disables the feature.
* @type int $order The order that the feature will appear in the list on the Features screen.
* Higher number = higher in the list. Defaults to 10.
* @type array $setting The properties used by the Settings API to render the setting control on
* the Features screen. See the Settings API for the schema of these props.
* @type string $deprecated_since The WooCommerce version since which this feature is deprecated.
* When set, feature_is_enabled() will force feature value to the deprecated_value
* instead of reading from the database.
* @type bool $deprecated_value The value to return for deprecated features when feature_is_enabled()
* is called. Defaults to false.
* }
*
* @return void
*/
public function add_feature_definition( $slug, $name, array $args = array() ) {
$defaults = array(
'disable_ui' => false,
'enabled_by_default' => false,
'is_experimental' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'skip_compatibility_checks' => false,
'name' => $name,
'order' => 10,
'learn_more_url' => '',
);
if ( empty( $args['default_plugin_compatibility'] ) ) {
wc_doing_it_wrong(
__FUNCTION__,
sprintf(
'Assuming positive compatibility by default will be deprecated in the future. Please set \'default_plugin_compatibility\' for feature "%s".',
esc_html( $slug )
),
'10.3.0'
);
}
$args = wp_parse_args( $args, $defaults );
// Sanitize 'default_plugin_compatibility'.
if ( ! in_array( $args['default_plugin_compatibility'], FeaturePluginCompatibility::VALID_REGISTRATION_VALUES, true ) ) {
$args['default_plugin_compatibility'] = wc_string_to_bool( $args['default_plugin_compatibility'] ) ? FeaturePluginCompatibility::COMPATIBLE : FeaturePluginCompatibility::INCOMPATIBLE;
}
// Support 'is_legacy' flag for backwards compatibility.
if ( ! empty( $args['is_legacy'] ) ) {
$args['skip_compatibility_checks'] = true;
}
$this->features[ $slug ] = $args;
}
/**
* Generate and cache the feature definitions.
*
* @return array[]
*/
private function get_feature_definitions() {
if ( empty( $this->features ) ) {
$this->init_feature_definitions();
}
if ( ! $this->registered_additional_features_via_class_calls ) {
// This needs to be set to true *before* additional feature definition calls are made,
// to prevent infinite loops in case one of these calls ends up calling here again.
$this->registered_additional_features_via_class_calls = true;
// Additional feature definitions.
// These used to be tied to the now deprecated woocommerce_register_feature_definitions action,
// and aren't processed in init_feature_definitions to avoid circular calls in the dependency injection container.
$container = wc_get_container();
$container->get( CustomOrdersTableController::class )->add_feature_definition( $this );
$container->get( CostOfGoodsSoldController::class )->add_feature_definition( $this );
$this->init_compatibility_info_by_feature();
}
return $this->features;
}
/**
* Initialize the hardcoded feature definitions array.
* This doesn't include:
* - Features that get initialized via the (deprecated) woocommerce_register_feature_definitions.
* - Features whose definition comes from another class. These are initialized directly in get_feature_definitions
* to avoid circular calls in the dependency injection container.
*/
private function init_feature_definitions(): void {
$alpha_feature_testing_is_enabled = Constants::is_true( 'WOOCOMMERCE_ENABLE_ALPHA_FEATURE_TESTING' );
$tracking_enabled = WC_Site_Tracking::is_tracking_enabled();
$legacy_features = array(
'analytics' => array(
'name' => __( 'Analytics', 'woocommerce' ),
'description' => __( 'Enable WooCommerce Analytics', 'woocommerce' ),
'option_key' => Analytics::TOGGLE_OPTION_NAME,
'is_experimental' => false,
'enabled_by_default' => true,
'disable_ui' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'product_block_editor' => array(
'name' => __( 'New product editor', 'woocommerce' ),
'description' => __( 'Try the new product editor (Beta)', 'woocommerce' ),
'is_experimental' => true,
'disable_ui' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'cart_checkout_blocks' => array(
'name' => __( 'Cart & Checkout Blocks', 'woocommerce' ),
'description' => __( 'Optimize for faster checkout', 'woocommerce' ),
'is_experimental' => false,
'disable_ui' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'rate_limit_checkout' => array(
'name' => __( 'Rate limit Checkout', 'woocommerce' ),
'description' => sprintf(
// translators: %s is the URL to the rate limiting documentation.
__( 'Enables rate limiting for Checkout place order and Store API /checkout endpoint. To further control this, refer to rate limiting documentation.', 'woocommerce' ),
'https://developer.woocommerce.com/docs/apis/store-api/rate-limiting/'
),
'is_experimental' => false,
'disable_ui' => false,
'enabled_by_default' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'marketplace' => array(
'name' => __( 'Marketplace', 'woocommerce' ),
'description' => __(
'New, faster way to find extensions and themes for your WooCommerce store',
'woocommerce'
),
'is_experimental' => false,
'enabled_by_default' => true,
'disable_ui' => true,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'deprecated_since' => '10.5.0',
'deprecated_value' => true,
),
// Marked as a legacy feature to avoid compatibility checks, which aren't really relevant to this feature.
// https://github.com/woocommerce/woocommerce/pull/39701#discussion_r1376976959.
'order_attribution' => array(
'name' => __( 'Order Attribution', 'woocommerce' ),
'description' => __(
'Enable this feature to track and credit channels and campaigns that contribute to orders on your site',
'woocommerce'
),
'enabled_by_default' => true,
'disable_ui' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_experimental' => false,
),
'site_visibility_badge' => array(
'name' => __( 'Site visibility badge', 'woocommerce' ),
'description' => __(
'Enable the site visibility badge in the WordPress admin bar',
'woocommerce'
),
'enabled_by_default' => true,
'disable_ui' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_experimental' => false,
'disabled' => false,
),
'hpos_fts_indexes' => array(
'name' => __( 'HPOS Full text search indexes', 'woocommerce' ),
'description' => __(
'Create and use full text search indexes for orders. This feature only works with high-performance order storage.',
'woocommerce'
),
'is_experimental' => true,
'enabled_by_default' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'option_key' => CustomOrdersTableController::HPOS_FTS_INDEX_OPTION,
),
'hpos_datastore_caching' => array(
'name' => __( 'HPOS Data Caching', 'woocommerce' ),
'description' => __(
'Enable order data caching in the datastore. This feature only works with high-performance order storage and is recommended for stores using object caching.',
'woocommerce'
),
'is_experimental' => false,
'enabled_by_default' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'disable_ui' => false,
'option_key' => CustomOrdersTableController::HPOS_DATASTORE_CACHING_ENABLED_OPTION,
),
'remote_logging' => array(
'name' => __( 'Remote Logging', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s: opening link tag, %2$s: closing link tag */
__( 'Allow WooCommerce to send error logs and non-sensitive diagnostic data to help improve WooCommerce. This feature requires %1$susage tracking%2$s to be enabled.', 'woocommerce' ),
'',
''
),
'enabled_by_default' => true,
'disable_ui' => false,
/*
* This is not truly a legacy feature (it is not a feature that pre-dates the FeaturesController),
* but we wish to handle compatibility checking in a similar fashion to legacy features. The
* rational for setting legacy to true is therefore similar to that of the 'order_attribution'
* feature.
*
* @see https://github.com/woocommerce/woocommerce/pull/39701#discussion_r1376976959
*/
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_experimental' => false,
'setting' => array(
'disabled' => function () use ( $tracking_enabled ) {
return ! $tracking_enabled;
},
'desc_tip' => function () use ( $tracking_enabled ) {
if ( ! $tracking_enabled ) {
return __( '⚠ Usage tracking must be enabled to use remote logging.', 'woocommerce' );
}
return '';
},
),
),
'email_improvements' => array(
'name' => __( 'Email improvements', 'woocommerce' ),
'description' => __(
'Enable modern email design for transactional emails',
'woocommerce'
),
/*
* This is not truly a legacy feature (it is not a feature that pre-dates the FeaturesController),
* but as this feature doesn't affect all extensions, and the rollout is fairly short,
* we'll skip the compatibility check by marking this as legacy. This is a workaround until
* we can implement a more sophisticated compatibility checking system.
*
* @see https://github.com/woocommerce/woocommerce/issues/39147
* @see https://github.com/woocommerce/woocommerce/issues/55540
*/
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_experimental' => false,
),
'blueprint' => array(
'name' => __( 'Blueprint (beta)', 'woocommerce' ),
'description' => __(
'Enable blueprint to import and export settings in bulk',
'woocommerce'
),
'enabled_by_default' => true,
'disable_ui' => false,
/*
* This is not truly a legacy feature (it is not a feature that pre-dates the FeaturesController),
* but we wish to handle compatibility checking in a similar fashion to legacy features. The
* rational for setting legacy to true is therefore similar to that of the 'order_attribution'
* feature.
*
* @see https://github.com/woocommerce/woocommerce/pull/39701#discussion_r1376976959
*/
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_experimental' => false,
),
'block_email_editor' => array(
'name' => __( 'Block Email Editor (alpha)', 'woocommerce' ),
'description' => __(
'Enable the block-based email editor for transactional emails.',
'woocommerce'
),
'learn_more_url' => 'https://github.com/woocommerce/woocommerce/discussions/52897#discussioncomment-11630256',
/*
* This is not truly a legacy feature (it is not a feature that pre-dates the FeaturesController),
* but we wish to handle compatibility checking in a similar fashion to legacy features. The
* rational for setting legacy to true is therefore similar to that of the 'order_attribution'
* feature.
*
* @see https://github.com/woocommerce/woocommerce/pull/39701#discussion_r1376976959
*/
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'enabled_by_default' => false,
),
'point_of_sale' => array(
'name' => __( 'Point of Sale', 'woocommerce' ),
'description' => __(
'Enable Point of Sale functionality in the WooCommerce mobile apps.',
'woocommerce'
),
'enabled_by_default' => true,
'disable_ui' => false,
/*
* This is not truly a legacy feature (it is not a feature that pre-dates the FeaturesController),
* but we wish to handle compatibility checking in a similar fashion to legacy features. The
* rational for setting legacy to true is therefore similar to that of the 'order_attribution'
* feature.
*
* @see https://github.com/woocommerce/woocommerce/pull/39701#discussion_r1376976959
*/
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_experimental' => true,
),
'fulfillments' => array(
'name' => __( 'Order Fulfillments', 'woocommerce' ),
'description' => __(
'Enable the Order Fulfillments feature to manage order fulfillment and shipping.',
'woocommerce'
),
'enabled_by_default' => false,
'disable_ui' => true,
'is_experimental' => false,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'mcp_integration' => array(
'name' => __( 'WooCommerce MCP', 'woocommerce' ),
'description' => $this->get_mcp_integration_description(),
'enabled_by_default' => false,
'disable_ui' => false,
'is_experimental' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
'is_legacy' => false,
),
'destroy-empty-sessions' => array(
'name' => __( 'Clear Customer Sessions When Empty', 'woocommerce' ),
'description' => __(
'[Performance] Removes session cookies for non-logged in customers when session data is empty, improving page caching performance. May cause compatibility issues with extensions that depend on the session cookie without using session data.',
'woocommerce'
),
'enabled_by_default' => false,
'is_experimental' => true,
'disable_ui' => false,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'agentic_checkout' => array(
'name' => __( 'Agentic Checkout API', 'woocommerce' ),
'description' => __(
'Enable the Agentic Checkout API for AI-powered checkout experiences (e.g., ChatGPT). This adds REST API endpoints that allow AI agents to create and manage checkout sessions.',
'woocommerce'
),
'enabled_by_default' => false,
'is_experimental' => true,
'disable_ui' => true,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
PushNotifications::FEATURE_NAME => array(
'name' => __( 'Push Notifications', 'woocommerce' ),
'description' => __(
'Enable push notifications for the WooCommerce mobile apps to receive order notifications and store updates.',
'woocommerce'
),
'enabled_by_default' => false,
'is_experimental' => true,
'disable_ui' => true,
'skip_compatibility_checks' => false,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
'rest_api_caching' => array(
'name' => __( 'REST API Caching', 'woocommerce' ),
'description' => sprintf(
/* translators: %1$s and %2$s are opening and closing tags */
__( 'Enable backend caching and cache control headers for REST API responses via the RestApiCache trait. ⚙️ %1$sConfiguration%2$s', 'woocommerce' ),
'',
''
),
'enabled_by_default' => false,
'is_experimental' => true,
'disable_ui' => false,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
ProductCacheController::FEATURE_NAME => array(
'name' => __( 'Cache Product Objects', 'woocommerce' ),
'description' => __(
'[Performance] Speeds up your store by caching product objects during each request, preventing duplicate product loads. Can improve page load times on product-heavy pages.',
'woocommerce'
),
'default_plugin_compatibility' => FeaturePluginCompatibility::INCOMPATIBLE,
'enabled_by_default' => false,
'is_experimental' => true,
'disable_ui' => false,
),
'fraud_protection' => array(
'name' => __( 'Fraud protection', 'woocommerce' ),
'description' => __(
'Enable fraud protection features for your store.',
'woocommerce'
),
'enabled_by_default' => false,
'disable_ui' => true,
'is_experimental' => true,
'skip_compatibility_checks' => true,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
),
);
if ( ! $tracking_enabled ) {
// Uncheck the remote logging feature when usage tracking is disabled.
$legacy_features['remote_logging']['setting']['value'] = 'no';
}
foreach ( $legacy_features as $slug => $definition ) {
$this->add_feature_definition( $slug, $definition['name'], $definition );
}
$this->init_compatibility_info_by_feature();
}
/**
* Initialize the compatibility_info_by_feature property after all the features have been added.
*/
private function init_compatibility_info_by_feature() {
foreach ( array_keys( $this->features ) as $feature_id ) {
if ( ! isset( $this->compatibility_info_by_feature[ $feature_id ] ) ) {
$this->compatibility_info_by_feature[ $feature_id ] = array(
FeaturePluginCompatibility::COMPATIBLE => array(),
FeaturePluginCompatibility::INCOMPATIBLE => array(),
);
}
}
}
/**
* Generate the description for the MCP integration feature.
*
* @return string The feature description with conditional permalink warning and documentation link.
*/
private function get_mcp_integration_description() {
$base_description = __( 'Enable WooCommerce MCP (Model Context Protocol) for AI-powered store operations. AI-generated results and actions can be unpredictable - please review before executing in your store.', 'woocommerce' );
// Check permalink structure requirement.
$permalink_structure = get_option( 'permalink_structure' );
if ( empty( $permalink_structure ) ) {
$permalinks_url = admin_url( 'options-permalink.php' );
$permalink_warning = sprintf(
'
%s: %s %s',
__( 'Configuration Required', 'woocommerce' ),
__( 'WordPress permalinks must be set to anything other than "Plain" for MCP to work.', 'woocommerce' ),
$permalinks_url,
__( 'Configure Permalinks', 'woocommerce' )
);
// Add documentation link to permalink warning.
$documentation_link = sprintf(
' %s',
'https://github.com/woocommerce/woocommerce/blob/trunk/docs/features/mcp/README.md',
__( 'Learn more', 'woocommerce' )
);
return $base_description . $permalink_warning . $documentation_link;
}
// Add documentation link.
$documentation_link = sprintf(
' %s',
'https://github.com/woocommerce/woocommerce/blob/trunk/docs/features/mcp/README.md',
__( 'Learn more', 'woocommerce' )
);
return $base_description . $documentation_link;
}
/**
* Function to trigger the (now deprecated) 'woocommerce_register_feature_definitions' hook.
*
* This function must execute immediately before the 'before_woocommerce_init'
* action is fired, so that feature compatibility declarations happening
* in that action find all the features properly declared already.
*
* @internal
*/
public function register_additional_features() {
if ( $this->registered_additional_features_via_action ) {
return;
}
if ( empty( $this->features ) ) {
$this->init_feature_definitions();
}
/**
* The action for registering features.
*
* @since 8.3.0
*
* @param FeaturesController $features_controller The instance of FeaturesController.
*
* @deprecated 9.9.0 Features should be defined directly in get_feature_definitions.
*/
do_action( 'woocommerce_register_feature_definitions', $this );
$this->init_compatibility_info_by_feature();
$this->registered_additional_features_via_action = true;
}
/**
* Initialize the class instance.
*
* @internal
*
* @param LegacyProxy $proxy The instance of LegacyProxy to use.
* @param PluginUtil $plugin_util The instance of PluginUtil to use.
*/
final public function init( LegacyProxy $proxy, PluginUtil $plugin_util ) {
$this->proxy = $proxy;
$this->plugin_util = $plugin_util;
$this->plugins_excluded_from_compatibility_ui = $plugin_util->get_plugins_excluded_from_compatibility_ui();
}
/**
* Get all the existing WooCommerce features.
*
* Returns an associative array where keys are unique feature ids
* and values are arrays with these keys:
*
* - name (string)
* - description (string)
* - is_experimental (bool)
* - is_enabled (bool) (only if $include_enabled_info is passed as true)
*
* @param bool $include_experimental Include also experimental/work in progress features in the list.
* @param bool $include_enabled_info True to include the 'is_enabled' field in the returned features info.
* @returns array An array of information about existing features.
*/
public function get_features( bool $include_experimental = false, bool $include_enabled_info = false ): array {
$features = $this->get_feature_definitions();
if ( ! $include_experimental ) {
$features = array_filter(
$features,
function ( $feature ) {
return ! $feature['is_experimental'];
}
);
}
if ( $include_enabled_info ) {
foreach ( array_keys( $features ) as $feature_id ) {
$is_enabled = false;
// For deprecated features, use the deprecated_value directly without triggering the deprecation notice.
// The deprecation notice should only fire for external code checking feature status, not for internal listing.
if ( ! empty( $features[ $feature_id ]['deprecated_since'] ) ) {
$is_enabled = (bool) ( $features[ $feature_id ]['deprecated_value'] ?? false );
} else {
$is_enabled = $this->feature_is_enabled( $feature_id );
}
$features[ $feature_id ]['is_enabled'] = $is_enabled;
}
}
// We're deprecating the product block editor feature in favor of a v3 coming out.
// We want to hide this setting in the UI for users that don't have it enabled.
// If users have it enabled, we won't hide it until they explicitly disable it.
if ( isset( $features['product_block_editor'] )
&& ! $this->feature_is_enabled( 'product_block_editor' ) ) {
$features['product_block_editor']['disable_ui'] = true;
}
return $features;
}
/**
* Get the default plugin compatibility for a given feature.
*
* @param string $feature_id Feature id to check.
* @return string Either 'compatible' or 'incompatible'.
* @throws \InvalidArgumentException If the feature doesn't exist.
*/
public function get_default_plugin_compatibility( string $feature_id ): string {
$feature = $this->get_feature_definition( $feature_id );
if ( null === $feature ) {
throw new \InvalidArgumentException( esc_html( "The WooCommerce feature '$feature_id' doesn't exist" ) );
}
$default_plugin_compatibility = $feature['default_plugin_compatibility'] ?? FeaturePluginCompatibility::COMPATIBLE;
// Filter below is only fired for backwards compatibility with (now removed) get_plugins_are_incompatible_by_default().
/**
* Filter to determine if plugins that don't declare compatibility nor incompatibility with a given feature
* are to be considered incompatible with that feature.
*
* @param bool $incompatible_by_default Default value, true if plugins are to be considered incompatible by default with the feature.
* @param string $feature_id The feature to check.
*
* @since 9.2.0
*/
$incompatible_by_default = (bool) apply_filters( 'woocommerce_plugins_are_incompatible_with_feature_by_default', FeaturePluginCompatibility::INCOMPATIBLE === $default_plugin_compatibility, $feature_id );
return $incompatible_by_default ? FeaturePluginCompatibility::INCOMPATIBLE : FeaturePluginCompatibility::COMPATIBLE;
}
/**
* Get the definition array for a specific feature.
*
* @param string $feature_id Unique feature id.
* @return array|null The feature definition array, or null if the feature doesn't exist.
*
* @since 10.5.0
*/
public function get_feature_definition( string $feature_id ): ?array {
return $this->get_feature_definitions()[ $feature_id ] ?? null;
}
/**
* Check if a given feature is currently enabled.
*
* Note: This method does not log deprecation notices for deprecated features.
* Deprecation logging is handled by FeaturesUtil::feature_is_enabled() which is the public API.
*
* @param string $feature_id Unique feature id.
* @return bool True if the feature is enabled, false if not or if the feature doesn't exist.
*/
public function feature_is_enabled( string $feature_id ): bool {
$feature = $this->get_feature_definition( $feature_id );
if ( null === $feature ) {
return false;
}
// Handle deprecated features - return the backwards-compatible value.
if ( ! empty( $feature['deprecated_since'] ) ) {
return (bool) ( $feature['deprecated_value'] ?? false );
}
if ( $this->is_preview_email_improvements_enabled( $feature_id ) ) {
return true;
}
$default_value = $this->feature_is_enabled_by_default( $feature_id ) ? 'yes' : 'no';
$value = 'yes' === get_option( $this->feature_enable_option_name( $feature_id ), $default_value );
return $value;
}
/**
* Check if a given feature is enabled by default.
*
* @param string $feature_id Unique feature id.
* @return boolean TRUE if the feature is enabled by default, FALSE otherwise.
*/
private function feature_is_enabled_by_default( string $feature_id ): bool {
$features = $this->get_feature_definitions();
return ! empty( $features[ $feature_id ]['enabled_by_default'] );
}
/**
* Change the enabled/disabled status of a feature.
*
* @param string $feature_id Unique feature id.
* @param bool $enable True to enable the feature, false to disable it.
* @return bool True on success, false if feature doesn't exist or the new value is the same as the old value.
*/
public function change_feature_enable( string $feature_id, bool $enable ): bool {
if ( ! $this->feature_exists( $feature_id ) ) {
return false;
}
return update_option( $this->feature_enable_option_name( $feature_id ), $enable ? 'yes' : 'no', 'on' );
}
/**
* Declare (in)compatibility with a given feature for a given plugin.
*
* This method MUST be executed from inside a handler for the 'before_woocommerce_init' hook.
*
* The plugin name is expected to be in the form 'directory/file.php' and be one of the keys
* of the array returned by 'get_plugins', but this won't be checked. Plugins are expected to use
* FeaturesUtil::declare_compatibility instead, passing the full plugin file path instead of the plugin name.
*
* @param string $feature_id Unique feature id.
* @param string $plugin_file Plugin file path, either full or in the form 'directory/file.php'.
* @param bool $positive_compatibility True if the plugin declares being compatible with the feature, false if it declares being incompatible.
* @return bool True on success, false on error (feature doesn't exist or not inside the required hook).
* @throws \Exception A plugin attempted to declare itself as compatible and incompatible with a given feature at the same time.
*/
public function declare_compatibility( string $feature_id, string $plugin_file, bool $positive_compatibility = true ): bool {
if ( ! $this->proxy->call_function( 'doing_action', 'before_woocommerce_init' ) ) {
$class_and_method = ( new \ReflectionClass( $this ) )->getShortName() . '::' . __FUNCTION__;
/* translators: 1: class::method 2: before_woocommerce_init */
$this->proxy->call_function( 'wc_doing_it_wrong', $class_and_method, sprintf( __( '%1$s should be called inside the %2$s action.', 'woocommerce' ), $class_and_method, 'before_woocommerce_init' ), '7.0' );
return false;
}
if ( ! $this->feature_exists( $feature_id ) ) {
return false;
}
if ( $this->lazy ) {
// Lazy mode: Queue to be normalized later.
$this->pending_declarations[] = array( $feature_id, $plugin_file, $positive_compatibility );
return true;
}
// Late call: Normalize and register immediately.
return $this->register_compatibility_internal( $feature_id, $plugin_file, $positive_compatibility );
}
/**
* Registers compatibility information internally for a given feature and plugin file.
*
* This method normalizes the plugin file path to a plugin ID, handles validation and logging for invalid plugins,
* and registers the compatibility data if valid.
* It updates the internal compatibility arrays, checks for conflicts (e.g., a plugin declaring both
* compatible and incompatible with the same feature), and throws an exception if a conflict is detected.
* Duplicate declarations (same compatibility type) are ignored.
*
* This is an internal helper method and should not be called directly.
*
* @internal For usage by WooCommerce core only. Backwards compatibility not guaranteed.
* @since 10.1.0
*
* @param string $feature_id Unique feature ID.
* @param string $plugin_file Raw plugin file path (full or 'directory/file.php').
* @param bool $positive_compatibility True if declaring compatibility, false if declaring incompatibility.
* @return bool True on successful registration, false if the feature does not exist.
* @throws \Exception If the plugin attempts to declare both compatibility and incompatibility for the same feature.
*/
private function register_compatibility_internal( string $feature_id, string $plugin_file, bool $positive_compatibility ): bool {
if ( ! $this->feature_exists( $feature_id ) ) {
return false;
}
// Normalize and validate plugin file.
$plugin_id = $this->plugin_util->get_wp_plugin_id( $plugin_file );
if ( ! $plugin_id ) {
$logger = $this->proxy->call_function( 'wc_get_logger' );
$logger->error( "FeaturesController: Invalid plugin file '{$plugin_file}' for feature '{$feature_id}'." );
return false;
}
// Register compatibility by plugin.
ArrayUtil::ensure_key_is_array( $this->compatibility_info_by_plugin, $plugin_id );
$key = $positive_compatibility ? FeaturePluginCompatibility::COMPATIBLE : FeaturePluginCompatibility::INCOMPATIBLE;
$opposite_key = $positive_compatibility ? FeaturePluginCompatibility::INCOMPATIBLE : FeaturePluginCompatibility::COMPATIBLE;
ArrayUtil::ensure_key_is_array( $this->compatibility_info_by_plugin[ $plugin_id ], $key );
ArrayUtil::ensure_key_is_array( $this->compatibility_info_by_plugin[ $plugin_id ], $opposite_key );
if ( in_array( $feature_id, $this->compatibility_info_by_plugin[ $plugin_id ][ $opposite_key ], true ) ) {
throw new \Exception( esc_html( "Plugin $plugin_id is trying to declare itself as $key with the '$feature_id' feature, but it already declared itself as $opposite_key" ) );
}
if ( ! in_array( $feature_id, $this->compatibility_info_by_plugin[ $plugin_id ][ $key ], true ) ) {
$this->compatibility_info_by_plugin[ $plugin_id ][ $key ][] = $feature_id;
}
// Register compatibility by feature.
$key = $positive_compatibility ? FeaturePluginCompatibility::COMPATIBLE : FeaturePluginCompatibility::INCOMPATIBLE;
if ( ! in_array( $plugin_id, $this->compatibility_info_by_feature[ $feature_id ][ $key ], true ) ) {
$this->compatibility_info_by_feature[ $feature_id ][ $key ][] = $plugin_id;
}
return true;
}
/**
* Processes any pending compatibility declarations by normalizing plugin file paths
* and registering them internally.
*
* This method is called lazily when compatibility information is queried (via
* get_compatible_features_for_plugin() or get_compatible_plugins_for_feature()).
* It resolves plugin IDs using PluginUtil and logs errors for unrecognized plugins.
* Pending declarations are cleared after processing to avoid redundant work.
*
* @internal For usage by WooCommerce core only. Backwards compatibility not guaranteed.
* @since 10.1.0
* @return void
*/
private function process_pending_declarations(): void {
if ( empty( $this->pending_declarations ) ) {
return;
}
foreach ( $this->pending_declarations as $declaration ) {
list( $feature_id, $plugin_file, $positive_compatibility ) = $declaration;
// Register internally.
$this->register_compatibility_internal( $feature_id, $plugin_file, $positive_compatibility );
}
$this->pending_declarations = array();
$this->lazy = false;
}
/**
* Check whether a feature exists with a given id.
*
* @param string $feature_id The feature id to check.
* @return bool True if the feature exists.
*/
private function feature_exists( string $feature_id ): bool {
$features = $this->get_feature_definitions();
return isset( $features[ $feature_id ] );
}
/**
* Get the ids of the features that a certain plugin has declared compatibility for.
*
* This method can't be called before the 'woocommerce_init' hook is fired.
*
* @param string $plugin_name Plugin name, in the form 'directory/file.php'.
* @param bool $enabled_features_only True to return only names of enabled plugins.
* @param bool $resolve_uncertain True to resolve the uncertain features to compatible or incompatible.
* @return array An array having a 'compatible' and an 'incompatible' key, each holding an array of feature ids.
*/
public function get_compatible_features_for_plugin( string $plugin_name, bool $enabled_features_only = false, bool $resolve_uncertain = false ): array {
$this->process_pending_declarations();
$this->verify_did_woocommerce_init( __FUNCTION__ );
$features = $this->get_feature_definitions();
if ( $enabled_features_only ) {
$features = array_filter(
$features,
array( $this, 'feature_is_enabled' ),
ARRAY_FILTER_USE_KEY
);
}
if ( ! isset( $this->compatibility_info_by_plugin[ $plugin_name ] ) ) {
return array(
FeaturePluginCompatibility::COMPATIBLE => array(),
FeaturePluginCompatibility::INCOMPATIBLE => array(),
FeaturePluginCompatibility::UNCERTAIN => array_keys( $features ),
);
}
$info = $this->compatibility_info_by_plugin[ $plugin_name ];
$info[ FeaturePluginCompatibility::COMPATIBLE ] = array_values( array_intersect( array_keys( $features ), $info[ FeaturePluginCompatibility::COMPATIBLE ] ) );
$info[ FeaturePluginCompatibility::INCOMPATIBLE ] = array_values( array_intersect( array_keys( $features ), $info[ FeaturePluginCompatibility::INCOMPATIBLE ] ) );
$info[ FeaturePluginCompatibility::UNCERTAIN ] = array_values( array_diff( array_keys( $features ), $info[ FeaturePluginCompatibility::COMPATIBLE ], $info[ FeaturePluginCompatibility::INCOMPATIBLE ] ) );
if ( $resolve_uncertain ) {
foreach ( $info[ FeaturePluginCompatibility::UNCERTAIN ] as $feature_id ) {
$key = $this->get_default_plugin_compatibility( $feature_id );
$info[ $key ][] = $feature_id;
}
$info[ FeaturePluginCompatibility::UNCERTAIN ] = array();
}
return $info;
}
/**
* Get the names of the plugins that have been declared compatible or incompatible with a given feature.
*
* @param string $feature_id Feature id.
* @param bool $active_only True to return only active plugins.
* @param bool $resolve_uncertain True to resolve the uncertain plugins to compatible or incompatible.
* @return array An array having a 'compatible', an 'incompatible' and an 'uncertain' key, each holding an array of plugin names.
*/
public function get_compatible_plugins_for_feature( string $feature_id, bool $active_only = false, bool $resolve_uncertain = false ): array {
$this->process_pending_declarations();
$this->verify_did_woocommerce_init( __FUNCTION__ );
$woo_aware_plugins = $this->plugin_util->get_woocommerce_aware_plugins( $active_only );
if ( ! $this->feature_exists( $feature_id ) ) {
return array(
FeaturePluginCompatibility::COMPATIBLE => array(),
FeaturePluginCompatibility::INCOMPATIBLE => array(),
FeaturePluginCompatibility::UNCERTAIN => $woo_aware_plugins,
);
}
$info = $this->compatibility_info_by_feature[ $feature_id ];
ArrayUtil::ensure_key_is_array( $info, FeaturePluginCompatibility::UNCERTAIN );
// Resolve uncertain plugin compatibility?
$uncertain_plugins = array_values( array_diff( $woo_aware_plugins, $info[ FeaturePluginCompatibility::COMPATIBLE ], $info[ FeaturePluginCompatibility::INCOMPATIBLE ] ) );
$key = $resolve_uncertain ? $this->get_default_plugin_compatibility( $feature_id ) : FeaturePluginCompatibility::UNCERTAIN;
$info[ $key ] = array_merge( $info[ $key ], $uncertain_plugins );
return $info;
}
/**
* Check if the 'woocommerce_init' has run or is running, do a 'wc_doing_it_wrong' if not.
*
* @param string|null $function_name Name of the invoking method, if not null, 'wc_doing_it_wrong' will be invoked if 'woocommerce_init' has not run and is not running.
*
* @return bool True if 'woocommerce_init' has run or is running, false otherwise.
*/
private function verify_did_woocommerce_init( ?string $function_name = null ): bool {
if ( ! $this->proxy->call_function( 'did_action', 'woocommerce_init' ) &&
! $this->proxy->call_function( 'doing_action', 'woocommerce_init' ) ) {
if ( ! is_null( $function_name ) ) {
$class_and_method = ( new \ReflectionClass( $this ) )->getShortName() . '::' . $function_name;
/* translators: 1: class::method 2: plugins_loaded */
$this->proxy->call_function( 'wc_doing_it_wrong', $class_and_method, sprintf( __( '%1$s should not be called before the %2$s action.', 'woocommerce' ), $class_and_method, 'woocommerce_init' ), '7.0' );
}
return false;
}
return true;
}
/**
* Get the name of the option that enables/disables a given feature.
*
* Note that it doesn't check if the feature actually exists. Instead it
* defaults to "woocommerce_feature_{$feature_id}_enabled" if a different
* name isn't specified in the feature registration.
*
* @param string $feature_id The id of the feature.
* @return string The option that enables or disables the feature.
*/
public function feature_enable_option_name( string $feature_id ): string {
$features = $this->get_feature_definitions();
if ( ! empty( $features[ $feature_id ]['option_key'] ) ) {
return $features[ $feature_id ]['option_key'];
}
return "woocommerce_feature_{$feature_id}_enabled";
}
/**
* Check if the compatibility checks should be skipped for a given feature.
*
* @since 10.3.0
*
* @param string $feature_id The feature id to check.
* @return bool TRUE if the compatibility checks should be skipped.
*/
public function should_skip_compatibility_checks( string $feature_id ): bool {
$features = $this->get_feature_definitions();
return ! empty( $features[ $feature_id ]['skip_compatibility_checks'] );
}
/**
* Sets a flag indicating that it's allowed to enable features for which incompatible plugins are active
* from the WooCommerce feature settings page.
*/
public function allow_enabling_features_with_incompatible_plugins(): void {
$this->force_allow_enabling_features = true;
}
/**
* Sets a flag indicating that it's allowed to activate plugins for which incompatible features are enabled
* from the WordPress plugins page.
*/
public function allow_activating_plugins_with_incompatible_features(): void {
$this->force_allow_enabling_plugins = true;
}
/**
* Adds our callbacks for the `updated_option` and `added_option` filter hooks.
*
* We delay adding these hooks until `init`, because both callbacks need to load our list of feature definitions,
* and building that list requires translating various strings (which should not be done earlier than `init`).
*
* @return void
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function start_listening_for_option_changes(): void {
add_filter( 'updated_option', array( $this, 'process_updated_option' ), 999, 3 );
add_filter( 'added_option', array( $this, 'process_added_option' ), 999, 3 );
}
/**
* Handler for the 'added_option' hook.
*
* It fires FEATURE_ENABLED_CHANGED_ACTION when a feature is enabled or disabled.
*
* @param string $option The option that has been created.
* @param mixed $value The value of the option.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function process_added_option( string $option, $value ) {
$this->process_updated_option( $option, false, $value );
}
/**
* Handler for the 'updated_option' hook.
*
* It fires FEATURE_ENABLED_CHANGED_ACTION when a feature is enabled or disabled.
*
* @param string $option The option that has been modified.
* @param mixed $old_value The old value of the option.
* @param mixed $value The new value of the option.
*
* @return void
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function process_updated_option( string $option, $old_value, $value ) {
$matches = array();
$is_default_key = preg_match( '/^woocommerce_feature_([a-zA-Z0-9_]+)_enabled$/', $option, $matches );
$features_with_custom_keys = array_filter(
$this->get_feature_definitions(),
function ( $feature ) {
return ! empty( $feature['option_key'] );
}
);
$custom_keys = wp_list_pluck( $features_with_custom_keys, 'option_key' );
if ( ! $is_default_key && ! in_array( $option, $custom_keys, true ) ) {
return;
}
if ( $value === $old_value ) {
return;
}
$feature_id = '';
if ( $is_default_key ) {
$feature_id = $matches[1];
} elseif ( in_array( $option, $custom_keys, true ) ) {
$feature_id = array_search( $option, $custom_keys, true );
}
if ( ! $feature_id ) {
return;
}
WC_Tracks::record_event(
self::FEATURE_ENABLED_CHANGED_ACTION,
array(
'feature_id' => $feature_id,
'enabled' => $value,
)
);
/**
* Action triggered when a feature is enabled or disabled (the value of the corresponding setting option is changed).
*
* @param string $feature_id The id of the feature.
* @param bool $enabled True if the feature has been enabled, false if it has been disabled.
*
* @since 7.0.0
*/
do_action( self::FEATURE_ENABLED_CHANGED_ACTION, $feature_id, 'yes' === $value );
}
/**
* Handler for the 'woocommerce_get_sections_advanced' hook,
* it adds the "Features" section to the advanced settings page.
*
* @param array $sections The original sections array.
* @return array The updated sections array.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function add_features_section( $sections ) {
if ( ! isset( $sections['features'] ) ) {
$sections['features'] = __( 'Features', 'woocommerce' );
}
return $sections;
}
/**
* Handler for the 'woocommerce_get_settings_advanced' hook,
* it adds the settings UI for all the existing features.
*
* Note that the settings added via the 'woocommerce_settings_features' hook will be
* displayed in the non-experimental features section.
*
* @param array $settings The existing settings for the corresponding settings section.
* @param string $current_section The section to get the settings for.
* @return array The updated settings array.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function add_feature_settings( $settings, $current_section ): array {
if ( 'features' !== $current_section ) {
return $settings;
}
$feature_settings = array(
array(
'title' => __( 'Features', 'woocommerce' ),
'type' => 'title',
'desc' => __( 'Start using new features that are being progressively rolled out to improve the store management experience.', 'woocommerce' ),
'id' => 'features_options',
),
);
$features = $this->get_features( true );
$feature_ids = array_keys( $features );
usort(
$feature_ids,
function ( $feature_id_a, $feature_id_b ) use ( $features ) {
return ( $features[ $feature_id_b ]['order'] ?? 0 ) <=> ( $features[ $feature_id_a ]['order'] ?? 0 );
}
);
$experimental_feature_ids = array_filter(
$feature_ids,
function ( $feature_id ) use ( $features ) {
return $features[ $feature_id ]['is_experimental'] ?? false;
}
);
$mature_feature_ids = array_diff( $feature_ids, $experimental_feature_ids );
$feature_ids = array_merge( $mature_feature_ids, array( 'mature_features_end' ), $experimental_feature_ids );
foreach ( $feature_ids as $id ) {
if ( 'mature_features_end' === $id ) {
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
/**
* Filter allowing to add additional settings to the WooCommerce Advanced - Features settings page.
*
* @param bool $disabled False.
*/
$feature_settings = apply_filters( 'woocommerce_settings_features', $feature_settings );
// phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment
if ( ! empty( $experimental_feature_ids ) ) {
$feature_settings[] = array(
'type' => 'sectionend',
'id' => 'features_options',
);
$feature_settings[] = array(
'title' => __( 'Experimental features', 'woocommerce' ),
'type' => 'title',
'desc' => __( 'These features are either experimental or incomplete, enable them at your own risk!', 'woocommerce' ),
'id' => 'experimental_features_options',
);
}
continue;
}
if ( 'new_navigation' === $id && 'yes' !== get_option( $this->feature_enable_option_name( $id ), 'no' ) ) {
continue;
}
if ( isset( $features[ $id ]['disable_ui'] ) && $features[ $id ]['disable_ui'] ) {
continue;
}
$feature_settings[] = $this->get_setting_for_feature( $id, $features[ $id ] );
$additional_settings = $features[ $id ]['additional_settings'] ?? array();
if ( count( $additional_settings ) > 0 ) {
$feature_settings = array_merge( $feature_settings, $additional_settings );
}
}
$feature_settings[] = array(
'type' => 'sectionend',
'id' => empty( $experimental_feature_ids ) ? 'features_options' : 'experimental_features_options',
);
if ( $this->verify_did_woocommerce_init() ) {
// Allow feature setting properties to be determined dynamically just before being rendered.
$feature_settings = array_map(
function ( $feature_setting ) {
foreach ( $feature_setting as $prop => $value ) {
if ( is_callable( $value ) ) {
$feature_setting[ $prop ] = call_user_func( $value );
}
}
return $feature_setting;
},
$feature_settings
);
}
return $feature_settings;
}
/**
* Get the parameters to display the setting enable/disable UI for a given feature.
*
* @param string $feature_id The feature id.
* @param array $feature The feature parameters, as returned by get_features.
* @return array The parameters to add to the settings array.
*/
private function get_setting_for_feature( string $feature_id, array $feature ): array {
$description = $feature['description'] ?? '';
$disabled = false;
$desc_tip = '';
$tooltip = $feature['tooltip'] ?? '';
$type = $feature['type'] ?? 'checkbox';
$setting_definition = $feature['setting'] ?? array();
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
/**
* Filter allowing WooCommerce Admin to be disabled.
*
* @param bool $disabled False.
*/
$admin_features_disabled = apply_filters( 'woocommerce_admin_disabled', false );
// phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment
if ( ( 'analytics' === $feature_id || 'new_navigation' === $feature_id ) && $admin_features_disabled ) {
$disabled = true;
$desc_tip = __( 'WooCommerce Admin has been disabled', 'woocommerce' );
} elseif ( 'new_navigation' === $feature_id ) {
$update_text = sprintf(
// translators: 1: line break tag.
__(
'%1$s This navigation will soon become unavailable while we make necessary improvements.
If you turn it off now, you will not be able to turn it back on.',
'woocommerce'
),
' '
);
$needs_update = version_compare( get_bloginfo( 'version' ), '5.6', '<' );
if ( $needs_update && current_user_can( 'update_core' ) && current_user_can( 'update_php' ) ) {
$update_text = sprintf(
// translators: 1: line break tag, 2: open link to WordPress update link, 3: close link tag.
__( '%1$s %2$sUpdate WordPress to enable the new navigation%3$s', 'woocommerce' ),
' ',
'',
''
);
$disabled = true;
}
if ( ! empty( $update_text ) ) {
$description .= $update_text;
}
}
if ( ! $this->should_skip_compatibility_checks( $feature_id ) && ! $disabled && $this->verify_did_woocommerce_init() ) {
$plugin_info_for_feature = $this->get_compatible_plugins_for_feature( $feature_id, true );
$desc_tip = $this->plugin_util->generate_incompatible_plugin_feature_warning( $feature_id, $plugin_info_for_feature );
}
/**
* Filter to customize the description tip that appears under the description of each feature in the features settings page.
*
* @since 7.1.0
*
* @param string $desc_tip The original description tip.
* @param string $feature_id The id of the feature for which the description tip is being customized.
* @param bool $disabled True if the UI currently prevents changing the enable/disable status of the feature.
* @return string The new description tip to use.
*/
$desc_tip = apply_filters( 'woocommerce_feature_description_tip', $desc_tip, $feature_id, $disabled );
$feature_setting_defaults = array(
'title' => $feature['name'],
'desc' => $description,
'type' => $type,
'id' => $this->feature_enable_option_name( $feature_id ),
'disabled' => $disabled && ! $this->force_allow_enabling_features,
'desc_tip' => $desc_tip,
'tooltip' => $tooltip,
'default' => $this->feature_is_enabled_by_default( $feature_id ) ? 'yes' : 'no',
);
$feature_setting = wp_parse_args( $setting_definition, $feature_setting_defaults );
if ( ! empty( $feature['learn_more_url'] ) ) {
$feature_setting['desc'] .= sprintf(
'%s',
esc_attr( $feature['learn_more_url'] ),
esc_html__( 'Learn more', 'woocommerce' )
);
}
/**
* Allows to modify feature setting that will be used to render in the feature page.
*
* @param array $feature_setting The feature setting. Describes the feature:
* - title: The title of the feature.
* - desc: The description of the feature. Will be displayed under the title.
* - type: The type of the feature. Could be any of supported settings types from `WC_Admin_Settings::output_fields`, but if it's anything other than checkbox or radio, it will need custom handling.
* - id: The id of the feature. Will be used as the name of the setting.
* - disabled: Whether the feature is disabled or not.
* - desc_tip: The description tip of the feature. Will be displayed as a tooltip next to the description.
* - tooltip: The tooltip of the feature. Will be displayed as a tooltip next to the name.
* - default: The default value of the feature.
* @param string $feature_id The id of the feature.
* @since 8.0.0
*/
return apply_filters( 'woocommerce_feature_setting', $feature_setting, $feature_id );
}
/**
* Handle the plugin deactivation hook.
*
* @param string $plugin_name Name of the plugin that has been deactivated.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function handle_plugin_deactivation( $plugin_name ): void {
unset( $this->compatibility_info_by_plugin[ $plugin_name ] );
foreach ( array_keys( $this->compatibility_info_by_feature ) as $feature ) {
$compatibles = $this->compatibility_info_by_feature[ $feature ][ FeaturePluginCompatibility::COMPATIBLE ];
$this->compatibility_info_by_feature[ $feature ][ FeaturePluginCompatibility::COMPATIBLE ] = array_diff( $compatibles, array( $plugin_name ) );
$incompatibles = $this->compatibility_info_by_feature[ $feature ][ FeaturePluginCompatibility::INCOMPATIBLE ];
$this->compatibility_info_by_feature[ $feature ][ FeaturePluginCompatibility::INCOMPATIBLE ] = array_diff( $incompatibles, array( $plugin_name ) );
}
}
/**
* Handler for the all_plugins filter.
*
* Returns the list of plugins incompatible with a given plugin
* if we are in the plugins page and the query string of the current request
* looks like '?plugin_status=incompatible_with_feature&feature_id='.
*
* @param array $plugin_list The original list of plugins.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function filter_plugins_list( $plugin_list ): array {
if ( ! $this->verify_did_woocommerce_init() ) {
return $plugin_list;
}
// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
if ( ! function_exists( 'get_current_screen' ) ||
( get_current_screen() && 'plugins' !== get_current_screen()->id ) ||
'incompatible_with_feature' !== ArrayUtil::get_value_or_default( $_GET, 'plugin_status' ) ) {
return $plugin_list;
}
$feature_id = $_GET['feature_id'] ?? 'all';
if ( 'all' !== $feature_id && ! $this->feature_exists( $feature_id ) ) {
return $plugin_list;
}
return $this->get_incompatible_plugins( $feature_id, $plugin_list );
}
/**
* Returns the list of plugins incompatible with a given feature.
*
* @param string $feature_id ID of the feature. Can also be `all` to denote all features.
* @param array $plugin_list List of plugins to filter.
*
* @return array List of plugins incompatible with the given feature.
*/
public function get_incompatible_plugins( $feature_id, $plugin_list ) {
$incompatibles = array();
$plugin_list = array_diff_key( $plugin_list, array_flip( $this->plugins_excluded_from_compatibility_ui ) );
$feature_ids = 'all' === $feature_id ? array_keys( $this->get_feature_definitions() ) : array( $feature_id );
$only_enabled_features = 'all' === $feature_id;
// phpcs:enable WordPress.Security.NonceVerification, WordPress.Security.ValidatedSanitizedInput
foreach ( array_keys( $plugin_list ) as $plugin_name ) {
if ( ! $this->plugin_util->is_woocommerce_aware_plugin( $plugin_name ) || ! $this->proxy->call_function( 'is_plugin_active', $plugin_name ) ) {
continue;
}
$compatibility_info = $this->get_compatible_features_for_plugin( $plugin_name );
foreach ( $feature_ids as $feature_id ) {
$features_considered_incompatible = array_filter(
$this->plugin_util->get_items_considered_incompatible( $feature_id, $compatibility_info ),
$only_enabled_features ?
fn( $id ) => $this->feature_is_enabled( $id ) && ! $this->should_skip_compatibility_checks( $id ) :
fn( $id ) => ! $this->should_skip_compatibility_checks( $id )
);
if ( in_array( $feature_id, $features_considered_incompatible, true ) ) {
$incompatibles[] = $plugin_name;
}
}
}
return array_intersect_key( $plugin_list, array_flip( $incompatibles ) );
}
/**
* Handler for the admin_notices action.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function display_notices_in_plugins_page(): void {
if ( ! $this->verify_did_woocommerce_init() ) {
return;
}
$feature_filter_description_shown = $this->maybe_display_current_feature_filter_description();
if ( ! $feature_filter_description_shown ) {
$this->maybe_display_feature_incompatibility_warning();
}
}
/**
* Shows a warning when there are any incompatibility between active plugins and enabled features.
* The warning is shown in on any admin screen except the plugins screen itself, since
* there's already a "You are viewing plugins that are incompatible" notice.
*/
private function maybe_display_feature_incompatibility_warning(): void {
if ( ! current_user_can( 'activate_plugins' ) ) {
return;
}
$incompatible_plugins = false;
$relevant_plugins = array_diff( $this->plugin_util->get_woocommerce_aware_plugins( true ), $this->plugins_excluded_from_compatibility_ui );
foreach ( $relevant_plugins as $plugin ) {
$compatibility_info = $this->get_compatible_features_for_plugin( $plugin, true );
$incompatibles = array_filter( $compatibility_info[ FeaturePluginCompatibility::INCOMPATIBLE ], fn( $id ) => ! $this->should_skip_compatibility_checks( $id ) );
if ( ! empty( $incompatibles ) ) {
$incompatible_plugins = true;
break;
}
$uncertains = array_filter( $compatibility_info[ FeaturePluginCompatibility::UNCERTAIN ], fn( $id ) => ! $this->should_skip_compatibility_checks( $id ) );
foreach ( $uncertains as $feature_id ) {
if ( FeaturePluginCompatibility::COMPATIBLE !== $this->get_default_plugin_compatibility( $feature_id ) ) {
$incompatible_plugins = true;
break;
}
}
if ( $incompatible_plugins ) {
break;
}
}
if ( ! $incompatible_plugins ) {
return;
}
$message = str_replace(
'',
'',
__( 'WooCommerce has detected that some of your active plugins are incompatible with currently enabled WooCommerce features. Please review the details.', 'woocommerce' )
);
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
?>
'.
*/
private function maybe_display_current_feature_filter_description(): bool {
if ( 'plugins' !== get_current_screen()->id ) {
return false;
}
// phpcs:disable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
$plugin_status = $_GET['plugin_status'] ?? '';
$feature_id = $_GET['feature_id'] ?? '';
// phpcs:enable WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput
if ( 'incompatible_with_feature' !== $plugin_status ) {
return false;
}
$feature_id = ( '' === $feature_id ) ? 'all' : $feature_id;
if ( 'all' !== $feature_id && ! $this->feature_exists( $feature_id ) ) {
return false;
}
$features = $this->get_feature_definitions();
$plugins_page_url = admin_url( 'plugins.php' );
$features_page_url = $this->get_features_page_url();
$message =
'all' === $feature_id
? __( 'You are viewing active plugins that are incompatible with currently enabled WooCommerce features.', 'woocommerce' )
: sprintf(
/* translators: %s is a feature name. */
__( "You are viewing the active plugins that are incompatible with the '%s' feature.", 'woocommerce' ),
$features[ $feature_id ]['name']
);
$message .= ' ';
$message .= sprintf(
__( "View all plugins - Manage WooCommerce features", 'woocommerce' ),
$plugins_page_url,
$features_page_url
);
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
?>
plugins_excluded_from_compatibility_ui, true ) ) {
return;
}
if ( 'incompatible_with_feature' !== ArrayUtil::get_value_or_default( $_GET, 'plugin_status' ) ) { // phpcs:ignore WordPress.Security.NonceVerification
return;
}
if ( is_null( $wp_list_table ) || ! $this->plugin_util->is_woocommerce_aware_plugin( $plugin_data ) ) {
return;
}
if ( ! $this->proxy->call_function( 'is_plugin_active', $plugin_file ) ) {
return;
}
$features = $this->get_feature_definitions();
$feature_compatibility_info = $this->get_compatible_features_for_plugin( $plugin_file, true, true );
$incompatible_features = $feature_compatibility_info[ FeaturePluginCompatibility::INCOMPATIBLE ];
$incompatible_features = array_values(
array_filter(
$incompatible_features,
function ( $feature_id ) {
return ! $this->should_skip_compatibility_checks( $feature_id );
}
)
);
$incompatible_features_count = count( $incompatible_features );
if ( $incompatible_features_count > 0 ) {
$columns_count = $wp_list_table->get_column_count();
$is_active = true; // For now we are showing active plugins in the "Incompatible with..." view.
$is_active_class = $is_active ? 'active' : 'inactive';
$is_active_td_style = $is_active ? " style='border-left: 4px solid #72aee6;'" : '';
if ( 1 === $incompatible_features_count ) {
$message = sprintf(
/* translators: %s = printable plugin name */
__( "⚠ This plugin is incompatible with the enabled WooCommerce feature '%s', it shouldn't be activated.", 'woocommerce' ),
$features[ $incompatible_features[0] ]['name']
);
} elseif ( 2 === $incompatible_features_count ) {
/* translators: %1\$s, %2\$s = printable plugin names */
$message = sprintf(
__( "⚠ This plugin is incompatible with the enabled WooCommerce features '%1\$s' and '%2\$s', it shouldn't be activated.", 'woocommerce' ),
$features[ $incompatible_features[0] ]['name'],
$features[ $incompatible_features[1] ]['name']
);
} else {
/* translators: %1\$s, %2\$s = printable plugin names, %3\$d = plugins count */
$message = sprintf(
__( "⚠ This plugin is incompatible with the enabled WooCommerce features '%1\$s', '%2\$s' and %3\$d more, it shouldn't be activated.", 'woocommerce' ),
$features[ $incompatible_features[0] ]['name'],
$features[ $incompatible_features[1] ]['name'],
$incompatible_features_count - 2
);
}
$features_page_url = $this->get_features_page_url();
$manage_features_message = __( 'Manage WooCommerce features', 'woocommerce' );
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
?>
>
elements as follows:
*
* - If the plugin needs update, the
will have an "update" class. This will prevent the lower
* border line to be drawn. Later an additional
with an "update available" warning will be rendered,
* it will have a "plugin-update-tr" class which will draw the missing lower border line.
* - Otherwise, the
will be already drawn with the lower border line.
*
* This is a problem for our rendering of the "plugin is incompatible with X features" warning:
*
* - If the plugin info
has "update", our
will render nicely right after it; but then
* our own "plugin-update-tr" class will draw an additional line before the "needs update" warning.
* - If not, the plugin info
will render its lower border line right before our compatibility info
.
*
* This small script fixes this by adding the "update" class to the plugin info
if it doesn't have it
* (so no extra line before our
), or removing 'plugin-update-tr' from our
otherwise
* (and then some extra manual tweaking of margins is needed).
*
* @param string $current_screen The current screen object.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function enqueue_script_to_fix_plugin_list_html( $current_screen ): void {
if ( 'plugins' !== $current_screen->id ) {
return;
}
$handle = 'wc-features-fix-plugin-list-html';
wp_register_script( $handle, '', array(), WC_VERSION, array( 'in_footer' => true ) );
wp_enqueue_script( $handle );
wp_add_inline_script(
$handle,
"
const warningRows = document.querySelectorAll('tr[data-plugin-row-type=\"feature-incomp-warn\"]');
for(const warningRow of warningRows) {
const pluginName = warningRow.getAttribute('data-plugin');
const pluginInfoRow = document.querySelector('tr.active[data-plugin=\"' + pluginName + '\"]:not(.plugin-update-tr), tr.inactive[data-plugin=\"' + pluginName + '\"]:not(.plugin-update-tr)');
if(!pluginInfoRow) {
continue;
}
if(pluginInfoRow.classList.contains('update')) {
warningRow.classList.remove('plugin-update-tr');
warningRow.querySelector('.notice').style.margin = '5px 10px 15px 30px';
}
else {
pluginInfoRow.classList.add('update');
}
}
"
);
}
/**
* Handler for the 'views_plugins' hook that shows the links to the different views in the plugins page.
* If we come from a "Manage incompatible plugins" in the features page we'll show just two views:
* "All" (so that it's easy to go back to a known state) and "Incompatible with X".
* We'll skip the rest of the views since the counts are wrong anyway, as we are modifying
* the plugins list via the 'all_plugins' filter.
*
* @param array $views An array of view ids => view links.
* @return string[] The actual views array to use.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function handle_plugins_page_views_list( $views ): array {
// phpcs:disable WordPress.Security.NonceVerification, WordPress.Security.ValidatedSanitizedInput
if ( 'incompatible_with_feature' !== ArrayUtil::get_value_or_default( $_GET, 'plugin_status' ) ) {
return $views;
}
$feature_id = $_GET['feature_id'] ?? 'all';
if ( 'all' !== $feature_id && ! $this->feature_exists( $feature_id ) ) {
return $views;
}
// phpcs:enable WordPress.Security.NonceVerification, WordPress.Security.ValidatedSanitizedInput
$all_items = get_plugins();
$features = $this->get_feature_definitions();
$incompatible_plugins_count = count( $this->filter_plugins_list( $all_items ) );
$incompatible_text =
'all' === $feature_id
? __( 'Incompatible with WooCommerce features', 'woocommerce' )
/* translators: %s = name of a WooCommerce feature */
: sprintf( __( "Incompatible with '%s'", 'woocommerce' ), $features[ $feature_id ]['name'] );
$incompatible_link = "{$incompatible_text} ({$incompatible_plugins_count})";
$all_plugins_count = count( $all_items );
$all_text = __( 'All', 'woocommerce' );
$all_link = "{$all_text} ({$all_plugins_count})";
return array(
'all' => $all_link,
'incompatible_with_feature' => $incompatible_link,
);
}
/**
* Set the feature nonce to be sent from client side.
*
* @param array $settings Component settings.
*
* @return array
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function set_change_feature_enable_nonce( $settings ) {
$settings['_feature_nonce'] = wp_create_nonce( 'change_feature_enable' );
return $settings;
}
/**
* Changes the feature given it's id, a toggle value and nonce as a query param.
*
* `/wp-admin/post.php?product_block_editor=1&_feature_nonce=1234`, 1 for on
* `/wp-admin/post.php?product_block_editor=0&_feature_nonce=1234`, 0 for off
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function change_feature_enable_from_query_params(): void {
if ( ! current_user_can( 'manage_woocommerce' ) ) {
return;
}
$is_feature_nonce_invalid = ( ! isset( $_GET['_feature_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_feature_nonce'] ) ), 'change_feature_enable' ) );
$query_params_to_remove = array( '_feature_nonce' );
foreach ( array_keys( $this->get_feature_definitions() ) as $feature_id ) {
if ( isset( $_GET[ $feature_id ] ) && is_numeric( $_GET[ $feature_id ] ) ) {
$value = absint( $_GET[ $feature_id ] );
if ( $is_feature_nonce_invalid ) {
wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'woocommerce' ) );
return;
}
if ( 1 === $value ) {
$this->change_feature_enable( $feature_id, true );
} elseif ( 0 === $value ) {
$this->change_feature_enable( $feature_id, false );
}
$query_params_to_remove[] = $feature_id;
}
}
if ( count( $query_params_to_remove ) > 1 && isset( $_SERVER['REQUEST_URI'] ) ) {
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
wp_safe_redirect( remove_query_arg( $query_params_to_remove, $_SERVER['REQUEST_URI'] ) );
}
}
/**
* Display the email improvements feedback notice to render CES modal in.
*
* @param string $feature_id The feature id.
* @param bool $is_enabled Whether the feature is enabled.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function display_email_improvements_feedback_notice( $feature_id, $is_enabled ): void {
if ( 'email_improvements' === $feature_id && ! $is_enabled ) {
set_transient( 'wc_settings_email_improvements_reverted', 'yes', 15 );
add_action(
'admin_notices',
function () {
echo '';
}
);
}
}
/**
* Check if the email improvements feature is enabled in preview mode in Settings > Emails.
* This is used to force the email improvements feature without affecting shoppers.
*
* @param string $feature_id The feature id.
* @return bool Whether the email improvements feature is enabled in preview mode.
*/
private function is_preview_email_improvements_enabled( string $feature_id ): bool {
if ( 'email_improvements' !== $feature_id ) {
return false;
}
/**
* This filter is documented in templates/emails/email-styles.php
*
* @since 9.9.0
* @param bool $is_email_preview Whether the email is being previewed.
*/
$is_email_preview = apply_filters( 'woocommerce_is_email_preview', false );
if ( $is_email_preview ) {
return get_transient( EmailPreview::TRANSIENT_PREVIEW_EMAIL_IMPROVEMENTS ) === 'yes';
}
return false;
}
}
PK [1]p" " ) DependencyManagement/RuntimeContainer.phpnu instance, to be used as the starting point for the resolved classes cache.
*/
public function __construct( array $initial_resolved_cache ) {
$this->initial_resolved_cache = $initial_resolved_cache;
$this->resolved_cache = $initial_resolved_cache;
}
/**
* Get an instance of a class.
*
* ContainerException will be thrown in these cases:
*
* - $class_name is outside the WooCommerce root namespace (and wasn't included in the initial resolve cache).
* - The class referred by $class_name doesn't exist.
* - Recursive resolution condition found.
* - Reflection exception thrown when instantiating or initializing the class.
*
* A "recursive resolution condition" happens when class A depends on class B and at the same time class B depends on class A, directly or indirectly;
* without proper handling this would lead to an infinite loop.
*
* Note that this method throwing ContainerException implies that code fixes are needed, it's not an error condition that's recoverable at runtime.
*
* @template T of object
* @param string $class_name Class name.
* @phpstan-param class-string $class_name
*
* @return T Object instance.
* @throws ContainerException Error when resolving the class to an object instance.
* @throws \Exception Exception thrown in the constructor or in the 'init' method of one of the resolved classes.
*/
public function get( string $class_name ) {
$class_name = trim( $class_name, '\\' );
$resolve_chain = array();
// @phpstan-ignore return.type (get_core uses reflection to instantiate the correct class type at runtime)
return $this->get_core( $class_name, $resolve_chain );
}
/**
* Core function to get an instance of a class.
*
* @param string $class_name The class name.
* @param array $resolve_chain Classes already resolved in this resolution chain. Passed between recursive calls to the method in order to detect a recursive resolution condition.
* @return object The resolved object.
* @throws ContainerException Error when resolving the class to an object instance.
*/
protected function get_core( string $class_name, array &$resolve_chain ) {
if ( isset( $this->resolved_cache[ $class_name ] ) ) {
return $this->resolved_cache[ $class_name ];
}
// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
if ( in_array( $class_name, $resolve_chain, true ) ) {
throw new ContainerException( "Recursive resolution of class '$class_name'. Resolution chain: " . implode( ', ', $resolve_chain ) );
}
if ( ! $this->is_class_allowed( $class_name ) ) {
throw new ContainerException( "Attempt to get an instance of class '$class_name', which is not in the " . self::WOOCOMMERCE_NAMESPACE . ' namespace. Did you forget to add a namespace import?' );
}
if ( ! class_exists( $class_name ) ) {
throw new ContainerException( "Attempt to get an instance of class '$class_name', which doesn't exist." );
}
// Account for the containers used by the Store API and Blocks.
if ( StringUtil::starts_with( $class_name, 'Automattic\WooCommerce\StoreApi\\' ) ) {
return StoreApi::container()->get( $class_name );
}
if ( StringUtil::starts_with( $class_name, 'Automattic\WooCommerce\Blocks\\' ) ) {
return BlocksPackage::container()->get( $class_name );
}
$resolve_chain[] = $class_name;
try {
$instance = $this->instantiate_class_using_reflection( $class_name, $resolve_chain );
} catch ( \ReflectionException $e ) {
throw new ContainerException( "Reflection error when resolving '$class_name': (" . get_class( $e ) . ") {$e->getMessage()}", 0, $e );
}
// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
$this->resolved_cache[ $class_name ] = $instance;
return $instance;
}
// phpcs:disable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
/**
* Get an instance of a class using reflection.
* This method recursively calls 'get_core' (which in turn calls this method) for each of the arguments
* in the 'init' method of the resolved class (if the method is public and non-static).
*
* @param string $class_name The name of the class to resolve.
* @param array $resolve_chain Classes already resolved in this resolution chain. Passed between recursive calls to the method in order to detect a recursive resolution condition.
* @return object The resolved object.
*
* @throws ContainerException The 'init' method has invalid arguments.
* @throws \ReflectionException Something went wrong when using reflection to get information about the class to resolve.
*/
private function instantiate_class_using_reflection( string $class_name, array &$resolve_chain ): object {
$ref_class = new \ReflectionClass( $class_name );
// phpcs:disable WordPress.Security.EscapeOutput.ExceptionNotEscaped
$constructor = $ref_class->getConstructor();
if ( ! is_null( $constructor ) ) {
if ( ! $constructor->isPublic() ) {
throw new ContainerException( "Error resolving '$class_name': the class doesn't have a public constructor." );
}
$constructor_arguments = $constructor->getParameters();
foreach ( $constructor_arguments as $argument ) {
if ( ! $argument->isOptional() ) {
throw new ContainerException( "Error resolving '$class_name': the class constructor has non-optional arguments." );
}
}
}
$instance = $ref_class->newInstance();
if ( ! $ref_class->hasMethod( 'init' ) ) {
return $instance;
}
$init_method = $ref_class->getMethod( 'init' );
if ( ! $init_method->isPublic() || $init_method->isStatic() ) {
return $instance;
}
$init_args = $init_method->getParameters();
$init_arg_instances = array_map(
function ( \ReflectionParameter $arg ) use ( $class_name, &$resolve_chain ) {
$arg_type = $arg->getType();
if ( ! ( $arg_type instanceof \ReflectionNamedType ) ) {
throw new ContainerException( "Error resolving '$class_name': argument '\${$arg->getName()}' doesn't have a type declaration." );
}
if ( $arg_type->isBuiltin() ) {
throw new ContainerException( "Error resolving '$class_name': argument '\${$arg->getName()}' is not of a class type." );
}
if ( $arg->isPassedByReference() ) {
throw new ContainerException( "Error resolving '$class_name': argument '\${$arg->getName()}' is passed by reference." );
}
return $this->get_core( $arg_type->getName(), $resolve_chain );
},
$init_args
);
// phpcs:enable WordPress.Security.EscapeOutput.ExceptionNotEscaped
$init_method->invoke( $instance, ...$init_arg_instances );
return $instance;
}
// phpcs:enable Squiz.Commenting.FunctionCommentThrowTag.WrongNumber
/**
* Tells if the 'get' method can be used to resolve a given class.
*
* Note that 'get' can throw an exception even if this method returns true,
* for example for classes that are in the correct namespace but don't have a public constructor.
*
* @param string $class_name The class name.
* @return bool True if the class with the supplied name can be resolved with 'get'.
*/
public function has( string $class_name ): bool {
$class_name = trim( $class_name, '\\' );
return $this->is_class_allowed( $class_name ) || isset( $this->resolved_cache[ $class_name ] );
}
/**
* Checks to see whether a class is allowed to be registered.
*
* @param string $class_name The class to check.
*
* @return bool True if the class is allowed to be registered, false otherwise.
*/
protected function is_class_allowed( string $class_name ): bool {
return StringUtil::starts_with( $class_name, self::WOOCOMMERCE_NAMESPACE, false );
}
}
PK [1]w + DependencyManagement/ContainerException.phpnu is_connected() ) {
$result = $manager->try_registration();
if ( is_wp_error( $result ) ) {
$errors->add( $result->get_error_code(), $result->get_error_message() );
}
}
$calypso_env = defined( 'WOOCOMMERCE_CALYPSO_ENVIRONMENT' ) && in_array( WOOCOMMERCE_CALYPSO_ENVIRONMENT, array( 'development', 'wpcalypso', 'horizon', 'stage' ), true ) ? WOOCOMMERCE_CALYPSO_ENVIRONMENT : 'production';
$authorization_url = $manager->get_authorization_url( null, $redirect_url );
$authorization_url = add_query_arg( 'locale', self::get_wpcom_locale(), $authorization_url );
if ( Features::is_enabled( 'use-wp-horizon' ) ) {
$calypso_env = 'horizon';
}
$color_scheme = get_user_option( 'admin_color', get_current_user_id() );
if ( ! $color_scheme ) {
// The default Core color schema is 'fresh'.
$color_scheme = 'fresh';
}
return array(
'success' => ! $errors->has_errors(),
'errors' => $errors->get_error_messages(),
'color_scheme' => $color_scheme,
'url' => add_query_arg(
array(
'from' => $from,
'calypso_env' => $calypso_env,
),
$authorization_url,
),
);
}
/**
* Return a locale string for wpcom.
*
* @return string
*/
private static function get_wpcom_locale() {
// List of locales that should be used with region code.
$locale_to_lang = array(
'bre' => 'br',
'de_AT' => 'de-at',
'de_CH' => 'de-ch',
'de' => 'de_formal',
'el' => 'el-po',
'en_GB' => 'en-gb',
'es_CL' => 'es-cl',
'es_MX' => 'es-mx',
'fr_BE' => 'fr-be',
'fr_CA' => 'fr-ca',
'nl_BE' => 'nl-be',
'nl' => 'nl_formal',
'pt_BR' => 'pt-br',
'sr' => 'sr_latin',
'zh_CN' => 'zh-cn',
'zh_HK' => 'zh-hk',
'zh_SG' => 'zh-sg',
'zh_TW' => 'zh-tw',
);
$system_locale = get_locale();
if ( isset( $locale_to_lang[ $system_locale ] ) ) {
// Return the locale with region code if it's in the list.
return $locale_to_lang[ $system_locale ];
}
// If the locale is not in the list, return the language code only.
return explode( '_', $system_locale )[0];
}
}
PK [1]MQH - RestApi/Routes/V4/AbstractCollectionQuery.phpnu array(
'description' => __( 'Shipping method instance ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'zone_id' => array(
'description' => __( 'Shipping zone ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'required' => true,
),
'enabled' => array(
'description' => __( 'Whether the shipping method is enabled.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'required' => true,
),
'order' => array(
'description' => __( 'Shipping method sort order.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'sanitize_callback' => 'absint',
),
'method_id' => array(
'description' => __( 'Shipping method ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'required' => true,
),
'settings' => array(
'description' => __( 'Shipping method settings including title and configuration.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'required' => true,
'properties' => array(
'title' => array(
'description' => __( 'Shipping method title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'required' => true,
),
),
'additionalProperties' => true,
),
);
}
/**
* Get the item response for a shipping method.
*
* @param object $method Shipping method instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $method, WP_REST_Request $request, array $include_fields = array() ): array {
if ( isset( $request['zone_id'] ) ) {
$zone_id = (int) $request['zone_id'];
} else {
$data_store = \WC_Data_Store::load( 'shipping-zone' );
$zone_id = $data_store->get_zone_id_by_instance_id( $method->instance_id );
}
return array(
'instance_id' => (int) $method->instance_id,
'zone_id' => (int) $zone_id,
'enabled' => wc_string_to_bool( $method->enabled ),
'order' => (int) $method->method_order,
'method_id' => $method->id,
'settings' => $this->get_method_settings( $method ),
);
}
/**
* Get shipping method settings with title included.
*
* @param object $method Shipping method instance.
* @return array Method settings including title.
*/
protected function get_method_settings( $method ): array {
$settings = array();
// Get the method title (moved from root to settings per Ismael's feedback).
$settings['title'] = $method->get_title();
// Get common method settings.
$common_fields = array( 'cost', 'min_amount', 'requires', 'class_cost', 'no_class_cost', 'tax_status' );
foreach ( $common_fields as $field ) {
if ( isset( $method->$field ) ) {
$settings[ $field ] = $method->$field;
}
}
// Return all available settings for maximum flexibility.
if ( isset( $method->instance_settings ) && is_array( $method->instance_settings ) ) {
$settings = array_merge( $settings, $method->instance_settings );
}
return $settings;
}
}
PK [1]q- - 3 RestApi/Routes/V4/ShippingZoneMethod/Controller.phpnu method_schema = $method_schema;
$this->shipping_method_service = $shipping_method_service;
}
/**
* Register the routes for shipping zone methods.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::DELETABLE ),
),
)
);
}
/**
* Check if a given request has permission to manage shipping methods.
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has permission, WP_Error otherwise.
*/
public function check_permissions( $request ) {
if ( ! wc_shipping_enabled() ) {
return new WP_Error(
'rest_shipping_disabled',
__( 'Shipping is disabled.', 'woocommerce' ),
array( 'status' => WP_Http::SERVICE_UNAVAILABLE )
);
}
$method = $request->get_method();
if ( 'GET' === $method ) {
$context = 'read';
} elseif ( 'DELETE' === $method ) {
$context = 'delete';
} else {
$context = 'edit';
}
if ( ! wc_rest_check_manager_permissions( 'settings', $context ) ) {
return $this->get_authentication_error_by_method( $method );
}
return true;
}
/**
* Get shipping zone method by ID.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
$instance_id = (int) $request['id'];
$method = WC_Shipping_Zones::get_shipping_method( $instance_id );
if ( ! $method ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
return rest_ensure_response( $this->prepare_item_for_response( $method, $request ) );
}
/**
* Create a shipping method.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object or WP_Error.
*/
public function create_item( $request ) {
$zone = $this->validate_zone( $request['zone_id'] );
if ( is_wp_error( $zone ) ) {
return $zone;
}
$method_validation = $this->validate_method_type( $request['method_id'] );
if ( is_wp_error( $method_validation ) ) {
return $method_validation;
}
$instance_id = $zone->add_shipping_method( $request['method_id'] );
if ( ! $instance_id ) {
return $this->get_route_error_by_code( self::CANNOT_CREATE );
}
$method = WC_Shipping_Zones::get_shipping_method( $instance_id );
if ( ! $method ) {
return $this->get_route_error_by_code( self::CANNOT_CREATE );
}
$result = $this->shipping_method_service->update_shipping_zone_method( $method, $instance_id, $request->get_params(), $zone->get_id() );
if ( is_wp_error( $result ) ) {
// Rollback: delete the method instance to prevent orphaned records.
$zone->delete_shipping_method( $instance_id );
return $result;
}
$request['zone_id'] = $zone->get_id();
$response = $this->prepare_item_for_response( $method, $request );
$response->set_status( 201 );
return $response;
}
/**
* Update a shipping method.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object or WP_Error.
*/
public function update_item( $request ) {
$instance_id = (int) $request['id'];
$method = WC_Shipping_Zones::get_shipping_method( $instance_id );
if ( ! $method ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$zone = $this->validate_zone_by_method_instance( $instance_id );
if ( is_wp_error( $zone ) ) {
return $zone;
}
if ( isset( $request['enabled'] ) || isset( $request['settings'] ) || isset( $request['order'] ) ) {
$result = $this->shipping_method_service->update_shipping_zone_method( $method, $instance_id, $request->get_params(), $zone->get_id() );
if ( is_wp_error( $result ) ) {
return $result;
}
}
$request['zone_id'] = $zone->get_id();
return $this->prepare_item_for_response( $method, $request );
}
/**
* Delete shipping zone method by ID.
*
* Note: In v2/v3, this endpoint required a `force` parameter, but since shipping zone methods
* do not support trashing, it would either delete (force=true) or return a 501 error (force=false).
* We removed the `force` parameter in v4 as it serves no purpose when soft delete is not supported.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function delete_item( $request ) {
$instance_id = (int) $request['id'];
// Get the method before deletion to return in response.
$method = WC_Shipping_Zones::get_shipping_method( $instance_id );
if ( ! $method ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$zone = $this->validate_zone_by_method_instance( $instance_id );
if ( is_wp_error( $zone ) ) {
return $zone;
}
// Prepare response before deletion.
$request->set_param( 'context', 'view' );
$request['zone_id'] = $zone->get_id();
$response = $this->prepare_item_for_response( $method, $request );
// Perform the deletion.
$result = $zone->delete_shipping_method( $instance_id );
if ( ! $result ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
/**
* Fires after a shipping zone method is deleted via the REST API.
*
* @since 10.5.0
*
* @param WC_Shipping_Method $method The shipping zone method being deleted.
* @param WC_Shipping_Zone $zone The shipping zone the method belonged to.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
*/
do_action( 'woocommerce_rest_delete_shipping_zone_method', $method, $zone, $response, $request );
return $response;
}
/**
* Get the schema for shipping methods.
*
* @return array
*/
protected function get_schema(): array {
return $this->method_schema->get_item_schema();
}
/**
* Get the item response for a shipping method.
*
* @param mixed $zone Shipping method data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $zone, WP_REST_Request $request ): array {
return $this->method_schema->get_item_response( $zone, $request, $this->get_fields_for_response( $request ) );
}
/**
* Get route error by code, including custom shipping method errors.
*
* @param string $error_code Error code.
* @return WP_Error
*/
protected function get_route_error_by_code( string $error_code ): WP_Error {
$custom_errors = array(
self::INVALID_ZONE_ID => array(
'message' => __( 'Invalid shipping zone ID.', 'woocommerce' ),
'status' => WP_Http::NOT_FOUND,
),
self::INVALID_METHOD_TYPE => array(
'message' => __( 'Invalid shipping method type.', 'woocommerce' ),
'status' => WP_Http::BAD_REQUEST,
),
self::ZONE_MISMATCH => array(
'message' => __( 'Shipping method does not belong to the specified zone.', 'woocommerce' ),
'status' => WP_Http::BAD_REQUEST,
),
);
if ( isset( $custom_errors[ $error_code ] ) ) {
return $this->get_route_error_response(
$this->get_error_prefix() . $error_code,
$custom_errors[ $error_code ]['message'],
$custom_errors[ $error_code ]['status']
);
}
return parent::get_route_error_by_code( $error_code );
}
/**
* Validate that a shipping zone exists.
*
* @param int $zone_id Zone ID.
* @return WC_Shipping_Zone|WP_Error Zone object or error.
*/
protected function validate_zone( $zone_id ) {
$zone = WC_Shipping_Zones::get_zone( $zone_id );
if ( ! $zone || ( 0 !== $zone->get_id() && ! $zone->get_zone_name() ) ) {
return $this->get_route_error_by_code( self::INVALID_ZONE_ID );
}
return $zone;
}
/**
* Validate that a shipping method type is valid.
*
* @param string $method_id Shipping method ID.
* @return true|WP_Error True if valid, error otherwise.
*/
protected function validate_method_type( $method_id ) {
$available_methods = WC()->shipping()->get_shipping_methods();
if ( ! isset( $available_methods[ $method_id ] ) ) {
return $this->get_route_error_by_code( self::INVALID_METHOD_TYPE );
}
return true;
}
/**
* Get zone by method instance ID.
*
* @param int $instance_id Method instance ID.
* @return WC_Shipping_Zone|WP_Error Zone object or error.
*/
protected function validate_zone_by_method_instance( $instance_id ) {
$zone = WC_Shipping_Zones::get_zone_by( 'instance_id', $instance_id );
if ( ! $zone ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
return $zone;
}
}
PK [1]: B RestApi/Routes/V4/ShippingZoneMethod/ShippingZoneMethodService.phpnu 'Express', 'cost' => '10']).
* Available settings depend on the specific shipping method type.
* @return WC_Shipping_Method|\WP_Error Updated method object on success, WP_Error on validation failure.
*/
public function update_shipping_method_settings( $method, $settings ) {
if ( ! is_array( $settings ) ) {
return new \WP_Error(
'woocommerce_rest_shipping_method_invalid_settings',
__( 'Settings must be an array.', 'woocommerce' ),
array( 'status' => 400 )
);
}
$method->init_instance_settings();
$instance_settings = $method->instance_settings;
/**
* Transform setting keys to WooCommerce's expected format.
*
* WC_Settings_API::get_field_value() expects prefixed keys (e.g., 'woocommerce_flat_rate_1_title').
* Transform clean keys ('title') to prefixed keys before validation.
*/
$post_data = array();
foreach ( $settings as $key => $value ) {
$field_key = $method->get_field_key( $key );
$post_data[ $field_key ] = $value;
}
$form_fields = $method->get_instance_form_fields();
foreach ( $settings as $key => $value ) {
if ( isset( $form_fields[ $key ] ) ) {
try {
$instance_settings[ $key ] = $method->get_field_value( $key, $form_fields[ $key ], $post_data );
} catch ( \Exception $e ) {
return new \WP_Error(
'woocommerce_rest_shipping_method_invalid_setting',
$e->getMessage(),
array( 'status' => 400 )
);
}
}
}
/**
* Filter the instance settings values before saving.
*
* @since 9.4.0
* @param array $instance_settings Instance settings.
* @param WC_Shipping_Method $method Shipping method instance.
*/
$filtered_settings = apply_filters( 'woocommerce_shipping_' . $method->id . '_instance_settings_values', $instance_settings, $method );
$result = update_option( $method->get_instance_option_key(), $filtered_settings );
if ( $result ) {
$method->instance_settings = $instance_settings;
}
return $method;
}
/**
* Update a shipping method's properties.
*
* Updates settings, enabled status, and/or sort order for a shipping method instance.
*
* @since 9.4.0
*
* @param WC_Shipping_Method $method Shipping method instance to update.
* @param int $instance_id Method instance ID from the database.
* @param array $data {
* Method properties to update. All parameters are optional.
*
* @type array $settings Settings to update (key-value pairs). See update_shipping_method_settings().
* @type bool $enabled Whether the shipping method is enabled.
* @type int $order Sort order for displaying methods.
* }
* @param int|null $zone_id Zone ID. Optional, but required for firing the status toggle hook.
* @return WC_Shipping_Method|\WP_Error Updated method object on success, WP_Error on failure.
*/
public function update_shipping_zone_method( $method, $instance_id, $data, $zone_id = null ) {
global $wpdb;
$data = wp_parse_args(
$data,
array(
'settings' => null,
'enabled' => null,
'order' => null,
)
);
$updates = array();
$formats = array();
$enabled_changed = false;
if ( ! is_null( $data['settings'] ) ) {
$result = $this->update_shipping_method_settings( $method, $data['settings'] );
if ( is_wp_error( $result ) ) {
return $result;
}
}
if ( ! is_null( $data['enabled'] ) ) {
$updates['is_enabled'] = wc_string_to_bool( $data['enabled'] ) ? 1 : 0;
$formats[] = '%d';
$method->enabled = wc_string_to_bool( $data['enabled'] ) ? 'yes' : 'no';
$enabled_changed = true;
}
if ( ! is_null( $data['order'] ) ) {
$updates['method_order'] = absint( $data['order'] );
$formats[] = '%d';
$method->method_order = absint( $data['order'] );
}
if ( empty( $updates ) ) {
return $method;
}
$result = $wpdb->update(
"{$wpdb->prefix}woocommerce_shipping_zone_methods",
$updates,
array( 'instance_id' => $instance_id ),
$formats,
array( '%d' )
);
if ( false === $result ) {
return new WP_Error(
'update_failed',
__( 'Could not update shipping method.', 'woocommerce' )
);
}
if ( $enabled_changed && null !== $zone_id ) {
/**
* Fires when a shipping method's enabled status is toggled.
*
* @since 3.0.0
* @param int $instance_id Instance ID of the shipping method.
* @param string $method_id Shipping method ID (e.g., 'flat_rate').
* @param int $zone_id Zone ID.
* @param bool $is_enabled Whether the method is enabled.
*/
do_action(
'woocommerce_shipping_zone_method_status_toggled',
$instance_id,
$method->id,
$zone_id,
(bool) $updates['is_enabled']
);
}
WC_Cache_Helper::get_transient_version( 'shipping', true );
return $method;
}
}
PK [1]u3 3 ) RestApi/Routes/V4/Products/Controller.phpnu namespace,
'/' . $this->rest_base . '/suggested-products',
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => $this->with_cache(
array( $this, 'get_suggested_products' ),
array( 'endpoint_id' => 'get_suggested_products' )
),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_suggested_products_collection_params(),
),
'schema' => array( $this, 'get_public_item_schema' ),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)/duplicate',
array(
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'duplicate_product' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_public_item_schema' ),
)
);
}
/**
* Override the get_item permissions so that published products which are
* not password-protected are available to users without the
* 'read_private_posts' capability but can edit posts.
* This is required for the Product block in the editor, see:
* https://github.com/woocommerce/woocommerce/pull/61470
*
* @param WP_REST_Request $request Request data.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
$object = $this->get_object( (int) $request['id'] );
if ( $object && 0 !== $object->get_id() ) {
if ( 'product' !== $object->post_type && 'product_variation' !== $object->post_type ) {
return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
}
$object_id = $object->get_id();
$post_type_object = get_post_type_object( $object->post_type );
$permission = false;
if ( $post_type_object instanceof \WP_Post_Type ) {
// These are the default permissions inherited from
// `WC_REST_Products_V2_Controller`.
$permission = current_user_can( $post_type_object->cap->read_private_posts, $object_id );
// We add an special case when the post is published, not
// password-protected and the user has post edit capabilities.
if ( ! $permission && 'publish' === $object->get_status() && ! post_password_required( $object_id ) ) {
$permission = current_user_can( 'edit_posts' ) && current_user_can( $post_type_object->cap->read, $object_id );
}
}
/**
* Filter the permission to view a product.
*
* @since 10.4.0
* @param bool $permission The permission to view a product.
* @param string $cap The capability to check.
* @param int $object_id The ID of the product.
* @param string $post_type The post type of the product.
*/
$permission = apply_filters( 'woocommerce_rest_check_permissions', $permission, 'read', $object_id, $object->post_type );
if ( ! $permission ) {
return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot view this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
}
}
return true;
}
/**
* Duplicate a product and returns the duplicated product.
* The product status is set to "draft" and the name includes a "(copy)" at the end by default.
*
* @param WP_REST_Request $request Request data.
* @return WP_REST_Response|WP_Error
*/
public function duplicate_product( $request ) {
$product_id = $request->get_param( 'id' );
$product = wc_get_product( $product_id );
if ( ! $product ) {
return new WP_Error( 'woocommerce_rest_product_invalid_id', __( 'Invalid product ID.', 'woocommerce' ), array( 'status' => 404 ) );
}
// Creating product object from request data in preparation for copying.
$updated_product = $this->prepare_object_for_database( $request );
$duplicated_product = ( new WC_Admin_Duplicate_Product() )->product_duplicate( $updated_product );
if ( is_wp_error( $duplicated_product ) ) {
return new WP_Error( 'woocommerce_rest_product_duplicate_error', $duplicated_product->get_error_message(), array( 'status' => 400 ) );
}
$response_data = $duplicated_product->get_data();
return new WP_REST_Response( $response_data, 200 );
}
/**
* Get the images for a product or product variation.
*
* @param WC_Product|WC_Product_Variation $product Product instance.
* @return array
*/
protected function get_images( $product ) {
$images = array();
$attachment_ids = array();
// Add featured image.
if ( $product->get_image_id() ) {
$attachment_ids[] = $product->get_image_id();
}
// Add gallery images.
$attachment_ids = array_merge( $attachment_ids, $product->get_gallery_image_ids() );
// Build image data.
foreach ( $attachment_ids as $attachment_id ) {
$attachment_post = get_post( $attachment_id );
if ( is_null( $attachment_post ) ) {
continue;
}
$attachment = wp_get_attachment_image_src( $attachment_id, 'full' );
if ( ! is_array( $attachment ) ) {
continue;
}
$thumbnail = wp_get_attachment_image_src( $attachment_id, 'woocommerce_thumbnail' );
$images[] = array(
'id' => (int) $attachment_id,
'date_created' => wc_rest_prepare_date_response( $attachment_post->post_date, false ),
'date_created_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_date_gmt ) ),
'date_modified' => wc_rest_prepare_date_response( $attachment_post->post_modified, false ),
'date_modified_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_modified_gmt ) ),
'src' => current( $attachment ),
'name' => get_the_title( $attachment_id ),
'alt' => get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ),
'srcset' => (string) wp_get_attachment_image_srcset( $attachment_id, 'full' ),
'sizes' => (string) wp_get_attachment_image_sizes( $attachment_id, 'full' ),
'thumbnail' => current( $thumbnail ),
);
}
return $images;
}
/**
* Make extra product orderby features supported by WooCommerce available to the WC API.
* This includes 'price', 'popularity', and 'rating'.
*
* @param WP_REST_Request $request Request data.
* @return array
*/
protected function prepare_objects_query( $request ) {
$args = WC_REST_CRUD_Controller::prepare_objects_query( $request );
// Set post_status.
$args['post_status'] = $request['status'];
// Filter by a list of product statuses.
if ( ! empty( $request['include_status'] ) ) {
$args['post_status'] = $request['include_status'];
}
if ( ! empty( $request['exclude_status'] ) ) {
$this->exclude_status = $request['exclude_status'];
} else {
$this->exclude_status = array();
}
// Filter downloadable products.
if ( isset( $request['downloadable'] ) ) {
$args['meta_query'] = $this->add_meta_query( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$args,
array(
'key' => '_downloadable',
'value' => wc_bool_to_string( $request['downloadable'] ),
)
);
}
// Filter virtual products.
if ( isset( $request['virtual'] ) ) {
$args['meta_query'] = $this->add_meta_query( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$args,
array(
'key' => '_virtual',
'value' => wc_bool_to_string( $request['virtual'] ),
)
);
}
// Taxonomy query to filter products by type, category,
// tag, shipping class, and attribute.
$tax_query = array();
// Map between taxonomy name and arg's key.
$taxonomies = array(
'product_cat' => 'category',
'product_tag' => 'tag',
'product_shipping_class' => 'shipping_class',
);
// Set tax_query for each passed arg.
foreach ( $taxonomies as $taxonomy => $key ) {
if ( ! empty( $request[ $key ] ) ) {
$tax_query[] = array(
'taxonomy' => $taxonomy,
'field' => 'term_id',
'terms' => $request[ $key ],
);
}
}
if ( ! empty( $request['exclude_category'] ) ) {
$tax_query[] = array(
'taxonomy' => 'product_cat',
'field' => 'term_id',
'terms' => $request['exclude_category'],
'operator' => 'NOT IN',
);
}
// Filter product type by slug.
$terms = array();
if ( ! empty( $request['include_types'] ) ) {
$terms = $request['include_types'];
} elseif ( ! empty( $request['type'] ) ) {
$terms[] = $request['type'];
}
if ( ! empty( $terms ) ) {
$tax_query[] = array(
'taxonomy' => 'product_type',
'field' => 'slug',
'terms' => $terms,
);
}
// Add exclude types filter.
if ( ! empty( $request['exclude_types'] ) ) {
$tax_query[] = array(
'taxonomy' => 'product_type',
'field' => 'slug',
'terms' => $request['exclude_types'],
'operator' => 'NOT IN',
);
}
// Filter by attribute and term.
if ( ! empty( $request['attribute'] ) && ! empty( $request['attribute_term'] ) ) {
if ( in_array( $request['attribute'], wc_get_attribute_taxonomy_names(), true ) ) {
$tax_query[] = array(
'taxonomy' => $request['attribute'],
'field' => 'term_id',
'terms' => $request['attribute_term'],
);
}
}
// Build tax_query if taxonomies are set.
if ( ! empty( $tax_query ) ) {
if ( ! empty( $args['tax_query'] ) ) {
$args['tax_query'] = array_merge( $tax_query, $args['tax_query'] ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
} else {
$args['tax_query'] = $tax_query; // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
}
}
// Filter featured.
if ( is_bool( $request['featured'] ) ) {
$args['tax_query'][] = array(
'taxonomy' => 'product_visibility',
'field' => 'name',
'terms' => 'featured',
'operator' => true === $request['featured'] ? 'IN' : 'NOT IN',
);
}
// Search parameter precedence: search_fields > search_name_or_sku > search_sku > sku.
$search_fields = $request['search_fields'] ?? array();
$search_arg = trim( $request['search'] ?? '' );
if ( $search_fields && $search_arg ) {
$tokens = array_filter( array_map( 'trim', explode( ' ', $search_arg ) ) );
$this->search_fields_tokens = array(
'fields' => $search_fields,
'tokens' => $tokens,
);
unset( $request['search'], $request['search_sku'], $request['sku'], $request['search_name_or_sku'], $args['s'] );
}
$search_name_or_sku_arg = $request['search_name_or_sku'] ?? '';
if ( '' !== $search_name_or_sku_arg ) {
// Do a tokenized search for name or SKU. Supersedes the 'search', 'search_sku' and 'sku' arguments.
$tokens = array_filter( array_map( 'trim', explode( ' ', $search_name_or_sku_arg ) ) );
$this->search_name_or_sku_tokens = $tokens;
unset( $request['search'] );
unset( $args['s'] );
unset( $request['search_sku'] );
unset( $request['sku'] );
} elseif ( wc_product_sku_enabled() ) {
// Do a partial match for a sku. Supersedes the 'sku' argument, that does exact matching.
if ( ! empty( $request['search_sku'] ) ) {
// Store this for use in the query clause filters.
$this->search_sku_arg_value = $request['search_sku'];
unset( $request['sku'] );
}
// Filter by sku.
if ( ! empty( $request['sku'] ) ) {
$skus = explode( ',', $request['sku'] );
// Include the current string as a SKU too.
if ( 1 < count( $skus ) ) {
$skus[] = $request['sku'];
}
$args['meta_query'] = $this->add_meta_query( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$args,
array(
'key' => '_sku',
'value' => $skus,
'compare' => 'IN',
)
);
}
}
if ( ! empty( $request['global_unique_id'] ) ) {
$global_unique_ids = array_map( 'trim', explode( ',', $request['global_unique_id'] ) );
$args['meta_query'] = $this->add_meta_query( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$args,
array(
'key' => '_global_unique_id',
'value' => $global_unique_ids,
'compare' => 'IN',
)
);
}
// Filter by tax class.
if ( ! empty( $request['tax_class'] ) ) {
$args['meta_query'] = $this->add_meta_query( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$args,
array(
'key' => '_tax_class',
'value' => 'standard' !== $request['tax_class'] ? $request['tax_class'] : '',
)
);
}
// Price filter.
if ( ! empty( $request['min_price'] ) || ! empty( $request['max_price'] ) ) {
$args['meta_query'] = $this->add_meta_query( $args, wc_get_min_max_price_meta_query( $request ) ); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
}
// Filter product by stock_status.
if ( ! empty( $request['stock_status'] ) ) {
$args['meta_query'] = $this->add_meta_query( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
$args,
array(
'key' => '_stock_status',
'value' => $request['stock_status'],
)
);
}
// Filter by on sale products.
if ( is_bool( $request['on_sale'] ) ) {
$on_sale_key = $request['on_sale'] ? 'post__in' : 'post__not_in';
$on_sale_ids = wc_get_product_ids_on_sale();
// Use 0 when there's no on sale products to avoid return all products.
$on_sale_ids = empty( $on_sale_ids ) ? array( 0 ) : $on_sale_ids;
$args[ $on_sale_key ] += $on_sale_ids;
}
// Force the post_type argument, since it's not a user input variable.
if ( ! empty( $request['sku'] ) || ! empty( $request['search_sku'] ) || $this->search_name_or_sku_tokens || $this->search_fields_tokens ) {
$args['post_type'] = array( 'product', 'product_variation' );
} else {
$args['post_type'] = $this->post_type;
}
$ordering_args = WC()->query->get_catalog_ordering_args( $args['orderby'], $args['order'] );
$args['orderby'] = $ordering_args['orderby'];
$args['order'] = $ordering_args['order'];
if ( $ordering_args['meta_key'] ) {
$args['meta_key'] = $ordering_args['meta_key']; // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
}
/*
* When the suggested products ids is not empty,
* filter the query to return only the suggested products,
* overwriting the post__in parameter.
*/
if ( ! empty( $this->suggested_products_ids ) ) {
$args['post__in'] = $this->suggested_products_ids;
}
// Force the post_type argument, since it's not a user input variable.
if ( ! empty( $request['global_unique_id'] ) ) {
$args['post_type'] = array( 'product', 'product_variation' );
}
return $args;
}
/**
* Get objects.
*
* @param array $query_args Query args.
* @return array
*/
protected function get_objects( $query_args ) {
$add_search_criteria = $this->search_sku_arg_value || $this->search_name_or_sku_tokens || $this->search_fields_tokens;
// Add filters for search criteria in product postmeta via the lookup table.
if ( $add_search_criteria ) {
add_filter( 'posts_join', array( $this, 'add_search_criteria_to_wp_query_join' ) );
add_filter( 'posts_where', array( $this, 'add_search_criteria_to_wp_query_where' ) );
}
// Add filters for excluding product statuses.
if ( ! empty( $this->exclude_status ) ) {
add_filter( 'posts_where', array( $this, 'exclude_product_statuses' ) );
}
$result = parent::get_objects( $query_args );
// Remove filters for search criteria in product postmeta via the lookup table.
if ( $add_search_criteria ) {
remove_filter( 'posts_join', array( $this, 'add_search_criteria_to_wp_query_join' ) );
remove_filter( 'posts_where', array( $this, 'add_search_criteria_to_wp_query_where' ) );
$this->search_sku_arg_value = '';
$this->search_name_or_sku_tokens = null;
$this->search_fields_tokens = null;
}
// Remove filters for excluding product statuses.
if ( ! empty( $this->exclude_status ) ) {
remove_filter( 'posts_where', array( $this, 'exclude_product_statuses' ) );
$this->exclude_status = array();
}
return $result;
}
/**
* Join `wc_product_meta_lookup` table when SKU search query is present.
*
* @param string $join Join clause used to search posts.
* @return string
*/
public function add_search_criteria_to_wp_query_join( $join ) {
// Check if already joined to avoid duplicate joins.
if ( strstr( $join, 'wc_product_meta_lookup' ) ) {
return $join;
}
// Only join if we need meta table search.
if ( ! $this->search_fields_tokens &&
! $this->search_sku_arg_value &&
! ( $this->search_name_or_sku_tokens && wc_product_sku_enabled() ) ) {
return $join;
}
global $wpdb;
$join .= " LEFT JOIN $wpdb->wc_product_meta_lookup wc_product_meta_lookup
ON $wpdb->posts.ID = wc_product_meta_lookup.product_id ";
return $join;
}
/**
* Add a where clause for matching the SKU field.
*
* @param string $where Where clause used to search posts.
* @return string
*/
public function add_search_criteria_to_wp_query_where( $where ) {
global $wpdb;
if ( $this->search_fields_tokens ) {
$where .= $this->build_dynamic_search_clauses(
$this->search_fields_tokens['tokens'],
$this->search_fields_tokens['fields']
);
} elseif ( $this->search_name_or_sku_tokens ) {
$searchable_fields = wc_product_sku_enabled() ? array( 'name', 'sku' ) : array( 'name' );
$where .= $this->build_dynamic_search_clauses(
$this->search_name_or_sku_tokens,
$searchable_fields
);
} elseif ( ! empty( $this->search_sku_arg_value ) ) {
$like_search = '%' . $wpdb->esc_like( $this->search_sku_arg_value ) . '%';
$where .= ' AND ' . $wpdb->prepare( '(wc_product_meta_lookup.sku LIKE %s)', $like_search );
}
return $where;
}
/**
* Build search clauses for dynamic product search.
*
* @param array $tokens Search tokens.
* @param array $fields Fields to search in.
* @return string
*/
private function build_dynamic_search_clauses( $tokens, $fields ) {
global $wpdb;
if ( empty( $fields ) || empty( $tokens ) ) {
return '';
}
$column_map = array(
'name' => "{$wpdb->posts}.post_title",
'sku' => 'wc_product_meta_lookup.sku',
'global_unique_id' => 'wc_product_meta_lookup.global_unique_id',
'description' => "{$wpdb->posts}.post_content",
'short_description' => "{$wpdb->posts}.post_excerpt",
);
$field_clauses = array();
foreach ( $tokens as $token ) {
$like_search = '%' . $wpdb->esc_like( $token ) . '%';
$field_token_clauses = array();
foreach ( $fields as $field ) {
if ( ! isset( $column_map[ $field ] ) ) {
continue;
}
$db_column = $column_map[ $field ];
$field_token_clauses[] = $wpdb->prepare( "({$db_column} LIKE %s)", $like_search ); // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
if ( $field_token_clauses ) {
$field_clauses[] = '(' . implode( ' OR ', $field_token_clauses ) . ')';
}
}
return $field_clauses ? ' AND (' . implode( ' AND ', $field_clauses ) . ')' : '';
}
/**
* Exclude product statuses from the query.
*
* @param string $where Where clause used to search posts.
* @return string
*/
public function exclude_product_statuses( $where ) {
if ( ! empty( $this->exclude_status ) && is_array( $this->exclude_status ) ) {
global $wpdb;
$not_in = array();
foreach ( $this->exclude_status as $status_to_exclude ) {
$not_in[] = $wpdb->prepare( '%s', $status_to_exclude );
}
$not_in = join( ', ', $not_in );
return $where . " AND $wpdb->posts.post_status NOT IN ( $not_in )";
}
return $where;
}
/**
* Set product images.
*
* @throws WC_REST_Exception REST API exceptions.
* @param WC_Product $product Product instance.
* @param array $images Images data.
* @return WC_Product
*/
protected function set_product_images( $product, $images ) {
$images = is_array( $images ) ? array_filter( $images ) : array();
if ( ! empty( $images ) ) {
$gallery = array();
foreach ( $images as $index => $image ) {
$attachment_id = isset( $image['id'] ) ? absint( $image['id'] ) : 0;
// The request can contain an attachment ID, if it doesn't, it's a new upload.
$is_new_upload = false;
if ( 0 === $attachment_id && isset( $image['src'] ) ) {
$upload = wc_rest_upload_image_from_url( esc_url_raw( $image['src'] ) );
if ( is_wp_error( $upload ) ) {
/**
* Filter to check if it should suppress the image upload error, false by default.
*/
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $product->get_id(), $images ) ) { // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
throw new WC_REST_Exception( 'woocommerce_product_image_upload_error', $upload->get_error_message(), 400 ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
} else {
continue;
}
}
$attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $product->get_id() );
$is_new_upload = true;
}
if ( ! wp_attachment_is_image( $attachment_id ) ) {
/* translators: %s: image ID */
throw new WC_REST_Exception( 'woocommerce_product_invalid_image_id', sprintf( __( '#%s is an invalid image ID.', 'woocommerce' ), $attachment_id ), 400 ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
}
if ( $is_new_upload && $attachment_id > 0 ) {
// Tracking this for rollback purposes.
$this->processed_attachment_ids_for_request[] = $attachment_id;
}
$featured_image = $product->get_image_id();
if ( 0 === $index ) {
$product->set_image_id( $attachment_id );
wc_product_attach_featured_image( $attachment_id, $product, false );
} else {
$gallery[] = $attachment_id;
}
// Set the image alt if present.
if ( ! empty( $image['alt'] ) ) {
update_post_meta( $attachment_id, '_wp_attachment_image_alt', wc_clean( $image['alt'] ) );
}
// Set the image name if present.
if ( ! empty( $image['name'] ) ) {
wp_update_post(
array(
'ID' => $attachment_id,
'post_title' => $image['name'],
)
);
}
}
$product->set_gallery_image_ids( $gallery );
} else {
$product->set_image_id( '' );
$product->set_gallery_image_ids( array() );
}
return $product;
}
/**
* Prepare a single product for create or update.
*
* @param WP_REST_Request $request Request object.
* @param bool $creating If is creating a new object.
* @return WP_Error|WC_Data
*/
protected function prepare_object_for_database( $request, $creating = false ) {
$id = isset( $request['id'] ) ? absint( $request['id'] ) : 0;
// Type is the most important part here because we need to be using the correct class and methods.
if ( isset( $request['type'] ) ) {
$classname = WC_Product_Factory::get_classname_from_product_type( $request['type'] );
if ( ! class_exists( $classname ) ) {
$classname = 'WC_Product_Simple';
}
$product = new $classname( $id );
} elseif ( isset( $request['id'] ) ) {
$product = wc_get_product( $id );
} else {
$product = new WC_Product_Simple();
}
if ( ProductType::VARIATION === $product->get_type() ) {
return new WP_Error(
"woocommerce_rest_invalid_{$this->post_type}_id",
__( 'To manipulate product variations you should use the /products/<product_id>/variations/<id> endpoint.', 'woocommerce' ),
array(
'status' => 404,
)
);
}
// Post title.
if ( isset( $request['name'] ) ) {
$product->set_name( wp_filter_post_kses( $request['name'] ) );
}
// Post content.
if ( isset( $request['description'] ) ) {
$product->set_description( wp_filter_post_kses( $request['description'] ) );
}
// Post excerpt.
if ( isset( $request['short_description'] ) ) {
$product->set_short_description( wp_filter_post_kses( $request['short_description'] ) );
}
// Post status.
if ( isset( $request['status'] ) ) {
$product->set_status( get_post_status_object( $request['status'] ) ? $request['status'] : ProductStatus::DRAFT );
}
// Post slug.
if ( isset( $request['slug'] ) ) {
$product->set_slug( $request['slug'] );
}
// Menu order.
if ( isset( $request['menu_order'] ) ) {
$product->set_menu_order( $request['menu_order'] );
}
// Comment status.
if ( isset( $request['reviews_allowed'] ) ) {
$product->set_reviews_allowed( $request['reviews_allowed'] );
}
// Post password.
if ( isset( $request['post_password'] ) ) {
$product->set_post_password( $request['post_password'] );
}
// Virtual.
if ( isset( $request['virtual'] ) ) {
$product->set_virtual( $request['virtual'] );
}
// Tax status.
if ( isset( $request['tax_status'] ) ) {
$product->set_tax_status( $request['tax_status'] );
}
// Tax Class.
if ( isset( $request['tax_class'] ) ) {
$product->set_tax_class( $request['tax_class'] );
}
// Catalog Visibility.
if ( isset( $request['catalog_visibility'] ) ) {
$product->set_catalog_visibility( $request['catalog_visibility'] );
}
// Purchase Note.
if ( isset( $request['purchase_note'] ) ) {
$product->set_purchase_note( wp_kses_post( wp_unslash( $request['purchase_note'] ) ) );
}
// Featured Product.
if ( isset( $request['featured'] ) ) {
$product->set_featured( $request['featured'] );
}
// Shipping data.
$product = $this->save_product_shipping_data( $product, $request );
// SKU.
if ( isset( $request['sku'] ) ) {
$product->set_sku( wc_clean( $request['sku'] ) );
}
// Unique ID.
if ( isset( $request['global_unique_id'] ) ) {
$product->set_global_unique_id( wc_clean( $request['global_unique_id'] ) );
}
// Attributes.
if ( isset( $request['attributes'] ) ) {
$attributes = array();
foreach ( $request['attributes'] as $attribute ) {
$attribute_id = 0;
$attribute_name = '';
// Check ID for global attributes or name for product attributes.
if ( ! empty( $attribute['id'] ) ) {
$attribute_id = absint( $attribute['id'] );
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
} elseif ( ! empty( $attribute['name'] ) ) {
$attribute_name = wc_clean( $attribute['name'] );
}
if ( ! $attribute_id && ! $attribute_name ) {
continue;
}
if ( $attribute_id ) {
if ( isset( $attribute['options'] ) ) {
$options = $attribute['options'];
if ( ! is_array( $attribute['options'] ) ) {
// Text based attributes - Posted values are term names.
$options = explode( WC_DELIMITER, $options );
}
$values = array_map( 'wc_sanitize_term_text_based', $options );
$values = array_filter( $values, 'strlen' );
} else {
$values = array();
}
if ( ! empty( $values ) ) {
// Add attribute to array, but don't set values.
$attribute_object = new WC_Product_Attribute();
$attribute_object->set_id( $attribute_id );
$attribute_object->set_name( $attribute_name );
$attribute_object->set_options( $values );
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
$attributes[] = $attribute_object;
}
} elseif ( isset( $attribute['options'] ) ) {
// Custom attribute - Add attribute to array and set the values.
if ( is_array( $attribute['options'] ) ) {
$values = $attribute['options'];
} else {
$values = explode( WC_DELIMITER, $attribute['options'] );
}
$attribute_object = new WC_Product_Attribute();
$attribute_object->set_name( $attribute_name );
$attribute_object->set_options( $values );
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
$attributes[] = $attribute_object;
}
}
$product->set_attributes( $attributes );
}
// Sales and prices.
if ( in_array( $product->get_type(), array( ProductType::VARIABLE, ProductType::GROUPED ), true ) ) {
$product->set_regular_price( '' );
$product->set_sale_price( '' );
$product->set_date_on_sale_to( '' );
$product->set_date_on_sale_from( '' );
$product->set_price( '' );
} else {
// Regular Price.
if ( isset( $request['regular_price'] ) ) {
$product->set_regular_price( $request['regular_price'] );
}
// Sale Price.
if ( isset( $request['sale_price'] ) ) {
$product->set_sale_price( $request['sale_price'] );
}
if ( isset( $request['date_on_sale_from'] ) ) {
$product->set_date_on_sale_from( $request['date_on_sale_from'] );
}
if ( isset( $request['date_on_sale_from_gmt'] ) ) {
$product->set_date_on_sale_from( $request['date_on_sale_from_gmt'] ? strtotime( $request['date_on_sale_from_gmt'] ) : null );
}
if ( isset( $request['date_on_sale_to'] ) ) {
$product->set_date_on_sale_to( $request['date_on_sale_to'] );
}
if ( isset( $request['date_on_sale_to_gmt'] ) ) {
$product->set_date_on_sale_to( $request['date_on_sale_to_gmt'] ? strtotime( $request['date_on_sale_to_gmt'] ) : null );
}
}
// Product parent ID.
if ( isset( $request['parent_id'] ) ) {
$product->set_parent_id( $request['parent_id'] );
}
// Sold individually.
if ( isset( $request['sold_individually'] ) ) {
$product->set_sold_individually( $request['sold_individually'] );
}
// Stock status; stock_status has priority over in_stock.
if ( isset( $request['stock_status'] ) ) {
$stock_status = $request['stock_status'];
} else {
$stock_status = $product->get_stock_status();
}
// Stock data.
if ( 'yes' === get_option( 'woocommerce_manage_stock' ) ) {
// Manage stock.
if ( isset( $request['manage_stock'] ) ) {
$product->set_manage_stock( $request['manage_stock'] );
}
// Backorders.
if ( isset( $request['backorders'] ) ) {
$product->set_backorders( $request['backorders'] );
}
if ( $product->is_type( ProductType::GROUPED ) ) {
$product->set_manage_stock( 'no' );
$product->set_backorders( 'no' );
$product->set_stock_quantity( '' );
$product->set_stock_status( $stock_status );
} elseif ( $product->is_type( ProductType::EXTERNAL ) ) {
$product->set_manage_stock( 'no' );
$product->set_backorders( 'no' );
$product->set_stock_quantity( '' );
$product->set_stock_status( ProductStockStatus::IN_STOCK );
} elseif ( $product->get_manage_stock() ) {
// Stock status is always determined by children so sync later.
if ( ! $product->is_type( ProductType::VARIABLE ) ) {
$product->set_stock_status( $stock_status );
}
// Stock quantity.
if ( isset( $request['stock_quantity'] ) ) {
$product->set_stock_quantity( wc_stock_amount( $request['stock_quantity'] ) );
} elseif ( isset( $request['inventory_delta'] ) ) {
$stock_quantity = wc_stock_amount( $product->get_stock_quantity() );
$stock_quantity += wc_stock_amount( $request['inventory_delta'] );
$product->set_stock_quantity( wc_stock_amount( $stock_quantity ) );
}
// Low stock amount.
// isset() returns false for value null, thus we need to check whether the value has been sent by the request.
if ( array_key_exists( 'low_stock_amount', $request->get_params() ) ) {
if ( null === $request['low_stock_amount'] ) {
$product->set_low_stock_amount( '' );
} else {
$product->set_low_stock_amount( wc_stock_amount( $request['low_stock_amount'] ) );
}
}
} else {
// Don't manage stock.
$product->set_manage_stock( 'no' );
$product->set_stock_quantity( '' );
$product->set_stock_status( $stock_status );
$product->set_low_stock_amount( '' );
}
} elseif ( ! $product->is_type( ProductType::VARIABLE ) ) {
$product->set_stock_status( $stock_status );
}
// Upsells.
if ( isset( $request['upsell_ids'] ) ) {
$upsells = array();
$ids = $request['upsell_ids'];
if ( ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( $id && $id > 0 ) {
$upsells[] = $id;
}
}
}
$product->set_upsell_ids( $upsells );
}
// Cross sells.
if ( isset( $request['cross_sell_ids'] ) ) {
$crosssells = array();
$ids = $request['cross_sell_ids'];
if ( ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( $id && $id > 0 ) {
$crosssells[] = $id;
}
}
}
$product->set_cross_sell_ids( $crosssells );
}
// Product categories.
if ( isset( $request['categories'] ) && is_array( $request['categories'] ) ) {
$product = $this->save_taxonomy_terms( $product, $request['categories'] );
}
// Product tags.
if ( isset( $request['tags'] ) && is_array( $request['tags'] ) ) {
$new_tags = array();
foreach ( $request['tags'] as $tag ) {
if ( ! isset( $tag['name'] ) ) {
$new_tags[] = $tag;
continue;
}
if ( ! term_exists( $tag['name'], 'product_tag' ) ) {
// Create the tag if it doesn't exist.
$term = wp_insert_term( $tag['name'], 'product_tag' );
if ( ! is_wp_error( $term ) ) {
$new_tags[] = array(
'id' => $term['term_id'],
);
continue;
}
} else {
// Tag exists, assume user wants to set the product with this tag.
$new_tags[] = array(
'id' => get_term_by( 'name', $tag['name'], 'product_tag' )->term_id,
);
}
}
$product = $this->save_taxonomy_terms( $product, $new_tags, 'tag' );
}
// Downloadable.
if ( isset( $request['downloadable'] ) ) {
$product->set_downloadable( $request['downloadable'] );
}
// Downloadable options.
if ( $product->get_downloadable() ) {
// Downloadable files.
if ( isset( $request['downloads'] ) && is_array( $request['downloads'] ) ) {
$product = $this->save_downloadable_files( $product, $request['downloads'] );
}
// Download limit.
if ( isset( $request['download_limit'] ) ) {
$product->set_download_limit( $request['download_limit'] );
}
// Download expiry.
if ( isset( $request['download_expiry'] ) ) {
$product->set_download_expiry( $request['download_expiry'] );
}
}
// Product url and button text for external products.
if ( $product->is_type( ProductType::EXTERNAL ) ) {
if ( isset( $request['external_url'] ) ) {
$product->set_product_url( $request['external_url'] );
}
if ( isset( $request['button_text'] ) ) {
$product->set_button_text( $request['button_text'] );
}
}
// Save default attributes for variable products.
if ( $product->is_type( ProductType::VARIABLE ) ) {
$product = $this->save_default_attributes( $product, $request );
}
// Set children for a grouped product.
if ( $product->is_type( ProductType::GROUPED ) && isset( $request['grouped_products'] ) ) {
$product->set_children( $request['grouped_products'] );
}
// Check for featured/gallery images, upload it and set it.
if ( isset( $request['images'] ) ) {
$product = $this->set_product_images( $product, $request['images'] );
}
// Allow set meta_data.
if ( is_array( $request['meta_data'] ) ) {
foreach ( $request['meta_data'] as $meta ) {
$product->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
if ( ! empty( $request['date_created'] ) ) {
$date = rest_parse_date( $request['date_created'] );
if ( $date ) {
$product->set_date_created( $date );
}
}
if ( ! empty( $request['date_created_gmt'] ) ) {
$date = rest_parse_date( $request['date_created_gmt'], true );
if ( $date ) {
$product->set_date_created( $date );
}
}
if ( $this->cogs_is_enabled() ) {
$this->set_cogs_info_in_product_object( $request, $product );
}
/**
* Filters an object before it is inserted via the REST API.
*
* The dynamic portion of the hook name, `$this->post_type`,
* refers to the object type slug.
*
* @param WC_Data $product Object object.
* @param WP_REST_Request $request Request object.
* @param bool $creating If is creating a new object.
*/
return apply_filters( "woocommerce_rest_pre_insert_{$this->post_type}_object", $product, $request, $creating ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
}
/**
* Get the Product's schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
$weight_unit_label = I18nUtil::get_weight_unit_label( get_option( 'woocommerce_weight_unit', 'kg' ) );
$dimension_unit_label = I18nUtil::get_dimensions_unit_label( get_option( 'woocommerce_dimension_unit', 'cm' ) );
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => $this->post_type,
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Product name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'slug' => array(
'description' => __( 'Product slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'permalink' => array(
'description' => __( 'Product URL.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the product was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'date_created_gmt' => array(
'description' => __( 'The date the product was created, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'date_modified' => array(
'description' => __( "The date the product was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified_gmt' => array(
'description' => __( 'The date the product was last modified, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'type' => array(
'description' => __( 'Product type.', 'woocommerce' ),
'type' => 'string',
'default' => ProductType::SIMPLE,
'enum' => array_keys( wc_get_product_types() ),
'context' => array( 'view', 'edit' ),
),
'status' => array(
'description' => __( 'Product status (post status).', 'woocommerce' ),
'type' => 'string',
'default' => ProductStatus::PUBLISH,
'enum' => array_merge( array_keys( get_post_statuses() ), array( ProductStatus::FUTURE, ProductStatus::AUTO_DRAFT, ProductStatus::TRASH ) ),
'context' => array( 'view', 'edit' ),
),
'featured' => array(
'description' => __( 'Featured product.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'catalog_visibility' => array(
'description' => __( 'Catalog visibility.', 'woocommerce' ),
'type' => 'string',
'default' => CatalogVisibility::VISIBLE,
'enum' => array( CatalogVisibility::VISIBLE, CatalogVisibility::CATALOG, CatalogVisibility::SEARCH, CatalogVisibility::HIDDEN ),
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'Product description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'short_description' => array(
'description' => __( 'Product short description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'sku' => array(
'description' => __( 'Stock Keeping Unit.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'global_unique_id' => array(
'description' => __( 'GTIN, UPC, EAN or ISBN.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'price' => array(
'description' => __( 'Current product price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'regular_price' => array(
'description' => __( 'Product regular price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'sale_price' => array(
'description' => __( 'Product sale price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_from' => array(
'description' => __( "Start date of sale price, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_from_gmt' => array(
'description' => __( 'Start date of sale price, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_to' => array(
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'date_on_sale_to_gmt' => array(
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
),
'price_html' => array(
'description' => __( 'Price formatted in HTML.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'on_sale' => array(
'description' => __( 'Shows if the product is on sale.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'purchasable' => array(
'description' => __( 'Shows if the product can be bought.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'total_sales' => array(
'description' => __( 'Amount of sales.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'virtual' => array(
'description' => __( 'If the product is virtual.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'downloadable' => array(
'description' => __( 'If the product is downloadable.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'downloads' => array(
'description' => __( 'List of downloadable files.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'File ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'File name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'file' => array(
'description' => __( 'File URL.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
'download_limit' => array(
'description' => __( 'Number of times downloadable files can be downloaded after purchase.', 'woocommerce' ),
'type' => 'integer',
'default' => -1,
'context' => array( 'view', 'edit' ),
),
'download_expiry' => array(
'description' => __( 'Number of days until access to downloadable files expires.', 'woocommerce' ),
'type' => 'integer',
'default' => -1,
'context' => array( 'view', 'edit' ),
),
'external_url' => array(
'description' => __( 'Product external URL. Only for external products.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
),
'button_text' => array(
'description' => __( 'Product external button text. Only for external products.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'tax_status' => array(
'description' => __( 'Tax status.', 'woocommerce' ),
'type' => 'string',
'default' => ProductTaxStatus::TAXABLE,
'enum' => array( ProductTaxStatus::TAXABLE, ProductTaxStatus::SHIPPING, ProductTaxStatus::NONE ),
'context' => array( 'view', 'edit' ),
),
'tax_class' => array(
'description' => __( 'Tax class.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'manage_stock' => array(
'description' => __( 'Stock management at product level.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'stock_quantity' => array(
'description' => __( 'Stock quantity.', 'woocommerce' ),
'type' => wc_is_stock_amount_integer() ? 'integer' : 'number',
'context' => array( 'view', 'edit' ),
),
'stock_status' => array(
'description' => __( 'Controls the stock status of the product.', 'woocommerce' ),
'type' => 'string',
'default' => ProductStockStatus::IN_STOCK,
'enum' => array_keys( wc_get_product_stock_status_options() ),
'context' => array( 'view', 'edit' ),
),
'backorders' => array(
'description' => __( 'If managing stock, this controls if backorders are allowed.', 'woocommerce' ),
'type' => 'string',
'default' => 'no',
'enum' => array( 'no', 'notify', 'yes' ),
'context' => array( 'view', 'edit' ),
),
'backorders_allowed' => array(
'description' => __( 'Shows if backorders are allowed.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'backordered' => array(
'description' => __( 'Shows if the product is on backordered.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'low_stock_amount' => array(
'description' => __( 'Low Stock amount for the product.', 'woocommerce' ),
'type' => array( 'integer', 'null' ),
'context' => array( 'view', 'edit' ),
),
'sold_individually' => array(
'description' => __( 'Allow one item to be bought in a single order.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'weight' => array(
/* translators: %s: weight unit */
'description' => sprintf( __( 'Product weight (%s).', 'woocommerce' ), $weight_unit_label ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'dimensions' => array(
'description' => __( 'Product dimensions.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'properties' => array(
'length' => array(
/* translators: %s: dimension unit */
'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), $dimension_unit_label ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'width' => array(
/* translators: %s: dimension unit */
'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), $dimension_unit_label ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'height' => array(
/* translators: %s: dimension unit */
'description' => sprintf( __( 'Product height (%s).', 'woocommerce' ), $dimension_unit_label ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
'shipping_required' => array(
'description' => __( 'Shows if the product need to be shipped.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'shipping_taxable' => array(
'description' => __( 'Shows whether or not the product shipping is taxable.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'shipping_class' => array(
'description' => __( 'Shipping class slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'shipping_class_id' => array(
'description' => __( 'Shipping class ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'reviews_allowed' => array(
'description' => __( 'Allow reviews.', 'woocommerce' ),
'type' => 'boolean',
'default' => true,
'context' => array( 'view', 'edit' ),
),
'post_password' => array(
'description' => __( 'Post password.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'average_rating' => array(
'description' => __( 'Reviews average rating.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'rating_count' => array(
'description' => __( 'Amount of reviews that the product have.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'related_ids' => array(
'description' => __( 'List of related products IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'upsell_ids' => array(
'description' => __( 'List of up-sell products IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
),
'cross_sell_ids' => array(
'description' => __( 'List of cross-sell products IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
),
'parent_id' => array(
'description' => __( 'Product parent ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'purchase_note' => array(
'description' => __( 'Optional note to send the customer after purchase.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'categories' => array(
'description' => __( 'List of categories.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Category ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Category name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'description' => __( 'Category slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'brands' => array(
'description' => __( 'List of brands.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Brand ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Brand name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'description' => __( 'Brand slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'tags' => array(
'description' => __( 'List of tags.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tag ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Tag name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'description' => __( 'Tag slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'images' => array(
'description' => __( 'List of images.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Image ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'date_created' => array(
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_created_gmt' => array(
'description' => __( 'The date the image was created, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the image was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'date_modified_gmt' => array(
'description' => __( 'The date the image was last modified, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'src' => array(
'description' => __( 'Image URL.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Image name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'alt' => array(
'description' => __( 'Image alternative text.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
'has_options' => array(
'description' => __( 'Shows if the product needs to be configured before it can be bought.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'attributes' => array(
'description' => __( 'List of attributes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Attribute ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Attribute name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'position' => array(
'description' => __( 'Attribute position.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'visible' => array(
'description' => __( "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'variation' => array(
'description' => __( 'Define if the attribute can be used as variation.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'options' => array(
'description' => __( 'List of available term names of the attribute.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
),
'context' => array( 'view', 'edit' ),
),
),
),
),
'default_attributes' => array(
'description' => __( 'Defaults variation attributes.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Attribute ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'name' => array(
'description' => __( 'Attribute name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'option' => array(
'description' => __( 'Selected attribute term name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
),
),
'variations' => array(
'description' => __( 'List of variations IDs.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'integer',
),
'readonly' => true,
),
'grouped_products' => array(
'description' => __( 'List of grouped products ID.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'menu_order' => array(
'description' => __( 'Menu order, used to custom sort products.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'meta_data' => array(
'description' => __( 'Meta data.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => 'mixed',
'context' => array( 'view', 'edit' ),
),
),
),
),
),
);
$post_type_obj = get_post_type_object( $this->post_type );
if ( is_post_type_viewable( $post_type_obj ) && $post_type_obj->public ) {
$schema['properties']['permalink_template'] = array(
'description' => __( 'Permalink template for the product.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'edit' ),
'readonly' => true,
);
$schema['properties']['generated_slug'] = array(
'description' => __( 'Slug automatically generated from the product name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'edit' ),
'readonly' => true,
);
}
if ( $this->cogs_is_enabled() ) {
$schema = $this->add_cogs_related_product_schema( $schema, false );
}
// New properties added for v4.
$schema['properties']['min_price'] = array(
'description' => __( 'Product minimum price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
);
$schema['properties']['max_price'] = array(
'description' => __( 'Product maximum price.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
);
$schema['properties']['add_to_cart'] = array(
'description' => __( 'Add to cart details.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'properties' => array(
'url' => array(
'description' => __( 'Add to cart URL.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'Add to cart description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'text' => array(
'description' => __( 'Add to cart text.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'single_text' => array(
'description' => __( 'Add to cart single text.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
'readonly' => true,
);
return $this->add_additional_fields_schema( $schema );
}
/**
* Add new options for 'orderby' to the collection params.
*
* @return array
*/
public function get_collection_params() {
$params = parent::get_collection_params();
$params['orderby']['enum'] = array_merge( $params['orderby']['enum'], array( 'price', 'popularity', 'rating' ) );
unset( $params['in_stock'] );
$params['stock_status'] = array(
'description' => __( 'Limit result set to products with specified stock status.', 'woocommerce' ),
'type' => 'string',
'enum' => array_keys( wc_get_product_stock_status_options() ),
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
$params['search_sku'] = array(
'description' => __( "Limit results to those with a SKU that partial matches a string. This argument takes precedence over 'sku'.", 'woocommerce' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
$params['search_name_or_sku'] = array(
'description' => __( "Limit results to those with a name or SKU that partial matches a string. This argument takes precedence over 'search', 'sku' and 'search_sku'.", 'woocommerce' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
$search_fields_enum = array( 'name', 'global_unique_id', 'description', 'short_description' );
if ( wc_product_sku_enabled() ) {
$search_fields_enum[] = 'sku';
}
$params['search_fields'] = array(
'description' => __( 'Limit search to specific fields when used with search parameter. Available fields: name, sku, global_unique_id, description, short_description. This argument takes precedence over all other search parameters.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => $search_fields_enum,
),
'default' => array(),
'sanitize_callback' => 'wp_parse_slug_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['include_status'] = array(
'description' => __( 'Limit result set to products with any of the statuses.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => array_merge( array( 'any', ProductStatus::FUTURE, ProductStatus::TRASH ), array_keys( get_post_statuses() ) ),
),
'sanitize_callback' => 'wp_parse_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['exclude_status'] = array(
'description' => __( 'Exclude products with any of the statuses from result set.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => array_merge( array( ProductStatus::FUTURE, ProductStatus::TRASH ), array_keys( get_post_statuses() ) ),
),
'sanitize_callback' => 'wp_parse_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['include_types'] = array(
'description' => __( 'Limit result set to products with any of the types.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => array_keys( wc_get_product_types() ),
),
'sanitize_callback' => 'wp_parse_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['exclude_types'] = array(
'description' => __( 'Exclude products with any of the types from result set.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => array_keys( wc_get_product_types() ),
),
'sanitize_callback' => 'wp_parse_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['exclude_category'] = array(
'description' => __( 'Exclude products that belong to specific product category IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'default' => array(),
'sanitize_callback' => 'wp_parse_id_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['downloadable'] = array(
'description' => __( 'Limit result set to downloadable products.', 'woocommerce' ),
'type' => 'boolean',
'sanitize_callback' => 'rest_sanitize_boolean',
'validate_callback' => 'rest_validate_request_arg',
);
$params['virtual'] = array(
'description' => __( 'Limit result set to virtual products.', 'woocommerce' ),
'type' => 'boolean',
'sanitize_callback' => 'rest_sanitize_boolean',
'validate_callback' => 'rest_validate_request_arg',
);
return $params;
}
/**
* Add new options for the suggested-products endpoint.
*
* @return array
*/
public function get_suggested_products_collection_params() {
$params = parent::get_collection_params();
$params['categories'] = array(
'description' => __( 'Limit result set to specific product categorie ids.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'default' => array(),
'sanitize_callback' => 'wp_parse_id_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['tags'] = array(
'description' => __( 'Limit result set to specific product tag ids.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'default' => array(),
'validate_callback' => 'rest_validate_request_arg',
'sanitize_callback' => 'wp_parse_id_list',
);
$params['limit'] = array(
'description' => __( 'Limit result set to specific amount of suggested products.', 'woocommerce' ),
'type' => 'integer',
'default' => 5,
'validate_callback' => 'rest_validate_request_arg',
'sanitize_callback' => 'absint',
);
return $params;
}
/**
* Get the downloads for a product.
*
* @param WC_Product $product Product instance.
*
* @return array
*/
protected function get_downloads( $product ) {
$downloads = array();
$context = isset( $this->request ) && isset( $this->request['context'] ) ? $this->request['context'] : 'view';
if ( $product->is_downloadable() || 'edit' === $context ) {
foreach ( $product->get_downloads() as $file_id => $file ) {
$downloads[] = array(
'id' => $file_id, // MD5 hash.
'name' => $file['name'],
'file' => $file['file'],
);
}
}
return $downloads;
}
/**
* Get product data.
*
* @param WC_Product $product Product instance.
* @param string $context Request context. Options: 'view' and 'edit'.
*
* @return array
*/
protected function get_product_data( $product, $context = 'view' ) {
$data = parent::get_product_data( ...func_get_args() );
if ( isset( $this->request ) ) {
$fields = $this->get_fields_for_response( $this->request );
// Add stock_status if needed.
if ( in_array( 'stock_status', $fields, true ) ) {
$data['stock_status'] = $product->get_stock_status( $context );
}
// Add has_options if needed.
if ( in_array( 'has_options', $fields, true ) ) {
$data['has_options'] = $product->has_options( $context );
}
if ( in_array( 'post_password', $fields, true ) ) {
$data['post_password'] = $product->get_post_password( $context );
}
if ( in_array( 'global_unique_id', $fields, true ) ) {
$data['global_unique_id'] = $product->get_global_unique_id( $context );
}
if ( in_array( 'min_price', $fields, true ) ) {
$data['min_price'] = method_exists( $product, 'get_min_price' ) ? $product->get_min_price() : '';
}
if ( in_array( 'max_price', $fields, true ) ) {
$data['max_price'] = method_exists( $product, 'get_max_price' ) ? $product->get_max_price() : '';
}
$post_type_obj = get_post_type_object( $this->post_type );
if ( is_post_type_viewable( $post_type_obj ) && $post_type_obj->public ) {
$permalink_template_requested = in_array( 'permalink_template', $fields, true );
$generated_slug_requested = in_array( 'generated_slug', $fields, true );
if ( $permalink_template_requested || $generated_slug_requested ) {
if ( ! function_exists( 'get_sample_permalink' ) ) {
require_once ABSPATH . 'wp-admin/includes/post.php';
}
$sample_permalink = get_sample_permalink( $product->get_id(), $product->get_name(), '' );
// Add permalink_template if needed.
if ( $permalink_template_requested ) {
$data['permalink_template'] = $sample_permalink[0];
}
// Add generated_slug if needed.
if ( $generated_slug_requested ) {
$data['generated_slug'] = $sample_permalink[1];
}
}
}
}
return $data;
}
/**
* Get the suggested products.
*
* @param WP_REST_Request $request Request object.
* @return object
*/
public function get_suggested_products( $request ) {
$categories = $request->get_param( 'categories' );
$tags = $request->get_param( 'tags' );
$exclude_ids = $request->get_param( 'exclude' );
$limit = $request->get_param( 'limit' ) ? $request->get_param( 'limit' ) : 5;
$data_store = \WC_Data_Store::load( 'product' );
// @phpstan-ignore-next-line method.notFound
$this->suggested_products_ids = $data_store->get_related_products(
$categories,
$tags,
$exclude_ids,
$limit,
null // No need to pass the product ID.
);
// When no suggested products are found, return an empty array.
if ( empty( $this->suggested_products_ids ) ) {
return array();
}
// Ensure to respect the limit, since the data store may return more than the limit.
$this->suggested_products_ids = array_slice( $this->suggested_products_ids, 0, $limit );
return parent::get_items( $request );
}
/**
* Core function to prepare a single product output for response
* (doesn't fire hooks, ensure_response, or add links).
*
* @param WC_Data $object_data Object data.
* @param WP_REST_Request $request Request object.
* @param string $context Request context.
* @return array Product data to be included in the response.
*/
protected function prepare_object_for_response_core( $object_data, $request, $context ): array {
$data = parent::prepare_object_for_response_core( $object_data, $request, $context );
if ( $this->cogs_is_enabled() ) {
$this->add_cogs_info_to_returned_product_data( $data, $object_data );
}
$data['add_to_cart'] = array(
'url' => $object_data->add_to_cart_url(),
'description' => $object_data->add_to_cart_description(),
'text' => $object_data->add_to_cart_text(),
'single_text' => $object_data->single_add_to_cart_text(),
);
return $data;
}
/**
* Create a single item.
* Handles cleanup of orphaned images if product creation fails.
*
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function create_item( $request ) {
$this->processed_attachment_ids_for_request = array();
$response = parent::create_item( $request );
if ( is_wp_error( $response ) ) {
if ( ! empty( $this->processed_attachment_ids_for_request ) ) {
// Handle deletion of orphaned images.
foreach ( $this->processed_attachment_ids_for_request as $attachment_id ) {
wp_delete_attachment( (int) $attachment_id, true );
}
}
}
$this->processed_attachment_ids_for_request = array();
return $response;
}
}
PK [1]XG G 7 RestApi/Routes/V4/OrderNotes/Schema/OrderNoteSchema.phpnu array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'order_id' => array(
'description' => __( 'Order ID the note belongs to.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'author' => array(
'description' => __( 'Order note author.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the order note was created, in the site's timezone.", 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_created_gmt' => array(
'description' => __( 'The date the order note was created, as GMT.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'note' => array(
'description' => __( 'Order note content.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'required' => true,
),
'title' => array(
'description' => __( 'The title of the order note group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'group' => array(
'description' => __( 'The group of order note.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'is_customer_note' => array(
'description' => __( 'If true, the note will be shown to customers. If false, the note will be for admin reference only.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
);
return $schema;
}
/**
* Get the item response.
*
* @param WP_Comment $note Order note object.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $note, WP_REST_Request $request, array $include_fields = array() ): array {
$group = get_comment_meta( $note->comment_ID, 'note_group', true );
$title = get_comment_meta( $note->comment_ID, 'note_title', true );
$is_customer_note = wc_string_to_bool( get_comment_meta( $note->comment_ID, 'is_customer_note', true ) );
if ( $group && ! $title ) {
$title = OrderNoteGroup::get_default_group_title( $group );
}
return array(
'id' => (int) $note->comment_ID,
'order_id' => (int) $note->comment_post_ID,
'author' => $note->comment_author,
'date_created' => wc_rest_prepare_date_response( $note->comment_date ),
'date_created_gmt' => wc_rest_prepare_date_response( $note->comment_date_gmt ),
'note' => $note->comment_content,
'title' => $title,
'group' => $group,
'is_customer_note' => $is_customer_note,
);
}
}
PK [1]Y1- 1- + RestApi/Routes/V4/OrderNotes/Controller.phpnu item_schema = $item_schema;
$this->collection_query = $query_utils;
}
/**
* Get the schema for the current resource. This use consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the collection args schema.
*
* @return array
*/
protected function get_query_schema(): array {
return $this->collection_query->get_query_schema();
}
/**
* Register the routes for orders.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'order_id' => array(
'description' => __( 'The order ID that notes belong to.', 'woocommerce' ),
'type' => 'integer',
'validate_callback' => function ( $value ) {
return $this->is_valid_order_id( $value );
},
'required' => true,
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
),
)
);
}
/**
* Prepare links for the request.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @param WP_REST_Response $response Response object.
* @return array
*/
protected function prepare_links( $item, WP_REST_Request $request, WP_REST_Response $response ): array {
return array(
'self' => array(
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, (int) $item->comment_ID ) ),
),
'collection' => array(
'href' => add_query_arg(
array( 'order_id' => (int) $item->comment_post_ID ),
rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) )
),
),
);
}
/**
* Prepare a single order note item for response.
*
* @param WP_Comment $note Note object.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $note, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $note, $request );
}
/**
* Check if a given request has access to read an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
$order = $this->get_order_by_note_id( (int) $request['id'] );
if ( ! $order ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
if ( ! wc_rest_check_post_permissions( 'shop_order', 'read', $order->get_id() ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to read items.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( 'shop_order', 'read', (int) $request['order_id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to create an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function create_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( 'shop_order', 'create', (int) $request['order_id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to delete an item.
*
* @param WP_REST_Request $request The request object.
* @return bool|WP_Error
*/
public function delete_item_permissions_check( $request ) {
$order = $this->get_order_by_note_id( (int) $request['id'] );
if ( ! $order ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
if ( ! wc_rest_check_post_permissions( 'shop_order', 'delete', $order->get_id() ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Get a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
$note = $this->get_note_by_id( (int) $request['id'] );
if ( ! $note ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
return $this->prepare_item_for_response( $note, $request );
}
/**
* Get collection of orders.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
$order = $this->get_order_by_id( (int) $request['order_id'] );
if ( ! $order ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$query_args = $this->collection_query->get_query_args( $request );
$results = $this->collection_query->get_query_results( $query_args, $request );
$items = array();
foreach ( $results as $result ) {
$items[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $result, $request ) );
}
return rest_ensure_response( $items );
}
/**
* Create a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
if ( ! empty( $request['id'] ) ) {
return $this->get_route_error_by_code( self::RESOURCE_EXISTS );
}
$order = $this->get_order_by_id( (int) $request['order_id'] );
$note_id = $order ? $order->add_order_note( $request['note'], $request['is_customer_note'], true ) : null;
if ( ! $note_id ) {
return $this->get_route_error_by_code( self::CANNOT_CREATE );
}
$note = get_comment( $note_id );
$this->update_additional_fields_for_object( $note, $request );
/**
* Fires after a single object is created via the REST API.
*
* @param WP_Comment $note Inserted object.
* @param WP_REST_Request $request Request object.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'created', $note, $request );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $note, $request );
$response->set_status( WP_Http::CREATED );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $note_id ) ) );
return $response;
}
/**
* Delete a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function delete_item( $request ) {
$note = $this->get_note_by_id( (int) $request['id'] );
if ( empty( $note ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $note, $request );
$result = wc_delete_order_note( (int) $note->comment_ID );
if ( ! $result ) {
return $this->get_route_error_by_code( self::CANNOT_DELETE );
}
/**
* Fires after a single object is deleted or trashed via the REST API.
*
* @param WP_Comment $note The deleted or trashed object.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'deleted', $note, $response, $request );
return $response;
}
/**
* Check if an order is valid.
*
* @param mixed $order_id The order ID.
* @return bool True if the order is valid, false otherwise.
*/
protected function is_valid_order_id( $order_id ): bool {
$order = $this->get_order_by_id( (int) $order_id );
return $order && $order instanceof WC_Order;
}
/**
* Get an order by ID.
*
* @param int $order_id The order ID.
* @return WC_Order|null
*/
protected function get_order_by_id( int $order_id ) {
if ( ! $order_id ) {
return null;
}
$order = wc_get_order( $order_id );
return $order && 'shop_order' === $order->get_type() ? $order : null;
}
/**
* Get the parent order of a note.
*
* @param int|WP_Comment $note_id The note ID or note object.
* @return WC_Order|null
*/
protected function get_order_by_note_id( $note_id ) {
$note = $note_id instanceof WP_Comment ? $note_id : $this->get_note_by_id( (int) $note_id );
if ( ! $note ) {
return null;
}
return $this->get_order_by_id( (int) $note->comment_post_ID );
}
/**
* Get a note by ID.
*
* @param int $note_id The note ID.
* @return WP_Comment|null
*/
protected function get_note_by_id( int $note_id ) {
if ( ! $note_id ) {
return null;
}
$note = get_comment( $note_id );
return $note && 'order_note' === $note->comment_type ? $note : null;
}
}
PK [1]Y 0 RestApi/Routes/V4/OrderNotes/CollectionQuery.phpnu array(
'default' => 'all',
'description' => __( 'Limit result to customer notes or private notes.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'all', 'customer', 'private' ),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Prepares query args.
*
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_args( WP_REST_Request $request ): array {
$args = array(
'post_id' => $request['order_id'] ?? 0,
'status' => 'approve',
'type' => 'order_note',
);
// Allow filter by order note type.
if ( 'customer' === $request['note_type'] ) {
$args['meta_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'key' => 'is_customer_note',
'value' => 1,
'compare' => '=',
),
);
} elseif ( 'private' === $request['note_type'] ) {
$args['meta_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'key' => 'is_customer_note',
'compare' => 'NOT EXISTS',
),
);
}
return $args;
}
/**
* Get results of the query.
*
* @param array $query_args The query arguments.
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_results( array $query_args, WP_REST_Request $request ): array {
remove_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 );
$results = get_comments( $query_args );
add_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ), 10, 1 );
return (array) $results;
}
}
PK [1]P4C| | - RestApi/Routes/V4/Orders/ActionController.phpnu array(
'description' => __( 'Marks the order as paid. Updates the order status and reduces line item stock if necessary.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
),
'reset_download_permissions' => array(
'description' => __( 'Resets any download permissions linked to the order.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
),
);
}
/**
* Run the actions for the order.
*
* @throws WC_REST_Exception If an error occurs.
* @param WC_Order $order The order object.
* @param WP_REST_Request $request The request object.
* @return void
*/
public function run_actions( WC_Order $order, WP_REST_Request $request ) {
$valid_actions = array_keys( $this->get_endpoint_args_for_actions() );
foreach ( $valid_actions as $action ) {
$callback = 'action_' . $action;
$param = $request->get_param( $action );
if ( null !== $param && is_callable( array( $this, $callback ) ) ) {
$result = call_user_func( array( $this, $callback ), $param, $order, $request );
if ( is_wp_error( $result ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_action', esc_html( $result->get_error_message() ) );
}
}
}
}
/**
* Regenerate the download permissions for the order.
*
* @param bool $action_value The action value.
* @param WC_Order $order The order object.
* @param WP_REST_Request $request The request object.
* @return bool
*/
private function action_reset_download_permissions( $action_value, WC_Order $order, WP_REST_Request $request ) {
if ( ! $action_value ) {
return false;
}
$data_store = \WC_Data_Store::load( 'customer-download' );
if ( $data_store ) {
$data_store->delete_by_order_id( $order->get_id() );
}
wc_downloadable_product_permissions( $order->get_id(), true );
$user_agent = esc_html( $request->get_header( 'User-Agent' ) );
$order->add_order_note(
esc_html__( 'Download permissions were reset manually.', 'woocommerce' ),
false,
true,
array(
'user_agent' => $user_agent ? $user_agent : 'REST API',
'note_title' => __( 'Download permissions', 'woocommerce' ),
'note_group' => OrderNoteGroup::ORDER_UPDATE,
)
);
return true;
}
/**
* Mark the order as paid.
*
* @param bool $action_value The action value.
* @param WC_Order $order The order object.
* @param WP_REST_Request $request The request object.
* @return true|WP_Error
*/
private function action_payment_complete( $action_value, WC_Order $order, WP_REST_Request $request ) {
if ( $action_value ) {
$result = $order->payment_complete( $request['transaction_id'] ?? '' );
if ( ! $result ) {
return new WP_Error( 'woocommerce_rest_payment_complete_failed', __( 'Could not mark the order as paid.', 'woocommerce' ) );
}
}
return true;
}
}
PK [1]5aB aB ' RestApi/Routes/V4/Orders/Controller.phpnu item_schema = $item_schema;
$this->collection_query = $query_utils;
$this->update_utils = $update_utils;
$this->action_controller = $action_controller;
}
/**
* Get the schema for the current resource. This use consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the collection args schema.
*
* @return array
*/
protected function get_query_schema(): array {
return $this->collection_query->get_query_schema();
}
/**
* List of args for endpoints. These may alter how data is returned or formatted. Extended by routes.
*
* @return array
*/
protected function get_endpoint_args(): array {
return array(
'num_decimals' => array(
'default' => wc_get_price_decimals(),
'description' => __( 'Number of decimal points to use in each resource.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Register the routes for orders.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => $this->get_endpoint_args(),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array_merge(
$this->get_endpoint_args(),
array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => array_merge(
$this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
$this->action_controller->get_endpoint_args_for_actions(),
),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'args' => array(
'force' => array(
'default' => false,
'type' => 'boolean',
'description' => __( 'Whether to bypass trash and force deletion.', 'woocommerce' ),
),
),
),
)
);
}
/**
* Prepare links for the request.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @param WP_REST_Response $response Response object.
* @return array
*/
protected function prepare_links( $item, WP_REST_Request $request, WP_REST_Response $response ): array {
$links = array(
'self' => array(
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $item->get_id() ) ),
),
'collection' => array(
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
),
'email-templates' => array(
'href' => rest_url( sprintf( '/wc/v3/%s/%d/actions/email_templates', $this->rest_base, $item->get_id() ) ),
'embeddable' => true,
),
'order-notes' => array(
'href' => add_query_arg(
array( 'order_id' => (int) $item->get_id() ),
rest_url( sprintf( '/%s/order-notes', $this->namespace ) )
),
'embeddable' => true,
),
'refunds' => array(
'href' => add_query_arg(
array( 'order_id' => (int) $item->get_id() ),
rest_url( sprintf( '/%s/refunds', $this->namespace ) )
),
'embeddable' => true,
),
);
if ( $item->get_payment_method() ) {
$links['payment_gateway'] = array(
'href' => rest_url( sprintf( '/%s/settings/payment-gateways/%s', $this->namespace, rawurlencode( $item->get_payment_method() ) ) ),
'embeddable' => true,
);
}
if ( $item->get_customer_id() ) {
$links['customer'] = array(
'href' => rest_url( sprintf( '/%s/customers/%d', $this->namespace, $item->get_customer_id() ) ),
);
}
if ( $item->get_parent_id() ) {
$links['up'] = array(
'href' => rest_url( sprintf( '/%s/orders/%d', $this->namespace, $item->get_parent_id() ) ),
);
}
return $links;
}
/**
* Prepare a single order object for response.
*
* @param WC_Order $order Order object.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $order, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $order, $request, $this->get_fields_for_response( $request ) );
}
/**
* Get a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
$order = wc_get_order( (int) $request['id'] );
if ( ! $this->is_valid_order_for_request( $order ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
return $this->prepare_item_for_response( $order, $request );
}
/**
* Get collection of orders.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
/**
* Filter collection query args before executing the query.
*
* @param array $query_args Query arguments for WC_Order_Query.
* @param WP_REST_Request $request The REST request object.
* @param Controller $controller The controller instance.
* @since 10.4.0
*/
$query_args = (array) apply_filters(
$this->get_hook_prefix() . 'collection_query_args',
$this->collection_query->get_query_args( $request ),
$request,
$this
);
$query_args = wp_parse_args(
$query_args,
array(
'post_type' => $this->post_type,
)
);
$results = $this->collection_query->get_query_results( $query_args, $request );
$items = array();
foreach ( $results['results'] as $result ) {
$items[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $result, $request ) );
}
$pagination_util = new Pagination();
$response = $pagination_util->add_headers( rest_ensure_response( $items ), $request, $results['total'], $results['pages'] );
return $response;
}
/**
* Create a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
if ( ! empty( $request['id'] ) ) {
/* translators: %s: post type */
return $this->get_route_error_by_code( self::RESOURCE_EXISTS );
}
try {
$order = new WC_Order();
$order->set_created_via( ! empty( $request['created_via'] ) ? sanitize_text_field( wp_unslash( $request['created_via'] ) ) : 'rest-api' );
$order->set_prices_include_tax( 'yes' === get_option( 'woocommerce_prices_include_tax' ) );
$this->update_utils->update_order_from_request( $order, $request );
$this->update_additional_fields_for_object( $order, $request );
/**
* Fires after a single object is created via the REST API.
*
* @param WC_Order $order Inserted object.
* @param WP_REST_Request $request Request object.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'created', $order, $request );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $order, $request );
$response->set_status( WP_Http::CREATED );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $order->get_id() ) ) );
return $response;
} catch ( \WC_Data_Exception $e ) {
$data = $e->getErrorData();
if ( $order && $order instanceof WC_Order && $order->get_id() ) {
try {
$order->set_status( 'checkout-draft' );
$order->save();
// phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
} catch ( \Exception $_ ) {
// We don't want a failure in changing the order status
// to throw on itself, but we don't have anything meaningful
// to do with this failure either.
}
$data['new_draft_order_id'] = $order->get_id();
}
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $data );
} catch ( \WC_REST_Exception $e ) {
if ( $order && $order instanceof WC_Order && $order->get_id() ) {
$order->delete( true );
}
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/**
* Update a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$order = wc_get_order( (int) $request['id'] );
if ( ! $this->is_valid_order_for_request( $order ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
try {
$this->update_utils->update_order_from_request( $order, $request );
$this->update_additional_fields_for_object( $order, $request );
$this->action_controller->run_actions( $order, $request );
/**
* Fires after a single object is updated via the REST API.
*
* @param WC_Data $order Inserted object.
* @param WP_REST_Request $request Request object.
* @param boolean $creating True when creating object, false when updating.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'updated', $order, $request );
$request->set_param( 'context', 'edit' );
return $this->prepare_item_for_response( $order, $request );
} catch ( \WC_Data_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), $e->getErrorData() );
} catch ( \WC_REST_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
/**
* Delete a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function delete_item( $request ) {
$order = wc_get_order( (int) $request['id'] );
if ( ! $this->is_valid_order_for_request( $order ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$request->set_param( 'context', 'edit' );
$force = (bool) $request['force'];
if ( $force ) {
$result = $order->delete( true );
$response = new WP_REST_Response( null, 204 );
} else {
$response = $this->prepare_item_for_response( $order, $request );
/**
* Filter whether an object is trashable.
*
* @param boolean $supports_trash Whether the object type support trashing.
* @param WC_Order $order The object being considered for trashing support.
* @since 10.2.0
*/
$supports_trash = apply_filters( $this->get_hook_prefix() . 'object_trashable', EMPTY_TRASH_DAYS > 0, $order );
if ( ! $supports_trash ) {
return $this->get_route_error_by_code( self::TRASH_NOT_SUPPORTED );
}
if ( 'trash' === $order->get_status() ) {
return $this->get_route_error_by_code( self::CANNOT_TRASH );
}
$order->delete();
$result = 'trash' === $order->get_status();
}
if ( ! $result ) {
return $this->get_route_error_by_code( self::CANNOT_DELETE );
}
/**
* Fires after a single object is deleted or trashed via the REST API.
*
* @param WC_Order $order The deleted or trashed object.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'deleted', $order, $response, $request );
return $response;
}
/**
* Check if an order is valid.
*
* @param WC_Order $order The order object.
* @return bool True if the order is valid, false otherwise.
*/
protected function is_valid_order_for_request( $order ): bool {
return $order instanceof WC_Order && $order->get_id() !== 0 && 'shop_order_refund' !== $order->get_type();
}
/**
* Check if a given request has access to read items.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'read' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to read an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'read', $request['id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to create an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function create_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'create' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to update an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'edit', $request['id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to delete an item.
*
* @param WP_REST_Request $request The request object.
* @return bool|WP_Error
*/
public function delete_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'delete', $request['id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
}
PK [1]og)0 )0 , RestApi/Routes/V4/Orders/CollectionQuery.phpnu array(
'description' => __( 'Current page of the collection.', 'woocommerce' ),
'type' => 'integer',
'default' => 1,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
'minimum' => 1,
),
'per_page' => array(
'description' => __( 'Maximum number of items to be returned in result set.', 'woocommerce' ),
'type' => 'integer',
'default' => 10,
'minimum' => 1,
'maximum' => 100,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'order' => array(
'description' => __( 'Order sort attribute ascending or descending.', 'woocommerce' ),
'type' => 'string',
'default' => 'desc',
'enum' => array( 'asc', 'desc' ),
'validate_callback' => 'rest_validate_request_arg',
),
'orderby' => array(
'description' => __( 'Sort collection by object attribute.', 'woocommerce' ),
'type' => 'string',
'default' => 'date',
'enum' => array(
'date',
'id',
'include',
'title',
'slug',
'modified',
'total',
),
'validate_callback' => 'rest_validate_request_arg',
),
'created_via' => array(
'description' => __( 'Limit result set to orders created via specific sources (e.g. checkout, admin).', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
),
'validate_callback' => 'rest_validate_request_arg',
'sanitize_callback' => 'wp_parse_list',
),
'customer' => array(
'description' => __( 'Limit result set to orders assigned a specific customer.', 'woocommerce' ),
'type' => array( 'string', 'integer' ),
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
'product' => array(
'description' => __( 'Limit result set to orders assigned a specific product.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'status' => array(
'default' => 'any',
'description' => __( 'Limit result set to orders which have specific statuses.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => array_map( OrderUtil::class . '::remove_status_prefix', array_merge( array( 'any', OrderStatus::TRASH ), array_keys( wc_get_order_statuses() ) ) ),
),
'validate_callback' => 'rest_validate_request_arg',
),
'search' => array(
'description' => __( 'Limit results to those matching a string.', 'woocommerce' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
'after' => array(
'description' => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg',
),
'before' => array(
'description' => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg',
),
'modified_after' => array(
'description' => __( 'Limit response to resources modified after a given ISO8601 compliant date.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg',
),
'modified_before' => array(
'description' => __( 'Limit response to resources modified before a given ISO8601 compliant date.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg',
),
'dates_are_gmt' => array(
'description' => __( 'Whether to consider GMT post dates when limiting response by published or modified date.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'validate_callback' => 'rest_validate_request_arg',
),
'total' => array(
'description' => __( 'Limit result set to orders with specific total amounts. For between operators, list two values.', 'woocommerce' ),
'type' => array( 'string', 'array' ),
'items' => array(
'type' => 'string',
),
'sanitize_callback' => 'wp_parse_list',
),
'total_operator' => array(
'description' => __( 'The comparison operator to use for total filtering.', 'woocommerce' ),
'type' => 'string',
'enum' => self::OPERATORS,
'default' => self::OPERATOR_IS,
'validate_callback' => function ( $param, $request, $key ) {
$valid = rest_validate_request_arg( $param, $request, $key );
if ( true === $valid && self::OPERATOR_BETWEEN === $param ) {
$total_field = wp_parse_list( $request->get_param( 'total' ) );
if ( ! is_array( $total_field ) || count( $total_field ) !== 2 ) {
return new WP_Error( 'rest_invalid_param', __( 'Total value must be an array with exactly 2 numbers for between operators.', 'woocommerce' ), array( 'status' => WP_Http::BAD_REQUEST ) );
}
}
return $valid;
},
),
'fulfillment_status' => array(
'description' => __( 'Limit result set to orders with specific fulfillment statuses.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => array_keys( FulfillmentUtils::get_order_fulfillment_statuses() ),
),
'sanitize_callback' => 'wp_parse_list',
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Prepares query args.
*
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_args( WP_REST_Request $request ): array {
$args = array(
'order' => $request['order'],
'orderby' => $request['orderby'],
'page' => $request['page'],
'posts_per_page' => $request['per_page'],
's' => $request['search'],
'created_via' => $request['created_via'],
'status' => $request['status'],
'customer' => $request['customer'],
);
if ( 'date' === $args['orderby'] ) {
$args['orderby'] = 'date ID';
}
$date_query = array();
$use_gmt = $request['dates_are_gmt'];
if ( isset( $request['before'] ) ) {
$date_query[] = array(
'column' => $use_gmt ? 'post_date_gmt' : 'post_date',
'before' => $request['before'],
);
}
if ( isset( $request['after'] ) ) {
$date_query[] = array(
'column' => $use_gmt ? 'post_date_gmt' : 'post_date',
'after' => $request['after'],
);
}
if ( isset( $request['modified_before'] ) ) {
$date_query[] = array(
'column' => $use_gmt ? 'post_modified_gmt' : 'post_modified',
'before' => $request['modified_before'],
);
}
if ( isset( $request['modified_after'] ) ) {
$date_query[] = array(
'column' => $use_gmt ? 'post_modified_gmt' : 'post_modified',
'after' => $request['modified_after'],
);
}
if ( ! empty( $date_query ) ) {
$date_query['relation'] = 'AND';
$args['date_query'] = $date_query;
}
// Search by product.
if ( ! empty( $request['product'] ) ) {
global $wpdb;
$order_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT order_id FROM %i WHERE order_item_id IN ( SELECT order_item_id FROM %i WHERE meta_key = '_product_id' AND meta_value = %d ) AND order_item_type = 'line_item'",
$wpdb->prefix . 'woocommerce_order_items',
$wpdb->prefix . 'woocommerce_order_itemmeta',
$request['product']
)
);
// Force WP_Query to return an empty array of IDs (0) if no matches are found. This forces no results.
if ( empty( $order_ids ) ) {
$order_ids = array( 0 );
} else {
$include_ids = $args['post__in'] ?? array();
$order_ids = ! empty( $include_ids ) ? array_intersect( $order_ids, $include_ids ) : $order_ids;
$args['post__in'] = array_merge( $order_ids, array( 0 ) );
}
}
// Search.
if ( ! OrderUtil::custom_orders_table_usage_is_enabled() && ! empty( $args['s'] ) ) {
$order_ids = wc_order_search( $args['s'] );
if ( ! empty( $order_ids ) ) {
unset( $args['s'] );
$include_ids = $args['post__in'] ?? array();
$order_ids = ! empty( $include_ids ) ? array_intersect( $order_ids, $include_ids ) : $order_ids;
$args['post__in'] = array_merge( $order_ids, array( 0 ) );
}
}
// Total filtering.
if ( isset( $request['total'] ) ) {
// WC_Order-Query uses `total` as the key. DataStores handle the operators.
$total_param = (array) $request['total']; // List of total values supports single and between.
$total_value = $total_param[0] ?? 0;
$total_operator = '=';
// Map rest api operators to the operators `WC_Order_Query` expects. These are the ones defined in the enum.
switch ( $request['total_operator'] ?? self::OPERATOR_IS ) {
case self::OPERATOR_IS_NOT:
$total_operator = '!=';
break;
case self::OPERATOR_LESS_THAN:
$total_operator = '<';
break;
case self::OPERATOR_GREATER_THAN:
$total_operator = '>';
break;
case self::OPERATOR_LESS_THAN_OR_EQUAL:
$total_operator = '<=';
break;
case self::OPERATOR_GREATER_THAN_OR_EQUAL:
$total_operator = '>=';
break;
case self::OPERATOR_BETWEEN:
$total_operator = 'BETWEEN';
$total_value = array( $total_param[0] ?? 0, $total_param[1] ?? 0 );
break;
}
$args['total'] = array(
'value' => $total_value,
'operator' => $total_operator,
);
}
// Order fulfillment status filtering.
if ( isset( $request['fulfillment_status'] ) ) {
$request['fulfillment_status'] = is_array( $request['fulfillment_status'] ) ? $request['fulfillment_status'] : array( $request['fulfillment_status'] );
$fulfillment_status = array();
foreach ( $request['fulfillment_status'] as $status ) {
if ( FulfillmentUtils::is_valid_order_fulfillment_status( $status ) ) {
$fulfillment_status[] = $status;
}
}
$args['fulfillment_status'] = $fulfillment_status;
}
return $args;
}
/**
* Get results of the query.
*
* @param array $query_args The query arguments from prepare_query().
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_results( array $query_args, WP_REST_Request $request ): array {
$query = new WC_Order_Query(
array_merge(
$query_args,
array(
'paginate' => true,
)
)
);
$results = $query->get_orders();
return array(
'results' => $results->orders,
'total' => $results->total,
'pages' => $results->max_num_pages,
);
}
}
PK [1]T.E .E ( RestApi/Routes/V4/Orders/UpdateUtils.phpnu order_schema = $order_schema;
}
/**
* Update an order from the request.
*
* @throws WC_REST_Exception When fails to set any item, \WC_Data_Exception When fails to set any item.
* @param WC_Order $order Order object.
* @param WP_REST_Request $request Request object.
* @return void
*/
public function update_order_from_request( WC_Order $order, WP_REST_Request $request ) {
// Get data that can be edited from schema.
$ignore_keys = array( 'created_via', 'status', 'customer_id' );
$data_keys = array_diff( array_keys( $this->order_schema->get_writable_item_schema_properties() ), $ignore_keys );
// Make sure gateways are loaded so hooks from gateways fire on save/create.
WC()->payment_gateways();
// Handle all writable props.
foreach ( $data_keys as $key ) {
$value = $request[ $key ];
if ( is_null( $value ) ) {
continue;
}
if ( 'billing' === $key || 'shipping' === $key ) {
$this->update_address( $order, $key, (array) $value );
} elseif ( 'coupon_lines' === $key ) {
$this->update_line_items( $order, (array) $value, 'coupon' );
} elseif ( 'line_items' === $key ) {
$this->update_line_items( $order, (array) $value, 'line_item' );
} elseif ( 'shipping_lines' === $key ) {
$this->update_line_items( $order, (array) $value, 'shipping' );
} elseif ( 'fee_lines' === $key ) {
$this->update_line_items( $order, (array) $value, 'fee' );
} elseif ( 'meta_data' === $key ) {
$this->update_meta_data( $order, (array) $value );
} elseif ( is_callable( array( $order, "set_{$key}" ) ) ) {
$order->{"set_{$key}"}( $value );
}
}
if ( ! is_null( $request['customer_id'] ) && 0 !== $request['customer_id'] ) {
// The customer must exist, and in a multisite context must be visible to the current user.
if ( is_wp_error( Users::get_user_in_current_site( $request['customer_id'] ) ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_customer_id', esc_html__( 'Customer ID is invalid.', 'woocommerce' ), (int) WP_Http::BAD_REQUEST );
}
// Make sure customer is part of blog.
if ( is_multisite() && ! is_user_member_of_blog( $request['customer_id'] ) ) {
add_user_to_blog( get_current_blog_id(), $request['customer_id'], 'customer' );
}
$order->set_customer_id( (int) $request['customer_id'] );
}
// Save before calculating totals to ensure all line items are up to date.
$order->save();
// If items have changed, recalculate order totals.
if ( isset( $request['billing'] ) || isset( $request['shipping'] ) || isset( $request['line_items'] ) || isset( $request['shipping_lines'] ) || isset( $request['fee_lines'] ) ) {
$order->calculate_totals( true );
}
if ( isset( $request['coupon_lines'] ) ) {
$order->recalculate_coupons();
}
if ( ! empty( $request['status'] ) ) {
$order->set_status( $request['status'], '', true );
$order->save();
}
}
/**
* Update address.
*
* @param WC_Order $order Order data.
* @param string $type Type of address; 'billing' or 'shipping'.
* @param array $request_data Posted data.
*/
protected function update_address( WC_Order $order, string $type, array $request_data ) {
foreach ( $request_data as $key => $value ) {
if ( is_callable( array( $order, "set_{$type}_{$key}" ) ) ) {
$order->{"set_{$type}_{$key}"}( $value );
}
}
}
/**
* Update meta data.
*
* @param WC_Order $order Order data.
* @param array $meta_data Posted data.
*/
protected function update_meta_data( WC_Order $order, array $meta_data ) {
foreach ( $meta_data as $meta ) {
$order->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
/**
* Update line items from an array of line item data for an order. Non-posted line items are removed.
*
* @throws WC_REST_Exception If line items type is invalid.
* @param WC_Order $order The order to update the line items for.
* @param array $line_items The line items to update.
* @param string $line_items_type The type of line items to update.
*/
protected function update_line_items( WC_Order $order, array $line_items, string $line_items_type = 'line_item' ) {
if ( ! in_array( $line_items_type, array( 'line_item', 'shipping', 'fee', 'coupon' ), true ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_line_items_type', esc_html__( 'Invalid line items type.', 'woocommerce' ), 400 );
}
// Get existing items from the order. Any items that are not in the $line_items array will be removed.
$existing_items = $order->get_items( $line_items_type );
$processed_item_ids = array();
foreach ( $line_items as $line_item_data ) {
if ( ! is_array( $line_item_data ) ) {
continue;
}
if ( $this->item_is_null_or_zero( $line_item_data ) ) {
if ( $line_item_data['id'] ) {
$this->remove_item_from_order( $order, $line_items_type, (int) $line_item_data['id'] );
}
continue;
}
$processed_item_ids[] = $this->update_line_item( $order, $line_items_type, $line_item_data );
}
// Remove any pre-existing items that were not posted.
foreach ( $existing_items as $existing_item ) {
if ( ! in_array( $existing_item->get_id(), $processed_item_ids, true ) ) {
$this->remove_item_from_order( $order, $line_items_type, $existing_item->get_id() );
}
}
}
/**
* Wrapper method to create/update order items.
* When updating, the item ID provided is checked to ensure it is associated with the order.
*
* @throws WC_REST_Exception If item ID is not associated with order.
* @param WC_Order $order order object.
* @param string $line_items_type The item type.
* @param array $line_item_data item provided in the request body.
* @return int The ID of the updated or created item.
*/
protected function update_line_item( WC_Order $order, string $line_items_type, array $line_item_data ) {
global $wpdb;
$action = empty( $line_item_data['id'] ) ? 'create' : 'update';
$method = 'prepare_' . $line_items_type . '_data';
$item = null;
// Verify provided line item ID is associated with order.
if ( 'update' === $action ) {
$item = $order->get_item( absint( $line_item_data['id'] ), false );
if ( ! $item ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_item_id', esc_html__( 'Order item ID provided is not associated with order.', 'woocommerce' ), 400 );
}
}
// Prepare item data.
$item = $this->$method( $line_item_data, $action, $item );
/**
* Allow extensions be notified before the item is saved.
*
* @param WC_Order_Item $item The item object.
* @param array $request_data The item data.
*
* @since 4.5.0.
*/
do_action( 'woocommerce_rest_set_order_item', $item, $line_item_data );
// If creating the order, add the item to it.
if ( 'create' === $action ) {
$order->add_item( $item );
} else {
$item->save();
}
// Maybe update product stock quantity.
if ( 'line_item' === $line_items_type && in_array( $order->get_status(), array( OrderStatus::PROCESSING, OrderStatus::COMPLETED, OrderStatus::ON_HOLD ), true ) ) {
require_once WC_ABSPATH . 'includes/admin/wc-admin-functions.php';
$changed_stock = wc_maybe_adjust_line_item_product_stock( $item );
if ( $changed_stock && ! is_wp_error( $changed_stock ) ) {
$order->add_order_note(
sprintf(
// translators: %s item name.
__( 'Adjusted stock: %s.', 'woocommerce' ),
sprintf(
'%1$s (%2$s→%3$s)',
$item->get_name(),
$changed_stock['from'],
$changed_stock['to']
)
),
false,
true,
array(
'note_group' => OrderNoteGroup::PRODUCT_STOCK,
)
);
}
}
return $item->get_id();
}
/**
* Helper method to check if the resource ID associated with the provided item is null.
* Items can be deleted by setting the resource ID to null.
*
* @param array $item Item provided in the request body.
* @return bool True if the item resource ID is null, false otherwise.
*/
protected function item_is_null_or_zero( $item ) {
$keys = array( 'product_id', 'method_id', 'method_title', 'name', 'code' );
foreach ( $keys as $key ) {
if ( array_key_exists( $key, $item ) && is_null( $item[ $key ] ) ) {
return true;
}
}
if ( array_key_exists( 'quantity', $item ) && 0 === $item['quantity'] ) {
return true;
}
return false;
}
/**
* Wrapper method to remove order items.
* When updating, the item ID provided is checked to ensure it is associated with the order.
*
* @param WC_Order $order The order to remove the item from.
* @param string $line_items_type The item type.
* @param int $item_id The ID of the item to remove.
*
* @return void
* @throws WC_REST_Exception If item ID is not associated with order.
*/
protected function remove_item_from_order( WC_Order $order, string $line_items_type, int $item_id ): void {
$item = $order->get_item( $item_id );
if ( ! $item ) {
throw new WC_REST_Exception(
'woocommerce_rest_invalid_item_id',
esc_html__( 'Order item ID provided is not associated with order.', 'woocommerce' ),
400
);
}
if ( 'line_item' === $line_items_type ) {
require_once WC_ABSPATH . 'includes/admin/wc-admin-functions.php';
wc_maybe_adjust_line_item_product_stock( $item, 0 );
}
/**
* Allow extensions be notified before the item is removed.
*
* @param WC_Order_Item $item The item object.
*
* @since 9.3.0.
*/
do_action( 'woocommerce_rest_remove_order_item', $item );
$order->remove_item( $item_id );
}
/**
* Gets the product ID from the SKU or posted ID.
*
* @throws WC_REST_Exception When SKU or ID is not valid.
* @param array $request_data Request data.
* @param string $action 'create' to add line item or 'update' to update it.
* @return int
*/
protected function get_product_id_from_line_item( $request_data, $action = 'create' ) {
if ( ! empty( $request_data['sku'] ) ) {
$product_id = (int) wc_get_product_id_by_sku( $request_data['sku'] );
} elseif ( ! empty( $request_data['product_id'] ) && empty( $request_data['variation_id'] ) ) {
$product_id = (int) $request_data['product_id'];
} elseif ( ! empty( $request_data['variation_id'] ) ) {
$product_id = (int) $request_data['variation_id'];
} elseif ( 'update' === $action ) {
$product_id = 0;
} else {
throw new WC_REST_Exception( 'woocommerce_rest_required_product_reference', esc_html__( 'Product ID or SKU is required.', 'woocommerce' ), 400 );
}
return $product_id;
}
/**
* Create or update a line item, overridden to add COGS data as needed.
*
* @param array $request_data Line item data.
* @param string $action 'create' to add line item or 'update' to update it.
* @param object $item Passed when updating an item. Null during creation.
* @return WC_Order_Item_Product
* @throws WC_REST_Exception Invalid data, server error.
*/
protected function prepare_line_item_data( $request_data, $action = 'create', $item = null ) {
$item = is_null( $item ) ? new WC_Order_Item_Product( ! empty( $request_data['id'] ) ? $request_data['id'] : '' ) : $item;
$product = wc_get_product( $this->get_product_id_from_line_item( $request_data, $action ) );
if ( $product && $product !== $item->get_product() ) {
$item->set_product( $product );
if ( 'create' === $action ) {
$quantity = isset( $request_data['quantity'] ) ? $request_data['quantity'] : 1;
$total = wc_get_price_excluding_tax( $product, array( 'qty' => $quantity ) );
$item->set_total( $total );
$item->set_subtotal( $total );
}
}
$this->maybe_set_item_props( $item, array( 'name', 'quantity', 'total', 'subtotal', 'tax_class' ), $request_data );
$this->maybe_set_item_meta_data( $item, $request_data );
if ( ! $item->has_cogs() || ! $this->cogs_is_enabled() ) {
return $item;
}
$cogs_value = $request_data['cost_of_goods_sold']['total_value'] ?? null;
if ( ! is_null( $cogs_value ) ) {
$item->set_cogs_value( (float) $cogs_value );
}
return $item;
}
/**
* Create or update an order shipping method.
*
* @param array $request_data $shipping Item data.
* @param string $action 'create' to add shipping or 'update' to update it.
* @param object $item Passed when updating an item. Null during creation.
* @return WC_Order_Item_Shipping
* @throws WC_REST_Exception Invalid data, server error.
*/
protected function prepare_shipping_data( $request_data, $action = 'create', $item = null ) {
$item = is_null( $item ) ? new WC_Order_Item_Shipping( ! empty( $request_data['id'] ) ? $request_data['id'] : '' ) : $item;
if ( 'create' === $action && empty( $request_data['method_id'] ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_shipping_item', esc_html__( 'Shipping method ID is required.', 'woocommerce' ), 400 );
}
$this->maybe_set_item_props( $item, array( 'method_id', 'method_title', 'total', 'instance_id' ), $request_data );
$this->maybe_set_item_meta_data( $item, $request_data );
return $item;
}
/**
* Create or update an order fee.
*
* @param array $request_data Item data.
* @param string $action 'create' to add fee or 'update' to update it.
* @param object $item Passed when updating an item. Null during creation.
* @return WC_Order_Item_Fee
* @throws WC_REST_Exception Invalid data, server error.
*/
protected function prepare_fee_data( $request_data, $action = 'create', $item = null ) {
$item = is_null( $item ) ? new WC_Order_Item_Fee( ! empty( $request_data['id'] ) ? $request_data['id'] : '' ) : $item;
if ( 'create' === $action && empty( $request_data['name'] ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_fee_item', esc_html__( 'Fee name is required.', 'woocommerce' ), 400 );
}
$this->maybe_set_item_props( $item, array( 'name', 'tax_class', 'tax_status', 'total' ), $request_data );
$this->maybe_set_item_meta_data( $item, $request_data );
return $item;
}
/**
* Create or update an order coupon.
*
* @param array $request_data Item data.
* @param string $action 'create' to add coupon or 'update' to update it.
* @param object $item Passed when updating an item. Null during creation.
* @return WC_Order_Item_Coupon
* @throws WC_REST_Exception Invalid data, server error.
*/
protected function prepare_coupon_data( $request_data, $action = 'create', $item = null ) {
$item = is_null( $item ) ? new WC_Order_Item_Coupon( ! empty( $request_data['id'] ) ? $request_data['id'] : '' ) : $item;
if ( 'create' === $action ) {
$coupon_code = ArrayUtil::get_value_or_default( $request_data, 'code' );
if ( StringUtil::is_null_or_whitespace( $coupon_code ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_invalid_coupon_coupon', esc_html__( 'Coupon code is required.', 'woocommerce' ), 400 );
}
}
$this->maybe_set_item_props( $item, array( 'code', 'discount' ), $request_data );
$this->maybe_set_item_meta_data( $item, $request_data );
return $item;
}
/**
* Maybe set an item prop if the value was posted.
*
* @param WC_Order_Item $item Order item.
* @param string $prop Order property.
* @param array $request_data Request data.
*/
protected function maybe_set_item_prop( $item, $prop, $request_data ) {
if ( isset( $request_data[ $prop ] ) && is_callable( array( $item, "set_$prop" ) ) ) {
$item->{"set_$prop"}( $request_data[ $prop ] );
}
}
/**
* Maybe set item props if the values were posted.
*
* @param WC_Order_Item $item Order item data.
* @param string[] $props Properties.
* @param array $request_data Request data.
*/
protected function maybe_set_item_props( $item, $props, $request_data ) {
foreach ( $props as $prop ) {
$this->maybe_set_item_prop( $item, $prop, $request_data );
}
}
/**
* Maybe set item meta if posted.
*
* @param WC_Order_Item $item Order item data.
* @param array $request_data Request data.
*/
protected function maybe_set_item_meta_data( $item, $request_data ) {
if ( ! empty( $request_data['meta_data'] ) && is_array( $request_data['meta_data'] ) ) {
foreach ( $request_data['meta_data'] as $meta ) {
if ( isset( $meta['key'] ) ) {
$value = isset( $meta['value'] ) ? $meta['value'] : null;
$item->update_meta_data( $meta['key'], $value, isset( $meta['id'] ) ? $meta['id'] : '' );
}
}
}
}
}
PK [1]e e : RestApi/Routes/V4/Orders/Schema/AbstractLineItemSchema.phpnu __( 'Meta data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => array( 'null', 'object', 'string', 'number', 'boolean', 'integer', 'array' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'display_key' => array(
'description' => __( 'Meta key for UI display.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'display_value' => array(
'description' => __( 'Meta value for UI display.', 'woocommerce' ),
'type' => array( 'null', 'object', 'string', 'number', 'boolean', 'integer', 'array' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
),
);
}
/**
* Prepare the meta data for the order item.
*
* @param WC_Order_Item $order_item Order item instance.
* @return array
*/
protected function prepare_meta_data( $order_item ) {
$formatted_meta_data = $order_item->get_all_formatted_meta_data( null );
$return = array();
foreach ( $formatted_meta_data as $meta_id => $meta ) {
$return[] = array(
'id' => $meta_id,
'key' => $meta->key,
'value' => $meta->value,
'display_key' => wc_clean( $meta->display_key ),
'display_value' => wc_clean( $meta->display_value ),
);
}
return $return;
}
/**
* Get the taxes schema shared by line item schemas.
*
* @return array
*/
protected function get_taxes_schema(): array {
return array(
'description' => __( 'Line taxes.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tax rate ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'total' => array(
'description' => __( 'Tax total.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'subtotal' => array(
'description' => __( 'Tax subtotal.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
),
),
);
}
/**
* Prepare the taxes for the order item.
*
* @param WC_Order_Item_Product|WC_Order_Item_Fee $order_item Order item instance.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function prepare_taxes( $order_item, WP_REST_Request $request ) {
$taxes = $order_item->get_taxes();
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$return = array();
if ( $taxes && ! empty( $taxes['total'] ) ) {
foreach ( $taxes['total'] as $tax_rate_id => $tax ) {
$return[] = array(
'id' => $tax_rate_id,
'total' => wc_format_decimal( $tax, $dp ),
'subtotal' => wc_format_decimal( $taxes['subtotal'][ $tax_rate_id ] ?? $tax, $dp ),
);
}
}
return $return;
}
}
PK [1]>Cn n / RestApi/Routes/V4/Orders/Schema/OrderSchema.phpnu order_item_schema = $order_item_schema;
$this->order_coupon_schema = $order_coupon_schema;
$this->order_fee_schema = $order_fee_schema;
$this->order_tax_schema = $order_tax_schema;
$this->order_shipping_schema = $order_shipping_schema;
}
/**
* Return all properties for the item schema.
*
* Note that context determines under which context data should be visible. For example, edit would be the context
* used when getting records with the intent of editing them. embed context allows the data to be visible when the
* item is being embedded in another response.
*
* @return array
*/
public function get_item_schema_properties(): array {
$schema = array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'parent_id' => array(
'description' => __( 'Parent order ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'number' => array(
'description' => __( 'Order number.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'order_key' => array(
'description' => __( 'Order key.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'created_via' => array(
'description' => __( 'Shows where the order was created.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'version' => array(
'description' => __( 'Version of WooCommerce which last updated the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'status' => array(
'description' => __( 'Order status.', 'woocommerce' ),
'type' => 'string',
'default' => OrderStatus::PENDING,
'enum' => array_map( OrderUtil::class . '::remove_status_prefix', array_merge( array( OrderStatus::AUTO_DRAFT ), array_keys( wc_get_order_statuses() ) ) ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'currency' => array(
'description' => __( 'Currency the order was created with, in ISO format.', 'woocommerce' ),
'type' => 'string',
'default' => get_woocommerce_currency(),
'enum' => array_keys( get_woocommerce_currencies() ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'currency_symbol' => array(
'description' => __( 'Currency symbol for the currency which can be used to format returned prices.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the order was created, in the site's timezone.", 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_created_gmt' => array(
'description' => __( 'The date the order was created, as GMT.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the order was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_modified_gmt' => array(
'description' => __( 'The date the order was last modified, as GMT.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'discount_total' => array(
'description' => __( 'Total discount amount for the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'discount_tax' => array(
'description' => __( 'Total discount tax amount for the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'shipping_total' => array(
'description' => __( 'Total shipping amount for the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'shipping_tax' => array(
'description' => __( 'Total shipping tax amount for the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'cart_tax' => array(
'description' => __( 'Sum of line item taxes only.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'total' => array(
'description' => __( 'Grand total.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'total_tax' => array(
'description' => __( 'Sum of all taxes.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'refund_total' => array(
'description' => __( 'Total refund amount for the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'refund_tax' => array(
'description' => __( 'Total refund tax amount for the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'prices_include_tax' => array(
'description' => __( 'True the prices included tax during checkout.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'customer_id' => array(
'description' => __( 'User ID who owns the order. 0 for guests.', 'woocommerce' ),
'type' => 'integer',
'default' => 0,
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'customer_ip_address' => array(
'description' => __( "Customer's IP address.", 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'customer_user_agent' => array(
'description' => __( 'User agent of the customer.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'customer_note' => array(
'description' => __( 'Note left by customer during checkout.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'billing' => array(
'description' => __( 'Billing address.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'properties' => array(
'first_name' => array(
'description' => __( 'First name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'last_name' => array(
'description' => __( 'Last name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'company' => array(
'description' => __( 'Company name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'address_1' => array(
'description' => __( 'Address line 1', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'address_2' => array(
'description' => __( 'Address line 2', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'city' => array(
'description' => __( 'City name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'state' => array(
'description' => __( 'ISO code or name of the state, province or district.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'postcode' => array(
'description' => __( 'Postal code.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'country' => array(
'description' => __( 'Country code in ISO 3166-1 alpha-2 format.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'email' => array(
'description' => __( 'Email address.', 'woocommerce' ),
'type' => array( 'string', 'null' ),
'format' => 'email',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'phone' => array(
'description' => __( 'Phone number.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
),
'shipping' => array(
'description' => __( 'Shipping address.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'properties' => array(
'first_name' => array(
'description' => __( 'First name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'last_name' => array(
'description' => __( 'Last name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'company' => array(
'description' => __( 'Company name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'address_1' => array(
'description' => __( 'Address line 1', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'address_2' => array(
'description' => __( 'Address line 2', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'city' => array(
'description' => __( 'City name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'state' => array(
'description' => __( 'ISO code or name of the state, province or district.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'postcode' => array(
'description' => __( 'Postal code.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'country' => array(
'description' => __( 'Country code in ISO 3166-1 alpha-2 format.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'phone' => array(
'description' => __( 'Phone number.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
),
'payment_method' => array(
'description' => __( 'Payment method ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'payment_method_title' => array(
'description' => __( 'Payment method title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field',
),
),
'transaction_id' => array(
'description' => __( 'Unique transaction ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'date_paid' => array(
'description' => __( "The date the order was paid, in the site's timezone.", 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_paid_gmt' => array(
'description' => __( 'The date the order was paid, as GMT.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_completed' => array(
'description' => __( "The date the order was completed, in the site's timezone.", 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_completed_gmt' => array(
'description' => __( 'The date the order was completed, as GMT.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'cart_hash' => array(
'description' => __( 'MD5 hash of cart items to ensure orders are not modified.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'meta_data' => array(
'description' => __( 'Meta data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => array( 'null', 'object', 'string', 'number', 'boolean', 'integer', 'array' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
),
),
'line_items' => array(
'description' => __( 'A list of line items (products) within this order.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'items' => array(
'type' => 'object',
'properties' => $this->order_item_schema->get_item_schema_properties(),
),
),
'tax_lines' => array(
'description' => __( 'Tax lines data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => $this->order_tax_schema->get_item_schema_properties(),
),
),
'shipping_lines' => array(
'description' => __( 'Shipping lines data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'items' => array(
'type' => 'object',
'properties' => $this->order_shipping_schema->get_item_schema_properties(),
),
),
'fee_lines' => array(
'description' => __( 'Fee lines data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'items' => array(
'type' => 'object',
'properties' => $this->order_fee_schema->get_item_schema_properties(),
),
),
'coupon_lines' => array(
'description' => __( 'Coupons line data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'items' => array(
'type' => 'object',
'properties' => $this->order_coupon_schema->get_item_schema_properties(),
),
),
'payment_url' => array(
'description' => __( 'Order payment URL.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'is_editable' => array(
'description' => __( 'Whether an order can be edited.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'needs_payment' => array(
'description' => __( 'Whether an order needs payment, based on status and order total.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'needs_processing' => array(
'description' => __( 'Whether an order needs processing before it can be completed.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'fulfillment_status' => array(
'description' => __( 'The fulfillment status of the order.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
);
if ( $this->cogs_is_enabled() ) {
$schema = $this->add_cogs_related_schema( $schema );
}
return $schema;
}
/**
* Add the Cost of Goods Sold related fields to the schema.
*
* @param array $schema The original schema.
* @return array The updated schema.
*/
private static function add_cogs_related_schema( array $schema ): array {
$schema['cost_of_goods_sold'] = array(
'description' => __( 'Cost of Goods Sold data.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'properties' => array(
'total_value' => array(
'description' => __( 'Total value of the Cost of Goods Sold for the order.', 'woocommerce' ),
'type' => 'number',
'readonly' => true,
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order $order Order instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $order, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$data = array(
'id' => $order->get_id(),
'parent_id' => $order->get_parent_id(),
'number' => $order->get_order_number(),
'order_key' => $order->get_order_key(),
'created_via' => $order->get_created_via(),
'version' => $order->get_version(),
'status' => OrderUtil::remove_status_prefix( $order->get_status() ),
'currency' => $order->get_currency(),
'currency_symbol' => html_entity_decode( get_woocommerce_currency_symbol( $order->get_currency() ), ENT_QUOTES ),
'date_created' => wc_rest_prepare_date_response( $order->get_date_created(), false ),
'date_created_gmt' => wc_rest_prepare_date_response( $order->get_date_created() ),
'date_modified' => wc_rest_prepare_date_response( $order->get_date_modified(), false ),
'date_modified_gmt' => wc_rest_prepare_date_response( $order->get_date_modified() ),
'discount_total' => wc_format_decimal( $order->get_discount_total(), $dp ),
'discount_tax' => wc_format_decimal( $order->get_discount_tax(), $dp ),
'shipping_total' => wc_format_decimal( $order->get_shipping_total(), $dp ),
'shipping_tax' => wc_format_decimal( $order->get_shipping_tax(), $dp ),
'cart_tax' => wc_format_decimal( $order->get_cart_tax(), $dp ),
'total' => wc_format_decimal( $order->get_total(), $dp ),
'total_tax' => wc_format_decimal( $order->get_total_tax(), $dp ),
'prices_include_tax' => $order->get_prices_include_tax(),
'customer_id' => $order->get_customer_id(),
'customer_ip_address' => $order->get_customer_ip_address(),
'customer_user_agent' => $order->get_customer_user_agent(),
'customer_note' => $order->get_customer_note(),
'billing' => array(
'first_name' => $order->get_billing_first_name(),
'last_name' => $order->get_billing_last_name(),
'company' => $order->get_billing_company(),
'address_1' => $order->get_billing_address_1(),
'address_2' => $order->get_billing_address_2(),
'city' => $order->get_billing_city(),
'state' => $order->get_billing_state(),
'postcode' => $order->get_billing_postcode(),
'country' => $order->get_billing_country(),
'email' => $order->get_billing_email(),
'phone' => $order->get_billing_phone(),
),
'shipping' => array(
'first_name' => $order->get_shipping_first_name(),
'last_name' => $order->get_shipping_last_name(),
'company' => $order->get_shipping_company(),
'address_1' => $order->get_shipping_address_1(),
'address_2' => $order->get_shipping_address_2(),
'city' => $order->get_shipping_city(),
'state' => $order->get_shipping_state(),
'postcode' => $order->get_shipping_postcode(),
'country' => $order->get_shipping_country(),
'phone' => $order->get_shipping_phone(),
),
'payment_method' => $order->get_payment_method(),
'payment_method_title' => $order->get_payment_method_title(),
'transaction_id' => $order->get_transaction_id(),
'date_paid' => wc_rest_prepare_date_response( $order->get_date_paid(), false ),
'date_paid_gmt' => wc_rest_prepare_date_response( $order->get_date_paid() ),
'date_completed' => wc_rest_prepare_date_response( $order->get_date_completed(), false ),
'date_completed_gmt' => wc_rest_prepare_date_response( $order->get_date_completed() ),
'cart_hash' => $order->get_cart_hash(),
'payment_url' => $order->get_checkout_payment_url(),
'is_editable' => $order->is_editable(),
'needs_payment' => $order->needs_payment(),
'needs_processing' => $order->needs_processing(),
'fulfillment_status' => FulfillmentUtils::get_order_fulfillment_status( $order ),
);
if ( in_array( 'refund_total', $include_fields, true ) ) {
$data['refund_total'] = wc_format_decimal( $order->get_total_refunded(), $dp );
}
if ( in_array( 'refund_tax', $include_fields, true ) ) {
$data['refund_tax'] = wc_format_decimal( $order->get_total_tax_refunded(), $dp );
}
if ( in_array( 'line_items', $include_fields, true ) ) {
$line_items = $order->get_items( 'line_item' );
$data['line_items'] = array();
foreach ( $line_items as $line_item ) {
$data['line_items'][] = $this->order_item_schema->get_item_response( $line_item, $request );
}
}
if ( in_array( 'shipping_lines', $include_fields, true ) ) {
$line_items = $order->get_items( 'shipping' );
$data['shipping_lines'] = array();
foreach ( $line_items as $line_item ) {
$data['shipping_lines'][] = $this->order_shipping_schema->get_item_response( $line_item, $request );
}
}
if ( in_array( 'coupon_lines', $include_fields, true ) ) {
$line_items = $order->get_items( 'coupon' );
$data['coupon_lines'] = array();
foreach ( $line_items as $line_item ) {
$data['coupon_lines'][] = $this->order_coupon_schema->get_item_response( $line_item, $request );
}
}
if ( in_array( 'fee_lines', $include_fields, true ) ) {
$line_items = $order->get_items( 'fee' );
$data['fee_lines'] = array();
foreach ( $line_items as $line_item ) {
$data['fee_lines'][] = $this->order_fee_schema->get_item_response( $line_item, $request );
}
}
if ( in_array( 'tax_lines', $include_fields, true ) ) {
$line_items = $order->get_items( 'tax' );
$data['tax_lines'] = array();
foreach ( $line_items as $line_item ) {
$data['tax_lines'][] = $this->order_tax_schema->get_item_response( $line_item, $request );
}
}
if ( in_array( 'meta_data', $include_fields, true ) ) {
$filtered_meta_data = $this->filter_internal_meta_keys( $order->get_meta_data() );
$data['meta_data'] = array();
foreach ( $filtered_meta_data as $meta_item ) {
$data['meta_data'][] = array(
'id' => $meta_item->id,
'key' => $meta_item->key,
'value' => $meta_item->value,
);
}
}
// Add COGS data.
if ( $this->cogs_is_enabled() && in_array( 'cost_of_goods_sold', $include_fields, true ) ) {
$data['cost_of_goods_sold']['total_value'] = $order->get_cogs_total_value();
}
$data = array_intersect_key( $data, array_flip( $include_fields ) );
return $data;
}
/**
* With HPOS, few internal meta keys such as _billing_address_index, _shipping_address_index are not considered internal anymore (since most internal keys were flattened into dedicated columns).
*
* This function helps in filtering out any remaining internal meta keys with HPOS is enabled.
*
* @param array $meta_data Order meta data.
* @return array Filtered order meta data.
*/
protected function filter_internal_meta_keys( $meta_data ) {
if ( ! OrderUtil::custom_orders_table_usage_is_enabled() ) {
return $meta_data;
}
$cpt_hidden_keys = ( new \WC_Order_Data_Store_CPT() )->get_internal_meta_keys();
$meta_data = array_filter(
$meta_data,
function ( $meta ) use ( $cpt_hidden_keys ) {
return ! in_array( $meta->key, $cpt_hidden_keys, true );
}
);
return array_values( $meta_data );
}
}
PK [1]j^
2 RestApi/Routes/V4/Orders/Schema/OrderTaxSchema.phpnu array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'rate_code' => array(
'description' => __( 'Tax rate code.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'rate_id' => array(
'description' => __( 'Tax rate ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'label' => array(
'description' => __( 'Tax rate label.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'compound' => array(
'description' => __( 'Show if is a compound tax rate.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'tax_total' => array(
'description' => __( 'Tax total (not including shipping taxes).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'shipping_tax_total' => array(
'description' => __( 'Shipping tax total.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'meta_data' => $this->get_meta_data_schema(),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order_Item_Tax $order_item Order item instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $order_item, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$data = array(
'id' => $order_item->get_id(),
'rate_code' => $order_item->get_rate_code(),
'rate_id' => $order_item->get_rate_id(),
'label' => $order_item->get_label(),
'compound' => $order_item->get_compound(),
'tax_total' => wc_format_decimal( $order_item->get_tax_total(), $dp ),
'shipping_tax_total' => wc_format_decimal( $order_item->get_shipping_tax_total(), $dp ),
'meta_data' => $this->prepare_meta_data( $order_item ),
);
return $data;
}
}
PK [1]`' `' 3 RestApi/Routes/V4/Orders/Schema/OrderItemSchema.phpnu array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'name' => array(
'description' => __( 'Item name.', 'woocommerce' ),
'type' => array( 'string', 'null' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'image' => array(
'description' => __( 'Line item image, if available.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'product_id' => array(
'description' => __( 'Product or variation ID.', 'woocommerce' ),
'type' => array( 'integer', 'null' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'product_data' => array(
'description' => __( 'Product data this item is linked to.', 'woocommerce' ),
'type' => array( 'object', 'null' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'properties' => $this->get_product_data_schema(),
),
'quantity' => array(
'description' => __( 'Quantity ordered.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'price' => array(
'description' => __( 'Item price. Calculated as total / quantity.', 'woocommerce' ),
'type' => 'number',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'tax_class' => array(
'description' => __( 'Tax class of product.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'subtotal' => array(
'description' => __( 'Line subtotal (before discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'subtotal_tax' => array(
'description' => __( 'Line subtotal tax (before discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'total' => array(
'description' => __( 'Line total (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'total_tax' => array(
'description' => __( 'Line total tax (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'taxes' => $this->get_taxes_schema(),
'meta_data' => $this->get_meta_data_schema(),
'currency' => array(
'description' => __( 'Currency the order item was created with, in ISO format.', 'woocommerce' ),
'type' => 'string',
'default' => get_woocommerce_currency(),
'enum' => array_keys( get_woocommerce_currencies() ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'currency_symbol' => array(
'description' => __( 'Currency symbol for the currency which can be used to format returned prices.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
);
if ( $this->cogs_is_enabled() ) {
$schema = $this->add_cogs_related_schema( $schema );
}
return $schema;
}
/**
* Add the Cost of Goods Sold related fields to the schema.
*
* @param array $schema The original schema.
* @return array The updated schema.
*/
private function add_cogs_related_schema( array $schema ): array {
$schema['cost_of_goods_sold'] = array(
'description' => __( 'Cost of Goods Sold data. Only present for product line items.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'properties' => array(
'total_value' => array(
'description' => __( 'Value of the Cost of Goods Sold for the order item.', 'woocommerce' ),
'type' => 'number',
'readonly' => true,
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order_Item_Product $order_item Order item instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $order_item, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$quantity_amount = (float) $order_item->get_quantity();
$data = array(
'id' => $order_item->get_id(),
'name' => $order_item->get_name(),
'image' => $this->get_image( $order_item ),
'product_id' => $order_item->get_variation_id() ? $order_item->get_variation_id() : $order_item->get_product_id(),
'product_data' => $this->get_product_data( $order_item ),
'quantity' => $order_item->get_quantity(),
'price' => $quantity_amount ? $order_item->get_total() / $quantity_amount : 0,
'tax_class' => $order_item->get_tax_class(),
'subtotal' => wc_format_decimal( $order_item->get_subtotal(), $dp ),
'subtotal_tax' => wc_format_decimal( $order_item->get_subtotal_tax(), $dp ),
'total' => wc_format_decimal( $order_item->get_total(), $dp ),
'total_tax' => wc_format_decimal( $order_item->get_total_tax(), $dp ),
'taxes' => $this->prepare_taxes( $order_item, $request ),
'meta_data' => $this->prepare_meta_data( $order_item ),
'currency' => $order_item->get_order()->get_currency(),
'currency_symbol' => html_entity_decode( get_woocommerce_currency_symbol( $order_item->get_order()->get_currency() ), ENT_QUOTES ),
);
// Add COGS data.
if ( self::cogs_is_enabled() ) {
$data['cost_of_goods_sold']['total_value'] = isset( $data['cogs_value'] ) ? $data['cogs_value'] : 0;
unset( $data['cogs_value'] );
}
return $data;
}
/**
* Get embedded product schema.
*
* @return array
*/
private function get_product_data_schema(): array {
return array(
'name' => array(
'description' => __( 'Product name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'permalink' => array(
'description' => __( 'Product permalink.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'sku' => array(
'description' => __( 'Product SKU.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'global_unique_id' => array(
'description' => __( 'Product global unique ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'type' => array(
'description' => __( 'Product type.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'is_virtual' => array(
'description' => __( 'Product is virtual.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'is_downloadable' => array(
'description' => __( 'Product is downloadable.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'needs_shipping' => array(
'description' => __( 'Product needs shipping.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
);
}
/**
* Get product data.
*
* @param WC_Order_Item_Product $order_item Order item instance.
* @return array|null
*/
private function get_product_data( WC_Order_Item_Product $order_item ) {
$product = $order_item->get_product();
if ( ! $product instanceof \WC_Product ) {
return null;
}
return array(
'name' => $product->get_name(),
'permalink' => $product->get_permalink(),
'sku' => $product->get_sku(),
'global_unique_id' => $product->get_global_unique_id(),
'type' => $product->get_type(),
'is_virtual' => $product->is_virtual(),
'is_downloadable' => $product->is_downloadable(),
'needs_shipping' => $product->needs_shipping(),
);
}
/**
* Get image.
*
* @param WC_Order_Item_Product $order_item Order item instance.
* @return string
*/
private function get_image( WC_Order_Item_Product $order_item ) {
$product = $order_item->get_product();
if ( ! $product instanceof \WC_Product ) {
return '';
}
$image_id = $product->get_image_id() ? $product->get_image_id() : 0;
return $image_id ? wp_get_attachment_image_url( $image_id, 'full' ) : '';
}
}
PK [1]u^ ^ 2 RestApi/Routes/V4/Orders/Schema/OrderFeeSchema.phpnu array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'name' => array(
'description' => __( 'Fee name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'tax_class' => array(
'description' => __( 'Tax class of fee.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'tax_status' => array(
'description' => __( 'Tax status of fee.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'enum' => array( 'taxable', 'none' ),
),
'total' => array(
'description' => __( 'Line total (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'total_tax' => array(
'description' => __( 'Line total tax (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'taxes' => $this->get_taxes_schema(),
'meta_data' => $this->get_meta_data_schema(),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order_Item_Fee $order_item Order item instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $order_item, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$data = array(
'id' => $order_item->get_id(),
'name' => $order_item->get_name(),
'tax_class' => $order_item->get_tax_class(),
'tax_status' => $order_item->get_tax_status(),
'total' => wc_format_decimal( $order_item->get_total(), $dp ),
'total_tax' => wc_format_decimal( $order_item->get_total_tax(), $dp ),
'taxes' => $this->prepare_taxes( $order_item, $request ),
'meta_data' => $this->prepare_meta_data( $order_item ),
);
return $data;
}
}
PK [1]N 7 RestApi/Routes/V4/Orders/Schema/OrderShippingSchema.phpnu array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'method_title' => array(
'description' => __( 'Shipping method name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'method_id' => array(
'description' => __( 'Shipping method ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'instance_id' => array(
'description' => __( 'Shipping instance ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'total' => array(
'description' => __( 'Line total (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'total_tax' => array(
'description' => __( 'Line total tax (after discounts).', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'taxes' => $this->get_taxes_schema(),
'meta_data' => $this->get_meta_data_schema(),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order_Item_Shipping $order_item Order item instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $order_item, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$data = array(
'id' => $order_item->get_id(),
'method_title' => $order_item->get_method_title(),
'method_id' => $order_item->get_method_id(),
'instance_id' => $order_item->get_instance_id(),
'total' => wc_format_decimal( $order_item->get_total(), $dp ),
'total_tax' => wc_format_decimal( $order_item->get_total_tax(), $dp ),
'taxes' => $this->prepare_taxes( $order_item, $request ),
'meta_data' => $this->prepare_meta_data( $order_item ),
);
return $data;
}
}
PK [1]L% % 5 RestApi/Routes/V4/Orders/Schema/OrderCouponSchema.phpnu array(
'description' => __( 'Item ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'code' => array(
'description' => __( 'Coupon code.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'discount' => array(
'description' => __( 'Discount total.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'discount_tax' => array(
'description' => __( 'Discount total tax.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'discount_type' => array(
'description' => __( 'Discount type.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'nominal_amount' => array(
'description' => __( 'Discount amount as defined in the coupon (absolute value or a percent, depending on the discount type).', 'woocommerce' ),
'type' => 'number',
'context' => array( 'view' ),
'readonly' => true,
),
'free_shipping' => array(
'description' => __( 'Whether the coupon grants free shipping or not.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'view' ),
'readonly' => true,
),
'meta_data' => $this->get_meta_data_schema(),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order_Item_Coupon $order_item Order item instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $order_item, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$temp_coupon = new WC_Coupon();
$coupon_info = $order_item->get_meta( 'coupon_info', true );
if ( $coupon_info ) {
$temp_coupon->set_short_info( $coupon_info );
} else {
$coupon_meta = $order_item->get_meta( 'coupon_data', true );
if ( $coupon_meta ) {
$temp_coupon->set_props( (array) $coupon_meta );
}
}
$data = array(
'id' => $order_item->get_id(),
'code' => $order_item->get_code(),
'discount' => wc_format_decimal( $order_item->get_discount(), $dp ),
'discount_tax' => wc_format_decimal( $order_item->get_discount_tax(), $dp ),
'discount_type' => $temp_coupon->get_discount_type(),
'nominal_amount' => (float) $temp_coupon->get_amount(),
'free_shipping' => $temp_coupon->get_free_shipping(),
'meta_data' => $this->prepare_meta_data( $order_item ),
);
return $data;
}
}
PK [1] _ $ RestApi/Routes/V4/AbstractSchema.phpnu 'http://json-schema.org/draft-04/schema#',
'title' => static::IDENTIFIER,
'type' => 'object',
'properties' => $this->get_item_schema_properties(),
);
}
/**
* Get the item response.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
abstract public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array;
/**
* Return all properties for the item schema.
*
* @return array The schema properties.
* @since 10.2.0
*/
public function get_item_schema_properties(): array {
return array();
}
/**
* Return all writable properties for the item schema.
*
* @return array The schema properties.
* @since 10.2.0
*/
public function get_writable_item_schema_properties(): array {
return array_filter( $this->get_item_schema_properties(), array( $this, 'filter_writable_props' ) );
}
/**
* Filter schema properties to only return writable ones.
*
* @param array $schema The schema property to check.
* @return bool True if the property is writable, false otherwise.
* @since 10.2.0
*/
protected function filter_writable_props( array $schema ): bool {
return empty( $schema['readonly'] );
}
}
PK [1]\ Q 7 RestApi/Routes/V4/ShippingZones/ShippingZoneService.phpnu get_data();
$rest_data['zone_id'] = $rest_of_the_world->get_id();
$rest_data['formatted_zone_location'] = array();
$rest_data['shipping_methods'] = $rest_of_the_world->get_shipping_methods( false, 'admin' );
$zones[0] = $rest_data;
uasort(
$zones,
function ( $a, $b ) {
return $a['zone_order'] <=> $b['zone_order'];
}
);
return $zones;
}
/**
* Create a new shipping zone.
*
* @param array $params {
* Zone parameters.
*
* @type string $name Zone name.
* @type int $order Zone order for sorting.
* @type array $locations Array of location objects with 'code' and 'type' keys.
* }
* @return WC_Shipping_Zone|WP_Error Zone object on success, WP_Error on failure.
*/
public function create_shipping_zone( $params ) {
$zone = new WC_Shipping_Zone( null );
$result = $this->update_shipping_zone( $zone, $params );
if ( is_wp_error( $result ) ) {
return $result;
}
return $zone;
}
/**
* Update an existing shipping zone.
*
* @param WC_Shipping_Zone $zone Zone object to update.
* @param array $params {
* Zone parameters to update. All parameters are optional.
*
* @type string $name Zone name. Cannot be changed for "Rest of the World" zone (ID 0).
* @type int $order Zone order for sorting. Cannot be changed for "Rest of the World" zone.
* @type array $locations Array of location objects. Cannot be changed for "Rest of the World" zone.
* Each location should have 'code' (string) and 'type' (string) keys.
* Valid types: 'postcode', 'state', 'country', 'continent'.
* }
* @return WC_Shipping_Zone|WP_Error Updated zone object on success, WP_Error on failure.
*/
public function update_shipping_zone( $zone, $params ) {
$params = wp_parse_args(
$params,
array(
'name' => null,
'order' => null,
'locations' => null,
)
);
$is_rest_of_world = 0 === $zone->get_id();
if ( ! is_null( $params['name'] ) ) {
if ( $is_rest_of_world ) {
return new WP_Error(
'woocommerce_rest_cannot_edit_zone',
__( 'Cannot change name of "Rest of the World" zone.', 'woocommerce' ),
array( 'status' => WP_Http::BAD_REQUEST )
);
}
$name = trim( $params['name'] );
if ( '' === $name ) {
return new WP_Error(
'woocommerce_rest_invalid_zone_name',
__( 'Zone name cannot be empty.', 'woocommerce' ),
array( 'status' => WP_Http::BAD_REQUEST )
);
}
$zone->set_zone_name( $name );
}
if ( ! is_null( $params['order'] ) ) {
if ( $is_rest_of_world ) {
return new WP_Error(
'woocommerce_rest_cannot_edit_zone',
__( 'Cannot change order of "Rest of the World" zone.', 'woocommerce' ),
array( 'status' => WP_Http::BAD_REQUEST )
);
}
$zone->set_zone_order( $params['order'] );
}
$locations_being_cleared = false;
if ( ! is_null( $params['locations'] ) ) {
if ( $is_rest_of_world ) {
return new WP_Error(
'woocommerce_rest_cannot_edit_zone',
__( 'Cannot change locations of "Rest of the World" zone.', 'woocommerce' ),
array( 'status' => WP_Http::BAD_REQUEST )
);
}
$raw_locations = $params['locations'];
$locations = array();
foreach ( (array) $raw_locations as $raw_location ) {
$locations_being_cleared = false;
if ( empty( $raw_location['code'] ) ) {
continue;
}
$type = ! empty( $raw_location['type'] ) ? $raw_location['type'] : 'country';
// Normalize 'country:state' to 'state' for v4 API backward compatibility.
if ( 'country:state' === $type ) {
$type = 'state';
}
if ( ! $zone->is_valid_location_type( $type ) ) {
continue;
}
$locations[] = array(
'code' => $raw_location['code'],
'type' => $type,
);
}
$locations_being_cleared = empty( $locations );
$zone->set_locations( $locations );
}
$zone->save();
// WORKAROUND: WC_Data::apply_changes() uses array_replace_recursive() which doesn't
// properly clear array properties when set to empty arrays. After save(), get_zone_locations()
// returns stale cached data. Only reload when clearing locations to get accurate state.
if ( $locations_being_cleared ) {
$zone = WC_Shipping_Zones::get_zone( $zone->get_id() );
}
return $zone;
}
}
PK [1]W5E 6 RestApi/Routes/V4/ShippingZones/ShippingZoneSchema.phpnu array(
'description' => __( 'Unique identifier for the shipping zone.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Shipping zone name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'required' => true,
'sanitize_callback' => 'sanitize_text_field',
),
'order' => array(
'description' => __( 'Shipping zone order.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'default' => 0,
),
'locations' => array(
'description' => __( 'Array of locations for this zone. Can be empty array but must be explicitly provided.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'required' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'code' => array(
'description' => __( 'Shipping zone location code.', 'woocommerce' ),
'type' => 'string',
),
'type' => array(
'description' => __( 'Shipping zone location type.', 'woocommerce' ),
'type' => 'string',
'default' => 'country',
),
'name' => array(
'description' => __( 'Shipping zone location name (readonly, auto-generated from code).', 'woocommerce' ),
'type' => 'string',
'readonly' => true,
),
),
),
),
'methods' => array(
'description' => __( 'Shipping methods for this zone.', 'woocommerce' ),
'type' => 'array',
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'instance_id' => array(
'description' => __( 'Shipping method instance ID.', 'woocommerce' ),
'type' => 'integer',
),
'title' => array(
'description' => __( 'Shipping method title.', 'woocommerce' ),
'type' => 'string',
),
'enabled' => array(
'description' => __( 'Whether the shipping method is enabled.', 'woocommerce' ),
'type' => 'boolean',
),
'method_id' => array(
'description' => __( 'Shipping method ID (e.g., flat_rate, free_shipping).', 'woocommerce' ),
'type' => 'string',
),
'settings' => array(
'description' => __( 'Raw shipping method settings for frontend processing.', 'woocommerce' ),
'type' => 'object',
),
),
),
),
);
return $schema;
}
/**
* Get the item response.
*
* @param WC_Shipping_Zone $zone WordPress representation of the zone.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $zone, WP_REST_Request $request, array $include_fields = array() ): array {
return array(
'id' => $zone->get_id(),
'name' => $zone->get_zone_name(),
'order' => $zone->get_zone_order(),
'locations' => $this->get_formatted_zone_locations( $zone ),
'methods' => $this->get_formatted_zone_methods( $zone ),
);
}
/**
* Get array of location objects for API response.
*
* @param WC_Shipping_Zone $zone Shipping zone object.
* @return array Array of location objects with code, type, and name.
*/
protected function get_formatted_zone_locations( WC_Shipping_Zone $zone ): array {
if ( 0 === $zone->get_id() ) {
return array();
}
$locations = $zone->get_zone_locations();
$formatted_locations = array();
foreach ( $locations as $location ) {
$formatted_locations[] = array(
'code' => isset( $location->code ) ? $location->code : '',
'type' => isset( $location->type ) ? $location->type : 'country',
'name' => $this->get_location_name( $location ),
);
}
return $formatted_locations;
}
/**
* Get formatted methods for a zone.
*
* @param WC_Shipping_Zone $zone Shipping zone object.
* @return array
*/
protected function get_formatted_zone_methods( $zone ) {
$methods = $zone->get_shipping_methods( false, 'json' );
$formatted_methods = array();
foreach ( $methods as $method ) {
$formatted_method = array(
'instance_id' => $method->instance_id,
'title' => $method->title,
'enabled' => 'yes' === $method->enabled,
'method_id' => $method->id,
'settings' => $this->get_method_settings( $method ),
);
$formatted_methods[] = $formatted_method;
}
return $formatted_methods;
}
/**
* Get raw method settings for frontend processing.
*
* @param object $method Shipping method object.
* @return array
*/
protected function get_method_settings( $method ) {
$settings = array();
// Common settings that most methods have.
$common_fields = array( 'cost', 'min_amount', 'requires', 'class_cost', 'no_class_cost' );
foreach ( $common_fields as $field ) {
if ( isset( $method->$field ) ) {
$settings[ $field ] = $method->$field;
}
}
// Return all available settings for maximum flexibility.
if ( isset( $method->instance_settings ) && is_array( $method->instance_settings ) ) {
$settings = array_merge( $settings, $method->instance_settings );
}
return $settings;
}
/**
* Get location name from location object.
*
* @param object $location Location object.
* @return string
*/
protected function get_location_name( $location ) {
switch ( $location->type ) {
case 'continent':
$continents = WC()->countries->get_continents();
return isset( $continents[ $location->code ] ) ? $continents[ $location->code ]['name'] : $location->code;
case 'country':
$countries = WC()->countries->get_countries();
return isset( $countries[ $location->code ] ) ? $countries[ $location->code ] : $location->code;
case 'state':
case 'country:state':
$parts = explode( ':', $location->code );
if ( count( $parts ) === 2 ) {
$states = WC()->countries->get_states( $parts[0] );
return isset( $states[ $parts[1] ] ) ? $states[ $parts[1] ] : $location->code;
}
return $location->code;
case 'postcode':
return $location->code;
default:
return $location->code;
}
}
}
PK [1])(Z% Z% . RestApi/Routes/V4/ShippingZones/Controller.phpnu item_schema = $zone_schema;
$this->shipping_zone_service = $shipping_zone_service;
}
/**
* Get the schema for the current resource. This use consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Register the routes for shipping zones.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'check_permissions' ),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
),
'schema' => array( $this, 'get_public_item_schema' ),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'check_permissions' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::DELETABLE ),
),
)
);
}
/**
* Get shipping zone by ID.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
$zone_id = (int) $request['id'];
$zone = WC_Shipping_Zones::get_zone_by( 'zone_id', $zone_id );
if ( ! $zone ) {
return $this->get_route_error_response(
$this->get_error_prefix() . 'invalid_id',
__( 'Invalid resource ID.', 'woocommerce' ),
WP_Http::NOT_FOUND
);
}
return rest_ensure_response( $this->prepare_item_for_response( $zone, $request ) );
}
/**
* Get all shipping zones.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_items( $request ) {
$zones = $this->shipping_zone_service->get_sorted_shipping_zones();
$items = array();
foreach ( $zones as $zone_data ) {
$zone_id = $zone_data['zone_id'];
$zone = WC_Shipping_Zones::get_zone( $zone_id );
$items[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $zone, $request ) );
}
return rest_ensure_response( $items );
}
/**
* Prepare a single order object for response.
*
* @param WC_Shipping_Zone $zone Shipping zone object.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $zone, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $zone, $request, $this->get_fields_for_response( $request ) );
}
/**
* Check if a given request has permission to manage shipping zones.
*
* @param WP_REST_Request $request Full details about the request.
* @return true|WP_Error True if the request has permission, WP_Error otherwise.
*/
public function check_permissions( $request ) {
if ( ! wc_shipping_enabled() ) {
return $this->get_route_error_response(
$this->get_error_prefix() . 'disabled',
__( 'Shipping is disabled.', 'woocommerce' ),
WP_Http::SERVICE_UNAVAILABLE
);
}
$method = $request->get_method();
if ( 'GET' === $method ) {
$context = 'read';
} elseif ( 'DELETE' === $method ) {
$context = 'delete';
} else {
$context = 'edit';
}
if ( ! wc_rest_check_manager_permissions( 'settings', $context ) ) {
return $this->get_authentication_error_by_method( $method );
}
return true;
}
/**
* Create a new shipping zone.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response Response object or WP_Error.
*/
public function create_item( $request ) {
$zone = $this->shipping_zone_service->create_shipping_zone( $request->get_params() );
if ( is_wp_error( $zone ) ) {
return $zone;
}
if ( 0 === $zone->get_id() ) {
return $this->get_route_error_response(
$this->get_error_prefix() . 'cannot_create',
__( 'Resource cannot be created. Check for validation errors or server logs for details.', 'woocommerce' ),
WP_Http::INTERNAL_SERVER_ERROR
);
}
$response = rest_ensure_response( $this->prepare_item_for_response( $zone, $request ) );
$response->set_status( 201 );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $zone->get_id() ) ) );
return $response;
}
/**
* Delete a shipping zone by zone id.
*
* Note: In v2/v3, this endpoint required a `force` parameter, but since shipping zones
* do not support trashing, it would either delete (force=true) or return a 501 error (force=false).
* We removed the `force` parameter in v4 as it serves no purpose when soft delete is not supported.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response Response object or WP_Error.
*/
public function delete_item( $request ) {
$zone_id = (int) $request['id'];
$zone = $this->validate_zone( $zone_id );
if ( is_wp_error( $zone ) ) {
return $zone;
}
$response = rest_ensure_response( $this->prepare_item_for_response( $zone, $request ) );
WC_Shipping_Zones::delete_zone( $zone_id );
return $response;
}
/**
* Get route error by code, including custom shipping zone errors.
*
* @param string $error_code Error code.
* @return WP_Error
*/
protected function get_route_error_by_code( string $error_code ): WP_Error {
$custom_errors = array(
self::INVALID_ZONE_ID => array(
'message' => __( 'Invalid shipping zone ID.', 'woocommerce' ),
'status' => WP_Http::NOT_FOUND,
),
);
if ( isset( $custom_errors[ $error_code ] ) ) {
return $this->get_route_error_response(
$this->get_error_prefix() . $error_code,
$custom_errors[ $error_code ]['message'],
$custom_errors[ $error_code ]['status']
);
}
return parent::get_route_error_by_code( $error_code );
}
/**
* Validate that a shipping zone exists.
*
* @param int $zone_id Zone ID.
* @return WC_Shipping_Zone|WP_Error Zone object or error.
*/
protected function validate_zone( $zone_id ) {
$zone = WC_Shipping_Zones::get_zone( $zone_id );
if ( ! $zone || ( 0 !== $zone->get_id() && ! $zone->get_zone_name() ) ) {
return $this->get_route_error_by_code( self::INVALID_ZONE_ID );
}
return $zone;
}
/**
* Update a shipping zone.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response Response object or WP_Error.
*/
public function update_item( $request ) {
$zone_id = (int) $request['id'];
$zone = $this->validate_zone( $zone_id );
if ( is_wp_error( $zone ) ) {
return $zone;
}
$result = $this->shipping_zone_service->update_shipping_zone( $zone, $request->get_params() );
if ( is_wp_error( $result ) ) {
return $result;
}
return rest_ensure_response( $this->prepare_item_for_response( $result, $request ) );
}
}
PK [1]}(# # 9 RestApi/Routes/V4/Settings/PaymentGateways/Controller.phpnu get_item_schema();
}
/**
* Register the routes for payment gateways.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\w-]+)',
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => array(
'values' => array(
'description' => __( 'Payment gateway field values to update.', 'woocommerce' ),
'type' => 'object',
'required' => true,
),
),
),
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'string',
'pattern' => '^[\w-]+$',
),
),
)
);
}
/**
* Get a single payment gateway.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function get_item( $request ) {
$id = $request['id'];
$payment_gateways = WC()->payment_gateways->payment_gateways();
if ( ! isset( $payment_gateways[ $id ] ) ) {
return new WP_Error( 'woocommerce_rest_payment_gateway_invalid_id', __( 'Invalid payment gateway ID.', 'woocommerce' ), array( 'status' => 404 ) );
}
$gateway = $payment_gateways[ $id ];
// Get gateway-specific schema.
$schema = $this->get_schema_for_gateway( $id );
$data = $schema->get_item_response( $gateway, $request );
return rest_ensure_response( $data );
}
/**
* Check if a given request has access to read payment gateways.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( $this->post_type, 'read' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to update payment gateways.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'payment_gateways', 'edit' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Get a gateway based on the current request object.
*
* @param string $id Gateway ID.
*
* @return WC_Payment_Gateway|null
*/
private function get_payment_gateway( $id ): ?WC_Payment_Gateway {
$payment_gateways = WC()->payment_gateways->payment_gateways();
return $payment_gateways[ $id ] ?? null;
}
/**
* Get the appropriate schema for a payment gateway.
*
* @param string $gateway_id Gateway ID.
* @return AbstractPaymentGatewaySettingsSchema
*/
private function get_schema_for_gateway( string $gateway_id ): AbstractPaymentGatewaySettingsSchema {
switch ( $gateway_id ) {
case 'bacs':
return new BacsGatewaySettingsSchema();
case 'cod':
return new CodGatewaySettingsSchema();
default:
// Use generic schema for unknown gateways.
return new PaymentGatewaySettingsSchema();
}
}
/**
* Update a payment gateway's settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$id = $request['id'];
$gateway = $this->get_payment_gateway( $id );
if ( ! $gateway ) {
return new WP_Error(
'woocommerce_rest_payment_gateway_invalid_id',
__( 'Invalid payment gateway ID.', 'woocommerce' ),
array( 'status' => 404 )
);
}
// Get gateway-specific schema.
$schema = $this->get_schema_for_gateway( $id );
// Get field values from the values parameter.
$params = $request->get_params();
$values_to_update = $params['values'] ?? null;
if ( empty( $values_to_update ) || ! is_array( $values_to_update ) ) {
return new WP_Error(
'rest_missing_callback_param',
__( 'Missing parameter(s): values', 'woocommerce' ),
array( 'status' => 400 )
);
}
// Handle top-level gateway fields from within values.
$gateway->init_form_fields();
if ( isset( $values_to_update['enabled'] ) ) {
$gateway->enabled = wc_bool_to_string( $values_to_update['enabled'] );
$gateway->settings['enabled'] = $gateway->enabled;
unset( $values_to_update['enabled'] );
}
if ( isset( $values_to_update['title'] ) ) {
$gateway->title = sanitize_text_field( $values_to_update['title'] );
$gateway->settings['title'] = $gateway->title;
unset( $values_to_update['title'] );
}
if ( isset( $values_to_update['description'] ) ) {
$gateway->description = wp_kses_post( $values_to_update['description'] );
$gateway->settings['description'] = $gateway->description;
unset( $values_to_update['description'] );
}
if ( isset( $values_to_update['order'] ) ) {
$order = absint( $values_to_update['order'] );
$gateway_order = (array) get_option( 'woocommerce_gateway_order', array() );
$gateway_order[ $id ] = $order;
update_option( 'woocommerce_gateway_order', $gateway_order );
unset( $values_to_update['order'] );
}
// Separate standard fields from special fields.
$standard_values = array();
$special_values = array();
foreach ( $values_to_update as $key => $value ) {
// Check if this is a special field.
if ( $schema->is_special_field( $key ) ) {
$special_values[ $key ] = $value;
} elseif ( isset( $gateway->form_fields[ $key ] ) ) {
$standard_values[ $key ] = $value;
}
// Silently skip unknown fields.
}
// Validate and sanitize standard settings.
$validated_settings = $schema->validate_and_sanitize_settings(
$gateway,
$standard_values
);
if ( is_wp_error( $validated_settings ) ) {
return $validated_settings;
}
// Validate and sanitize special fields.
$validated_special = $schema->validate_and_sanitize_special_fields(
$gateway,
$special_values
);
if ( is_wp_error( $validated_special ) ) {
return $validated_special;
}
// Update standard settings.
foreach ( $validated_settings as $key => $value ) {
$gateway->settings[ $key ] = $value;
}
// Save standard settings to database.
update_option( $gateway->get_option_key(), $gateway->settings );
// Update special fields.
$schema->update_special_fields( $gateway, $validated_special );
// Return updated gateway data.
$data = $schema->get_item_response( $gateway, $request );
return rest_ensure_response( $data );
}
/**
* Get the item response for a payment gateway.
*
* @param WC_Payment_Gateway $item Payment gateway object.
* @param WP_REST_Request $request Request object.
* @return array The item response.
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
// Get gateway-specific schema.
$schema = $this->get_schema_for_gateway( $item->id );
return $schema->get_item_response( $item, $request );
}
}
PK [1]#LQ Q Z RestApi/Routes/V4/Settings/PaymentGateways/Schema/AbstractPaymentGatewaySettingsSchema.phpnu array(
'description' => __( 'Payment gateway ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Payment gateway title on checkout.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Payment gateway description on checkout.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'order' => array(
'description' => __( 'Payment gateway sort order.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'arg_options' => array(
'sanitize_callback' => 'absint',
),
),
'enabled' => array(
'description' => __( 'Payment gateway enabled status.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_CONTEXT,
),
'method_title' => array(
'description' => __( 'Payment gateway method title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'method_description' => array(
'description' => __( 'Payment gateway method description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'method_supports' => array(
'description' => __( 'Supported features for this payment gateway.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
'items' => array(
'type' => 'string',
),
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'number', 'select', 'multiselect', 'checkbox' ),
'context' => array( 'view', 'edit' ),
),
'options' => array(
'description' => __( 'Available options for select/multiselect fields.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
);
}
/**
* Get flat key-value mapping of all setting values.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
private function get_values( WC_Payment_Gateway $gateway ): array {
$values = array();
$gateway->init_form_fields();
foreach ( $gateway->form_fields as $id => $field ) {
$field_type = $field['type'] ?? '';
// Skip non-data fields.
if ( in_array( $field_type, array( 'title', 'sectionend' ), true ) ) {
continue;
}
// Get value from gateway settings.
$values[ $id ] = $gateway->settings[ $id ] ?? ( $field['default'] ?? '' );
}
// Add special fields for this gateway.
$special_fields = $this->get_special_field_values( $gateway );
$values = array_merge( $values, $special_fields );
return $values;
}
/**
* Get values for gateway-specific special fields.
*
* Override this method in gateway-specific schema classes to provide special field values.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
protected function get_special_field_values( WC_Payment_Gateway $gateway ): array {
return array();
}
/**
* Get grouped settings structure with field metadata.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
private function get_groups( WC_Payment_Gateway $gateway ): array {
// Check if gateway has custom grouping.
$custom_groups = $this->get_custom_groups_for_gateway( $gateway );
if ( ! empty( $custom_groups ) ) {
return $custom_groups;
}
// Default: single group with all fields.
return $this->get_default_group( $gateway );
}
/**
* Get custom groups for specific gateways.
*
* Override this method in gateway-specific schema classes to provide custom groupings.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
protected function get_custom_groups_for_gateway( WC_Payment_Gateway $gateway ): array {
return array();
}
/**
* Get default single group with all gateway fields.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
private function get_default_group( WC_Payment_Gateway $gateway ): array {
$gateway->init_form_fields();
$group = array(
'title' => __( 'Settings', 'woocommerce' ),
'description' => '',
'order' => 1,
'fields' => array(),
);
// Add standard top-level fields first.
$group['fields'][] = array(
'id' => 'enabled',
'label' => __( 'Enable/Disable', 'woocommerce' ),
'type' => 'checkbox',
'desc' => __( 'Enable this payment gateway', 'woocommerce' ),
);
$group['fields'][] = array(
'id' => 'title',
'label' => __( 'Title', 'woocommerce' ),
'type' => 'text',
'desc' => __( 'This controls the title which the user sees during checkout.', 'woocommerce' ),
);
$group['fields'][] = array(
'id' => 'description',
'label' => __( 'Description', 'woocommerce' ),
'type' => 'text',
'desc' => __( 'This controls the description which the user sees during checkout.', 'woocommerce' ),
);
$group['fields'][] = array(
'id' => 'order',
'label' => __( 'Order', 'woocommerce' ),
'type' => 'number',
'desc' => __( 'Determines the display order of payment gateways during checkout.', 'woocommerce' ),
);
foreach ( $gateway->form_fields as $id => $field ) {
$field_type = $field['type'] ?? '';
// Skip non-data fields, top-level fields (already added above), and special fields.
if ( in_array( $field_type, array( 'title', 'sectionend' ), true ) ||
in_array( $id, array( 'enabled', 'description', 'title' ), true ) ||
$this->is_special_field( $id ) ) {
continue;
}
$group['fields'][] = $this->transform_field_to_schema( $id, $field, $gateway );
}
// Add special fields.
$special_fields = $this->get_special_field_schemas( $gateway );
$group['fields'] = array_merge( $group['fields'], $special_fields );
if ( empty( $group['fields'] ) ) {
return array();
}
return array( 'settings' => $group );
}
/**
* Get field schemas for gateway-specific special fields.
*
* Override this method in gateway-specific schema classes to provide special field schemas.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
protected function get_special_field_schemas( WC_Payment_Gateway $gateway ): array {
return array();
}
/**
* Transform WooCommerce field definition to API field schema.
*
* @param string $id Field ID.
* @param array $field Field definition.
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
private function transform_field_to_schema( string $id, array $field, WC_Payment_Gateway $gateway ): array {
$field_type = $field['type'] ?? 'text';
$schema_field = array(
'id' => $id,
'label' => $field['title'] ?? $field['label'] ?? '',
'type' => $this->normalize_field_type( $field_type ),
'desc' => $field['description'] ?? '',
);
// For checkbox fields, use the 'label' field as description if no explicit description exists.
if ( 'checkbox' === $field_type && empty( $schema_field['desc'] ) && ! empty( $field['label'] ) ) {
$schema_field['desc'] = $field['label'];
}
// Add options for select/multiselect fields.
if ( in_array( $schema_field['type'], array( 'select', 'multiselect' ), true ) ) {
if ( ! empty( $field['options'] ) ) {
$schema_field['options'] = $field['options'];
} else {
// Generate options dynamically for specific fields.
$schema_field['options'] = $this->get_field_options( $id );
}
}
return $schema_field;
}
/**
* Get options for specific gateway fields.
*
* Override this method in gateway-specific schema classes to provide
* dynamic options for select/multiselect fields.
*
* @param string $field_id Field ID.
* @return array Field options.
*/
protected function get_field_options( string $field_id ): array {
return array();
}
/**
* Normalize WooCommerce field types to standard REST API types.
*
* @param string $wc_type WooCommerce field type.
* @return string
*/
private function normalize_field_type( string $wc_type ): string {
$type_map = array(
'email' => 'text',
'password' => 'text',
'textarea' => 'text',
'safe_text' => 'text',
'color' => 'text',
'image_width' => 'text',
'radio' => 'select',
);
return $type_map[ $wc_type ] ?? $wc_type;
}
/**
* Return settings associated with this payment gateway.
*
* Note: Some gateways may conditionally populate the 'options' array for select/multiselect fields
* based on context (e.g., only when accessing settings pages) for performance reasons.
* For example, the COD gateway's `enable_for_methods` field loads shipping method options only
* when `is_accessing_settings()` returns true. This means the options array may be empty when
* accessed via the REST API, even though the field type is multiselect.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
*
* @return array
*/
public function get_settings( WC_Payment_Gateway $gateway ): array {
$settings = array();
$gateway->init_form_fields();
foreach ( $gateway->form_fields as $id => $field ) {
// Make sure we at least have a title and type.
if ( empty( $field['title'] ) || empty( $field['type'] ) ) {
continue;
}
// Ignore 'enabled' and 'description' which get included elsewhere.
if ( in_array( $id, array( 'enabled', 'description' ), true ) ) {
continue;
}
$data = array(
'id' => $id,
'label' => empty( $field['label'] ) ? $field['title'] : $field['label'],
'description' => empty( $field['description'] ) ? '' : $field['description'],
'type' => $field['type'],
'value' => empty( $gateway->settings[ $id ] ) ? '' : $gateway->settings[ $id ],
'default' => empty( $field['default'] ) ? '' : $field['default'],
'tip' => empty( $field['description'] ) ? '' : $field['description'],
'placeholder' => empty( $field['placeholder'] ) ? '' : $field['placeholder'],
);
if ( ! empty( $field['options'] ) ) {
$data['options'] = $field['options'];
}
$settings[ $id ] = $data;
}
return $settings;
}
/**
* Get the item response.
*
* @param WC_Payment_Gateway $gateway Payment gateway object.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $gateway, WP_REST_Request $request, array $include_fields = array() ): array {
$order = (array) get_option( 'woocommerce_gateway_order' );
return array(
'id' => $gateway->id,
'title' => $gateway->title,
'description' => $gateway->description,
'order' => $order[ $gateway->id ] ?? '',
'enabled' => ( 'yes' === $gateway->enabled ),
'method_title' => $gateway->get_method_title(),
'method_description' => $gateway->get_method_description(),
'method_supports' => $gateway->supports,
'values' => $this->get_values( $gateway ),
'groups' => $this->get_groups( $gateway ),
);
}
/**
* Check if a field is a special field.
*
* Override this method in gateway-specific schema classes to identify special fields.
*
* @param string $field_id Field ID.
* @return bool
*/
public function is_special_field( string $field_id ): bool {
return false;
}
/**
* Validate and sanitize standard gateway settings.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @param array $values Values to validate and sanitize.
* @return array|WP_Error Validated settings or error.
*/
public function validate_and_sanitize_settings( WC_Payment_Gateway $gateway, array $values ) {
$gateway->init_form_fields();
$validated = array();
foreach ( $values as $key => $value ) {
// Security: only allow valid form fields.
if ( ! isset( $gateway->form_fields[ $key ] ) ) {
continue;
}
$field = $gateway->form_fields[ $key ];
$field_type = $field['type'] ?? 'text';
// Sanitize by type.
$sanitized = $this->sanitize_field_value( $field_type, $value );
// Validate.
$validation = $this->validate_field_value( $key, $sanitized, $field, $gateway );
if ( is_wp_error( $validation ) ) {
return $validation;
}
$validated[ $key ] = $sanitized;
}
return $validated;
}
/**
* Sanitize field value based on type.
*
* @param string $type Field type.
* @param mixed $value Field value.
* @return mixed Sanitized value.
*/
private function sanitize_field_value( string $type, $value ) {
switch ( $type ) {
case 'checkbox':
return wc_bool_to_string( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return '';
}
$int_value = filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE );
return null !== $int_value ? $int_value : floatval( $value );
case 'multiselect':
if ( is_array( $value ) ) {
return array_map( 'sanitize_text_field', $value );
}
return is_string( $value ) ? array( sanitize_text_field( $value ) ) : array();
case 'textarea':
return sanitize_textarea_field( $value );
case 'email':
return sanitize_email( $value );
case 'password':
case 'color':
return sanitize_text_field( $value );
case 'text':
case 'safe_text':
case 'select':
case 'radio':
case 'image_width':
default:
return sanitize_text_field( $value );
}
}
/**
* Validate field value.
*
* @param string $key Field key.
* @param mixed $value Sanitized value.
* @param array $field Field definition.
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return true|WP_Error True if valid, WP_Error otherwise.
*/
private function validate_field_value( string $key, $value, array $field, WC_Payment_Gateway $gateway ) {
$field_type = $this->normalize_field_type( $field['type'] ?? 'text' );
// Validate select/radio options.
if ( in_array( $field_type, array( 'select', 'radio' ), true ) && ! empty( $field['options'] ) ) {
if ( ! array_key_exists( $value, $field['options'] ) && '' !== $value ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: 1: field key, 2: valid options */
__( 'Invalid value for %1$s. Valid options: %2$s', 'woocommerce' ),
$key,
implode( ', ', array_keys( $field['options'] ) )
),
array( 'status' => 400 )
);
}
}
// Validate multiselect options.
if ( 'multiselect' === $field_type && ! empty( $field['options'] ) ) {
if ( is_array( $value ) ) {
foreach ( $value as $v ) {
if ( ! array_key_exists( $v, $field['options'] ) ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: 1: field key, 2: invalid value */
__( 'Invalid option "%2$s" for %1$s.', 'woocommerce' ),
$key,
$v
),
array( 'status' => 400 )
);
}
}
}
}
// Add more validations as needed.
return true;
}
/**
* Validate and sanitize special fields.
*
* Override this method in gateway-specific schema classes to provide custom validation.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @param array $values Special field values.
* @return array|WP_Error Validated values or error.
*/
public function validate_and_sanitize_special_fields( WC_Payment_Gateway $gateway, array $values ) {
return array();
}
/**
* Update special fields in database.
*
* Override this method in gateway-specific schema classes to provide custom update logic.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @param array $values Validated special field values.
* @return void
*/
public function update_special_fields( WC_Payment_Gateway $gateway, array $values ): void {
// Base implementation does nothing.
}
}
PK [1]/1b b N RestApi/Routes/V4/Settings/PaymentGateways/Schema/CodGatewaySettingsSchema.phpnu load_shipping_method_options();
default:
return array();
}
}
/**
* Load all shipping method options for the enable_for_methods field.
*
* This method replicates the logic from WC_Gateway_COD::load_shipping_method_options()
* to provide shipping method options for the REST API without relying on the gateway class.
*
* @return array Nested array of shipping method options.
*/
private function load_shipping_method_options(): array {
$data_store = WC_Data_Store::load( 'shipping-zone' );
$raw_zones = $data_store->get_zones();
$zones = array();
foreach ( $raw_zones as $raw_zone ) {
$zones[] = new WC_Shipping_Zone( $raw_zone );
}
$zones[] = new WC_Shipping_Zone( 0 );
$options = array();
foreach ( WC()->shipping()->load_shipping_methods() as $method ) {
$options[ $method->get_method_title() ] = array();
// Translators: %1$s shipping method name.
$options[ $method->get_method_title() ][ $method->id ] = sprintf( __( 'Any "%1$s" method', 'woocommerce' ), $method->get_method_title() );
foreach ( $zones as $zone ) {
$shipping_method_instances = $zone->get_shipping_methods();
foreach ( $shipping_method_instances as $shipping_method_instance_id => $shipping_method_instance ) {
if ( $shipping_method_instance->id !== $method->id ) {
continue;
}
$option_id = $shipping_method_instance->get_rate_id();
// Translators: %1$s shipping method title, %2$s shipping method id.
$option_instance_title = sprintf( __( '%1$s (#%2$s)', 'woocommerce' ), $shipping_method_instance->get_title(), $shipping_method_instance_id );
// Translators: %1$s zone name, %2$s shipping method instance name.
$option_title = sprintf( __( '%1$s – %2$s', 'woocommerce' ), $zone->get_id() ? $zone->get_zone_name() : __( 'Other locations', 'woocommerce' ), $option_instance_title );
$options[ $method->get_method_title() ][ $option_id ] = $option_title;
}
}
}
return $options;
}
}
PK [1]TPV V R RestApi/Routes/V4/Settings/PaymentGateways/Schema/PaymentGatewaySettingsSchema.phpnu get_option( 'woocommerce_bacs_accounts', array() ),
);
}
/**
* Get field schemas for BACS-specific special fields.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @return array
*/
protected function get_special_field_schemas( WC_Payment_Gateway $gateway ): array {
$gateway->init_form_fields();
// Start with information from the gateway's form_fields if available.
$field = $gateway->form_fields['account_details'] ?? array();
return array(
array(
'id' => 'account_details',
'label' => $field['title'] ?? __( 'Account details', 'woocommerce' ),
'type' => 'array',
'desc' => $field['description'] ?? __( 'Bank account details for direct bank transfer.', 'woocommerce' ),
),
);
}
/**
* Check if a field is a special field for BACS.
*
* @param string $field_id Field ID.
* @return bool
*/
public function is_special_field( string $field_id ): bool {
return 'account_details' === $field_id;
}
/**
* Validate and sanitize BACS special fields.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @param array $values Special field values.
* @return array|WP_Error Validated values or error.
*/
public function validate_and_sanitize_special_fields( WC_Payment_Gateway $gateway, array $values ) {
$validated = array();
foreach ( $values as $field_id => $value ) {
if ( 'account_details' === $field_id ) {
$validated[ $field_id ] = $this->validate_bacs_accounts( $value );
if ( is_wp_error( $validated[ $field_id ] ) ) {
return $validated[ $field_id ];
}
}
}
return $validated;
}
/**
* Update BACS special fields in database.
*
* @param WC_Payment_Gateway $gateway Gateway instance.
* @param array $values Validated special field values.
* @return void
*/
public function update_special_fields( WC_Payment_Gateway $gateway, array $values ): void {
foreach ( $values as $field_id => $value ) {
if ( 'account_details' === $field_id ) {
update_option( 'woocommerce_bacs_accounts', $value );
}
}
}
/**
* Validate BACS account details array.
*
* @param mixed $value Account details value.
* @return array|WP_Error Validated accounts or error.
*/
private function validate_bacs_accounts( $value ) {
if ( ! is_array( $value ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Account details must be an array.', 'woocommerce' ),
array( 'status' => 400 )
);
}
$validated_accounts = array();
$valid_fields = array( 'account_name', 'account_number', 'sort_code', 'bank_name', 'iban', 'bic' );
foreach ( $value as $index => $account ) {
if ( ! is_array( $account ) ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: %d: account index */
__( 'Account at index %d must be an object.', 'woocommerce' ),
$index
),
array( 'status' => 400 )
);
}
$validated_account = array();
// Sanitize each field.
foreach ( $valid_fields as $field ) {
$validated_account[ $field ] = isset( $account[ $field ] )
? sanitize_text_field( $account[ $field ] )
: '';
}
// Only add if at least one field is filled.
if ( array_filter( $validated_account ) ) {
$validated_accounts[] = $validated_account;
}
}
return $validated_accounts;
}
}
PK [1]3Cn# # 0 RestApi/Routes/V4/Settings/Emails/Controller.phpnu schema = $schema;
}
/**
* Register routes.
*/
public function register_routes() {
// Collection endpoint.
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => array(
'post_id' => array(
'description' => __( 'Filter by template post ID.', 'woocommerce' ),
'type' => 'integer',
),
),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
// Single item endpoint.
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\w-]+)',
array(
'args' => array(
'email_id' => array(
'description' => __( 'Email template ID.', 'woocommerce' ),
'type' => 'string',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Check permissions for reading email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to access email settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Check permissions for reading a single email setting.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
return $this->get_items_permissions_check( $request );
}
/**
* Check permissions for updating email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to edit email settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get all email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_items( $request ) {
try {
$emails = WC_Emails::instance()->get_emails();
$items = array();
foreach ( $emails as $email ) {
$item = $this->schema->get_item_response( $email, $request );
// Filter by post_id if provided.
$post_id = $request->get_param( 'post_id' );
if ( $post_id && (int) $item['post_id'] !== (int) $post_id ) {
continue;
}
$items[] = $item;
}
return rest_ensure_response( $items );
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_emails_settings_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
}
/**
* Get a single email setting.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
$email_id = $request['email_id'];
$email = $this->get_email_by_id( $email_id );
if ( ! $email ) {
return new WP_Error(
'woocommerce_rest_email_not_found',
__( 'Email template not found.', 'woocommerce' ),
array( 'status' => 404 )
);
}
try {
$response = $this->schema->get_item_response( $email, $request );
return rest_ensure_response( $response );
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_email_settings_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
}
/**
* Update a single email setting.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$email_id = $request['email_id'];
$email = $this->get_email_by_id( $email_id );
if ( ! $email ) {
return new WP_Error(
'woocommerce_rest_email_not_found',
__( 'Email template not found.', 'woocommerce' ),
array( 'status' => 404 )
);
}
$params = $request->get_json_params();
if ( ! is_array( $params ) || empty( $params ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid or empty request body.', 'woocommerce' ),
array( 'status' => 400 )
);
}
// Check if the request contains a 'values' field with the flat key-value mapping.
$values_to_update = array();
if ( isset( $params['values'] ) && is_array( $params['values'] ) ) {
$values_to_update = $params['values'];
} else {
// Fallback to the old format for backward compatibility.
$values_to_update = $params;
}
// Validate and sanitize.
$validated = $this->schema->validate_and_sanitize_settings( $email, $values_to_update );
if ( is_wp_error( $validated ) ) {
return $validated;
}
// Update options.
$updated_fields = array();
foreach ( $validated as $key => $value ) {
$email->update_option( $key, $value );
$updated_fields[] = $key;
}
// Reload emails after the update.
WC_Emails::instance()->init();
// Get updated email and return formatted response.
$updated_email = $this->get_email_by_id( $email_id );
if ( ! $updated_email ) {
return new WP_Error(
'woocommerce_rest_email_update_error',
__( 'Failed to retrieve updated email settings.', 'woocommerce' ),
array( 'status' => 500 )
);
}
// Trigger action for settings update.
if ( ! empty( $updated_fields ) ) {
/**
* Fires when WooCommerce email settings are updated.
*
* @param array $updated_fields Array of updated field IDs.
* @param string $rest_base The REST base of the settings.
* @since 10.2.0
*/
do_action( 'woocommerce_settings_updated', $updated_fields, $this->rest_base );
}
try {
$response = $this->schema->get_item_response( $updated_email, $request );
return rest_ensure_response( $response );
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_email_settings_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
}
/**
* Get the item response for a single email.
*
* @param mixed $item Email instance.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->schema->get_item_response( $item, $request );
}
/**
* Get email instance by ID.
*
* @param string $email_id Email ID.
* @return \WC_Email|null Email instance or null if not found.
*/
private function get_email_by_id( string $email_id ) {
$emails = WC_Emails::instance()->get_emails();
foreach ( $emails as $email ) {
if ( $email->id === $email_id ) {
return $email;
}
}
return null;
}
/**
* Get the schema for the current resource.
*
* @return array
*/
protected function get_schema(): array {
return $this->schema->get_item_schema();
}
/**
* Get the item schema for the controller.
*
* @return array
*/
public function get_item_schema(): array {
return $this->get_schema();
}
/**
* Get the endpoint args for item schema.
*
* @param string $method HTTP method of the request.
* @return array Endpoint arguments.
*/
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ): array {
return rest_get_endpoint_args_for_schema( $this->get_item_schema(), $method );
}
}
PK [1]A
M
M A RestApi/Routes/V4/Settings/Emails/Schema/EmailsSettingsSchema.phpnu personalization_tags_registry = Email_Editor_Container::container()->get( Personalization_Tags_Registry::class );
}
/**
* Return all properties for the item schema.
*
* @return array
*/
public function get_item_schema_properties(): array {
return array(
'id' => array(
'description' => __( 'Email template ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Email title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'description' => array(
'description' => __( 'Email description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'post_id' => array(
'description' => __( 'Template post ID.', 'woocommerce' ),
'type' => array( 'integer', 'null' ),
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'link' => array(
'description' => __( 'Link to template editor.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'email_group' => array(
'description' => __( 'Email group identifier.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'email_group_title' => array(
'description' => __( 'Email group title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'is_customer_email' => array(
'description' => __( 'Whether this is a customer email.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'is_manual' => array(
'description' => __( 'Whether this is sent only manually.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_CONTEXT,
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'email', 'number', 'select', 'multiselect', 'checkbox', 'textarea', 'color', 'password' ),
'context' => self::VIEW_EDIT_CONTEXT,
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'options' => array(
'description' => __( 'Available options for select/multiselect fields.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
);
}
/**
* Get the item response for a single email.
*
* @param WC_Email $email Email instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $email, WP_REST_Request $request, array $include_fields = array() ): array {
// Get template post ID.
$email_post_manager = WCTransactionalEmailPostsManager::get_instance();
$post_id = $email_post_manager->get_email_template_post_id( $email->id ?? '' );
// Convert false to null, ensure int otherwise.
$post_id = $post_id ? (int) $post_id : null;
$link = '';
if ( $post_id ) {
$permalink = get_permalink( $post_id );
$link = is_string( $permalink ) ? $permalink : '';
}
$email->init_form_fields();
$response = array(
'id' => $email->id ?? '',
'title' => $email->title ?? '',
'description' => $email->description ?? '',
'post_id' => $post_id,
'link' => $link,
'email_group' => $email->email_group ?? '',
'email_group_title' => method_exists( $email, 'get_email_group_title' ) ? $email->get_email_group_title() : '',
'is_customer_email' => method_exists( $email, 'is_customer_email' ) ? $email->is_customer_email() : false,
'is_manual' => method_exists( $email, 'is_manual' ) ? $email->is_manual() : false,
'values' => $this->get_values( $email ),
'groups' => $this->get_groups( $email ),
);
if ( ! empty( $include_fields ) ) {
$response = array_intersect_key( $response, array_flip( $include_fields ) );
}
return $response;
}
/**
* Get flat key-value mapping of all setting values.
*
* @param WC_Email $email Email instance.
* @return array
*/
private function get_values( WC_Email $email ): array {
$values = array();
$form_fields = $email->get_form_fields();
if ( ! is_array( $form_fields ) ) {
return $values;
}
// Create a dummy order object, as some of the getter methods require one.
$email->object = new \WC_Order();
foreach ( $form_fields as $id => $field ) {
$field_type = $field['type'] ?? 'text';
// Skip non-data fields.
if ( in_array( $field_type, array( 'title', 'sectionend' ), true ) ) {
continue;
}
// Get saved value an fallback to default.
$default = $this->get_field_default_value( $email, $id, $field );
$value = $email->get_option( $id, $default );
// Unwrap personalization tags if the field supports them.
if ( in_array( $id, self::FIELDS_SUPPORTING_PERSONALIZATION_TAGS, true ) ) {
$value = $this->unwrap_woocommerce_tags( $value );
}
// Convert checkbox to boolean for API.
if ( 'checkbox' === $field_type ) {
$value = ( 'yes' === $value );
}
$values[ $id ] = $value;
}
return $values;
}
/**
* Prepare the default value for a field.
* We use special methods for well known core fields and use fallback to default value if no special method is available.
*
* @param WC_Email $email Email instance.
* @param string $id Field ID.
* @param array $field Field definition.
* @return mixed The default value for the field.
*/
private function get_field_default_value( WC_Email $email, string $id, array $field ) {
switch ( $id ) {
case 'enabled':
return method_exists( $email, 'is_enabled' ) ? $email->is_enabled() : false;
case 'recipient':
return method_exists( $email, 'get_recipient' ) ? $email->get_recipient() : '';
case 'subject':
return method_exists( $email, 'get_subject' ) ? $email->get_subject() : '';
case 'heading':
return method_exists( $email, 'get_heading' ) ? $email->get_heading() : '';
case 'preheader':
return method_exists( $email, 'get_preheader' ) ? $email->get_preheader() : '';
case 'additional_content':
return method_exists( $email, 'get_additional_content' ) ? $email->get_additional_content() : '';
case 'cc':
return $email->cc ?? '';
case 'bcc':
return $email->bcc ?? '';
case 'email_type':
return $email->email_type ?? '';
default:
return $field['default'] ?? ( $field['placeholder'] ?? '' );
}
}
/**
* Remove HTML comment wrappers from personalization tags.
*
* Converts tags from back to [prefix/tag-name] for all registered prefixes.
* For example: becomes [woocommerce/customer-name].
*
* This is required because the email editor personalization tags are wrapped in HTML comment wrappers.
* We need to remove the tags to make editing easier for the end-users and also because the tags are not well formatted in the current DataForm implementation.
*
* @param string $value The value to unwrap.
* @return string The unwrapped value.
*/
private function unwrap_woocommerce_tags( $value ) {
if ( ! is_string( $value ) ) {
return $value;
}
// Get all registered prefixes dynamically.
$prefixes = $this->get_personalization_tag_prefixes();
// If no prefixes, return the value unchanged.
if ( empty( $prefixes ) ) {
return $value;
}
// Escape prefixes for use in regex and join with |.
$escaped_prefixes = array_map( 'preg_quote', $prefixes );
$prefixes_pattern = implode( '|', $escaped_prefixes );
// Remove HTML comment wrappers from personalization tags.
$unwrapped_value = preg_replace( '//i', '$1', $value );
return $unwrapped_value;
}
/**
* Wrap personalization tags in HTML comments for the email editor.
* This is required for the email editor personalization.
* Use negative lookbehind and lookahead to avoid double-wrapping already wrapped tags.
*
* @param mixed $value The value to wrap.
* @return mixed The wrapped value.
*/
private function wrap_woocommerce_tags( $value ) {
if ( ! is_string( $value ) ) {
return $value;
}
$prefixes = $this->get_personalization_tag_prefixes();
if ( empty( $prefixes ) ) {
return $value;
}
// Escape prefixes for use in regex and join with |.
$escaped_prefixes = array_map( 'preg_quote', $prefixes );
$prefixes_pattern = implode( '|', $escaped_prefixes );
// Wrap tags that aren't already wrapped.
return preg_replace( '/(?)/i', '', $value );
}
/**
* Get grouped settings structure with field metadata.
*
* @param WC_Email $email Email instance.
* @return array
*/
private function get_groups( WC_Email $email ): array {
$group = array(
'title' => __( 'Email Settings', 'woocommerce' ),
'description' => '',
'order' => 1,
'fields' => array(),
);
$form_fields = $email->get_form_fields();
foreach ( $form_fields as $id => $field ) {
$field_type = $field['type'] ?? 'text';
// Skip non-data fields.
if ( in_array( $field_type, array( 'title', 'sectionend' ), true ) ) {
continue;
}
$field_schema = array(
'id' => $id,
'label' => $field['title'] ?? $id,
'type' => $field_type,
'desc' => $field['description'] ?? '',
);
// Add options for select/multiselect fields.
if ( isset( $field['options'] ) && is_array( $field['options'] ) ) {
$field_schema['options'] = $field['options'];
}
$group['fields'][] = $field_schema;
}
if ( empty( $group['fields'] ) ) {
return array();
}
return array( 'settings' => $group );
}
/**
* Validate and sanitize email settings.
*
* @param WC_Email $email Email instance.
* @param array $values Values to validate and sanitize.
* @return array|WP_Error Validated settings or error.
*/
public function validate_and_sanitize_settings( WC_Email $email, array $values ) {
$email->init_form_fields();
$validated = array();
foreach ( $values as $field_id => $value ) {
// Only allow valid form fields.
if ( ! isset( $email->form_fields[ $field_id ] ) ) {
continue;
}
$field = $email->form_fields[ $field_id ];
$field_type = $field['type'] ?? 'text';
// Unwrap personalization tags if the field supports them to make sure we don't strip them in the sanitization process.
if ( in_array( $field_id, self::FIELDS_SUPPORTING_PERSONALIZATION_TAGS, true ) ) {
$value = $this->unwrap_woocommerce_tags( $value );
}
// Sanitize by type.
$sanitized = $this->sanitize_field_value( $field_type, $value );
// Sanitize Personalization tags. Wrap them in HTML comments for the email editor.
if ( in_array( $field_id, self::FIELDS_SUPPORTING_PERSONALIZATION_TAGS, true ) ) {
$sanitized = $this->wrap_woocommerce_tags( $sanitized );
}
// Validate.
$validation = $this->validate_field_value( $field_id, $sanitized, $field );
if ( is_wp_error( $validation ) ) {
return $validation;
}
$validated[ $field_id ] = $sanitized;
}
return $validated;
}
/**
* Sanitize field value based on type.
*
* @param string $type Field type.
* @param mixed $value Field value.
* @return mixed Sanitized value.
*/
private function sanitize_field_value( string $type, $value ) {
switch ( $type ) {
case 'checkbox':
// Ensure we have a scalar value for checkbox settings.
if ( is_array( $value ) ) {
$value = ! empty( $value ); // Convert array to boolean based on emptiness.
}
return wc_bool_to_string( $value );
case 'email':
return sanitize_email( $value );
case 'textarea':
return sanitize_textarea_field( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return 0;
}
$int_value = filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE );
return null !== $int_value ? $int_value : floatval( $value );
case 'multiselect':
if ( is_array( $value ) ) {
return array_map( 'sanitize_text_field', $value );
}
return is_string( $value ) ? array( sanitize_text_field( $value ) ) : array();
case 'color':
case 'password':
case 'text':
case 'select':
default:
return sanitize_text_field( $value );
}
}
/**
* Validate field value.
*
* @param string $key Field key.
* @param mixed $value Sanitized value.
* @param array $field Field definition.
* @return true|WP_Error True if valid, WP_Error otherwise.
*/
private function validate_field_value( string $key, $value, array $field ) {
$field_type = $field['type'] ?? 'text';
// Validate email format.
if ( 'email' === $field_type && ! empty( $value ) && ! is_email( $value ) ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: %s: field key */
__( 'Invalid email format for %s.', 'woocommerce' ),
$key
),
array( 'status' => 400 )
);
}
// Validate select options.
if ( 'select' === $field_type && ! empty( $field['options'] ) ) {
if ( ! array_key_exists( $value, $field['options'] ) && '' !== $value ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: 1: field key, 2: valid options */
__( 'Invalid value for %1$s. Valid options: %2$s', 'woocommerce' ),
$key,
implode( ', ', array_keys( $field['options'] ) )
),
array( 'status' => 400 )
);
}
}
// Validate multiselect options.
if ( 'multiselect' === $field_type && ! empty( $field['options'] ) ) {
if ( is_array( $value ) ) {
foreach ( $value as $v ) {
if ( ! array_key_exists( $v, $field['options'] ) ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: 1: field key, 2: invalid value */
__( 'Invalid option "%2$s" for %1$s.', 'woocommerce' ),
$key,
$v
),
array( 'status' => 400 )
);
}
}
}
}
return true;
}
/**
* Get all unique prefixes from registered personalization tags.
*
* Extracts the prefix part (before the /) from all registered personalization tags.
* For example, from [woocommerce/customer-name] it extracts 'woocommerce'.
* Results are cached to avoid repeated processing.
*
* @return array Array of unique prefixes, escaped for use in regex patterns.
*/
private function get_personalization_tag_prefixes(): array {
if ( null === $this->personalization_tags_registry ) {
return array();
}
// Return cached prefixes if available.
if ( null !== $this->cached_prefixes ) {
return $this->cached_prefixes;
}
$prefixes = array();
$tags = $this->personalization_tags_registry->get_all();
foreach ( $tags as $tag ) {
$token = $tag->get_token(); // E.g., [woocommerce/customer-name].
// Extract the prefix from the token (the part before the /).
// Remove brackets and get the part before /.
if ( preg_match( '/^\[([^\/\]]+)\//', $token, $matches ) ) {
$prefixes[ $matches[1] ] = true; // Use array key to ensure uniqueness.
}
}
// Convert to array of values and cache.
$this->cached_prefixes = array_keys( $prefixes );
return $this->cached_prefixes;
}
}
PK [1]ICS3 S3 1 RestApi/Routes/V4/Settings/General/Controller.phpnu schema = $schema;
}
/**
* Get the WC_Settings_General instance.
*
* @return WC_Settings_General
*/
private function get_settings_general_instance() {
if ( is_null( $this->settings_general_instance ) ) {
$this->settings_general_instance = new WC_Settings_General();
}
return $this->settings_general_instance;
}
/**
* Register routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Check permissions for reading general settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to access general settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Check permissions for updating general settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to edit general settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get general settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
try {
$settings = $this->get_all_settings();
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_general_settings_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
$response = $this->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Update general settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$params = $request->get_json_params();
if ( ! is_array( $params ) || empty( $params ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid or empty request body.', 'woocommerce' ),
array( 'status' => 400 )
);
}
// Check if the request contains a 'values' field with the flat key-value mapping.
$values_to_update = array();
if ( isset( $params['values'] ) && is_array( $params['values'] ) ) {
$values_to_update = $params['values'];
} else {
// Fallback to the old format for backward compatibility.
$values_to_update = $params;
}
// Filter out the woocommerce_share_key_display field as it's not allowed to be updated via API.
if ( isset( $values_to_update['woocommerce_share_key_display'] ) ) {
unset( $values_to_update['woocommerce_share_key_display'] );
}
// Get all general settings definitions.
$settings = $this->get_all_settings();
$settings_by_id = array_column( $settings, null, 'id' );
// Exclude non-editable markers like 'title' and 'sectionend'.
$settings_by_id = array_filter(
$settings_by_id,
static function ( $def ) {
$type = $def['type'] ?? '';
return isset( $def['id'] ) && ! in_array( $type, array( 'title', 'sectionend' ), true );
}
);
$valid_setting_ids = array_keys( $settings_by_id );
$validated_settings = array();
// Process each setting in the payload.
foreach ( $values_to_update as $setting_id => $setting_value ) {
// Sanitize the setting ID.
$setting_id = sanitize_text_field( $setting_id );
// Security check: only allow updating valid WooCommerce general settings.
if ( ! in_array( $setting_id, $valid_setting_ids, true ) ) {
continue;
}
// Sanitize the value based on the setting type.
$setting_definition = $settings_by_id[ $setting_id ];
$setting_type = $setting_definition['type'] ?? 'text';
$sanitized_value = $this->sanitize_setting_value( $setting_type, $setting_value );
// Additional validation for specific settings.
$validation_result = $this->validate_setting_value( $setting_id, $sanitized_value );
if ( is_wp_error( $validation_result ) ) {
return $validation_result;
}
// Store validated values first.
$validated_settings[ $setting_id ] = $sanitized_value;
}
// After validation loop, update all settings.
$updated_settings = array();
foreach ( $validated_settings as $setting_id => $value ) {
$update_result = update_option( $setting_id, $value );
if ( $update_result ) {
$updated_settings[] = $setting_id;
}
}
// Log the update if settings were changed.
if ( ! empty( $updated_settings ) ) {
/**
* Fires when WooCommerce settings are updated.
*
* @param array $updated_settings Array of updated settings IDs.
* @param string $rest_base The REST base of the settings.
* @since 4.0.0
*/
do_action( 'woocommerce_settings_updated', $updated_settings, $this->rest_base );
}
// Get all settings after update.
$settings = $this->get_all_settings();
// Return updated settings.
$response = $this->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Validate a setting value before updating.
*
* @param string $setting_id Setting ID.
* @param mixed $value Setting value.
* @return bool|WP_Error True if valid, WP_Error if invalid.
*/
private function validate_setting_value( $setting_id, $value ) {
// Custom validation rules for specific settings.
switch ( $setting_id ) {
case 'woocommerce_price_num_decimals':
$int = filter_var( $value, FILTER_VALIDATE_INT );
if ( false === $int || $int < 0 || $int > 10 ) {
return new WP_Error(
'rest_invalid_param',
__( 'Number of decimals must be between 0 and 10.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_default_country':
if ( ! $this->validate_country_or_state_code( $value ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid country/state format.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_allowed_countries':
$valid_options = array( 'all', 'all_except', 'specific' );
if ( ! in_array( $value, $valid_options, true ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid selling location option.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_ship_to_countries':
$valid_options = array( '', 'all', 'specific', 'disabled' );
if ( ! in_array( $value, $valid_options, true ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid shipping location option.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_specific_allowed_countries':
case 'woocommerce_specific_ship_to_countries':
if ( ! is_array( $value ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Expected an array of country codes.', 'woocommerce' ),
array( 'status' => 400 )
);
}
foreach ( $value as $code ) {
if ( ! is_string( $code ) || ! $this->validate_country_or_state_code( $code ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid country code in list.', 'woocommerce' ),
array( 'status' => 400 )
);
}
}
break;
}
return true;
}
/**
* Sanitize setting value based on its type.
*
* @param string $setting_type Setting type.
* @param mixed $value Setting value.
* @return mixed Sanitized value.
*/
private function sanitize_setting_value( $setting_type, $value ) {
// Normalize WooCommerce setting types to REST API schema types.
$type_map = array(
'single_select_country' => 'select',
'multi_select_countries' => 'multiselect',
);
$setting_type = $type_map[ $setting_type ] ?? $setting_type;
switch ( $setting_type ) {
case 'text':
return sanitize_text_field( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return 0;
}
return filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE ) ?? floatval( $value );
case 'checkbox':
// Ensure we have a scalar value for checkbox settings.
if ( is_array( $value ) ) {
$value = ! empty( $value ); // Convert array to boolean based on emptiness.
}
return wc_bool_to_string( $value );
case 'select':
return sanitize_text_field( $value );
case 'multiselect':
if ( is_array( $value ) ) {
return array_map( 'sanitize_text_field', $value );
}
if ( is_string( $value ) ) {
return array( sanitize_text_field( $value ) );
}
if ( is_scalar( $value ) ) {
return array( sanitize_text_field( (string) $value ) );
}
return array();
default:
// If a type is not explicitly handled, treat it as text.
return sanitize_text_field( $value );
}
}
/**
* Get all general settings definitions.
*
* @return array Array of setting definitions.
*/
private function get_all_settings(): array {
$settings_instance = $this->get_settings_general_instance();
$sections = $settings_instance->get_sections();
$settings = array();
foreach ( array_keys( $sections ) as $section ) {
$section_settings = $settings_instance->get_settings_for_section( $section );
$settings = array_merge( $settings, $section_settings );
}
return $settings;
}
/**
* Validate country or state code.
*
* @param string $country_or_state Country or state code.
* @return boolean Valid or not valid.
*/
private function validate_country_or_state_code( $country_or_state ) {
list( $country, $state ) = array_pad( explode( ':', (string) $country_or_state, 2 ), 2, '' );
if ( '' === $country ) {
return false;
}
$country_codes = array_keys( WC()->countries->get_countries() );
if ( ! in_array( $country, $country_codes, true ) ) {
return false;
}
if ( '' === $state ) {
return true;
}
$states_for_country = WC()->countries->get_states( $country );
if ( empty( $states_for_country ) ) {
return false;
}
return isset( $states_for_country[ $state ] );
}
/**
* Get the schema for the current resource.
*
* @return array
*/
public function get_schema(): array {
return $this->schema->get_item_schema();
}
/**
* Get the item schema for the controller.
*
* @return array
*/
public function get_item_schema(): array {
return $this->get_schema();
}
/**
* Get the item response for a single settings group.
*
* @param mixed $item Settings data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->schema->get_item_response( $item, $request );
}
/**
* Get the endpoint args for item schema.
*
* @param string $method HTTP method of the request.
* @return array Endpoint arguments.
*/
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ): array {
return rest_get_endpoint_args_for_schema( $this->get_item_schema(), $method );
}
}
PK [1]D ( ( C RestApi/Routes/V4/Settings/General/Schema/GeneralSettingsSchema.phpnu array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Settings title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'description' => array(
'description' => __( 'Settings description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_CONTEXT,
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'number', 'select', 'multiselect', 'checkbox' ),
'context' => self::VIEW_EDIT_CONTEXT,
),
'options' => array(
'description' => __( 'Available options for select/multiselect fields.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
);
}
/**
* Get general settings data by transforming raw settings into REST API format.
*
* @param mixed $item Raw settings array.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include.
* @return array
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$raw_settings = $item;
// Transform raw settings into grouped format based on title/sectionend markers.
$groups = array();
$values = array();
$current_group = null;
$current_group_id = null;
foreach ( $raw_settings as $setting ) {
$setting_type = $setting['type'] ?? '';
// Handle section titles - start of a new group.
if ( 'title' === $setting_type ) {
$current_group_id = $setting['id'] ?? '';
$current_group = array(
'title' => $setting['title'] ?? '',
'description' => $setting['desc'] ?? '',
'order' => isset( $setting['order'] ) ? (int) $setting['order'] : 999,
'fields' => array(),
);
continue;
}
// Handle section ends - save the current group.
if ( 'sectionend' === $setting_type ) {
if ( $current_group && $current_group_id ) {
$groups[ $current_group_id ] = $current_group;
}
$current_group = null;
$current_group_id = null;
continue;
}
// Skip title and sectionend types.
if ( in_array( $setting_type, array( 'title', 'sectionend' ), true ) ) {
continue;
}
// Convert setting to field format.
if ( isset( $setting['id'] ) && $current_group ) {
$field = $this->transform_setting_to_field( $setting );
if ( $field ) {
$current_group['fields'][] = $field;
// Add field value to the flat values array.
$raw_value = get_option( $field['id'], $setting['default'] ?? '' );
$values[ $field['id'] ] = $this->validate_field_value( $raw_value, $field['type'] );
}
}
}
// Sort groups by their order if available.
uasort(
$groups,
function ( $a, $b ) {
$a_order = $a['order'] ?? 999;
$b_order = $b['order'] ?? 999;
return $a_order - $b_order;
}
);
$response = array(
'id' => 'general',
'title' => __( 'General', 'woocommerce' ),
'description' => __( 'Set your store\'s address, visibility, currency, language, and timezone.', 'woocommerce' ),
'values' => $values,
'groups' => $groups,
);
if ( ! empty( $include_fields ) ) {
$response = array_intersect_key( $response, array_flip( $include_fields ) );
}
return $response;
}
/**
* Transform a WooCommerce setting into REST API field format.
*
* @param array $setting WooCommerce setting array.
* @return array|null Transformed field or null if should be skipped.
*/
private function transform_setting_to_field( array $setting ): ?array {
$setting_id = $setting['id'] ?? '';
$setting_type = $setting['type'] ?? 'text';
$field = array(
'id' => $setting_id,
'label' => $setting['title'] ?? $setting_id,
'type' => $this->normalize_field_type( $setting_type ),
'desc' => $setting['desc'] ?? '',
);
// Add options for select fields.
if ( isset( $setting['options'] ) && is_array( $setting['options'] ) ) {
$field['options'] = $setting['options'];
} else {
// Generate options for special field types.
$field['options'] = $this->get_field_options( $setting_id );
}
return $field;
}
/**
* Get options for specific field types.
*
* @param string $field_id Field ID.
* @return array Field options.
*/
private function get_field_options( string $field_id ): array {
switch ( $field_id ) {
case 'woocommerce_currency':
if ( ! function_exists( 'get_woocommerce_currencies' ) || ! function_exists( 'get_woocommerce_currency_symbol' ) ) {
return array();
}
$currencies = get_woocommerce_currencies();
$options = array();
foreach ( $currencies as $code => $name ) {
$label = wp_specialchars_decode( (string) $name );
$symbol = wp_specialchars_decode( (string) get_woocommerce_currency_symbol( $code ) );
$options[ $code ] = $label . ' (' . $symbol . ') — ' . $code;
}
return $options;
case 'woocommerce_default_country':
case 'woocommerce_specific_allowed_countries':
case 'woocommerce_specific_ship_to_countries':
if ( ! function_exists( 'WC' ) ) {
return array();
}
$countries = WC()->countries->get_countries();
$states = WC()->countries->get_states();
$options = array();
foreach ( $countries as $country_code => $country_name ) {
$country_states = $states[ $country_code ] ?? array();
if ( empty( $country_states ) ) {
$options[ $country_code ] = $country_name;
} else {
foreach ( $country_states as $state_code => $state_name ) {
$options[ $country_code . ':' . $state_code ] = $country_name . ' — ' . $state_name;
}
}
}
return $options;
}
return array();
}
/**
* Normalize WooCommerce field types to REST API field types.
*
* @param string $wc_type WooCommerce field type.
* @return string Normalized field type.
*/
private function normalize_field_type( string $wc_type ): string {
$type_map = array(
'single_select_country' => 'select',
'multi_select_countries' => 'multiselect',
);
return $type_map[ $wc_type ] ?? $wc_type;
}
/**
* Validate and sanitize field value based on its type.
*
* @param mixed $value Field value.
* @param string $type Field type.
* @return mixed Validated value.
*/
private function validate_field_value( $value, string $type ) {
switch ( $type ) {
case 'number':
return is_numeric( $value ) ? (float) $value : 0;
case 'checkbox':
if ( function_exists( 'wc_string_to_bool' ) ) {
return wc_string_to_bool( $value );
}
if ( is_bool( $value ) ) {
return $value;
}
return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
case 'multiselect':
if ( ! is_array( $value ) ) {
return array();
}
return array_map( 'sanitize_text_field', $value );
case 'text':
case 'select':
default:
return is_string( $value ) ? $value : (string) $value;
}
}
}
PK [1]+d;vw# w# C RestApi/Routes/V4/Settings/Account/Schema/AccountSettingsSchema.phpnu array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Settings title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'description' => array(
'description' => __( 'Settings description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_CONTEXT,
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'textarea', 'number', 'select', 'multiselect', 'checkbox' ),
'context' => self::VIEW_EDIT_CONTEXT,
),
'options' => array(
'description' => __( 'Available options for select/multiselect fields.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
);
}
/**
* Get account settings data by transforming raw settings into REST API format.
*
* @param mixed $item Raw settings array.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include.
* @return array
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$raw_settings = $item;
// Transform raw settings into grouped format based on title/sectionend markers.
$groups = array();
$values = array();
$current_group = null;
$current_group_id = null;
foreach ( $raw_settings as $setting ) {
$setting_type = $setting['type'] ?? '';
// Handle section titles - start of a new group.
if ( 'title' === $setting_type ) {
$current_group_id = $setting['id'] ?? '';
$current_group = array(
'title' => $setting['title'] ?? '',
'description' => $setting['desc'] ?? '',
'order' => isset( $setting['order'] ) ? (int) $setting['order'] : 999,
'fields' => array(),
);
continue;
}
// Handle section ends - save the current group.
if ( 'sectionend' === $setting_type ) {
if ( $current_group && $current_group_id ) {
$groups[ $current_group_id ] = $current_group;
}
$current_group = null;
$current_group_id = null;
continue;
}
// Convert setting to field format.
if ( isset( $setting['id'] ) && $current_group ) {
$field = $this->transform_setting_to_field( $setting );
if ( $field ) {
$current_group['fields'][] = $field;
// Add field value to the flat values array.
$raw_value = get_option( $field['id'], $setting['default'] ?? '' );
$values[ $field['id'] ] = $this->validate_field_value( $raw_value, $field['type'] );
}
}
}
// Sort groups by their order if available.
uasort(
$groups,
function ( $a, $b ) {
$a_order = $a['order'] ?? 999;
$b_order = $b['order'] ?? 999;
return $a_order - $b_order;
}
);
$response = array(
'id' => 'account',
'title' => __( 'Accounts & Privacy', 'woocommerce' ),
'description' => __( 'Set options relating to customer accounts and data privacy.', 'woocommerce' ),
'values' => $values,
'groups' => $groups,
);
if ( ! empty( $include_fields ) ) {
$response = array_intersect_key( $response, array_flip( $include_fields ) );
}
return $response;
}
/**
* Transform a WooCommerce setting into REST API field format.
*
* @param array $setting WooCommerce setting array.
* @return array|null Transformed field or null if should be skipped.
*/
private function transform_setting_to_field( array $setting ): ?array {
$setting_id = $setting['id'] ?? '';
$setting_type = $setting['type'] ?? 'text';
$field = array(
'id' => $setting_id,
'label' => $setting['title'] ?? $setting_id,
'type' => $this->normalize_field_type( $setting_type ),
'desc' => $setting['desc'] ?? '',
);
// Add options for select fields.
if ( isset( $setting['options'] ) && is_array( $setting['options'] ) ) {
$field['options'] = $setting['options'];
} else {
// Generate options for special field types.
$field['options'] = $this->get_field_options( $setting_id );
}
return $field;
}
/**
* Get options for specific field types.
*
* @param string $field_id Field ID.
* @return array Field options.
*/
private function get_field_options( string $field_id ): array {
// No field has options for now.
return array();
}
/**
* Normalize WooCommerce field types to REST API field types.
*
* @param string $wc_type WooCommerce field type.
* @return string Normalized field type.
*/
private function normalize_field_type( string $wc_type ): string {
$type_map = array(
'single_select_page' => 'select',
'single_select_page_with_search' => 'select',
);
return $type_map[ $wc_type ] ?? $wc_type;
}
/**
* Validate and sanitize field value based on its type.
*
* @param mixed $value Field value.
* @param string $type Field type.
* @return mixed Validated value.
*/
private function validate_field_value( $value, string $type ) {
switch ( $type ) {
case 'number':
return is_numeric( $value ) ? (float) $value : 0;
case 'checkbox':
if ( function_exists( 'wc_string_to_bool' ) ) {
return wc_string_to_bool( $value );
}
if ( is_bool( $value ) ) {
return $value;
}
return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
case 'multiselect':
if ( ! is_array( $value ) ) {
return array();
}
return array_map( 'sanitize_text_field', $value );
case 'textarea':
return sanitize_textarea_field( $value );
case 'text':
case 'select':
default:
return sanitize_text_field( $value );
}
}
}
PK [1]U( ( 1 RestApi/Routes/V4/Settings/Account/Controller.phpnu schema = $schema;
}
/**
* Get the WC_Settings_Accounts instance.
*
* @return WC_Settings_Accounts
*/
private function get_settings_account_instance() {
if ( is_null( $this->settings_account_instance ) ) {
// We need to mock the admin environment to get the settings.
if ( ! class_exists( 'WC_Admin_Settings' ) ) {
require_once WC_ABSPATH . 'includes/admin/class-wc-admin-settings.php';
}
$this->settings_account_instance = new WC_Settings_Accounts();
}
return $this->settings_account_instance;
}
/**
* Register routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Check permissions for reading account settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to access account settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Check permissions for updating account settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to edit account settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get account settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
try {
$settings = $this->get_all_settings();
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_account_settings_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
$response = $this->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Update account settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$params = $request->get_json_params();
if ( ! is_array( $params ) || empty( $params ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid or empty request body.', 'woocommerce' ),
array( 'status' => 400 )
);
}
// Check if the request contains a 'values' field with the flat key-value mapping.
$values_to_update = array();
if ( isset( $params['values'] ) && is_array( $params['values'] ) ) {
$values_to_update = $params['values'];
} else {
// Fallback to the old format for backward compatibility.
$values_to_update = $params;
}
// Get all account settings definitions.
$settings = $this->get_all_settings();
$settings_by_id = array_column( $settings, null, 'id' );
// Exclude non-editable markers like 'title' and 'sectionend'.
$settings_by_id = array_filter(
$settings_by_id,
static function ( $def ) {
$type = $def['type'] ?? '';
return isset( $def['id'] ) && ! in_array( $type, array( 'title', 'sectionend' ), true );
}
);
$valid_setting_ids = array_keys( $settings_by_id );
$validated_settings = array();
// Process each setting in the payload.
foreach ( $values_to_update as $setting_id => $setting_value ) {
// Sanitize the setting ID.
$setting_id = sanitize_text_field( $setting_id );
// Security check: only allow updating valid WooCommerce account settings.
if ( ! in_array( $setting_id, $valid_setting_ids, true ) ) {
continue;
}
// Sanitize the value based on the setting type.
$setting_definition = $settings_by_id[ $setting_id ];
$setting_type = $setting_definition['type'] ?? 'text';
$sanitized_value = $this->sanitize_setting_value( $setting_type, $setting_value );
// Additional validation for specific settings.
$validation_result = $this->validate_setting_value( $setting_id, $sanitized_value );
if ( is_wp_error( $validation_result ) ) {
return $validation_result;
}
// Store validated values first.
$validated_settings[ $setting_id ] = $sanitized_value;
}
// After validation loop, update all settings.
$updated_settings = array();
foreach ( $validated_settings as $setting_id => $value ) {
$update_result = update_option( $setting_id, $value );
if ( $update_result ) {
$updated_settings[] = $setting_id;
}
}
// Log the update if settings were changed.
if ( ! empty( $updated_settings ) ) {
/**
* Fires when WooCommerce settings are updated.
*
* @param array $updated_settings Array of updated settings IDs.
* @param string $rest_base The REST base of the settings.
* @since 4.0.0
*/
do_action( 'woocommerce_settings_updated', $updated_settings, $this->rest_base );
}
// Get all settings after update.
$settings = $this->get_all_settings();
// Return updated settings.
$response = $this->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Validate a setting value before updating.
*
* @param string $setting_id Setting ID.
* @param mixed $value Setting value.
* @return bool|WP_Error True if valid, WP_Error if invalid.
*/
private function validate_setting_value( $setting_id, $value ) {
// No specific validation for account settings yet.
return true;
}
/**
* Sanitize setting value based on its type.
*
* @param string $setting_type Setting type.
* @param mixed $value Setting value.
* @return mixed Sanitized value.
*/
private function sanitize_setting_value( $setting_type, $value ) {
// Normalize WooCommerce setting types to REST API schema types.
$type_map = array(
'single_select_page' => 'select',
'single_select_page_with_search' => 'select',
);
$setting_type = $type_map[ $setting_type ] ?? $setting_type;
switch ( $setting_type ) {
case 'text':
return sanitize_text_field( $value );
case 'textarea':
return sanitize_textarea_field( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return 0;
}
return filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE ) ?? floatval( $value );
case 'checkbox':
// Ensure we have a scalar value for checkbox settings.
if ( is_array( $value ) ) {
$value = ! empty( $value ); // Convert array to boolean based on emptiness.
}
return wc_bool_to_string( $value );
case 'select':
return sanitize_text_field( $value );
case 'multiselect':
if ( is_array( $value ) ) {
return array_map( 'sanitize_text_field', $value );
}
if ( is_string( $value ) ) {
return array( sanitize_text_field( $value ) );
}
if ( is_scalar( $value ) ) {
return array( sanitize_text_field( (string) $value ) );
}
return array();
default:
// If a type is not explicitly handled, treat it as text.
return sanitize_text_field( $value );
}
}
/**
* Get all account settings definitions.
*
* @return array Array of setting definitions.
*/
private function get_all_settings(): array {
$settings_instance = $this->get_settings_account_instance();
return $settings_instance->get_settings();
}
/**
* Get the schema for the current resource.
*
* @return array
*/
public function get_schema(): array {
return $this->schema->get_item_schema();
}
/**
* Get the item schema for the controller.
*
* @return array
*/
public function get_item_schema(): array {
return $this->get_schema();
}
/**
* Get the item response for a single settings group.
*
* @param mixed $item Settings data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->schema->get_item_response( $item, $request );
}
/**
* Get the endpoint args for item schema.
*
* @param string $method HTTP method of the request.
* @return array Endpoint arguments.
*/
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ): array {
return rest_get_endpoint_args_for_schema( $this->get_item_schema(), $method );
}
}
PK [1] array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Title of the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'description' => array(
'description' => __( 'Description of the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'values' => array(
'description' => __( 'Current enabled state for all payment methods.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
'additionalProperties' => array(
'type' => 'boolean',
),
),
'groups' => array(
'description' => __( 'Grouped settings for offline payment methods.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
'properties' => array(
'payment_methods' => array(
'description' => __( 'Available offline payment methods.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
'additionalProperties' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Unique identifier for the payment method.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'_order' => array(
'description' => __( 'Sort order for the payment method.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
),
'title' => array(
'description' => __( 'Title of the payment method.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Description of the payment method.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'icon' => array(
'description' => __( 'Icon URL for the payment method.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => self::VIEW_EDIT_CONTEXT,
),
'state' => array(
'description' => __( 'Current state configuration of the payment method.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'boolean',
),
),
'management' => array(
'description' => __( 'Management options for the payment method.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'properties' => array(
'_links' => array(
'description' => __( 'Management links for the payment method.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'object',
'properties' => array(
'href' => array(
'description' => __( 'URL for the management link.', 'woocommerce' ),
'type' => 'string',
'format' => 'uri',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
'additionalProperties' => false,
),
),
),
'additionalProperties' => false,
),
),
),
),
),
),
);
}
/**
* Get the item response.
*
* @param mixed $item Payment method data array.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
* @SuppressWarnings(PHPMD.UnusedFormalParameter) $request is unused; filtering handled by REST server.
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$response = (array) $item;
if ( ! empty( $include_fields ) ) {
$response = array_intersect_key( $response, array_flip( $include_fields ) );
}
return $response;
}
}
PK [1]^Z! Z! ? RestApi/Routes/V4/Settings/OfflinePaymentMethods/Controller.phpnu payments = $payments;
$this->item_schema = $schema;
}
/**
* Register the routes for offline payment methods.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => array_merge(
$this->get_collection_params(),
array(
'location' => array(
'description' => __( 'Country code to retrieve offline payment methods for.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => static function ( $value ) {
return sanitize_text_field( $value );
},
),
)
),
),
'schema' => array( $this, 'get_public_item_schema' ),
)
);
}
/**
* Check permissions for reading offline payment methods.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'payment_gateways', 'read' ) ) {
return new WP_Error(
'woocommerce_rest_cannot_read',
__( 'Sorry, you cannot list resources.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get offline payment methods.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_items( $request ) {
try {
$offline_methods = $this->get_offline_payment_methods_data( $request );
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_offline_payment_methods_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
if ( is_wp_error( $offline_methods ) ) {
return $offline_methods;
}
// Transform data to match the new format.
$response_data = array(
'id' => 'payments/offline-methods',
'title' => __( 'Offline Payment Methods', 'woocommerce' ),
'description' => __( 'Manage offline payment methods available for your store.', 'woocommerce' ),
'values' => array(),
'groups' => array(
'payment_methods' => array(),
),
);
// Validate input is an array.
if ( ! is_array( $offline_methods ) ) {
return new WP_Error(
'woocommerce_rest_invalid_data',
__( 'Invalid payment methods data received.', 'woocommerce' ),
array( 'status' => 500 )
);
}
// Process each offline payment method.
foreach ( $offline_methods as $method ) {
// Skip if method is not an array.
if ( ! is_array( $method ) ) {
continue;
}
$method_id = $method['id'] ?? '';
if ( empty( $method_id ) || ! is_string( $method_id ) ) {
continue;
}
// Add method to values (current settings/state).
$enabled_state = false;
if ( isset( $method['state'] ) && is_array( $method['state'] ) ) {
$enabled_state = $method['state']['enabled'] ?? false;
}
if ( is_array( $enabled_state ) ) {
$enabled_state = $enabled_state['value'] ?? false;
}
if ( is_string( $enabled_state ) ) {
$enabled_state = wc_string_to_bool( $enabled_state );
} elseif ( ! is_bool( $enabled_state ) ) {
$enabled_state = (bool) $enabled_state;
}
$response_data['values'][ $method_id ] = $enabled_state;
// Add complete payment method data to groups.payment_methods.
$response_data['groups']['payment_methods'][ $method_id ] = array(
'id' => $method_id,
'_order' => isset( $method['_order'] ) ? absint( $method['_order'] ) : 0,
'title' => sanitize_text_field( $method['title'] ?? '' ),
'description' => wp_kses_post( $method['description'] ?? '' ),
'icon' => esc_url_raw( $method['icon'] ?? '' ),
'state' => array_map(
'rest_sanitize_boolean',
wp_parse_args(
is_array( $method['state'] ?? null ) ? $method['state'] : array(),
array(
'enabled' => false,
'account_connected' => false,
'needs_setup' => false,
'test_mode' => false,
'dev_mode' => false,
)
)
),
'management' => $this->sanitize_management_field( $method['management'] ?? array() ),
);
}
return rest_ensure_response( $response_data );
}
/**
* Get offline payment methods data.
*
* @param WP_REST_Request $request Full details about the request.
* @return array|WP_Error The offline payment methods data or error.
* @throws \Exception If there's an error retrieving the data.
*/
private function get_offline_payment_methods_data( $request ) {
$location = sanitize_text_field( $request->get_param( 'location' ) );
if ( empty( $location ) ) {
// Fall back to the payments country if no location is provided.
$location = $this->payments->get_country();
}
try {
$providers = $this->payments->get_payment_providers( $location );
} catch ( \Exception $e ) {
return new \WP_Error( 'woocommerce_rest_payment_providers_error', $e->getMessage(), array( 'status' => 500 ) );
}
if ( is_wp_error( $providers ) ) {
return $providers;
}
// Retrieve the offline PMs from the main providers list.
$offline_payment_providers = array_values(
array_filter(
$providers,
fn( $provider ) => isset( $provider['_type'] ) && PaymentsProviders::TYPE_OFFLINE_PM === $provider['_type']
)
);
return $offline_payment_providers;
}
/**
* Get the schema for the current resource.
*
* @return array
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the item response for a single payment method.
*
* @param mixed $item Payment method data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $item, $request );
}
/**
* Sanitize the management field data.
*
* @param mixed $management The management data to sanitize.
* @return array Sanitized management array.
*/
private function sanitize_management_field( $management ) {
if ( ! is_array( $management ) ) {
return array( '_links' => array() );
}
$sanitized = array(
'_links' => array(),
);
if ( isset( $management['_links'] ) && is_array( $management['_links'] ) ) {
foreach ( $management['_links'] as $key => $link ) {
$sanitized_key = sanitize_key( $key );
if ( is_array( $link ) && isset( $link['href'] ) ) {
// Handle link objects with href property.
$sanitized['_links'][ $sanitized_key ] = array(
'href' => esc_url_raw( $link['href'] ),
);
} elseif ( is_string( $link ) ) {
// Handle direct URL strings.
$sanitized['_links'][ $sanitized_key ] = array(
'href' => esc_url_raw( $link ),
);
}
}
}
return $sanitized;
}
}
PK [1],sA1. 1. / RestApi/Routes/V4/Settings/Email/Controller.phpnu schema = $schema;
}
/**
* Register routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Get the WC_Settings_Emails instance.
*
* @return WC_Settings_Emails
*/
private function get_settings_emails_instance() {
if ( is_null( $this->settings_emails_instance ) ) {
$this->settings_emails_instance = new WC_Settings_Emails();
}
return $this->settings_emails_instance;
}
/**
* Get all email settings definitions.
*
* @return array Array of setting definitions.
*/
private function get_all_settings(): array {
$settings_instance = $this->get_settings_emails_instance();
$sections = $settings_instance->get_sections();
$settings = array();
foreach ( array_keys( $sections ) as $section ) {
$section_settings = $settings_instance->get_settings_for_section( $section );
$settings = array_merge( $settings, $section_settings );
}
return $settings;
}
/**
* Check permissions for reading email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to access email settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Check permissions for updating email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to edit email settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
try {
$settings = $this->get_all_settings();
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_email_settings_error',
$e->getMessage(),
array( 'status' => 500 )
);
}
$response = $this->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Update email settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$params = $request->get_json_params();
if ( ! is_array( $params ) || empty( $params ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid or empty request body.', 'woocommerce' ),
array( 'status' => 400 )
);
}
// Check if the request contains a 'values' field with the flat key-value mapping.
$values_to_update = array();
if ( isset( $params['values'] ) && is_array( $params['values'] ) ) {
$values_to_update = $params['values'];
} else {
// Fallback to the old format for backward compatibility.
$values_to_update = $params;
}
// Get all email settings definitions.
$settings = $this->get_all_settings();
$settings_by_id = array_column( $settings, null, 'id' );
// Exclude non-editable markers like 'title' and 'sectionend, ...'.
$settings_by_id = array_filter(
$settings_by_id,
static function ( $def ) {
$type = $def['type'] ?? '';
return isset( $def['id'] ) && ! in_array( $type, EmailSettingsSchema::NON_EDITABLE_TYPES, true );
}
);
$valid_setting_ids = array_keys( $settings_by_id );
$validated_settings = array();
// Get reply_to_enabled for validation context.
$reply_to_enabled = get_option( 'woocommerce_email_reply_to_enabled', 'no' );
if ( isset( $values_to_update['woocommerce_email_reply_to_enabled'] ) ) {
$reply_to_enabled = wc_bool_to_string( $values_to_update['woocommerce_email_reply_to_enabled'] );
}
// Process each setting in the payload.
foreach ( $values_to_update as $setting_id => $setting_value ) {
// Sanitize the setting ID.
$setting_id = sanitize_text_field( $setting_id );
// Security check: only allow updating valid WooCommerce email settings.
if ( ! in_array( $setting_id, $valid_setting_ids, true ) ) {
continue;
}
// Sanitize the value based on the setting type.
$setting_definition = $settings_by_id[ $setting_id ];
$setting_type = $setting_definition['type'] ?? 'text';
$sanitized_value = $this->sanitize_setting_value( $setting_type, $setting_value );
// Additional validation for specific settings.
$validation_result = $this->validate_setting_value( $setting_id, $sanitized_value, $reply_to_enabled );
if ( is_wp_error( $validation_result ) ) {
return $validation_result;
}
// Store validated values first.
$validated_settings[ $setting_id ] = $sanitized_value;
}
// After validation loop, update all settings.
$updated_settings = array();
foreach ( $validated_settings as $setting_id => $value ) {
$update_result = update_option( $setting_id, $value );
if ( $update_result ) {
$updated_settings[] = $setting_id;
}
}
// Log the update if settings were changed.
if ( ! empty( $updated_settings ) ) {
/**
* Fires when WooCommerce settings are updated.
*
* @param array $updated_settings Array of updated settings IDs.
* @param string $rest_base The REST base of the settings.
* @since 4.0.0
*/
do_action( 'woocommerce_settings_updated', $updated_settings, $this->rest_base );
}
// Get all settings after update.
$settings = $this->get_all_settings();
// Return updated settings.
$response = $this->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Validate a setting value before updating.
*
* @param string $setting_id Setting ID.
* @param mixed $value Setting value.
* @param string $reply_to_enabled Reply-to enabled.
* @return bool|WP_Error True if valid, WP_Error if invalid.
*/
private function validate_setting_value( $setting_id, $value, $reply_to_enabled ) {
$check_reply_to = 'yes' === $reply_to_enabled;
switch ( $setting_id ) {
case 'woocommerce_email_from_name':
if ( empty( $value ) || ! is_string( $value ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Email sender name cannot be empty.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_email_from_address':
if ( empty( $value ) || ! is_email( $value ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Please enter a valid email address.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_email_reply_to_enabled':
// Convert string 'true'/'false' to boolean if needed.
if ( is_string( $value ) ) {
$value = filter_var( $value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );
}
if ( ! is_bool( $value ) && null !== $value ) {
return new WP_Error(
'rest_invalid_param',
__( 'Reply-to enabled must be a boolean value.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_email_reply_to_name':
// Only validate if reply-to is enabled.
if ( $check_reply_to && ( empty( $value ) || ! is_string( $value ) ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Reply-to name cannot be empty when reply-to is enabled.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_email_reply_to_address':
// Only validate if reply-to is enabled.
if ( $check_reply_to && ( empty( $value ) || ! is_email( $value ) ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Please enter a valid reply-to email address.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
}
return true;
}
/**
* Sanitize setting value based on its type.
*
* @param string $setting_type Setting type.
* @param mixed $value Setting value.
* @return mixed Sanitized value.
*/
private function sanitize_setting_value( $setting_type, $value ) {
switch ( $setting_type ) {
case 'text':
case 'select':
case 'color':
return sanitize_text_field( $value );
case 'email':
return sanitize_email( $value );
case 'checkbox':
// Ensure we have a scalar value for checkbox settings.
if ( is_array( $value ) ) {
$value = ! empty( $value ); // Convert array to boolean based on emptiness.
}
return wc_bool_to_string( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return 0;
}
return filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE ) ?? floatval( $value );
default:
// If a type is not explicitly handled, treat it as text.
return sanitize_text_field( $value );
}
}
/**
* Get the schema for the current resource.
*
* @return array
*/
protected function get_schema(): array {
return $this->schema->get_item_schema();
}
/**
* Get the item schema for the controller.
*
* @return array
*/
public function get_item_schema(): array {
return $this->get_schema();
}
/**
* Get the item response for a single settings group.
*
* @param mixed $item Settings data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->schema->get_item_response( $item, $request );
}
/**
* Get the endpoint args for item schema.
*
* @param string $method HTTP method of the request.
* @return array Endpoint arguments.
*/
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ): array {
return rest_get_endpoint_args_for_schema( $this->get_item_schema(), $method );
}
}
PK [1]̦C ? RestApi/Routes/V4/Settings/Email/Schema/EmailSettingsSchema.phpnu array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Settings title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'description' => array(
'description' => __( 'Settings description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_CONTEXT,
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'email', 'checkbox', 'number', 'color', 'select' ),
'context' => self::VIEW_EDIT_CONTEXT,
),
'desc' => array(
'description' => __( 'Setting field description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'options' => array(
'description' => __( 'Available options for selectable fields.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
);
}
/**
* Get email settings data by transforming email settings into REST API format.
*
* @param mixed $item Settings array from WC_Settings_Emails.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include.
* @return array
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$settings = is_array( $item ) ? $item : array();
// Transform settings into grouped format based on title/sectionend markers.
$groups = array();
$values = array();
$current_group = null;
$current_group_id = null;
foreach ( $settings as $setting ) {
$setting_type = $setting['type'] ?? '';
// Handle section titles and email_color_palette - start of a new group.
if ( 'title' === $setting_type || 'email_color_palette' === $setting_type ) {
$current_group_id = $setting['id'] ?? '';
$current_group = array(
'title' => $setting['title'] ?? '',
'description' => $setting['desc'] ?? '',
'order' => isset( $setting['order'] ) ? (int) $setting['order'] : 999,
'fields' => array(),
);
continue;
}
// Handle section ends - save the current group.
if ( 'sectionend' === $setting_type ) {
if ( $current_group && $current_group_id ) {
$groups[ $current_group_id ] = $current_group;
}
$current_group = null;
$current_group_id = null;
continue;
}
// Skip non-editable field types.
if ( in_array( $setting_type, self::NON_EDITABLE_TYPES, true ) ) {
continue;
}
// Process field if we have a current group and the setting has an ID.
if ( isset( $setting['id'] ) && $current_group ) {
$setting_id = $setting['id'];
$setting_type = $setting['type'] ?? 'text';
// Map WooCommerce field types to REST API types.
$api_type = $this->map_setting_type_to_api_type( $setting_type );
// Build field definition.
$field = array(
'id' => $setting_id,
'label' => $setting['title'] ?? $setting_id,
'type' => $api_type,
);
// Add description if available.
if ( ! empty( $setting['desc'] ) ) {
$field['desc'] = $setting['desc'];
}
// Add options if available.
if ( isset( $setting['options'] ) && is_array( $setting['options'] ) ) {
$field['options'] = $setting['options'];
}
$current_group['fields'][] = $field;
// Get current value.
$default_value = $setting['default'] ?? '';
$current_value = get_option( $setting_id, $default_value );
// Convert checkbox values to boolean for API.
if ( 'checkbox' === $setting_type ) {
$current_value = 'yes' === $current_value;
}
$values[ $setting_id ] = $current_value;
}
}
// Filter groups without fields.
$groups = array_filter(
$groups,
function ( $group ) {
return ! empty( $group['fields'] );
}
);
$response = array(
'id' => 'email',
'title' => __( 'Email design', 'woocommerce' ),
'description' => __( 'Customize the look and feel of all you notification emails.', 'woocommerce' ),
'values' => $values,
'groups' => $groups,
);
if ( ! empty( $include_fields ) ) {
$response = array_intersect_key( $response, array_flip( $include_fields ) );
}
return $response;
}
/**
* Map WooCommerce setting type to REST API type.
*
* @param string $setting_type WooCommerce setting type.
* @return string REST API type.
*/
private function map_setting_type_to_api_type( string $setting_type ): string {
$type_map = array(
'text' => 'text',
'email' => 'email',
'checkbox' => 'checkbox',
'number' => 'number',
'color' => 'color',
'select' => 'select',
);
return $type_map[ $setting_type ] ?? 'text';
}
}
PK [1]ɥg )* )* 2 RestApi/Routes/V4/Settings/Products/Controller.phpnu schema = $schema;
}
/**
* Get the WC_Settings_Products instance.
*
* @return \WC_Settings_Products
*/
private function get_settings_products_instance() {
if ( is_null( $this->settings_products_instance ) ) {
$this->settings_products_instance = new WC_Settings_Products();
}
return $this->settings_products_instance;
}
/**
* Register routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Check if a given request has access to read settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to access product settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Check if a given request has access to update settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error(
'rest_forbidden',
__( 'Sorry, you are not allowed to edit product settings.', 'woocommerce' ),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Get product settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
$settings = $this->get_all_settings();
$response = $this->schema->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Update product settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$params = $request->get_json_params();
if ( ! is_array( $params ) || empty( $params ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid or empty request body.', 'woocommerce' ),
array( 'status' => 400 )
);
}
// Check if the request contains a 'values' field with the flat key-value mapping.
$values_to_update = array();
if ( isset( $params['values'] ) && is_array( $params['values'] ) ) {
$values_to_update = $params['values'];
} else {
// Fallback to the old format for backward compatibility.
$values_to_update = $params;
}
// Get all product settings definitions.
$settings = $this->get_all_settings();
$settings_by_id = array_column( $settings, null, 'id' );
$valid_setting_ids = array_keys( $settings_by_id );
$validated_settings = array();
// Process each setting in the payload.
foreach ( $values_to_update as $setting_id => $setting_value ) {
// Sanitize the setting ID.
$setting_id = sanitize_text_field( $setting_id );
// Security check: only allow updating valid WooCommerce product settings.
if ( ! in_array( $setting_id, $valid_setting_ids, true ) ) {
continue;
}
// Sanitize the value based on the setting type.
$setting_definition = $settings_by_id[ $setting_id ];
$setting_type = $setting_definition['type'] ?? 'text';
$sanitized_value = $this->sanitize_setting_value( $setting_type, $setting_value );
// Additional validation for specific settings.
$validation_result = $this->validate_setting_value( $setting_id, $sanitized_value );
if ( is_wp_error( $validation_result ) ) {
return $validation_result;
}
// Store validated values first.
$validated_settings[ $setting_id ] = $sanitized_value;
}
// After validation loop, update all settings.
$updated_settings = array();
foreach ( $validated_settings as $setting_id => $value ) {
$update_result = update_option( $setting_id, $value );
if ( $update_result ) {
$updated_settings[] = $setting_id;
}
}
// Log the update if settings were changed.
if ( ! empty( $updated_settings ) ) {
/**
* Fires when WooCommerce product settings are updated.
*
* @param array $updated_settings Array of updated settings IDs.
* @param string $rest_base The REST base of the settings.
* @since 4.0.0
*/
do_action( 'woocommerce_settings_updated', $updated_settings, $this->rest_base );
}
// Get all settings after update.
$settings = $this->get_all_settings();
// Return updated settings.
$response = $this->schema->get_item_response( $settings, $request );
return rest_ensure_response( $response );
}
/**
* Validate a setting value before updating.
*
* @param string $setting_id Setting ID.
* @param mixed $value Setting value.
* @return bool|WP_Error True if valid, WP_Error if invalid.
*/
private function validate_setting_value( string $setting_id, $value ) {
// Custom validation rules for specific product settings.
switch ( $setting_id ) {
case 'woocommerce_weight_unit':
/**
* Filter the available weight units.
*
* @since 10.4.0
*
* @param array $weight_units Array of weight unit strings.
*/
$valid_units = apply_filters( 'woocommerce_weight_units', array( 'kg', 'g', 'lbs', 'oz' ) );
if ( ! in_array( $value, $valid_units, true ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid weight unit. Valid units are: kg, g, lbs, oz.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_dimension_unit':
/**
* Filter the available dimension units.
*
* @since 10.4.0
*
* @param array $dimension_units Array of dimension unit strings.
*/
$valid_units = apply_filters( 'woocommerce_dimension_units', array( 'm', 'cm', 'mm', 'in', 'yd' ) );
if ( ! in_array( $value, $valid_units, true ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid dimension unit. Valid units are: m, cm, mm, in, yd.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
case 'woocommerce_product_type':
$valid_types = array_keys( wc_get_product_types() );
if ( ! in_array( $value, $valid_types, true ) ) {
return new WP_Error(
'rest_invalid_param',
__( 'Invalid product type.', 'woocommerce' ),
array( 'status' => 400 )
);
}
break;
}
return true;
}
/**
* Sanitize setting value based on its type.
*
* @param string $setting_type Setting type.
* @param mixed $value Setting value.
* @return mixed Sanitized value.
*/
private function sanitize_setting_value( string $setting_type, $value ) {
switch ( $setting_type ) {
case 'text':
return sanitize_text_field( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return 0;
}
return filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE ) ?? floatval( $value );
case 'checkbox':
// Ensure we have a scalar value for checkbox settings.
if ( is_array( $value ) ) {
$value = ! empty( $value ); // Convert array to boolean based on emptiness.
}
return wc_bool_to_string( $value );
case 'select':
return sanitize_text_field( $value );
case 'multiselect':
if ( is_array( $value ) ) {
return array_map( 'sanitize_text_field', $value );
}
if ( is_string( $value ) ) {
return array( sanitize_text_field( $value ) );
}
if ( is_scalar( $value ) ) {
return array( sanitize_text_field( (string) $value ) );
}
return array();
default:
return sanitize_text_field( $value );
}
}
/**
* Get the schema for the current resource. This use consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*/
protected function get_schema(): array {
return $this->schema->get_item_schema();
}
/**
* Get the item schema for the controller.
*
* @return array
*/
public function get_item_schema(): array {
return $this->get_schema();
}
/**
* Prepare a single item for response.
*
* @param mixed $item Object to prepare.
* @param WP_REST_Request $request Request object.
* @return array Response data.
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->schema->get_item_response( $item, $request );
}
/**
* Get all product settings definitions.
*
* @return array Array of setting definitions.
*/
private function get_all_settings(): array {
$settings_instance = $this->get_settings_products_instance();
$sections = $settings_instance->get_sections();
$settings = array();
foreach ( array_keys( $sections ) as $section ) {
$section_settings = $settings_instance->get_settings_for_section( $section );
$settings = array_merge( $settings, $section_settings );
}
return $settings;
}
}
PK [1]x & & D RestApi/Routes/V4/Settings/Products/Schema/ProductSettingsSchema.phpnu array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'description' => __( 'Settings title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'description' => __( 'Settings description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'number', 'select', 'multiselect', 'checkbox' ),
'context' => array( 'view', 'edit' ),
),
'options' => array(
'description' => __( 'Available options for select/multiselect fields.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
);
}
/**
* Get product settings data by transforming WC_Settings_Products data into REST API format.
*
* @param mixed $item Settings products instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include.
* @return array
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$raw_settings = $item;
// Transform raw settings into grouped format based on title/sectionend markers.
$groups = array();
$values = array();
$current_group = null;
$current_group_id = null;
foreach ( $raw_settings as $setting ) {
$setting_type = $setting['type'] ?? '';
// Handle section titles - start of a new group.
if ( 'title' === $setting_type ) {
$current_group_id = $setting['id'] ?? '';
$current_group = array(
'title' => $setting['title'] ?? '',
'description' => $setting['desc'] ?? '',
'order' => isset( $setting['order'] ) ? (int) $setting['order'] : 999,
'fields' => array(),
);
continue;
}
// Handle section ends - save the current group.
if ( 'sectionend' === $setting_type ) {
if ( $current_group && $current_group_id ) {
$groups[ $current_group_id ] = $current_group;
}
$current_group = null;
$current_group_id = null;
continue;
}
// Skip title and sectionend types.
if ( in_array( $setting_type, array( 'title', 'sectionend' ), true ) ) {
continue;
}
// Convert setting to field format.
if ( isset( $setting['id'] ) && $current_group ) {
$field = $this->transform_setting_to_field( $setting );
if ( $field ) {
$current_group['fields'][] = $field;
// Add field value to the flat values array.
$raw_value = get_option( $field['id'], $setting['default'] ?? '' );
$values[ $field['id'] ] = $this->validate_field_value( $raw_value, $field['type'] );
}
}
}
// Sort groups by their order if available.
uasort(
$groups,
function ( $a, $b ) {
$a_order = $a['order'] ?? 999;
$b_order = $b['order'] ?? 999;
return $a_order - $b_order;
}
);
return array(
'id' => 'products',
'title' => __( 'Products', 'woocommerce' ),
'description' => __( 'Manage product settings including dimensions, weight units, and display options.', 'woocommerce' ),
'values' => $values,
'groups' => $groups,
);
}
/**
* Transform a WooCommerce setting into REST API field format.
*
* @param array $setting WooCommerce setting array.
* @return array|null Transformed field or null if should be skipped.
*/
private function transform_setting_to_field( array $setting ): ?array {
$setting_id = $setting['id'] ?? '';
$setting_type = $setting['type'] ?? 'text';
$field = array(
'id' => $setting_id,
'label' => $setting['title'] ?? $setting_id,
'type' => $this->normalize_field_type( $setting_type ),
'desc' => $setting['desc'] ?? '',
);
// Add options for select fields.
if ( isset( $setting['options'] ) && is_array( $setting['options'] ) ) {
$field['options'] = $setting['options'];
} else {
// Generate options for special field types.
$field['options'] = $this->get_field_options( $setting_id );
}
return $field;
}
/**
* Get options for specific field types.
*
* @param string $field_id Field ID.
* @return array Field options.
*/
private function get_field_options( string $field_id ): array {
switch ( $field_id ) {
case 'woocommerce_weight_unit':
return array(
'kg' => __( 'kg', 'woocommerce' ),
'g' => __( 'g', 'woocommerce' ),
'lbs' => __( 'lbs', 'woocommerce' ),
'oz' => __( 'oz', 'woocommerce' ),
);
case 'woocommerce_dimension_unit':
return array(
'm' => __( 'm', 'woocommerce' ),
'cm' => __( 'cm', 'woocommerce' ),
'mm' => __( 'mm', 'woocommerce' ),
'in' => __( 'in', 'woocommerce' ),
'yd' => __( 'yd', 'woocommerce' ),
);
case 'woocommerce_product_type':
if ( ! function_exists( 'wc_get_product_types' ) ) {
return array();
}
$product_types = wc_get_product_types();
return is_array( $product_types ) ? $product_types : array();
}
return array();
}
/**
* Normalize WooCommerce field types to REST API field types.
*
* @param string $wc_type WooCommerce field type.
* @return string Normalized field type.
*/
private function normalize_field_type( string $wc_type ): string {
$type_map = array(
'single_select_product' => 'select',
'multi_select_product' => 'multiselect',
);
return $type_map[ $wc_type ] ?? $wc_type;
}
/**
* Validate and sanitize field value based on its type.
*
* @param mixed $value Field value.
* @param string $type Field type.
* @return mixed Validated value.
*/
private function validate_field_value( $value, string $type ) {
switch ( $type ) {
case 'number':
return is_numeric( $value ) ? (float) $value : 0;
case 'checkbox':
if ( function_exists( 'wc_string_to_bool' ) ) {
return wc_string_to_bool( $value );
}
if ( is_bool( $value ) ) {
return $value;
}
return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
case 'multiselect':
return is_array( $value ) ? $value : array();
case 'text':
case 'select':
default:
return is_string( $value ) ? $value : (string) $value;
}
}
}
PK [1]K?" ?" ; RestApi/Routes/V4/Settings/Tax/Schema/TaxSettingsSchema.phpnu array(
'description' => __( 'Unique identifier for the settings group.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'title' => array(
'description' => __( 'Settings title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'description' => array(
'description' => __( 'Settings description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'values' => array(
'description' => __( 'Flat key-value mapping of all setting field values.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'description' => __( 'Setting field value.', 'woocommerce' ),
'type' => array( 'string', 'number', 'array', 'boolean' ),
),
),
'groups' => array(
'description' => __( 'Collection of setting groups.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'additionalProperties' => array(
'type' => 'object',
'description' => __( 'Settings group.', 'woocommerce' ),
'properties' => array(
'title' => array(
'description' => __( 'Group title.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'description' => array(
'description' => __( 'Group description.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'order' => array(
'description' => __( 'Display order for the group.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'fields' => array(
'description' => __( 'Settings fields.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_CONTEXT,
'items' => $this->get_field_schema(),
),
),
),
),
);
}
/**
* Get the schema for individual setting fields.
*
* @return array
*/
private function get_field_schema(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Setting field ID.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'label' => array(
'description' => __( 'Setting field label.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'type' => array(
'description' => __( 'Setting field type.', 'woocommerce' ),
'type' => 'string',
'enum' => array( 'text', 'number', 'select', 'multiselect', 'checkbox', 'radio', 'textarea' ),
'context' => self::VIEW_EDIT_CONTEXT,
),
'options' => array(
'description' => __( 'Available options for select/radio fields.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
),
'desc' => array(
'description' => __( 'Description for the setting field.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
);
}
/**
* Get tax settings data by transforming raw settings into REST API format.
*
* @param mixed $item Raw settings array.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include.
* @return array
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
$raw_settings = $item;
// Transform raw settings into grouped format based on title/sectionend markers.
$groups = array();
$values = array();
$current_group = null;
$current_group_id = null;
foreach ( $raw_settings as $setting ) {
$setting_type = $setting['type'] ?? '';
// Handle section titles - start of a new group.
if ( 'title' === $setting_type ) {
$current_group_id = $setting['id'] ?? '';
$current_group = array(
'title' => $setting['title'] ?? '',
'description' => $setting['desc'] ?? '',
'order' => isset( $setting['order'] ) ? (int) $setting['order'] : 999,
'fields' => array(),
);
continue;
}
// Handle section ends - save the current group.
if ( 'sectionend' === $setting_type ) {
if ( $current_group && $current_group_id ) {
$groups[ $current_group_id ] = $current_group;
}
$current_group = null;
$current_group_id = null;
continue;
}
// Skip special marker types.
if ( in_array( $setting_type, array( 'title', 'sectionend', 'conflict_error', 'add_settings_slot' ), true ) ) {
continue;
}
// Convert setting to field format.
if ( isset( $setting['id'] ) && $current_group ) {
$field = $this->transform_setting_to_field( $setting );
if ( $field ) {
$current_group['fields'][] = $field;
// Add field value to the flat values array.
$raw_value = get_option( $field['id'], $setting['default'] ?? '' );
$values[ $field['id'] ] = $this->validate_field_value( $raw_value, $field['type'] );
}
}
}
// Sort groups by their order if available.
uasort(
$groups,
function ( $a, $b ) {
$a_order = $a['order'] ?? 999;
$b_order = $b['order'] ?? 999;
return $a_order - $b_order;
}
);
$response = array(
'id' => 'tax',
'title' => __( 'Taxes', 'woocommerce' ),
'description' => __( 'Manage your store’s tax setup.', 'woocommerce' ),
'values' => $values,
'groups' => $groups,
);
if ( ! empty( $include_fields ) ) {
$response = array_intersect_key( $response, array_flip( $include_fields ) );
}
return $response;
}
/**
* Transform a WooCommerce setting into REST API field format.
*
* @param array $setting WooCommerce setting array.
* @return array|null Transformed field or null if should be skipped.
*/
private function transform_setting_to_field( array $setting ): ?array {
$setting_id = $setting['id'] ?? '';
$setting_type = $setting['type'] ?? 'text';
$field = array(
'id' => $setting_id,
'label' => $setting['title'] ?? $setting_id,
'type' => $this->normalize_field_type( $setting_type ),
'desc' => $setting['desc'] ?? '',
);
// Add options for select/radio fields.
if ( isset( $setting['options'] ) && is_array( $setting['options'] ) ) {
$field['options'] = $setting['options'];
}
return $field;
}
/**
* Normalize WooCommerce field types to REST API field types.
*
* @param string $wc_type WooCommerce field type.
* @return string Normalized field type.
*/
private function normalize_field_type( string $wc_type ): string {
$type_map = array(
'single_select_country' => 'select',
'multi_select_countries' => 'multiselect',
'radio' => 'radio',
);
return $type_map[ $wc_type ] ?? $wc_type;
}
/**
* Validate and sanitize field value based on its type.
*
* @param mixed $value Field value.
* @param string $type Field type.
* @return mixed Validated value.
*/
private function validate_field_value( $value, string $type ) {
switch ( $type ) {
case 'number':
return is_numeric( $value ) ? (float) $value : 0;
case 'checkbox':
if ( function_exists( 'wc_string_to_bool' ) ) {
return wc_string_to_bool( $value );
}
if ( is_bool( $value ) ) {
return $value;
}
return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
case 'multiselect':
return is_array( $value ) ? $value : array();
case 'radio':
case 'select':
case 'text':
case 'textarea':
default:
return is_string( $value ) ? $value : (string) $value;
}
}
}
PK [1]S' ' - RestApi/Routes/V4/Settings/Tax/Controller.phpnu item_schema = $item_schema;
}
/**
* Get the WC_Settings_Tax instance.
*
* @return WC_Settings_Tax
*/
private function get_settings_tax_instance() {
if ( is_null( $this->settings_tax_instance ) ) {
$this->settings_tax_instance = new WC_Settings_Tax();
}
return $this->settings_tax_instance;
}
/**
* Register routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Check permissions for reading tax settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check permissions for updating tax settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error
*/
public function update_item_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Get tax settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function get_item( $request ) {
$settings = $this->get_all_settings();
return $this->prepare_item_for_response( $settings, $request );
}
/**
* Update tax settings.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function update_item( $request ) {
$params = $request->get_json_params();
if ( ! is_array( $params ) || empty( $params ) ) {
return $this->get_route_error_response(
$this->get_error_prefix() . 'invalid_param',
__( 'Invalid or empty request body.', 'woocommerce' ),
400
);
}
// Check if the request contains a 'values' field with the flat key-value mapping.
$values_to_update = array();
if ( isset( $params['values'] ) && is_array( $params['values'] ) ) {
$values_to_update = $params['values'];
} else {
// Fallback to the old format for backward compatibility.
$values_to_update = $params;
}
// Get all tax settings definitions.
$settings = $this->get_all_settings();
$settings_by_id = array_column( $settings, null, 'id' );
// Exclude non-editable markers like 'title' and 'sectionend'.
$settings_by_id = array_filter(
$settings_by_id,
static function ( $def ) {
$type = $def['type'] ?? '';
return isset( $def['id'] ) && ! in_array( $type, array( 'title', 'sectionend', 'conflict_error', 'add_settings_slot' ), true );
}
);
$valid_setting_ids = array_keys( $settings_by_id );
$validated_settings = array();
// Process each setting in the payload.
foreach ( $values_to_update as $setting_id => $setting_value ) {
// Sanitize the setting ID.
$setting_id = sanitize_text_field( $setting_id );
// Security check: only allow updating valid WooCommerce tax settings.
if ( ! in_array( $setting_id, $valid_setting_ids, true ) ) {
continue;
}
// Sanitize the value based on the setting type.
$setting_definition = $settings_by_id[ $setting_id ];
$setting_type = $setting_definition['type'] ?? 'text';
$sanitized_value = $this->sanitize_setting_value( $setting_type, $setting_value );
// Additional validation for specific settings.
$validation_result = $this->validate_setting_value( $setting_definition, $sanitized_value );
if ( is_wp_error( $validation_result ) ) {
return $validation_result;
}
// Store validated values first.
$validated_settings[ $setting_id ] = $sanitized_value;
}
// After validation loop, update all settings.
$updated_settings = array();
foreach ( $validated_settings as $setting_id => $value ) {
$update_result = update_option( $setting_id, $value );
if ( $update_result ) {
$updated_settings[] = $setting_id;
}
}
// Log the update if settings were changed.
if ( ! empty( $updated_settings ) ) {
/**
* Fires when WooCommerce settings are updated.
*
* @param array $updated_settings Array of updated settings IDs.
* @param string $rest_base The REST base of the settings.
* @since 4.0.0
*/
do_action( 'woocommerce_settings_updated', $updated_settings, $this->rest_base );
}
// Get all settings after update.
$settings = $this->get_all_settings();
// Return updated settings.
return $this->prepare_item_for_response( $settings, $request );
}
/**
* Validate a setting value before updating.
*
* @param array $setting Setting definition.
* @param mixed $value Setting value.
* @return bool|WP_Error True if valid, WP_Error if invalid.
*/
private function validate_setting_value( $setting, $value ) {
$setting_id = $setting['id'] ?? '';
$options = $setting['options'] ?? array();
if ( empty( $options ) ) {
return true;
}
$allowed_values = array_map( 'strval', array_keys( (array) $options ) );
// Normalize value to array for consistent validation.
$check_values = is_array( $value ) ? array_map( 'strval', $value ) : array( (string) $value );
$invalid_values = array_diff( $check_values, $allowed_values );
if ( ! empty( $invalid_values ) ) {
// Note: Using setting_id instead of setting_label because plugins can filter settings
// and clear the 'title' field (e.g., ciab-next), making the label unreliable.
// The setting_id is always present and provides a clear, machine-readable identifier.
return $this->get_route_error_response(
$this->get_error_prefix() . 'invalid_param',
sprintf(
/* translators: 1: Setting ID, 2: Allowed values list. */
__( 'Invalid value for "%1$s". Allowed values: %2$s.', 'woocommerce' ),
$setting_id,
implode( ', ', $allowed_values )
),
400
);
}
return true;
}
/**
* Sanitize setting value based on its type.
*
* @param string $setting_type Setting type.
* @param mixed $value Setting value.
* @return mixed Sanitized value.
*/
private function sanitize_setting_value( $setting_type, $value ) {
// Normalize WooCommerce setting types to REST API schema types.
$type_map = array(
'single_select_country' => 'select',
'multi_select_countries' => 'multiselect',
);
$setting_type = $type_map[ $setting_type ] ?? $setting_type;
switch ( $setting_type ) {
case 'text':
return sanitize_text_field( $value );
case 'number':
if ( ! is_numeric( $value ) ) {
return 0;
}
return filter_var( $value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE ) ?? floatval( $value );
case 'checkbox':
// Ensure we have a scalar value for checkbox settings.
if ( is_array( $value ) ) {
$value = ! empty( $value ); // Convert array to boolean based on emptiness.
}
return wc_bool_to_string( $value );
case 'radio':
case 'select':
return sanitize_text_field( $value );
case 'multiselect':
if ( is_array( $value ) ) {
return array_map( 'sanitize_text_field', $value );
}
if ( is_string( $value ) ) {
return array( sanitize_text_field( $value ) );
}
if ( is_scalar( $value ) ) {
return array( sanitize_text_field( (string) $value ) );
}
return array();
case 'textarea':
return sanitize_textarea_field( $value );
default:
// If a type is not explicitly handled, treat it as text.
return sanitize_text_field( $value );
}
}
/**
* Get all tax settings definitions.
*
* @return array Array of setting definitions.
*/
private function get_all_settings(): array {
$settings_instance = $this->get_settings_tax_instance();
$settings = $settings_instance->get_settings_for_section( '' );
return $settings;
}
/**
* Get the schema for the current resource.
*
* @return array
*/
public function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the item response for a single settings group.
*
* @param mixed $item Settings data.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $item, $request );
}
}
PK [1] ֧( ( ( RestApi/Routes/V4/AbstractController.phpnu get_query_schema();
$params['context'] = $this->get_context_param( array( 'default' => 'view' ) );
/**
* Filter the collection params.
*
* @param array $params The collection params.
* @since 10.2.0
*/
return apply_filters( $this->get_hook_prefix() . 'collection_params', $params, $this );
}
/**
* Get item schema, conforming to JSON Schema. Extended by routes.
*
* @return array The item schema.
* @since 10.2.0
*/
public function get_item_schema() {
// Cache the schema for the route.
if ( null === $this->schema ) {
/**
* Filter the item schema for this route.
*
* @param array $schema The item schema.
* @since 10.2.0
*/
$this->schema = apply_filters( $this->get_hook_prefix() . 'item_schema', $this->add_additional_fields_schema( $this->get_schema() ) );
}
return $this->schema;
}
/**
* Get the item response.
*
* @param mixed $item WooCommerce representation of the item.
* @param WP_REST_Request $request Request object.
* @return array The item response.
* @since 10.2.0
*/
abstract protected function get_item_response( $item, WP_REST_Request $request ): array;
/**
* Prepare links for the request.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @param WP_REST_Response $response Response object.
* @return array
*/
protected function prepare_links( $item, WP_REST_Request $request, WP_REST_Response $response ): array {
return array();
}
/**
* Prepares the item for the REST response. Controllers do not need to override this method as they can define a
* get_item_response method to prepare items. This method will take care of filter hooks.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
* @since 10.2.0
*/
public function prepare_item_for_response( $item, $request ) {
$response_data = $this->get_item_response( $item, $request );
$response_data = $this->add_additional_fields_to_object( $response_data, $request );
$response_data = $this->filter_response_by_context( $response_data, $request['context'] ?? 'view' );
$response = rest_ensure_response( $response_data );
$response->add_links( $this->prepare_links( $item, $request, $response ) );
/**
* Filter the data for a response.
*
* @param WP_REST_Response $response The response object.
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @since 10.2.0
*/
return rest_ensure_response( apply_filters( $this->get_hook_prefix() . 'item_response', $response, $item, $request ) );
}
/**
* Get the hook prefix for actions and filters.
*
* Example: woocommerce_rest_api_v4_orders_
*
* @return string The hook prefix.
* @since 10.2.0
*/
protected function get_hook_prefix(): string {
return 'woocommerce_rest_api_v4_' . str_replace( '-', '_', $this->rest_base ) . '_';
}
/**
* Get the error prefix for errors.
*
* Example: woocommerce_rest_api_v4_orders_
*
* @return string The error prefix.
* @since 10.2.0
*/
protected function get_error_prefix(): string {
return 'woocommerce_rest_api_v4_' . str_replace( '-', '_', $this->rest_base ) . '_';
}
/**
* Get route response when something went wrong.
*
* @param string $error_code String based error code.
* @param string $error_message User facing error message.
* @param int $http_status_code HTTP status. Defaults to 400.
* @param array $additional_data Extra data (key value pairs) to expose in the error response.
* @return WP_Error WP Error object.
* @since 10.2.0
*/
protected function get_route_error_response( string $error_code, string $error_message, int $http_status_code = WP_Http::BAD_REQUEST, array $additional_data = array() ): WP_Error {
if ( empty( $error_code ) ) {
$error_code = 'invalid_request';
}
if ( empty( $error_message ) ) {
$error_message = __( 'An error occurred while processing your request.', 'woocommerce' );
}
return new WP_Error(
$error_code,
$error_message,
array_merge(
$additional_data,
array( 'status' => $http_status_code )
)
);
}
/**
* Get route response when something went wrong and the supplied error is a WP_Error.
*
* @param WP_Error $error_object The WP_Error object containing the error.
* @param int $http_status_code HTTP status. Defaults to 400.
* @param array $additional_data Extra data (key value pairs) to expose in the error response.
* @return WP_Error WP Error object.
* @since 10.2.0
*/
protected function get_route_error_response_from_object( WP_Error $error_object, int $http_status_code = WP_Http::BAD_REQUEST, array $additional_data = array() ): WP_Error {
if ( ! $error_object instanceof WP_Error ) {
return $this->get_route_error_response( 'invalid_error_object', __( 'Invalid error object provided.', 'woocommerce' ), $http_status_code, $additional_data );
}
$error_object->add_data( array_merge( $additional_data, array( 'status' => $http_status_code ) ) );
return $error_object;
}
/**
* Returns an authentication error for a given HTTP verb.
*
* @param string $method HTTP method.
* @return WP_Error|false WP Error object or false if no error is found.
*/
protected function get_authentication_error_by_method( string $method ) {
$errors = array(
'GET' => array(
'code' => $this->get_error_prefix() . 'cannot_view',
'message' => __( 'Sorry, you cannot view resources.', 'woocommerce' ),
),
'POST' => array(
'code' => $this->get_error_prefix() . 'cannot_create',
'message' => __( 'Sorry, you cannot create resources.', 'woocommerce' ),
),
'PUT' => array(
'code' => $this->get_error_prefix() . 'cannot_update',
'message' => __( 'Sorry, you cannot update resources.', 'woocommerce' ),
),
'PATCH' => array(
'code' => $this->get_error_prefix() . 'cannot_update',
'message' => __( 'Sorry, you cannot update resources.', 'woocommerce' ),
),
'DELETE' => array(
'code' => $this->get_error_prefix() . 'cannot_delete',
'message' => __( 'Sorry, you cannot delete resources.', 'woocommerce' ),
),
);
if ( ! isset( $errors[ $method ] ) ) {
return false;
}
return new WP_Error(
$errors[ $method ]['code'],
$errors[ $method ]['message'],
array( 'status' => rest_authorization_required_code() )
);
}
/**
* Get an error response for a given error code.
*
* @param string $error_code The error code.
* @return WP_Error WP Error object.
*/
protected function get_route_error_by_code( string $error_code ): WP_Error {
$error_messages = array(
self::INVALID_ID => __( 'Invalid ID.', 'woocommerce' ),
self::RESOURCE_EXISTS => __( 'Resource already exists.', 'woocommerce' ),
self::CANNOT_CREATE => __( 'Cannot create resource.', 'woocommerce' ),
self::CANNOT_DELETE => __( 'Cannot delete resource.', 'woocommerce' ),
self::CANNOT_UPDATE => __( 'Cannot update resource.', 'woocommerce' ),
self::CANNOT_TRASH => __( 'Cannot trash resource.', 'woocommerce' ),
self::TRASH_NOT_SUPPORTED => __( 'Trash not supported.', 'woocommerce' ),
);
$http_status_codes = array(
self::INVALID_ID => WP_Http::NOT_FOUND,
self::RESOURCE_EXISTS => WP_Http::BAD_REQUEST,
self::CANNOT_CREATE => WP_Http::INTERNAL_SERVER_ERROR,
self::CANNOT_DELETE => WP_Http::INTERNAL_SERVER_ERROR,
self::CANNOT_UPDATE => WP_Http::INTERNAL_SERVER_ERROR,
self::CANNOT_TRASH => WP_Http::GONE,
self::TRASH_NOT_SUPPORTED => WP_Http::NOT_IMPLEMENTED,
);
return $this->get_route_error_response(
$this->get_error_prefix() . $error_code,
$error_messages[ $error_code ] ?? __( 'An error occurred while processing your request.', 'woocommerce' ),
$http_status_codes[ $error_code ] ?? WP_Http::BAD_REQUEST
);
}
}
PK [1](o{J {J - RestApi/Routes/V4/Fulfillments/Controller.phpnu item_schema = $item_schema;
$this->order_fulfillments_controller = $order_fulfillments_controller;
}
/**
* Register the routes for fulfillments.
*
* @since 4.0.0
*/
public function register_routes() {
// Register the route for getting and setting order fulfillments.
register_rest_route(
$this->namespace,
$this->rest_base,
array(
'schema' => array( $this, 'get_public_item_schema' ),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_fulfillments' ),
'permission_callback' => array( $this, 'check_permission_for_fulfillments' ),
'args' => array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
),
),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_fulfillment' ),
'permission_callback' => array( $this, 'check_permission_for_fulfillments' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
),
),
);
// Register the route for getting a specific fulfillment.
register_rest_route(
$this->namespace,
$this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_fulfillment' ),
'permission_callback' => array( $this, 'check_permission_for_fulfillments' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_fulfillment' ),
'permission_callback' => array( $this, 'check_permission_for_fulfillments' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_fulfillment' ),
'permission_callback' => array( $this, 'check_permission_for_fulfillments' ),
'args' => array(
'notify_customer' => array(
'description' => __( 'Whether to notify the customer about the fulfillment update.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'required' => false,
),
),
),
),
);
// Register the route for getting shipping providers.
register_rest_route(
$this->namespace,
$this->rest_base . '/providers',
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_providers' ),
'permission_callback' => array( $this, 'check_permission_for_providers' ),
'schema' => array( $this, 'get_schema_for_providers' ),
),
)
);
}
/**
* Get a list of fulfillments for a specific order.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response
*/
public function get_fulfillments( WP_REST_Request $request ): WP_REST_Response {
$order_id = (int) $request->get_param( 'order_id' );
// Validate the order ID.
if ( ! $order_id ) {
return $this->prepare_error_response(
'woocommerce_rest_order_id_required',
__( 'The order ID is required.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
$order = wc_get_order( $order_id );
if ( ! $order ) {
return $this->prepare_error_response(
'woocommerce_rest_order_invalid_id',
__( 'Invalid order ID.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::NOT_FOUND ) )
);
}
$request->set_param( 'order_id', $order_id );
return $this->order_fulfillments_controller->get_fulfillments( $request );
}
/**
* Create a fulfillment for a specific order.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response
*/
public function create_fulfillment( WP_REST_Request $request ): WP_REST_Response {
$params = $request->get_json_params();
$entity_id = $params['entity_id'] ?? null;
// Validate the entity ID.
if ( ! $entity_id ) {
return $this->prepare_error_response(
'woocommerce_rest_entity_id_required',
__( 'The entity ID is required.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
$order = wc_get_order( (int) $entity_id );
if ( ! $order ) {
return $this->prepare_error_response(
'woocommerce_rest_order_invalid_id',
__( 'Invalid order ID.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::NOT_FOUND ) )
);
}
$request->set_param( 'order_id', $entity_id );
return $this->order_fulfillments_controller->create_fulfillment( $request );
}
/**
* Get a specific fulfillment for a specific order.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response
*/
public function get_fulfillment( WP_REST_Request $request ): WP_REST_Response {
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
$fulfillment = new Fulfillment( $fulfillment_id );
if ( ! $fulfillment->get_id() ) {
return $this->prepare_error_response(
'woocommerce_rest_fulfillment_invalid_id',
__( 'Invalid fulfillment ID.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::NOT_FOUND ) )
);
}
if ( $fulfillment->get_entity_type() !== WC_Order::class ) {
return $this->prepare_error_response(
'woocommerce_rest_invalid_entity_type',
__( 'The entity type must be "order".', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
$order_id = (int) $fulfillment->get_entity_id();
$request->set_param( 'order_id', $order_id );
return $this->order_fulfillments_controller->get_fulfillment( $request );
}
/**
* Update a specific fulfillment for a specific order.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response
*/
public function update_fulfillment( WP_REST_Request $request ): WP_REST_Response {
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
$fulfillment = new Fulfillment( $fulfillment_id );
if ( ! $fulfillment->get_id() ) {
return $this->prepare_error_response(
'woocommerce_rest_fulfillment_invalid_id',
__( 'Invalid fulfillment ID.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::NOT_FOUND ) )
);
}
if ( $fulfillment->get_entity_type() !== WC_Order::class ) {
return $this->prepare_error_response(
'woocommerce_rest_invalid_entity_type',
__( 'The entity type must be "order".', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
$order_id = (int) $fulfillment->get_entity_id();
$request->set_param( 'order_id', $order_id );
return $this->order_fulfillments_controller->update_fulfillment( $request );
}
/**
* Delete a specific fulfillment for a specific order.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response
*/
public function delete_fulfillment( WP_REST_Request $request ): WP_REST_Response {
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
$fulfillment = new Fulfillment( $fulfillment_id );
$order_id = (int) $fulfillment->get_entity_id();
$request->set_param( 'order_id', $order_id );
return $this->order_fulfillments_controller->delete_fulfillment( $request );
}
/**
* Permission check for REST API endpoints, given the request method.
* For all fulfillments methods that have an order_id, we need to be sure the user has permission to view the order.
* For all other methods, we check if the user is logged in as admin and has the required capability.
*
* @param WP_REST_Request $request The request for which the permission is checked.
* @return bool|WP_Error True if the current user has the capability, otherwise an "Unauthorized" error or False if no error is available for the request method.
*
* @throws WP_Error If the URL contains an order, but the order does not exist.
*/
public function check_permission_for_fulfillments( WP_REST_Request $request ) {
// Fetch the order first if there's an order_id in the request.
$order = null;
// If there's an order_id in the request, try to get the order.
if ( $request->has_param( 'order_id' ) ) {
$order_id = (int) $request->get_param( 'order_id' );
$order = wc_get_order( $order_id );
}
// If there's a fulfillment_id in the request, try to get the order from the fulfillment.
if ( ! $order && $request->has_param( 'fulfillment_id' ) ) {
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
if ( $fulfillment_id ) {
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$order_id = (int) $fulfillment->get_entity_id();
$order = wc_get_order( $order_id );
} catch ( ApiException $ex ) {
return new WP_Error(
$ex->getErrorCode(),
$ex->getMessage(),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_fulfillment_invalid_id',
$e->getMessage(),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
}
}
// If there's no order_id in the request, try to get it from the request body.
$body_params = $request->get_json_params();
if ( ! $order && isset( $body_params['entity_id'] ) && isset( $body_params['entity_type'] ) ) {
if ( WC_Order::class !== $body_params['entity_type'] ) {
return new WP_Error(
'woocommerce_rest_invalid_entity_type',
esc_html__( 'The entity type must be "order".', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
$order_id = (int) $body_params['entity_id'];
$order = wc_get_order( $order_id );
}
// If there's still no order, return an error.
if ( ! $order ) {
return new WP_Error(
'woocommerce_rest_order_id_required',
esc_html__( 'The order ID is required.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::BAD_REQUEST ) )
);
}
// Check if the user is logged in as admin, and has the required capability.
// Admins who can manage WooCommerce can view all fulfillments.
if ( current_user_can( 'manage_woocommerce' ) ) { // phpcs:ignore WordPress.WP.Capabilities.Unknown
return true;
}
// Check if the order exists, and if the current user is the owner of the order, and the request is a read request.
// We allow this because we need to render the order fulfillments on the customer's order details and order tracking pages.
// But they will be only able to view them, not edit.
if ( get_current_user_id() === $order->get_customer_id() && WP_REST_Server::READABLE === $request->get_method() ) {
return true;
}
// Return an error related to the request method.
$error_information = $this->get_authentication_error_by_method( $request->get_method() );
if ( false === $error_information ) {
return false;
}
return $error_information;
}
/**
* Get the schema for the fulfillment resource. This is consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*
* @return array The schema for the fulfillment resource.
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the item response for a fulfillment.
*
* @param mixed $item The fulfillment item.
* @param WP_REST_Request $request The request object.
* @return array The item response.
*/
protected function get_item_response( $item, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $item, $request, $this->get_fields_for_response( $request ) );
}
/**
* Prepare an error response.
*
* @param string $code The error code.
* @param string $message The error message.
* @param array $data Additional error data, including 'status' key for HTTP status code.
*
* @return WP_REST_Response The error response.
*/
private function prepare_error_response( $code, $message, $data ): WP_REST_Response {
return new WP_REST_Response(
array(
'code' => $code,
'message' => $message,
'data' => $data,
),
$data['status'] ?? WP_Http::BAD_REQUEST
);
}
/**
* Get all shipping providers.
*
* @since 10.5.0
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response
*/
public function get_providers( WP_REST_Request $request ): WP_REST_Response {
$providers = \Automattic\WooCommerce\Internal\Fulfillments\FulfillmentUtils::get_shipping_providers_object();
/**
* Filters the shipping providers response before it is returned.
*
* Each provider in the array must have the following structure:
* - 'label' (string): The display name of the provider.
* - 'icon' (string): URL to the provider's icon.
* - 'value' (string): The provider's unique identifier.
* - 'url' (string): The tracking URL template.
*
* @param array $providers The shipping providers data.
* @param WP_REST_Request $request The request object.
*
* @since 10.5.0
*/
$providers = apply_filters( 'woocommerce_rest_prepare_fulfillments_providers', $providers, $request );
// Validate filtered result to prevent extensions from returning invalid structures.
if ( ! is_array( $providers ) ) {
_doing_it_wrong(
'woocommerce_rest_prepare_fulfillments_providers',
esc_html__( 'The filter must return an array of providers.', 'woocommerce' ),
'10.5.0'
);
$providers = array();
} else {
$providers = $this->validate_providers_structure( $providers );
}
return new WP_REST_Response( $providers, WP_Http::OK );
}
/**
* Validate the structure of providers returned by a filter.
*
* Removes any providers that don't have the required keys (label, icon, value, url).
*
* @since 10.5.0
* @param array $providers The providers array to validate.
* @return array The validated providers array with invalid entries removed.
*/
private function validate_providers_structure( array $providers ): array {
$required_keys = array( 'label', 'icon', 'value', 'url' );
$valid_providers = array();
$has_invalid = false;
foreach ( $providers as $key => $provider ) {
if ( ! is_array( $provider ) ) {
$has_invalid = true;
continue;
}
$missing_keys = array_diff( $required_keys, array_keys( $provider ) );
if ( ! empty( $missing_keys ) ) {
$has_invalid = true;
continue;
}
$valid_providers[ $key ] = $provider;
}
if ( $has_invalid ) {
_doing_it_wrong(
'woocommerce_rest_prepare_fulfillments_providers',
esc_html__( 'Some providers were removed because they are missing required keys (label, icon, value, url).', 'woocommerce' ),
'10.5.0'
);
}
return $valid_providers;
}
/**
* Check permissions for accessing shipping providers.
*
* @since 10.5.0
* @param WP_REST_Request $request Full details about the request.
* @return bool|WP_Error True if the current user has the capability, otherwise a WP_Error.
*/
public function check_permission_for_providers( WP_REST_Request $request ) {
if ( ! current_user_can( 'manage_woocommerce' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Get the schema for the providers endpoint.
*
* @since 10.5.0
* @return array The schema for the providers endpoint.
*/
public function get_schema_for_providers(): array {
return array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => __( 'Shipping providers', 'woocommerce' ),
'type' => 'object',
'additionalProperties' => array(
'type' => 'object',
'properties' => array(
'label' => array(
'description' => __( 'The display name of the shipping provider.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'icon' => array(
'description' => __( 'The icon URL for the shipping provider.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'value' => array(
'description' => __( 'The unique key for the shipping provider.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'url' => array(
'description' => __( 'The tracking URL template for the shipping provider.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
),
),
);
}
}
PK [1]SB ; RestApi/Routes/V4/Fulfillments/Schema/FulfillmentSchema.phpnu array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'entity_type' => array(
'description' => __( 'The type of entity for which the fulfillment is created.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
),
'entity_id' => array(
'description' => __( 'Unique identifier for the entity.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
),
'status' => array(
'description' => __( 'The status of the fulfillment.', 'woocommerce' ),
'type' => 'string',
'default' => 'unfulfilled',
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
),
'is_fulfilled' => array(
'description' => __( 'Whether the fulfillment is fulfilled.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
),
'date_updated' => array(
'description' => __( 'The date the fulfillment was last updated.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
'required' => true,
),
'date_deleted' => array(
'description' => __( 'The date the fulfillment was deleted.', 'woocommerce' ),
'anyOf' => array(
array(
'type' => 'string',
),
array(
'type' => 'null',
),
),
'default' => null,
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
'required' => true,
),
'meta_data' => array(
'description' => __( 'Meta data for the fulfillment.', 'woocommerce' ),
'type' => 'array',
'required' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'The unique identifier for the meta data. Set `0` for new records.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'key' => array(
'description' => __( 'The key of the meta data.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
),
'value' => array(
'description' => __( 'The value of the meta data.', 'woocommerce' ),
'type' => array( 'string', 'number', 'boolean', 'object', 'array', 'null' ),
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
),
),
'required' => true,
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
),
);
}
/**
* Get the item response.
*
* @param Fulfillment $fulfillment Fulfillment object.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $fulfillment, WP_REST_Request $request, array $include_fields = array() ): array {
$date_deleted = $fulfillment->get_date_deleted();
return array(
'id' => $fulfillment->get_id(),
'entity_type' => $fulfillment->get_entity_type(),
'entity_id' => (string) $fulfillment->get_entity_id(),
'status' => $fulfillment->get_status(),
'is_fulfilled' => $fulfillment->get_is_fulfilled(),
'date_updated' => wc_rest_prepare_date_response( $fulfillment->get_date_updated() ),
'date_deleted' => $date_deleted ? wc_rest_prepare_date_response( $date_deleted ) : null,
'meta_data' => $fulfillment->get_meta_data(),
);
}
}
PK [1]`B6i@ i@ * RestApi/Routes/V4/Customers/Controller.phpnu item_schema = $item_schema;
$this->collection_query = $collection_query;
$this->update_utils = $update_utils;
}
/**
* Get the schema for the current resource. This use consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the collection args schema.
*
* @return array
*/
protected function get_query_schema(): array {
return $this->collection_query->get_query_schema();
}
/**
* Register the routes for customers.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'schema' => array( $this, 'get_public_item_schema' ),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => array_merge(
$this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
array(
'email' => array(
'required' => true,
'type' => 'string',
'description' => __( 'New user email address.', 'woocommerce' ),
),
'username' => array(
'required' => 'no' === get_option( 'woocommerce_registration_generate_username', 'yes' ),
'description' => __( 'New user username.', 'woocommerce' ),
'type' => 'string',
),
'password' => array(
'required' => 'no' === get_option( 'woocommerce_registration_generate_password', 'no' ),
'description' => __( 'New user password.', 'woocommerce' ),
'type' => 'string',
),
)
),
),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'args' => array(
'force' => array(
'default' => false,
'type' => 'boolean',
'description' => __( 'Required to be true, as resource does not support trashing.', 'woocommerce' ),
),
),
),
)
);
}
/**
* Get a single customer.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
$user = \Automattic\WooCommerce\Internal\Utilities\Users::get_user_in_current_site( $request['id'] );
if ( is_wp_error( $user ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$customer = $this->prepare_item_for_response( new WC_Customer( $user->ID ), $request );
$response = rest_ensure_response( $customer );
return $response;
}
/**
* Prepare a single customer object for response.
*
* @param WC_Customer $customer Customer object.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $customer, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $customer, $request, $this->get_fields_for_response( $request ) );
}
/**
* Get collection of customers.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
$query_args = $this->collection_query->get_query_args( $request );
$results = $this->collection_query->get_query_results( $query_args, $request );
$items = array();
foreach ( $results['results'] as $customer ) {
$items[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $customer, $request ) );
}
$pagination_util = new Pagination();
$response = $pagination_util->add_headers( rest_ensure_response( $items ), $request, $results['total'], $results['pages'] );
return $response;
}
/**
* Create a single customer.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
if ( ! empty( $request['id'] ) ) {
return $this->get_route_error_by_code( self::RESOURCE_EXISTS );
}
try {
// Sets the username.
$request['username'] = ! empty( $request['username'] ) ? $request['username'] : '';
// Sets the password.
$request['password'] = ! empty( $request['password'] ) ? $request['password'] : '';
// Create customer.
$customer = new WC_Customer();
$customer->set_username( $request['username'] );
$customer->set_password( $request['password'] );
$customer->set_email( $request['email'] );
$this->update_utils->update_customer_from_request( $customer, $request, true );
if ( ! $customer->get_id() ) {
return $this->get_route_error_by_code( self::CANNOT_CREATE );
}
$user_data = get_userdata( $customer->get_id() );
$this->update_additional_fields_for_object( $user_data, $request );
/**
* Fires after a customer is created via the REST API.
*
* @param WP_User $user_data Data used to create the customer.
* @param WP_REST_Request $request Request object.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'created', $user_data, $request );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $customer, $request );
$response->set_status( WP_Http::CREATED );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $customer->get_id() ) ) );
return $response;
} catch ( \WC_REST_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
} catch ( \Exception $e ) {
return $this->get_route_error_by_code( self::CANNOT_CREATE );
}
}
/**
* Update a single customer.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$user = \Automattic\WooCommerce\Internal\Utilities\Users::get_user_in_current_site( $request['id'] );
if ( is_wp_error( $user ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$customer = new WC_Customer( $user->ID );
if ( ! $customer->get_id() ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
try {
$this->update_utils->update_customer_from_request( $customer, $request, false );
$user_data = get_userdata( $customer->get_id() );
$this->update_additional_fields_for_object( $user_data, $request );
/**
* Fires after a customer is updated via the REST API.
*
* @param WP_User $user_data Data used to update the customer.
* @param WP_REST_Request $request Request object.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'updated', $user_data, $request );
$request->set_param( 'context', 'edit' );
return $this->prepare_item_for_response( $customer, $request );
} catch ( \WC_REST_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
} catch ( \Exception $e ) {
return $this->get_route_error_by_code( self::CANNOT_UPDATE );
}
}
/**
* Delete a single customer.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function delete_item( $request ) {
$id = (int) $request['id'];
$force = isset( $request['force'] ) ? (bool) $request['force'] : false;
// We don't support trashing for this type, error out.
if ( ! $force ) {
return $this->get_route_error_by_code( self::TRASH_NOT_SUPPORTED );
}
$user_data = \Automattic\WooCommerce\Internal\Utilities\Users::get_user_in_current_site( $id );
if ( is_wp_error( $user_data ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( new WC_Customer( $id ), $request );
/** Include admin customer functions to get access to wp_delete_user() */
require_once ABSPATH . 'wp-admin/includes/user.php';
$customer = new WC_Customer( $id );
$result = $customer->delete();
if ( ! $result ) {
return $this->get_route_error_by_code( self::CANNOT_DELETE );
}
/**
* Fires after a customer is deleted via the REST API.
*
* @param WP_User $user_data User data.
* @param WP_REST_Response $response The response returned from the API.
* @param WP_REST_Request $request The request sent to the API.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'deleted', $user_data, $response, $request );
return $response;
}
/**
* Check if a given request has access to read items.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_user_permissions( 'read' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to read an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
$user = \Automattic\WooCommerce\Internal\Utilities\Users::get_user_in_current_site( $request['id'] );
if ( is_wp_error( $user ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
if ( ! wc_rest_check_user_permissions( 'read', $user->ID ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to create an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function create_item_permissions_check( $request ) {
if ( ! wc_rest_check_user_permissions( 'create' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to update an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function update_item_permissions_check( $request ) {
$user = \Automattic\WooCommerce\Internal\Utilities\Users::get_user_in_current_site( $request['id'] );
if ( is_wp_error( $user ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
if ( ! wc_rest_check_user_permissions( 'edit', $user->ID ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
// Check if user role is allowed to be updated.
$allowed_roles = $this->get_allowed_roles();
$customer = new WC_Customer( $user->ID );
if ( $customer && ! in_array( $customer->get_role(), $allowed_roles, true ) ) {
// Check against existing props to be compatible with clients that will send the entire user object.
$non_editable_props = array( 'email', 'password' );
$customer_prop = array( 'email' => $customer->get_email() );
foreach ( $non_editable_props as $prop ) {
if ( isset( $request[ $prop ] ) && ( 'password' === $prop || $request[ $prop ] !== $customer_prop[ $prop ] ) ) {
return new WP_Error(
'woocommerce_rest_cannot_edit',
sprintf(
/* translators: 1s: name of the property (email, role), 2: Role of the user (administrator, customer). */
__( 'Sorry, %1$s cannot be updated via this endpoint for a user with role %2$s.', 'woocommerce' ),
$prop,
$customer->get_role()
),
array( 'status' => rest_authorization_required_code() )
);
}
}
}
return true;
}
/**
* Check if a given request has access to delete an item.
*
* @param WP_REST_Request $request The request object.
* @return bool|WP_Error
*/
public function delete_item_permissions_check( $request ) {
$user = \Automattic\WooCommerce\Internal\Utilities\Users::get_user_in_current_site( $request['id'] );
if ( is_wp_error( $user ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
if ( ! wc_rest_check_user_permissions( 'delete', $user->ID ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
$id = (int) $request['id'];
$allowed_roles = $this->get_allowed_roles();
$customer = new WC_Customer( $id );
if ( ! in_array( $customer->get_role(), $allowed_roles, true ) ) {
return new WP_Error(
'woocommerce_rest_cannot_delete',
sprintf(
/* translators: 1: Role of the user (administrator, customer), 2: comma separated list of allowed roles. egs customer, subscriber */
__( 'Sorry, users with %1$s role cannot be deleted via this endpoint. Allowed roles: %2$s', 'woocommerce' ),
$customer->get_role(),
implode( ', ', $allowed_roles )
),
array( 'status' => rest_authorization_required_code() )
);
}
return true;
}
/**
* Returns list of allowed roles for the REST API.
*
* @return array $roles Allowed roles to be updated via the REST API.
*/
private function get_allowed_roles(): array {
/**
* Filter the allowed roles for the REST API.
*
* Danger: Make sure that the roles listed here cannot manage the shop.
*
* @param array $roles Array of allowed roles.
*
* @since 9.5.2
*/
return apply_filters( 'woocommerce_rest_customer_allowed_roles', array( 'customer', 'subscriber' ) );
}
}
PK [1]ݲ* * . RestApi/Routes/V4/Customers/CustomerSchema.phpnu array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the customer was created, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'date_created_gmt' => array(
'description' => __( 'The date the customer was created, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'date_modified' => array(
'description' => __( "The date the customer was last modified, in the site's timezone.", 'woocommerce' ),
'type' => 'date-time',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'date_modified_gmt' => array(
'description' => __( 'The date the customer was last modified, as GMT.', 'woocommerce' ),
'type' => 'date-time',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'email' => array(
'description' => __( 'The email address for the customer.', 'woocommerce' ),
'type' => 'string',
'format' => 'email',
'context' => self::VIEW_EDIT_CONTEXT,
),
'first_name' => array(
'description' => __( 'Customer first name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field',
),
),
'last_name' => array(
'description' => __( 'Customer last name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field',
),
),
'role' => array(
'description' => __( 'Customer role.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'username' => array(
'description' => __( 'Customer login name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'arg_options' => array(
'sanitize_callback' => 'sanitize_user',
),
),
'billing' => array(
'description' => __( 'List of billing address data.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'properties' => array(
'first_name' => array(
'description' => __( 'First name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'last_name' => array(
'description' => __( 'Last name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'company' => array(
'description' => __( 'Company name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'address_1' => array(
'description' => __( 'Address line 1', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'address_2' => array(
'description' => __( 'Address line 2', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'city' => array(
'description' => __( 'City name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'state' => array(
'description' => __( 'ISO code or name of the state, province or district.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'postcode' => array(
'description' => __( 'Postal code.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'country' => array(
'description' => __( 'ISO code of the country.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'email' => array(
'description' => __( 'Email address.', 'woocommerce' ),
'type' => 'string',
'format' => 'email',
'context' => self::VIEW_EDIT_CONTEXT,
),
'phone' => array(
'description' => __( 'Phone number.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
),
'shipping' => array(
'description' => __( 'List of shipping address data.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_CONTEXT,
'properties' => array(
'first_name' => array(
'description' => __( 'First name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'last_name' => array(
'description' => __( 'Last name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'company' => array(
'description' => __( 'Company name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'address_1' => array(
'description' => __( 'Address line 1', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'address_2' => array(
'description' => __( 'Address line 2', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'city' => array(
'description' => __( 'City name.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'state' => array(
'description' => __( 'ISO code or name of the state, province or district.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'postcode' => array(
'description' => __( 'Postal code.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'country' => array(
'description' => __( 'ISO code of the country.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
'phone' => array(
'description' => __( 'Phone number.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
),
),
),
'is_paying_customer' => array(
'description' => __( 'Is the customer a paying customer?', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'orders_count' => array(
'description' => __( 'Quantity of orders made by the customer.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'total_spent' => array(
'description' => __( 'Total amount spent.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'avatar_url' => array(
'description' => __( 'Avatar URL.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'last_active' => array(
'description' => __( "When the customer was last active in the site's timezone.", 'woocommerce' ),
'type' => array( 'null', 'string' ),
'format' => 'date-time',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
'last_active_gmt' => array(
'description' => __( 'When the customer was last active, as GMT.', 'woocommerce' ),
'type' => array( 'null', 'string' ),
'format' => 'date-time',
'context' => self::VIEW_EDIT_CONTEXT,
'readonly' => true,
),
);
return $schema;
}
/**
* Get the item response.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array The item response.
*/
public function get_item_response( $item, WP_REST_Request $request, array $include_fields = array() ): array {
if ( ! $item instanceof WC_Customer ) {
return array();
}
$data = $item->get_data();
// Normalize last active timestamp - treat empty string, '0', 0, or false as null.
$last_active = $item->get_meta( 'wc_last_active' );
$last_active = empty( $last_active ) ? null : $last_active;
$formatted_data = array(
'id' => $item->get_id(),
'date_created' => wc_rest_prepare_date_response( $item->get_date_created(), false ),
'date_created_gmt' => wc_rest_prepare_date_response( $item->get_date_created() ),
'date_modified' => wc_rest_prepare_date_response( $item->get_date_modified(), false ),
'date_modified_gmt' => wc_rest_prepare_date_response( $item->get_date_modified() ),
'email' => $data['email'],
'first_name' => $data['first_name'],
'last_name' => $data['last_name'],
'role' => $data['role'],
'username' => $data['username'],
'billing' => $data['billing'],
'shipping' => $data['shipping'],
'is_paying_customer' => $data['is_paying_customer'],
'orders_count' => $item->get_order_count(),
'total_spent' => $item->get_total_spent(),
'avatar_url' => $item->get_avatar_url(),
'last_active' => $last_active ? wc_rest_prepare_date_response( $last_active, false ) : null,
'last_active_gmt' => $last_active ? wc_rest_prepare_date_response( $last_active ) : null,
);
// Filter fields if specified.
if ( ! empty( $include_fields ) ) {
$formatted_data = array_intersect_key( $formatted_data, array_flip( $include_fields ) );
}
return $formatted_data;
}
}
PK [1]( / RestApi/Routes/V4/Customers/CollectionQuery.phpnu array(
'description' => __( 'Current page of the collection.', 'woocommerce' ),
'type' => 'integer',
'default' => 1,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
'minimum' => 1,
),
'per_page' => array(
'description' => __( 'Maximum number of items to be returned in result set.', 'woocommerce' ),
'type' => 'integer',
'default' => 10,
'minimum' => 1,
'maximum' => 100,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'search' => array(
'description' => __( 'Limit results to those matching a string.', 'woocommerce' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
'exclude' => array(
'description' => __( 'Ensure result set excludes specific IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'default' => array(),
'sanitize_callback' => 'wp_parse_id_list',
),
'include' => array(
'description' => __( 'Limit result set to specific IDs.', 'woocommerce' ),
'type' => 'array',
'items' => array(
'type' => 'integer',
),
'default' => array(),
'sanitize_callback' => 'wp_parse_id_list',
),
'order' => array(
'description' => __( 'Order sort attribute ascending or descending.', 'woocommerce' ),
'type' => 'string',
'default' => 'asc',
'enum' => array( 'asc', 'desc' ),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
),
'orderby' => array(
'description' => __( 'Sort collection by object attribute.', 'woocommerce' ),
'type' => 'string',
'default' => 'name',
'enum' => array(
'id',
'name',
'registered_date',
'order_count',
'total_spent',
'last_active',
),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
),
'role' => array(
'description' => __( 'Limit result set to resources with a specific role.', 'woocommerce' ),
'type' => 'string',
'default' => 'customer',
'enum' => array( 'customer', 'all' ),
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Prepares query args.
*
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_args( WP_REST_Request $request ): array {
$prepared_args = array();
$prepared_args['exclude'] = $request['exclude'];
$prepared_args['include'] = $request['include'];
$prepared_args['order'] = $request['order'];
$prepared_args['number'] = $request['per_page'];
$prepared_args['page'] = max( 1, intval( $request['page'] ) );
$orderby_possibles = array(
'id' => 'ID',
'name' => 'display_name',
'registered_date' => 'user_registered',
'order_count' => 'wc_order_count',
'total_spent' => 'wc_money_spent',
'last_active' => 'wc_last_active',
);
$prepared_args['orderby'] = $orderby_possibles[ $request['orderby'] ];
$prepared_args['search'] = $request['search'];
if ( ! empty( $prepared_args['search'] ) ) {
$prepared_args['search'] = '*' . $prepared_args['search'] . '*';
}
// Always pass role through (datastore handles 'all' vs 'customer').
$prepared_args['role'] = $request['role'];
/**
* Filter arguments, before passing to WP_User_Query, when querying users via the REST API.
*
* @see https://developer.wordpress.org/reference/classes/wp_user_query/
*
* @param array $prepared_args Array of arguments for WP_User_Query.
* @param WP_REST_Request $request The current request.
* @since 10.2.0
*/
$prepared_args = apply_filters( 'woocommerce_rest_customer_query', $prepared_args, $request );
return $prepared_args;
}
/**
* Get results of the query.
*
* @param array $query_args The query arguments.
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_results( array $query_args, WP_REST_Request $request ): array {
$method_args = array(
'order' => $query_args['order'] ?? 'asc',
'orderby' => $query_args['orderby'] ?? 'user_registered',
'per_page' => $query_args['number'] ?? 10,
'search' => $query_args['search'] ?? '',
'role' => $query_args['role'] ?? 'customer',
'include' => $query_args['include'] ?? array(),
'exclude' => $query_args['exclude'] ?? array(),
'page' => $query_args['page'] ?? 1,
);
$data_store = \WC_Data_Store::load( 'customer' );
$customer_query_results = $data_store->query_customers( $method_args );
$users = $customer_query_results->customers;
$total_users = $customer_query_results->total;
$max_pages = $customer_query_results->max_num_pages;
return array(
'results' => $users,
'total' => $total_users,
'pages' => $max_pages,
);
}
}
PK [1]2\ + RestApi/Routes/V4/Customers/UpdateUtils.phpnu set_email( sanitize_email( $request['email'] ) );
}
// Customer password.
if ( isset( $request['password'] ) ) {
$customer->set_password( $request['password'] );
}
// Customer first name.
if ( isset( $request['first_name'] ) ) {
$customer->set_first_name( wc_clean( $request['first_name'] ) );
}
// Customer last name.
if ( isset( $request['last_name'] ) ) {
$customer->set_last_name( wc_clean( $request['last_name'] ) );
}
// Customer billing address.
if ( isset( $request['billing'] ) && is_array( $request['billing'] ) ) {
$this->update_customer_address( $customer, $request['billing'], 'billing' );
}
// Customer shipping address.
if ( isset( $request['shipping'] ) && is_array( $request['shipping'] ) ) {
$this->update_customer_address( $customer, $request['shipping'], 'shipping' );
}
// Save the customer.
$customer->save();
// Additional fields for user data.
$user_data = get_userdata( $customer->get_id() );
if ( $user_data ) {
$this->update_additional_fields_for_object( $user_data, $request );
// Ensure user is a member of the blog and has customer role.
if ( ! is_user_member_of_blog( $user_data->ID ) ) {
$user_data->add_role( 'customer' );
}
}
}
/**
* Update customer address fields.
*
* @param WC_Customer $customer Customer object.
* @param array $address Address data.
* @param string $type Address type (billing or shipping).
* @return void
*/
private function update_customer_address( WC_Customer $customer, array $address, string $type ): void {
$address = wc_clean( $address );
$address_fields = array(
'first_name',
'last_name',
'company',
'address_1',
'address_2',
'city',
'state',
'postcode',
'country',
'email',
'phone',
);
foreach ( $address_fields as $field ) {
if ( isset( $address[ $field ] ) && is_callable( array( $customer, "set_{$type}_{$field}" ) ) ) {
$value = ( 'email' === $field ) ? sanitize_email( $address[ $field ] ) : $address[ $field ];
$customer->{"set_{$type}_{$field}"}( $value );
}
}
}
/**
* Update additional fields for object.
*
* @param mixed $item Object to update.
* @param WP_REST_Request $request Request object.
* @return void
* @throws WC_REST_Exception If there's an error updating additional fields.
*/
private function update_additional_fields_for_object( $item, WP_REST_Request $request ): void {
$additional_fields = $this->get_additional_fields();
foreach ( $additional_fields as $field_name => $field_options ) {
if ( ! $field_options['update_callback'] || ! is_callable( $field_options['update_callback'] ) ) {
continue;
}
if ( ! isset( $request[ $field_name ] ) ) {
continue;
}
$result = call_user_func( $field_options['update_callback'], $request[ $field_name ], $item, $field_name, $request );
if ( is_wp_error( $result ) ) {
throw new WC_REST_Exception( 'woocommerce_rest_cannot_update', esc_html( $result->get_error_message() ), 400 );
}
}
}
/**
* Get additional fields for this object.
*
* @return array
*/
private function get_additional_fields(): array {
$fields = array();
/**
* Filter additional fields for objects of this type.
*
* @param array $fields Additional fields registered for the object type.
* @param string $object_type Object type.
* @since 10.2.0
*/
$fields = apply_filters( 'rest_additional_fields', $fields, 'user' );
/**
* Filter additional fields for objects of this type.
*
* @param array $fields Additional fields registered for the object type.
* @param string $object_type Object type.
* @since 10.2.0
*/
$fields = apply_filters( "rest_{$this->get_object_type()}_additional_fields", $fields, 'user' );
return $fields;
}
/**
* Get object type.
*
* @return string
*/
private function get_object_type(): string {
return 'user';
}
}
PK [1]- = = 1 RestApi/Routes/V4/Refunds/Schema/RefundSchema.phpnu order_item_schema = $order_item_schema;
$this->order_fee_schema = $order_fee_schema;
$this->order_tax_schema = $order_tax_schema;
$this->order_shipping_schema = $order_shipping_schema;
}
/**
* Return all properties for the item schema.
*
* Note that context determines under which context data should be visible. For example, edit would be the context
* used when getting records with the intent of editing them. embed context allows the data to be visible when the
* item is being embedded in another response.
*
* @return array
*/
public function get_item_schema_properties(): array {
$schema = array(
'id' => array(
'description' => __( 'Unique identifier for the refund.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'order_id' => array(
'description' => __( 'The ID of the order that was refunded.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'required' => true,
'sanitize_callback' => 'absint',
),
'amount' => array(
'description' => __( 'Amount that was refunded. This is calculated from the line items if not provided.', 'woocommerce' ),
'type' => 'number',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'default' => 0,
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
'reason' => array(
'description' => __( 'Reason for the refund.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'default' => '',
'sanitize_callback' => 'sanitize_text_field',
),
'currency' => array(
'description' => __( 'Currency the refund was created with, in ISO format.', 'woocommerce' ),
'type' => 'string',
'default' => get_woocommerce_currency(),
'enum' => array_keys( get_woocommerce_currencies() ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'currency_symbol' => array(
'description' => __( 'Currency symbol for the currency which can be used to format returned prices.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_created' => array(
'description' => __( "The date the refund was created, in the site's timezone.", 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'date_created_gmt' => array(
'description' => __( 'The date the refund was created, as GMT.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'refunded_by' => array(
'description' => __( 'User who created the refund.', 'woocommerce' ),
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'User ID of user who created the refund.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'display_name' => array(
'description' => __( 'Display name of the user who created the refund.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'avatar_url' => array(
'description' => __( 'Avatar URL of the user who created the refund.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
'format' => 'uri',
),
),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'refunded_payment' => array(
'description' => __( 'If the payment was refunded via the API.', 'woocommerce' ),
'type' => 'boolean',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'meta_data' => array(
'description' => __( 'Meta data.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Meta ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'key' => array(
'description' => __( 'Meta key.', 'woocommerce' ),
'type' => 'string',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
'value' => array(
'description' => __( 'Meta value.', 'woocommerce' ),
'type' => array( 'null', 'object', 'string', 'number', 'boolean', 'integer', 'array' ),
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
),
),
'line_items' => array(
'description' => __( 'Refunded line items. This can include products, fees, and shipping lines, combined into a single array.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'default' => array(),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'ID of the refund line item. This is not the ID of the original line item.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
),
'line_item_id' => array(
'description' => __( 'ID of the original line item.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'required' => true,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'quantity' => array(
'description' => __( 'Quantity refunded.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'default' => 0,
'sanitize_callback' => 'wc_stock_amount',
'validate_callback' => 'rest_validate_request_arg',
),
'refund_total' => array(
'description' => __( 'Total refunded for this item.', 'woocommerce' ),
'type' => 'number',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'default' => 0,
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
'refund_tax' => array(
'description' => __( 'Optional: Taxes refunded for this item. If not provided, tax will be automatically extracted from refund_total using the order\'s tax rates.', 'woocommerce' ),
'type' => 'array',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'default' => array(),
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Tax ID.', 'woocommerce' ),
'type' => 'integer',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'required' => true,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'refund_total' => array(
'description' => __( 'Amount refunded for this tax.', 'woocommerce' ),
'type' => 'number',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'required' => true,
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
),
),
),
),
),
),
);
if ( $this->cogs_is_enabled() ) {
$schema = $this->add_cogs_related_schema( $schema );
}
return $schema;
}
/**
* Add the Cost of Goods Sold related fields to the schema.
*
* @param array $schema The original schema.
* @return array The updated schema.
*/
private static function add_cogs_related_schema( array $schema ): array {
$schema['cost_of_goods_sold'] = array(
'description' => __( 'Cost of Goods Sold data.', 'woocommerce' ),
'type' => 'object',
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
'readonly' => true,
'properties' => array(
'total_value' => array(
'description' => __( 'Total value of the Cost of Goods Sold for the refund.', 'woocommerce' ),
'type' => 'number',
'readonly' => true,
'context' => self::VIEW_EDIT_EMBED_CONTEXT,
),
),
);
return $schema;
}
/**
* Get an item response.
*
* @param WC_Order_Refund $refund Refund instance.
* @param WP_REST_Request $request Request object.
* @param array $include_fields Fields to include in the response.
* @return array
*/
public function get_item_response( $refund, WP_REST_Request $request, array $include_fields = array() ): array {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$data = array(
'id' => $refund->get_id(),
'order_id' => $refund->get_parent_id(),
'currency' => $refund->get_currency(),
'currency_symbol' => html_entity_decode( get_woocommerce_currency_symbol( $refund->get_currency() ), ENT_QUOTES ),
'date_created' => wc_rest_prepare_date_response( $refund->get_date_created(), false ),
'date_created_gmt' => wc_rest_prepare_date_response( $refund->get_date_created() ),
'amount' => wc_format_decimal( $refund->get_amount(), $dp ),
'reason' => $refund->get_reason(),
'refunded_payment' => $refund->get_refunded_payment(),
);
if ( in_array( 'refunded_by', $include_fields, true ) ) {
$refunded_user = new \WP_User( $refund->get_refunded_by() );
if ( $refunded_user->exists() ) {
$data['refunded_by'] = array(
'id' => $refunded_user->ID,
'display_name' => $refunded_user->display_name,
'avatar_url' => get_avatar_url( $refunded_user ),
);
} else {
$data['refunded_by'] = null;
}
}
if ( in_array( 'line_items', $include_fields, true ) ) {
$data['line_items'] = array_merge(
$this->get_line_items_response( $refund->get_items( 'line_item' ), $request ),
$this->get_line_items_response( $refund->get_items( 'fee' ), $request ),
$this->get_line_items_response( $refund->get_items( 'shipping' ), $request ),
);
}
if ( in_array( 'meta_data', $include_fields, true ) ) {
$filtered_meta_data = $this->filter_internal_meta_keys( $refund->get_meta_data() );
$data['meta_data'] = array();
foreach ( $filtered_meta_data as $meta_item ) {
$data['meta_data'][] = array(
'id' => $meta_item->id,
'key' => $meta_item->key,
'value' => $meta_item->value,
);
}
}
// Add COGS data.
if ( $this->cogs_is_enabled() && in_array( 'cost_of_goods_sold', $include_fields, true ) ) {
$data['cost_of_goods_sold']['total_value'] = $refund->get_cogs_total_value();
}
$data = array_intersect_key( $data, array_flip( $include_fields ) );
return $data;
}
/**
* Standardize the line items response.
*
* @param array $line_items Line items.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_line_items_response( $line_items, WP_REST_Request $request ) {
$line_items_response = array();
foreach ( $line_items as $line_item ) {
$line_items_response[] = $this->prepare_line_item( $line_item, $request );
}
return $line_items_response;
}
/**
* Standardize the line item response.
*
* @param WC_Order_Item $line_item Line item instance.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function prepare_line_item( $line_item, WP_REST_Request $request ) {
$dp = is_null( $request['num_decimals'] ) ? wc_get_price_decimals() : absint( $request['num_decimals'] );
$tax_response = array();
$taxes = $line_item->get_taxes();
foreach ( $taxes['total'] ?? array() as $tax_rate_id => $tax ) {
$tax_response[] = array(
'id' => absint( $tax_rate_id ),
'refund_total' => wc_format_decimal( abs( (float) $tax ), $dp ),
);
}
return array(
'id' => absint( $line_item->get_id() ),
'line_item_id' => absint( $line_item->get_meta( '_refunded_item_id' ) ),
'quantity' => wc_stock_amount( abs( (float) $line_item->get_quantity() ) ),
'refund_total' => wc_format_decimal( abs( (float) $line_item->get_total() ), $dp ),
'refund_tax' => $tax_response,
);
}
/**
* With HPOS, few internal meta keys such as _billing_address_index, _shipping_address_index are not considered internal anymore (since most internal keys were flattened into dedicated columns).
*
* This function helps in filtering out any remaining internal meta keys with HPOS is enabled.
*
* @param array $meta_data Order meta data.
* @return array Filtered order meta data.
*/
protected function filter_internal_meta_keys( $meta_data ) {
if ( ! OrderUtil::custom_orders_table_usage_is_enabled() ) {
return $meta_data;
}
$cpt_hidden_keys = ( new \WC_Order_Data_Store_CPT() )->get_internal_meta_keys();
$meta_data = array_filter(
$meta_data,
function ( $meta ) use ( $cpt_hidden_keys ) {
return ! in_array( $meta->key, $cpt_hidden_keys, true );
}
);
return array_values( $meta_data );
}
}
PK [1]9 9 ( RestApi/Routes/V4/Refunds/Controller.phpnu item_schema = $item_schema;
$this->collection_query = $collection_query;
$this->data_utils = $data_utils;
}
/**
* Get the schema for the current resource. This use consumed by the AbstractController to generate the item schema
* after running various hooks on the response.
*/
protected function get_schema(): array {
return $this->item_schema->get_item_schema();
}
/**
* Get the collection args schema.
*
* @return array
*/
protected function get_query_schema(): array {
return $this->collection_query->get_query_schema();
}
/**
* List of args for endpoints. These may alter how data is returned or formatted. Extended by routes.
*
* @return array
*/
protected function get_endpoint_args(): array {
return array(
'num_decimals' => array(
'default' => wc_get_price_decimals(),
'description' => __( 'Number of decimal points to use in each resource.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Register the routes for orders.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
array(
'args' => $this->get_endpoint_args(),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => $this->get_collection_params(),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => array_merge(
$this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
array(
'api_refund' => array(
'description' => __( 'When true, the payment gateway API is used to perform the refund. If the payment gateway does not support refunds, the refund will fail.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'edit' ),
'default' => false,
'sanitize_callback' => 'rest_sanitize_boolean',
),
'api_restock' => array(
'description' => __( 'When true, refunded items are restocked.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'edit' ),
'default' => false,
'sanitize_callback' => 'rest_sanitize_boolean',
),
)
),
),
'schema' => array( $this, 'get_public_item_schema' ),
)
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P[\d]+)',
array(
'schema' => array( $this, 'get_public_item_schema' ),
'args' => array_merge(
$this->get_endpoint_args(),
array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
),
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => $this->get_context_param( array( 'default' => 'view' ) ),
),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
),
)
);
}
/**
* Prepare links for the request.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @param WP_REST_Response $response Response object.
* @return array
*/
protected function prepare_links( $item, WP_REST_Request $request, WP_REST_Response $response ): array {
$links = array(
'self' => array(
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $item->get_id() ) ),
),
'collection' => array(
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
),
'up' => array(
'href' => rest_url( sprintf( '/%s/orders/%d', $this->namespace, $item->get_parent_id() ) ),
),
);
if ( $item->get_refunded_by() ) {
$links['refunded_by'] = array(
'href' => rest_url( sprintf( '/wp/v2/users/%d', $item->get_refunded_by() ) ),
'embeddable' => true,
);
}
return $links;
}
/**
* Prepare a single order object for response.
*
* @param WC_Order_Refund $refund Refund object.
* @param WP_REST_Request $request Request object.
* @return array
*/
protected function get_item_response( $refund, WP_REST_Request $request ): array {
return $this->item_schema->get_item_response( $refund, $request, $this->get_fields_for_response( $request ) );
}
/**
* Get a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
$refund = wc_get_order( (int) $request['id'] );
if ( ! $this->is_valid_refund_for_request( $refund ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
return $this->prepare_item_for_response( $refund, $request );
}
/**
* Get collection of refunds.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
$query_args = $this->collection_query->get_query_args( $request );
$results = $this->collection_query->get_query_results(
array_merge(
$query_args,
array(
'post_type' => $this->post_type,
'post_status' => array_keys( wc_get_order_statuses() ),
)
),
$request
);
$items = array();
foreach ( $results['results'] as $result ) {
$items[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $result, $request ) );
}
$pagination_util = new Pagination();
$response = $pagination_util->add_headers( rest_ensure_response( $items ), $request, $results['total'], $results['pages'] );
return $response;
}
/**
* Create a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
if ( ! empty( $request['id'] ) ) {
/* translators: %s: post type */
return $this->get_route_error_by_code( self::RESOURCE_EXISTS );
}
try {
$order = wc_get_order( $request['order_id'] );
if ( ! $order ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
// Validate request line_items before proceeding against the order being refunded.
$validation_error = $this->data_utils->validate_line_items( $request['line_items'], $order );
if ( is_wp_error( $validation_error ) ) {
return $this->get_route_error_response( $validation_error->get_error_code(), $validation_error->get_error_message() );
}
// Convert line items to internal format.
$line_item_data = $this->data_utils->convert_line_items_to_internal_format( $request['line_items'], $order );
$calculated_total = ! empty( $request['line_items'] ) ? $this->data_utils->calculate_refund_amount( $request['line_items'] ) : 0;
$refund_amount = ! empty( $request['amount'] ) ? $request['amount'] : $calculated_total;
if ( 0 > $refund_amount || ! $refund_amount ) {
return $this->get_route_error_response( 'invalid_refund_amount', __( 'Refund total must be greater than zero.', 'woocommerce' ) );
}
// Prevent under-refunding: amount cannot be less than calculated line items total.
// Over-refunding is allowed for goodwill/compensation scenarios.
if ( ! empty( $request['amount'] ) && $calculated_total > 0 && $refund_amount < $calculated_total ) {
return $this->get_route_error_response(
'invalid_refund_amount',
sprintf(
/* translators: %s: calculated total from line items */
__( 'Refund amount cannot be less than the total of line items (%s).', 'woocommerce' ),
wc_format_decimal( $calculated_total, 2 )
)
);
}
$refund = wc_create_refund(
array(
'order_id' => $order->get_id(),
'amount' => $refund_amount,
'reason' => $request['reason'],
'line_items' => $line_item_data,
'refund_payment' => $request['api_refund'],
'restock_items' => $request['api_restock'],
)
);
if ( ! $refund ) {
return $this->get_route_error_response( 'cannot_create_refund', __( 'Cannot create order refund.', 'woocommerce' ) );
}
if ( is_wp_error( $refund ) ) {
return $this->get_route_error_response( 'cannot_create_refund', $refund->get_error_message() );
}
if ( ! empty( $request['meta_data'] ) && is_array( $request['meta_data'] ) ) {
foreach ( $request['meta_data'] as $meta ) {
$refund->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
}
$refund->save_meta_data();
}
$this->update_additional_fields_for_object( $refund, $request );
/**
* Fires after a single object is created via the REST API.
*
* @param WC_Order_Refund $refund Inserted object.
* @param WP_REST_Request $request Request object.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'created', $refund, $request );
$request->set_param( 'context', 'edit' );
$response = $this->prepare_item_for_response( $refund, $request );
$response->set_status( WP_Http::CREATED );
$response->header( 'Location', rest_url( sprintf( '/%s/%s/%d', $this->namespace, $this->rest_base, $refund->get_id() ) ) );
return $response;
} catch ( \WC_Data_Exception $e ) {
return $this->get_route_error_response( $e->getErrorCode(), $e->getMessage() );
} catch ( \WC_REST_Exception $e ) {
return $this->get_route_error_response( $e->getErrorCode(), $e->getMessage() );
}
}
/**
* Delete a single item.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error
*/
public function delete_item( $request ) {
$refund = wc_get_order( (int) $request['id'] );
if ( ! $this->is_valid_refund_for_request( $refund ) ) {
return $this->get_route_error_by_code( self::INVALID_ID );
}
$request->set_param( 'context', 'edit' );
$response = new WP_REST_Response( null, 204 );
$result = $refund->delete( true );
if ( ! $result ) {
return $this->get_route_error_by_code( self::CANNOT_DELETE );
}
/**
* Fires after a single object is deleted or trashed via the REST API.
*
* @param WC_Order_Refund $refund The deleted object.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
* @since 10.2.0
*/
do_action( $this->get_hook_prefix() . 'deleted', $refund, $response, $request );
return $response;
}
/**
* Check if an order is valid.
*
* @param WC_Order_Refund $refund The refund object.
* @return bool True if the refund is valid, false otherwise.
*/
protected function is_valid_refund_for_request( $refund ): bool {
return $refund instanceof WC_Order_Refund && $refund->get_id() !== 0 && 'shop_order_refund' === $refund->get_type();
}
/**
* Check if a given request has access to read items.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'read' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to read an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'read', $request['id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to create an item.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|boolean
*/
public function create_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'create' ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
/**
* Check if a given request has access to delete an item.
*
* @param WP_REST_Request $request The request object.
* @return bool|WP_Error
*/
public function delete_item_permissions_check( $request ) {
if ( ! wc_rest_check_post_permissions( $this->post_type, 'delete', $request['id'] ) ) {
return $this->get_authentication_error_by_method( $request->get_method() );
}
return true;
}
}
PK [1]~'8K K - RestApi/Routes/V4/Refunds/CollectionQuery.phpnu array(
'description' => __( 'Filter refunds by order ID.', 'woocommerce' ),
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'page' => array(
'description' => __( 'Current page of the collection.', 'woocommerce' ),
'type' => 'integer',
'default' => 1,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
'minimum' => 1,
),
'per_page' => array(
'description' => __( 'Maximum number of items to be returned in result set.', 'woocommerce' ),
'type' => 'integer',
'default' => 10,
'minimum' => 1,
'maximum' => 100,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'order' => array(
'description' => __( 'Order sort attribute ascending or descending.', 'woocommerce' ),
'type' => 'string',
'default' => 'desc',
'enum' => array( 'asc', 'desc' ),
'validate_callback' => 'rest_validate_request_arg',
),
'orderby' => array(
'description' => __( 'Sort collection by object attribute.', 'woocommerce' ),
'type' => 'string',
'default' => 'date',
'enum' => array(
'date',
'id',
'include',
'title',
'slug',
'modified',
'total',
),
'validate_callback' => 'rest_validate_request_arg',
),
'after' => array(
'description' => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg',
),
'before' => array(
'description' => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'woocommerce' ),
'type' => 'string',
'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg',
),
'dates_are_gmt' => array(
'description' => __( 'Whether to consider GMT post dates when limiting response by published or modified date.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Prepares query args.
*
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_args( WP_REST_Request $request ): array {
$args = array(
'order' => $request['order'],
'orderby' => $request['orderby'],
'page' => $request['page'],
'posts_per_page' => $request['per_page'],
);
if ( 'date' === $args['orderby'] ) {
$args['orderby'] = 'date ID';
}
$date_query = array();
$use_gmt = $request['dates_are_gmt'];
if ( isset( $request['before'] ) ) {
$date_query[] = array(
'column' => $use_gmt ? 'post_date_gmt' : 'post_date',
'before' => $request['before'],
);
}
if ( isset( $request['after'] ) ) {
$date_query[] = array(
'column' => $use_gmt ? 'post_date_gmt' : 'post_date',
'after' => $request['after'],
);
}
if ( ! empty( $date_query ) ) {
$date_query['relation'] = 'AND';
$args['date_query'] = $date_query;
}
$order_id = absint( $request['order_id'] ?? 0 );
if ( $order_id ) {
$args['post_parent__in'] = array( $order_id );
}
return $args;
}
/**
* Get results of the query.
*
* @param array $query_args The query arguments from prepare_query().
* @param WP_REST_Request $request The request object.
* @return array
*/
public function get_query_results( array $query_args, WP_REST_Request $request ): array {
$query = new WC_Order_Query(
array_merge(
$query_args,
array(
'paginate' => true,
)
)
);
$results = $query->get_orders();
return array(
'results' => $results->orders,
'total' => $results->total,
'pages' => $results->max_num_pages,
);
}
}
PK [1]i[ ' RestApi/Routes/V4/Refunds/DataUtils.phpnu [
* "qty" => 1,
* "refund_total" => 123,
* "refund_tax" => [
* 1 => 123,
* 2 => 456,
* ],
* ]
*
* @param array $line_items The line items to convert.
* @param WC_Order $order The order being refunded.
* @return array The converted line items.
*/
public function convert_line_items_to_internal_format( $line_items, WC_Order $order ) {
$prepared_line_items = array();
foreach ( $line_items as $line_item ) {
if ( ! isset( $line_item['line_item_id'], $line_item['quantity'], $line_item['refund_total'] ) ) {
continue;
}
// If no explicit refund_tax provided, extract tax from refund_total using WC_Tax.
if ( ! isset( $line_item['refund_tax'] ) ) {
$original_item = $order->get_item( $line_item['line_item_id'] );
if ( $original_item ) {
$original_taxes = $original_item->get_taxes();
$tax_ids = array_keys( $original_taxes['total'] ?? array() );
if ( ! empty( $tax_ids ) ) {
$tax_rates = $this->build_tax_rates_array( $order, $tax_ids );
// Always assume refund_total includes tax - extract it using WC_Tax.
$calculated_taxes = WC_Tax::calc_inclusive_tax(
(float) $line_item['refund_total'],
$tax_rates
);
$line_item['refund_tax'] = $this->convert_proportional_taxes_to_schema_format(
$calculated_taxes
);
// Subtract extracted tax from refund_total to get the amount excluding tax.
$total_tax = array_sum( $calculated_taxes );
$line_item['refund_total'] = $line_item['refund_total'] - $total_tax;
}
}
}
$prepared_line_items[ $line_item['line_item_id'] ] = array(
'qty' => $line_item['quantity'],
'refund_total' => $line_item['refund_total'],
'refund_tax' => $this->convert_line_item_taxes_to_internal_format( $line_item['refund_tax'] ?? array() ),
);
}
return $prepared_line_items;
}
/**
* Convert line item taxes (schema format) to internal format. This keys arrays by tax ID and has some different naming
*
* @param array $line_item_taxes The taxes to convert.
* @return array The converted taxes.
*/
private function convert_line_item_taxes_to_internal_format( $line_item_taxes ) {
$prepared_taxes = array();
foreach ( $line_item_taxes as $line_item_tax ) {
if ( ! isset( $line_item_tax['id'], $line_item_tax['refund_total'] ) ) {
continue;
}
$prepared_taxes[ $line_item_tax['id'] ] = $line_item_tax['refund_total'];
}
return $prepared_taxes;
}
/**
* Calculate the refund amount from line items.
*
* @param array $line_items The line items to calculate the refund amount from.
* @return float|null The refund amount, or null if it can't be calculated.
*/
public function calculate_refund_amount( array $line_items ): ?float {
if ( empty( $line_items ) ) {
return null;
}
$amount = 0;
foreach ( $line_items as $line_item ) {
if ( ! empty( $line_item['refund_total'] ) && is_numeric( $line_item['refund_total'] ) ) {
$amount += $line_item['refund_total'];
}
if ( ! empty( $line_item['refund_tax'] ) && is_array( $line_item['refund_tax'] ) ) {
foreach ( $line_item['refund_tax'] as $tax ) {
if ( ! empty( $tax['refund_total'] ) && is_numeric( $tax['refund_total'] ) ) {
$amount += $tax['refund_total'];
}
}
}
}
return $amount;
}
/**
* Validate line items (schema format) before conversion to internal format.
*
* @param array $line_items The line items to validate.
* @param WC_Order $order The order object.
* @return boolean|WP_Error
*/
public function validate_line_items( $line_items, WC_Order $order ) {
foreach ( $line_items as $line_item ) {
$line_item_id = $line_item['line_item_id'] ?? null;
if ( ! $line_item_id ) {
return new WP_Error( 'invalid_line_item', __( 'Line item ID is required.', 'woocommerce' ) );
}
$item = $order->get_item( $line_item_id );
// Validate item exists and belongs to the order.
if ( ! $item || $item->get_order_id() !== $order->get_id() ) {
return new WP_Error( 'invalid_line_item', __( 'Line item not found.', 'woocommerce' ) );
}
if ( ! $item instanceof \WC_Order_Item_Product && ! $item instanceof \WC_Order_Item_Fee && ! $item instanceof \WC_Order_Item_Shipping ) {
return new WP_Error( 'invalid_line_item', __( 'Line item is not a product, fee, or shipping line.', 'woocommerce' ) );
}
// Validate item quantity is not greater than the item quantity.
if ( $item->get_quantity() < $line_item['quantity'] ) {
/* translators: %s: item quantity */
return new WP_Error( 'invalid_line_item', sprintf( __( 'Line item quantity cannot be greater than the item quantity (%s).', 'woocommerce' ), $item->get_quantity() ) );
}
// Validate refund total is not greater than the item total (including tax).
$item_total_with_tax = $item->get_total() + $item->get_total_tax();
if ( $item_total_with_tax < $line_item['refund_total'] ) {
return new WP_Error(
'invalid_refund_amount',
sprintf(
/* translators: %s: item total with tax */
__( 'Refund total cannot be greater than the line item total including tax (%s).', 'woocommerce' ),
$item_total_with_tax
)
);
}
if ( isset( $line_item['refund_tax'] ) ) {
$item_taxes = $item->get_taxes();
if ( $item_taxes ) {
$allowed_tax_ids = array_keys( $item_taxes['total'] ?? array() );
foreach ( $line_item['refund_tax'] as $refund_tax ) {
if ( ! isset( $refund_tax['id'], $refund_tax['refund_total'] ) ) {
return new WP_Error( 'invalid_line_item', __( 'Tax id and refund_total are required.', 'woocommerce' ) );
}
$tax_id = $refund_tax['id'];
$tax_refund_total = $refund_tax['refund_total'];
if ( ! in_array( $tax_id, $allowed_tax_ids, true ) ) {
return new WP_Error(
'invalid_line_item',
sprintf(
/* translators: %s: tax IDs */
__( 'Line item tax not found. Must be: %s.', 'woocommerce' ),
implode( ', ', $allowed_tax_ids )
)
);
}
if ( $item_taxes['total'][ $tax_id ] < $tax_refund_total ) {
return new WP_Error(
'invalid_refund_amount',
sprintf(
/* translators: %s: tax total */
__( 'Refund tax total cannot be greater than the line item tax total (%s).', 'woocommerce' ),
$item_taxes['total'][ $tax_id ]
)
);
}
}
}
}
}
return true;
}
/**
* Convert calculated taxes (internal format) to schema format.
*
* @param array $calculated_taxes Taxes keyed by tax ID with amounts.
* @return array Schema format with id and refund_total keys.
*/
private function convert_proportional_taxes_to_schema_format( array $calculated_taxes ): array {
$result = array();
foreach ( $calculated_taxes as $tax_id => $amount ) {
$result[] = array(
'id' => (int) $tax_id,
'refund_total' => $amount,
);
}
return $result;
}
/**
* Build tax rate array from order tax items for use with WC_Tax calculations.
*
* @param WC_Order $order The order.
* @param array $tax_ids Array of tax rate IDs that apply to an item.
* @return array Tax rates array formatted for WC_Tax::calc_*_tax() methods.
*/
private function build_tax_rates_array( WC_Order $order, array $tax_ids ): array {
$tax_rates = array();
$tax_items = $order->get_items( 'tax' );
foreach ( $tax_ids as $tax_id ) {
foreach ( $tax_items as $tax_item ) {
if ( $tax_item->get_rate_id() === (int) $tax_id ) {
$tax_rates[ $tax_id ] = array(
'rate' => $tax_item->get_rate_percent(),
'label' => $tax_item->get_label(),
'compound' => $tax_item->is_compound() ? 'yes' : 'no',
);
break;
}
}
}
return $tax_rates;
}
}
PK [1]3JVO% O% ' ComingSoon/ComingSoonRequestHandler.phpnu coming_soon_helper = $coming_soon_helper;
// Hook into plugins_loaded to ensure features are initialized to determine coming soon status.
add_action(
'plugins_loaded',
function () {
// Skip if the site is live.
if ( $this->coming_soon_helper->is_site_live() ) {
return;
}
add_filter( 'template_include', array( $this, 'handle_template_include' ) );
add_filter( 'wp_theme_json_data_theme', array( $this, 'experimental_filter_theme_json_theme' ) );
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_styles' ) );
add_action( 'after_setup_theme', array( $this, 'possibly_init_block_templates' ), 999 );
}
);
}
/**
* Initializes block templates so we can show coming soon page in non-FSE themes.
*/
public function possibly_init_block_templates() {
// No need to initialize block templates since we've already initialized them in the Block Bootstrap.
if ( wp_is_block_theme() || current_theme_supports( 'block-template-parts' ) ) {
return;
}
$container = BlocksPackage::container();
$container->get( BlockTemplatesRegistry::class )->init();
$container->get( BlockTemplatesController::class )->init();
}
/**
* Replaces the page template with a 'coming soon' when the site is in coming soon mode.
*
* @internal
*
* @param string $template The path to the previously determined template.
* @return string The path to the 'coming soon' template or any empty string to prevent further template loading in FSE themes.
*/
public function handle_template_include( $template ) {
if ( ! $this->should_show_coming_soon() ) {
return $template;
}
// A coming soon page needs to be displayed. Set a short cache duration to prevents ddos attacks.
header( 'Cache-Control: max-age=60' );
$is_fse_theme = wp_is_block_theme();
$is_store_coming_soon = $this->coming_soon_helper->is_store_coming_soon();
add_theme_support( 'block-templates' );
$coming_soon_template = get_query_template( 'coming-soon' );
if ( ! $is_fse_theme && $is_store_coming_soon ) {
get_header();
}
add_action(
'wp_head',
function () {
echo "";
}
);
if ( ! empty( $coming_soon_template ) && file_exists( $coming_soon_template ) ) {
if ( ! $is_fse_theme && $is_store_coming_soon && function_exists( 'get_the_block_template_html' ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo get_the_block_template_html();
} else {
include $coming_soon_template;
}
}
if ( ! $is_fse_theme && $is_store_coming_soon ) {
get_footer();
}
if ( $is_fse_theme ) {
// Since we've already rendered a template, return empty string to ensure no other template is rendered.
return '';
} else {
// In non-FSE themes, other templates will still be rendered.
// We need to exit to prevent further processing.
exit();
}
}
/**
* Determines whether the coming soon screen should be shown.
*
* @return bool
*/
private function should_show_coming_soon() {
// Early exit if already determined that the coming soon screen should be shown.
if ( self::$show_coming_soon ) {
return true;
}
// Early exit if LYS feature is disabled.
if ( ! Features::is_enabled( 'launch-your-store' ) ) {
return false;
}
// Early exit if the user is logged in as administrator / shop manager.
if ( current_user_can( 'manage_woocommerce' ) ) {
return false;
}
// Do not show coming soon on 404 pages when applied to store pages only.
if ( $this->coming_soon_helper->is_store_coming_soon() && is_404() ) {
return false;
}
// Early exit if the current page doesn't need a coming soon screen.
if ( ! $this->coming_soon_helper->is_current_page_coming_soon() ) {
return false;
}
/**
* Check if there is an exclusion.
*
* @since 9.1.0
*
* @param bool $is_excluded If the request should be excluded from Coming soon mode. Defaults to false.
*/
if ( apply_filters( 'woocommerce_coming_soon_exclude', false ) ) {
return false;
}
// Check if the private link option is enabled.
if ( get_option( 'woocommerce_private_link' ) === 'yes' ) {
// Exclude users with a private link.
if ( isset( $_GET['woo-share'] ) && get_option( 'woocommerce_share_key' ) === $_GET['woo-share'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
// Persist the share link with a cookie for 90 days.
setcookie( 'woo-share', sanitize_text_field( wp_unslash( $_GET['woo-share'] ) ), time() + 60 * 60 * 24 * 90, '/' ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
return false;
}
if ( isset( $_COOKIE['woo-share'] ) && get_option( 'woocommerce_share_key' ) === $_COOKIE['woo-share'] ) {
return false;
}
}
self::$show_coming_soon = true;
return true;
}
/**
* Filters the theme.json data to add Coming Soon fonts.
* This runs after child theme merging to ensure parent theme fonts are included.
*
* @param WP_Theme_JSON_Data $theme_json The theme json data object.
* @return WP_Theme_JSON_Data The filtered theme json data.
*/
public function experimental_filter_theme_json_theme( $theme_json ) {
if ( ! Features::is_enabled( 'launch-your-store' ) ) {
return $theme_json;
}
$theme_data = $theme_json->get_data();
$font_data = $theme_data['settings']['typography']['fontFamilies']['theme'] ?? array();
// Check if the current theme is a child theme. And if so, merge the parent theme fonts with the existing fonts.
if ( wp_get_theme()->parent() ) {
$parent_theme = wp_get_theme()->parent();
$parent_theme_json_file = $parent_theme->get_file_path( 'theme.json' );
if ( is_readable( $parent_theme_json_file ) ) {
$parent_theme_json_data = json_decode( file_get_contents( $parent_theme_json_file ), true ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
if ( isset( $parent_theme_json_data['settings']['typography']['fontFamilies'] ) ) {
$parent_fonts = $parent_theme_json_data['settings']['typography']['fontFamilies'];
// Merge parent theme fonts with existing fonts.
foreach ( $parent_fonts as $parent_font ) {
$found = false;
foreach ( $font_data as $existing_font ) {
if ( isset( $parent_font['name'] ) && isset( $existing_font['name'] ) &&
$parent_font['name'] === $existing_font['name'] ) {
$found = true;
break;
}
}
if ( ! $found ) {
$font_data[] = $parent_font;
}
}
}
}
}
$fonts_to_add = array(
array(
'fontFamily' => '"Inter", sans-serif',
'name' => 'Inter',
'slug' => 'inter',
'fontFace' => array(
array(
'fontFamily' => 'Inter',
'fontStretch' => 'normal',
'fontStyle' => 'normal',
'fontWeight' => '300 900',
'src' => array( WC()->plugin_url() . '/assets/fonts/Inter-VariableFont_slnt,wght.woff2' ),
),
),
),
array(
'fontFamily' => 'Cardo',
'name' => 'Cardo',
'slug' => 'cardo',
'fontFace' => array(
array(
'fontFamily' => 'Cardo',
'fontStyle' => 'normal',
'fontWeight' => '400',
'src' => array( WC()->plugin_url() . '/assets/fonts/cardo_normal_400.woff2' ),
),
),
),
);
// Add WooCommerce fonts if they don't already exist.
foreach ( $fonts_to_add as $font_to_add ) {
$found = false;
foreach ( $font_data as $font ) {
if ( isset( $font['name'] ) && $font['name'] === $font_to_add['name'] ) {
$found = true;
break;
}
}
if ( ! $found ) {
$font_data[] = $font_to_add;
}
}
$new_data = array(
'version' => 1,
'settings' => array(
'typography' => array(
'fontFamilies' => array(
'theme' => $font_data,
),
),
),
);
$theme_json->update_with( $new_data );
return $theme_json;
}
/**
* Enqueues the coming soon banner styles.
*/
public function enqueue_styles() {
// Early exit if the user is not logged in as administrator / shop manager.
if ( ! current_user_can( 'manage_woocommerce' ) ) {
return;
}
// Early exit if LYS feature is disabled.
if ( ! Features::is_enabled( 'launch-your-store' ) ) {
return;
}
if ( $this->coming_soon_helper->is_site_live() ) {
return;
}
wp_enqueue_style(
'woocommerce-coming-soon',
WC()->plugin_url() . '/assets/css/coming-soon' . ( is_rtl() ? '-rtl' : '' ) . '.css',
array(),
Constants::get_constant( 'WC_VERSION' )
);
}
}
PK [1].KŌ ) ComingSoon/ComingSoonCacheInvalidator.phpnu $cart_page_id,
'post_status' => 'publish',
)
);
}
}
}
PK [1]; & ComingSoon/ComingSoonAdminBarBadge.phpnu __( 'Coming soon', 'woocommerce' ),
'store-coming-soon' => __( 'Store coming soon', 'woocommerce' ),
'live' => __( 'Live', 'woocommerce' ),
);
if ( get_option( 'woocommerce_coming_soon' ) === 'yes' ) {
if ( get_option( 'woocommerce_store_pages_only' ) === 'yes' ) {
$key = 'store-coming-soon';
} else {
$key = 'coming-soon';
}
} else {
$key = 'live';
}
$args = array(
'id' => 'woocommerce-site-visibility-badge',
'title' => $labels[ $key ],
'href' => admin_url( 'admin.php?page=wc-settings&tab=site-visibility' ),
'meta' => array(
'class' => 'woocommerce-site-status-badge-' . $key,
),
);
$wp_admin_bar->add_node( $args );
}
/**
* Output CSS for site visibility badge.
*
* @internal
*/
public function output_css() {
// Early exit if LYS feature is disabled.
if ( ! FeaturesUtil::feature_is_enabled( 'site_visibility_badge' ) ) {
return;
}
if ( is_admin_bar_showing() ) {
echo '';
}
}
}
PK [1] f f ComingSoon/ComingSoonHelper.phpnu is_site_live() ) {
return false;
}
if ( $this->is_site_coming_soon() ) {
return true;
}
// Check the current page is a store page when in "store coming soon" mode.
if ( $this->is_store_coming_soon() && WCAdminHelper::is_current_page_store_page() ) {
return true;
}
// Default to false.
return false;
}
}
PK [1]cOb% % 5 AddressProvider/AbstractAutomatticAddressProvider.phpnu branding_html = 'Powered by ';
}
/**
* Get the JWT for the address service, a service should implement an A8C hosted API or some mechanism to get a JWT, this will be passed to frontend code to be used in the address autocomplete and maps.
*
* This method shouldn't implement any caching, it should only fetch the token or throw an exception, if you must handle caching, consider also overriding get_jwt.
*
* @return string The JWT for the address service.
*/
abstract public function get_address_service_jwt();
/**
* Get the telemetry status for the address service, this is meant to be overridden by the implementor to return true if the service has permission to send telemetry data.
*
* @return bool The telemetry status for the address service.
*/
public function can_telemetry() {
return false;
}
/**
* Loads up a JWT from cache or from the implementor side.
*
* @return void
*
* phpcs:ignore Squiz.Commenting.FunctionCommentThrowTag.Missing -- As we wrap the throw in a try/catch.
*/
public function load_jwt() {
// If the address autocomplete is disabled, we don't load the JWT.
if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) !== true ) {
return;
}
// If we already have a loaded, valid token, we return early.
if ( $this->jwt && is_string( $this->jwt ) && JsonWebToken::shallow_validate( $this->jwt ) ) {
return;
}
$cached_jwt = $this->get_cached_option( 'address_autocomplete_jwt' );
// If we have a cached, valid token, we load it to class and return early.
if ( $cached_jwt && is_string( $cached_jwt ) && JsonWebToken::shallow_validate( $cached_jwt ) ) {
$this->jwt = $cached_jwt;
return;
}
$retry_data = $this->get_cached_option( 'jwt_retry_data' );
if ( $retry_data && isset( $retry_data['try_after'] ) && $retry_data['try_after'] > time() ) {
return;
}
try {
$fresh_jwt = $this->get_address_service_jwt();
if ( $fresh_jwt && is_string( $fresh_jwt ) && JsonWebToken::shallow_validate( $fresh_jwt ) ) {
$this->set_jwt( $fresh_jwt );
// Clear retry data on success.
$this->delete_cached_option( 'jwt_retry_data' );
return;
} else {
throw new \Exception( 'Invalid JWT received from address service.' );
}
} catch ( \Exception $e ) {
$retry_data['attempts'] = isset( $retry_data['attempts'] ) ? $retry_data['attempts'] + 1 : 1;
wc_get_logger()->error(
sprintf(
'Failed loading JWT for %1$s address autocomplete service (attempt %2$d) with error %3$s.',
$this->name,
$retry_data['attempts'],
$e->getMessage()
),
'address-autocomplete'
);
$backoff_hours = pow( 2, $retry_data['attempts'] - 1 ); // 1, 2, 4, 8 hours.
$retry_data['try_after'] = time() + ( $backoff_hours * HOUR_IN_SECONDS );
$this->update_cached_option( 'jwt_retry_data', $retry_data, DAY_IN_SECONDS );
}
}
/**
* Gets the JWT for the address service.
*
* @return string The JWT for the address service.
*/
public function get_jwt() {
if ( null === $this->jwt ) {
$this->load_jwt();
}
return $this->jwt;
}
/**
* Sets the JWT for the address service.
*
* @param string $jwt The JWT for the address service.
*/
public function set_jwt( $jwt ) {
$this->jwt = $jwt;
if ( null !== $jwt ) {
$cache_duration = $this->get_jwt_cache_duration( $jwt );
// If the token is expired, we don't cache it and we fetch a new one.
if ( 0 === $cache_duration ) {
$this->jwt = null;
$this->load_jwt();
return;
}
$this->update_cached_option( 'address_autocomplete_jwt', $jwt, $cache_duration );
} else {
$this->delete_cached_option( 'address_autocomplete_jwt' );
}
}
/**
* Gets the cache duration for the JWT.
*
* @param string $jwt The JWT for the address service.
* @return int The cache duration for the JWT.
*/
public function get_jwt_cache_duration( $jwt ) {
$parts = JsonWebToken::get_parts( $jwt );
if ( property_exists( $parts->payload, 'exp' ) ) {
return max( $parts->payload->exp - time(), 0 );
}
}
/**
* Deletes the cached token if we disable the autocomplete service or fetches a new one if it's enabled.
*
* @param string $setting If the service is enabled or disabled.
* @return string the setting value.
*/
public function refresh_cache( $setting ) {
if ( wc_string_to_bool( $setting ) ) {
$this->load_jwt();
} else {
$this->set_jwt( null );
}
return $setting;
}
/**
* Gets the cached option.
*
* @param string $key The key of the option.
* @return mixed|null The cached option.
*/
private function get_cached_option( $key ) {
$data = get_option( $this->id . '_' . $key );
if ( is_array( $data ) && isset( $data['data'] ) ) {
if ( ! self::is_expired( $data ) ) {
return $data['data'];
}
$this->delete_cached_option( $key );
}
return null;
}
/**
* Updates the cached option.
*
* @param string $key The key of the option.
* @param mixed $value The value of the option.
* @param int $ttl The TTL of the option.
*/
private function update_cached_option( $key, $value, $ttl = DAY_IN_SECONDS ) {
$result = update_option(
$this->id . '_' . $key,
array(
'data' => $value,
'updated' => time(),
'ttl' => $ttl,
),
false
);
if ( false === $result ) {
wp_cache_delete( $this->id . '_' . $key, 'options' );
}
}
/**
* Deletes the cached option.
*
* @param string $key The key of the option.
*/
private function delete_cached_option( $key ) {
if ( delete_option( $this->id . '_' . $key ) ) {
wp_cache_delete( $this->id . '_' . $key, 'options' );
}
}
/**
* Checks if the cache value is expired.
*
* @param array $cache_contents The cache contents.
*
* @return boolean True if the contents are expired. False otherwise.
*/
private static function is_expired( $cache_contents ) {
if ( ! is_array( $cache_contents ) || ! isset( $cache_contents['updated'] ) || ! isset( $cache_contents['ttl'] ) ) {
// Treat bad/invalid cache contents as expired.
return true;
}
// Double-check that we have integers for `updated` and `ttl`.
if ( ! is_int( $cache_contents['updated'] ) || ! is_int( $cache_contents['ttl'] ) ) {
return true;
}
$expires = $cache_contents['updated'] + $cache_contents['ttl'];
$now = time();
return $expires < $now;
}
/**
* Return asset URL, copied from WC_Frontend_Scripts::get_asset_url.
*
* @param string $path Assets path.
* @return string
*/
public static function get_asset_url( $path ) {
/**
* Filters the asset URL.
*
* @since 3.2.0
*
* @param string $url The asset URL.
* @param string $path The asset path.
* @return string The filtered asset URL.
*/
return apply_filters( 'woocommerce_get_asset_url', plugins_url( $path, Constants::get_constant( 'WC_PLUGIN_FILE' ) ), $path );
}
/**
* Enqueues the checkout script, checks if it's already registered or not so we don't duplicate, and prints out the JWT to the page to be consumed.
*/
public function load_scripts() {
// If the address autocomplete setting is disabled, don't load the scripts.
if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) !== true ) {
return;
}
if ( ! is_checkout() ) {
return;
}
if ( ! $this->get_jwt() ) {
return;
}
$suffix = Constants::is_true( 'SCRIPT_DEBUG' ) ? '' : '.min';
$version = Constants::get_constant( 'WC_VERSION' );
if ( ! wp_script_is( 'a8c-address-autocomplete-service', 'registered' ) ) {
wp_register_script( 'a8c-address-autocomplete-service', self::get_asset_url( 'assets/js/frontend/a8c-address-autocomplete-service' . $suffix . '.js' ), array( 'wc-address-autocomplete' ), $version, array( 'strategy' => 'defer' ) );
}
if ( ! wp_script_is( 'a8c-address-autocomplete-service', 'enqueued' ) ) {
wp_enqueue_script( 'a8c-address-autocomplete-service' );
}
wp_add_inline_script(
'a8c-address-autocomplete-service',
sprintf(
'var a8cAddressAutocompleteServiceKeys = a8cAddressAutocompleteServiceKeys || {}; a8cAddressAutocompleteServiceKeys[ %1$s ] = { key: %2$s, canTelemetry: %3$s };',
wp_json_encode( $this->id, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( $this->get_jwt(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( false !== $this->can_telemetry() && (bool) $this->can_telemetry(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
),
'before'
);
}
}
PK [1]* - AddressProvider/AddressProviderController.phpnu preferred_provider_option = get_option( 'woocommerce_address_autocomplete_provider', '' );
$this->providers = $this->get_registered_providers();
}
/**
* Get the registered providers.
*
* @return WC_Address_Provider[] array of WC_Address_Providers.
*/
public function get_providers(): array {
return $this->providers;
}
/**
* Get all registered providers.
*
* @return WC_Address_Provider[] array of WC_Address_Providers.
*/
private function get_registered_providers(): array {
/**
* Filter the registered address providers.
*
* @since 9.9.0
* @param array $providers Array of fully qualified class names (strings) or WC_Address_Provider instances.
* Class names will be instantiated automatically.
* Example: array( 'My_Provider_Class', new My_Other_Provider() )
*/
$provider_items = apply_filters( 'woocommerce_address_providers', array() );
// The filter returned nothing but an empty array, so we can skip the rest of the function.
if ( empty( $provider_items ) && is_array( $provider_items ) ) {
return array();
}
$logger = wc_get_logger();
if ( ! is_array( $provider_items ) ) {
$logger->error(
'Invalid return value for woocommerce_address_providers, expected an array of class names or instances.',
array(
'context' => 'address_provider_service',
)
);
return array();
}
$providers = array();
$seen_ids = array();
foreach ( $provider_items as $provider_item ) {
if ( is_string( $provider_item ) && class_exists( $provider_item ) ) {
$provider_item = new $provider_item();
}
// Providers need to be valid and extend WC_Address_Provider.
if ( ! is_a( $provider_item, WC_Address_Provider::class ) ) {
$logger->error(
sprintf(
'Invalid address provider item "%s", expected a string class name or WC_Address_Provider instance.',
is_object( $provider_item ) ? get_class( $provider_item ) : gettype( $provider_item )
),
array(
'context' => 'address_provider_service',
)
);
continue;
}
// Validate the instance has the necessary properties.
if ( empty( $provider_item->id ) || empty( $provider_item->name ) ) {
$logger->error(
'Invalid address provider instance, id or name property is missing or empty: ' . get_class( $provider_item ),
array(
'context' => 'address_provider_service',
)
);
continue;
}
// Check for duplicate IDs.
if ( isset( $seen_ids[ $provider_item->id ] ) ) {
$logger->error(
sprintf(
'Duplicate provider ID found. ID "%s" is used by both %s and %s.',
$provider_item->id,
$seen_ids[ $provider_item->id ],
get_class( $provider_item )
),
array(
'context' => 'address_provider_service',
)
);
continue;
}
// Track the ID and its provider class for error reporting.
$seen_ids[ $provider_item->id ] = get_class( $provider_item );
// Add the provider instance to the array after all checks are completed.
$providers[] = $provider_item;
}
if ( ! empty( $this->preferred_provider_option ) && ! empty( $providers ) ) {
// Look for the preferred provider in the array.
foreach ( $providers as $key => $provider ) {
if ( $provider->id === $this->preferred_provider_option ) {
// Found the preferred provider, move it to the beginning of the array.
$preferred_provider = $provider;
unset( $providers[ $key ] );
array_unshift( $providers, $preferred_provider );
break;
}
}
}
return $providers;
}
/**
* Check if a specific provider is registered and available.
*
* @param string $provider_id The provider ID to check.
* @return bool
*/
public function is_provider_available( string $provider_id ): bool {
foreach ( $this->providers as $provider ) {
if ( $provider->id === $provider_id ) {
return true;
}
}
return false;
}
/**
* Get the preferred provider; this is what was selected in the WooCommerce "preferred provider" setting *or* the
* first registered provider if no preference was set. If the provider selected in WC Settings is not registered
* anymore, it will fall back to the first registered provider. Any other case will return an empty string.
*
* @return string
*/
public function get_preferred_provider(): string {
if ( $this->is_provider_available( $this->preferred_provider_option ) ) {
return $this->preferred_provider_option;
}
// Get the first provider's ID.
return $this->providers[0]->id ?? '';
}
}
PK [1]lɭ Customers/SearchService.phpnu get_col(
$wpdb->prepare(
"SELECT DISTINCT customer_id FROM %i WHERE billing_email IN ($placeholders)",
OrdersTableDataStore::get_orders_table_name(),
...$emails
)
);
// phpcs:enable
if ( array() === $include_user_ids ) {
return array();
}
}
$users_query = new \WP_User_Query(
array(
'fields' => 'ID',
'include' => $include_user_ids,
'meta_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'key' => 'billing_email',
'value' => $emails,
'compare' => 'IN',
),
),
)
);
return array_map( 'intval', array_unique( $users_query->get_results() ) );
}
}
PK [1]ypr # Agentic/Enums/Specs/MessageType.phpnu namespace;
}
/**
* Register the routes for order statuses.
*/
public function register_routes() {
register_rest_route(
$this->get_rest_api_namespace(),
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => '__return_true',
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Get all order statuses.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( WP_REST_Request $request ) {
$order_statuses = wc_get_order_statuses();
$formatted_statuses = array();
foreach ( $order_statuses as $status_slug => $status_name ) {
$slug = str_replace( 'wc-', '', $status_slug );
$formatted_statuses[] = array(
'slug' => $slug,
'name' => wc_get_order_status_name( $slug ),
);
}
if ( ! $formatted_statuses ) {
return new WP_Error( 'woocommerce_rest_not_found', __( 'Order statuses not found', 'woocommerce' ), array( 'status' => 404 ) );
}
return rest_ensure_response( $formatted_statuses );
}
/**
* Get the order status schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'order_status',
'type' => 'object',
'properties' => array(
'slug' => array(
'description' => __( 'Order status slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Order status name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
),
);
return $schema;
}
}
PK [1]9 Orders/CardIcons/jcb.svgnu
PK [1]D8n0 n0 Orders/CardIcons/mastercard.svgnu
PK [1]B Orders/CardIcons/diners.svgnu
PK [1]z:{ { Orders/CardIcons/unknown.svgnu PK [1]d Orders/CardIcons/visa.svgnu
PK [1]b} Orders/CardIcons/interac.svgnu PK [1]( ( Orders/CardIcons/amex.svgnu
PK [1] P P Orders/CardIcons/discover.svgnu
PK [1]1 K Orders/IppFunctions.phpnu get_status(), array( 'pending', 'on-hold', 'processing' ), true );
$has_payment_method = in_array( $order->get_payment_method(), array( WC_Gateway_COD::ID, 'woocommerce_payments', 'none' ), true );
$order_is_not_paid = null === $order->get_date_paid();
$order_is_not_refunded = empty( $order->get_refunds() );
$order_has_no_subscription_products = true;
foreach ( $order->get_items() as $item ) {
$product = $item->get_product();
if ( is_object( $product ) && $product->is_type( 'subscription' ) ) {
$order_has_no_subscription_products = false;
break;
}
}
return $has_status && $has_payment_method && $order_is_not_paid && $order_is_not_refunded && $order_has_no_subscription_products;
}
/**
* Returns if store is eligible to accept In-Person Payments.
*
* @return bool true if store is eligible, false otherwise
*/
public static function is_store_in_person_payment_eligible(): bool {
$is_store_usa_based = self::has_store_specified_country_currency( 'US', 'USD' );
$is_store_canada_based = self::has_store_specified_country_currency( 'CA', 'CAD' );
return $is_store_usa_based || $is_store_canada_based;
}
/**
* Checks if the store has specified country location and currency used.
*
* @param string $country country to compare store's country with.
* @param string $currency currency to compare store's currency with.
*
* @return bool true if specified country and currency match the store's ones. false otherwise
*/
public static function has_store_specified_country_currency( string $country, string $currency ): bool {
return ( WC()->countries->get_base_country() === $country && get_woocommerce_currency() === $currency );
}
}
PK [1]x x + Orders/OrderAttributionBlocksController.phpnu extend_schema = $extend_schema;
$this->features_controller = $features_controller;
$this->order_attribution_controller = $order_attribution_controller;
}
/**
* Register this class instance to the appropriate hooks.
*
* @return void
*/
public function register() {
add_action( 'init', array( $this, 'on_init' ) );
}
/**
* Hook into WordPress on init.
*/
public function on_init() {
// Bail if the feature is not enabled.
if ( ! $this->features_controller->feature_is_enabled( 'order_attribution' ) ) {
return;
}
$this->extend_api();
}
/**
* Extend the Store API.
*
* @return void
*/
private function extend_api() {
$this->extend_schema->register_endpoint_data(
array(
'endpoint' => CheckoutSchema::IDENTIFIER,
'namespace' => 'woocommerce/order-attribution',
'schema_callback' => $this->get_schema_callback(),
)
);
// Update order based on extended data.
add_action(
'woocommerce_store_api_checkout_update_order_from_request',
function ( $order, $request ) {
$extensions = $request->get_param( 'extensions' );
$params = $extensions['woocommerce/order-attribution'] ?? array();
if ( empty( $params ) ) {
return;
}
// Check if this order already has any attribution data to prevent duplicates attribution data.
if ( $this->order_attribution_controller->has_attribution( $order ) ) {
return;
}
/**
* Run an action to save order attribution data.
*
* @since 8.5.0
*
* @param WC_Order $order The order object.
* @param array $params Unprefixed order attribution data.
*/
do_action( 'woocommerce_order_save_attribution_data', $order, $params );
},
10,
2
);
}
/**
* Get the schema callback.
*
* @return callable
*/
private function get_schema_callback() {
return function() {
$schema = array();
$field_names = $this->order_attribution_controller->get_field_names();
$validate_callback = function( $value ) {
if ( ! is_string( $value ) && null !== $value ) {
return new WP_Error(
'api-error',
sprintf(
/* translators: %s is the property type */
esc_html__( 'Value of type %s was posted to the order attribution callback', 'woocommerce' ),
gettype( $value )
)
);
}
return true;
};
$sanitize_callback = function( $value ) {
return sanitize_text_field( $value );
};
foreach ( $field_names as $field_name ) {
$schema[ $field_name ] = array(
'description' => sprintf(
/* translators: %s is the field name */
__( 'Order attribution field: %s', 'woocommerce' ),
esc_html( $field_name )
),
'type' => array( 'string', 'null' ),
'context' => array(),
'arg_options' => array(
'validate_callback' => $validate_callback,
'sanitize_callback' => $sanitize_callback,
),
);
}
return $schema;
};
}
}
PK [1]
+ ! Orders/MobileMessagingHandler.phpnu diff( $now )->days <= self::OPEN_ORDER_INTERVAL_DAYS;
$has_jetpack = null !== $blog_id;
if ( IppFunctions::is_store_in_person_payment_eligible() && IppFunctions::is_order_in_person_payment_eligible( $order ) ) {
return self::accept_payment_message( $blog_id, $domain );
} else {
if ( $used_app_in_last_month && $has_jetpack ) {
return self::manage_order_message( $blog_id, $order->get_id(), $domain );
} else {
return self::no_app_message( $blog_id, $domain );
}
}
} catch ( Exception $e ) {
return null;
}
}
/**
* Returns the closest date of last usage of any mobile app platform.
*
* @return ?DateTime
*/
private static function get_closer_mobile_usage_date(): ?DateTime {
$mobile_usage = WC_Tracker::get_woocommerce_mobile_usage();
if ( ! $mobile_usage ) {
return null;
}
$last_ios_used = self::get_last_used_or_null( 'ios', $mobile_usage );
$last_android_used = self::get_last_used_or_null( 'android', $mobile_usage );
return max( $last_android_used, $last_ios_used );
}
/**
* Returns last used date of specified mobile app platform.
*
* @param string $platform mobile platform to check.
* @param array $mobile_usage mobile apps usage data.
*
* @return ?DateTime last used date of specified mobile app
*/
private static function get_last_used_or_null(
string $platform, array $mobile_usage
): ?DateTime {
try {
if ( array_key_exists( $platform, $mobile_usage ) ) {
return new DateTime( $mobile_usage[ $platform ]['last_used'] );
} else {
return null;
}
} catch ( Exception $e ) {
return null;
}
}
/**
* Prepares message with a deep link to mobile payment.
*
* @param ?int $blog_id blog id to deep link to.
* @param string $domain URL of the current site.
*
* @return string formatted message
*/
private static function accept_payment_message( ?int $blog_id, $domain ): string {
$deep_link_url = add_query_arg(
array_merge(
array(
'blog_id' => absint( $blog_id ),
),
self::prepare_utm_parameters( 'deeplinks_payments', $blog_id, $domain )
),
'https://woocommerce.com/mobile/payments'
);
return sprintf(
/* translators: 1: opening link tag 2: closing link tag. */
esc_html__(
'%1$sCollect payments easily%2$s from your customers anywhere with our mobile app.',
'woocommerce'
),
'',
''
);
}
/**
* Prepares message with a deep link to manage order details.
*
* @param int $blog_id blog id to deep link to.
* @param int $order_id order id to deep link to.
* @param string $domain URL of the current site.
*
* @return string formatted message
*/
private static function manage_order_message( int $blog_id, int $order_id, string $domain ): string {
$deep_link_url = add_query_arg(
array_merge(
array(
'blog_id' => absint( $blog_id ),
'order_id' => absint( $order_id ),
),
self::prepare_utm_parameters( 'deeplinks_orders_details', $blog_id, $domain )
),
'https://woocommerce.com/mobile/orders/details'
);
return sprintf(
/* translators: 1: opening link tag 2: closing link tag. */
esc_html__(
'%1$sManage the order%2$s with the app.',
'woocommerce'
),
'',
''
);
}
/**
* Prepares message with a deep link to learn more about mobile app.
*
* @param ?int $blog_id blog id used for tracking.
* @param string $domain URL of the current site.
*
* @return string formatted message
*/
private static function no_app_message( ?int $blog_id, string $domain ): string {
$deep_link_url = add_query_arg(
array_merge(
array(
'blog_id' => absint( $blog_id ),
),
self::prepare_utm_parameters( 'deeplinks_promote_app', $blog_id, $domain )
),
'https://woocommerce.com/mobile'
);
return sprintf(
/* translators: 1: opening link tag 2: closing link tag. */
esc_html__(
'Process your orders on the go. %1$sGet the app%2$s.',
'woocommerce'
),
'',
''
);
}
/**
* Prepares array of parameters used by WooCommerce.com for tracking.
*
* @param string $campaign name of the deep link campaign.
* @param int|null $blog_id blog id of the current site.
* @param string $domain URL of the current site.
*
* @return array
*/
private static function prepare_utm_parameters(
string $campaign,
?int $blog_id,
string $domain
): array {
return array(
'utm_campaign' => $campaign,
'utm_medium' => 'email',
'utm_source' => $domain,
'utm_term' => absint( $blog_id ),
);
}
}
PK [1]Uu35B 5B % Orders/OrderAttributionController.phpnu proxy = $proxy;
$this->feature_controller = $controller;
$this->consent = $consent;
$this->logger = $proxy->call_function( 'wc_get_logger' );
$this->set_fields_and_prefix();
}
/**
* Register this class instance to the appropriate hooks.
*
* @return void
*/
public function register() {
// Don't run during install.
if ( Constants::get_constant( 'WC_INSTALLING' ) ) {
return;
}
add_action( 'init', array( $this, 'on_init' ) );
}
/**
* Hook into WordPress on init.
*/
public function on_init() {
// Bail if the feature is not enabled.
if ( ! $this->feature_controller->feature_is_enabled( 'order_attribution' ) ) {
return;
}
// Reset the static flag at the start of each request to prevent issues in persistent PHP environments.
self::$is_stamp_html_called = false;
// Register WPConsentAPI integration.
$this->consent->register();
add_action(
'wp_enqueue_scripts',
function () {
$this->enqueue_scripts_and_styles();
}
);
add_action(
'admin_enqueue_scripts',
function () {
$this->enqueue_admin_scripts_and_styles();
}
);
/**
* Filter set of actions used to stamp the checkout order attribution HTML container element.
*
* @since 9.0.0
*
* @param array $stamp_checkout_html_actions The set of actions used to stamp the checkout order attribution HTML container element.
*/
$stamp_checkout_html_actions = apply_filters(
'wc_order_attribution_stamp_checkout_html_actions',
array(
'woocommerce_checkout_billing',
'woocommerce_after_checkout_billing_form',
'woocommerce_checkout_shipping',
'woocommerce_after_order_notes',
'woocommerce_checkout_after_customer_details',
)
);
foreach ( $stamp_checkout_html_actions as $action ) {
add_action( $action, array( $this, 'stamp_html_element' ) );
}
add_action( 'woocommerce_register_form', array( $this, 'stamp_html_element' ) );
// Update order based on submitted fields.
add_action(
'woocommerce_checkout_order_created',
function ( $order ) {
// Check if this order already has any attribution data to prevent duplicates attribution data.
if ( $this->has_attribution( $order ) ) {
return;
}
// Nonce check is handled by WooCommerce before woocommerce_checkout_order_created hook.
// phpcs:ignore WordPress.Security.NonceVerification
$params = $this->get_unprefixed_field_values( $_POST );
/**
* Run an action to save order attribution data.
*
* @since 8.5.0
*
* @param WC_Order $order The order object.
* @param array $params Unprefixed order attribution data.
*/
do_action( 'woocommerce_order_save_attribution_data', $order, $params );
}
);
add_action(
'woocommerce_order_save_attribution_data',
function ( $order, $data ) {
$source_data = $this->get_source_values( $data );
$this->send_order_tracks( $source_data, $order );
$this->set_order_source_data( $source_data, $order );
},
10,
2
);
add_action(
'user_register',
function ( $customer_id ) {
try {
$customer = new WC_Customer( $customer_id );
$this->set_customer_source_data( $customer );
} catch ( Exception $e ) {
$this->log( $e->getMessage(), __METHOD__, WC_Log_Levels::ERROR );
}
}
);
// Add origin data to the order table.
add_action(
'admin_init',
function () {
$this->register_order_origin_column();
}
);
add_action(
'woocommerce_new_order',
function ( $order_id, $order ) {
$this->maybe_set_admin_source( $order );
},
2,
10
);
}
/**
* If the order is created in the admin, set the source type and origin to admin/Web admin.
* Only execute this if the order is created in the admin interface (or via ajax in the admin interface).
*
* @param WC_Order $order The recently created order object.
*
* @since 8.5.0
*/
private function maybe_set_admin_source( WC_Order $order ) {
// For ajax requests, bail if the referer is not an admin page.
$http_referer = esc_url_raw( wp_unslash( $_SERVER['HTTP_REFERER'] ?? '' ) );
$referer_is_admin = 0 === strpos( $http_referer, get_admin_url() );
if ( ! $referer_is_admin && wp_doing_ajax() ) {
return;
}
// If not admin interface page, bail.
if ( ! is_admin() ) {
return;
}
$order->add_meta_data( $this->get_meta_prefixed_field_name( 'source_type' ), 'admin' );
$order->save();
}
/**
* Get all of the field names.
*
* @return array
*/
public function get_field_names(): array {
return $this->field_names;
}
/**
* Get the prefix for the fields.
*
* @return string
*/
public function get_prefix(): string {
return $this->field_prefix;
}
/**
* Scripts & styles for custom source tracking and cart tracking.
*/
private function enqueue_scripts_and_styles() {
wp_enqueue_script(
'sourcebuster-js',
plugins_url( "assets/js/sourcebuster/sourcebuster{$this->get_script_suffix()}.js", WC_PLUGIN_FILE ),
array(),
Constants::get_constant( 'WC_VERSION' ),
true
);
wp_enqueue_script(
'wc-order-attribution',
plugins_url( "assets/js/frontend/order-attribution{$this->get_script_suffix()}.js", WC_PLUGIN_FILE ),
// Technically we do depend on 'wp-data', 'wc-blocks-checkout' for blocks checkout,
// but as implementing conditional dependency on the server-side would be too complex,
// we resolve this condition at the client-side.
array( 'sourcebuster-js' ),
Constants::get_constant( 'WC_VERSION' ),
true
);
/**
* Filter the lifetime of the cookie used for source tracking.
*
* @since 8.5.0
*
* @param float $lifetime The lifetime of the Sourcebuster cookies in months.
*
* The default value forces Sourcebuster into making the cookies valid for the current session only.
*/
$lifetime = (float) apply_filters( 'wc_order_attribution_cookie_lifetime_months', 0.00001 );
/**
* Filter the session length for source tracking.
*
* @since 8.5.0
*
* @param int $session_length The session length in minutes.
*/
$session_length = (int) apply_filters( 'wc_order_attribution_session_length_minutes', 30 );
/**
* Filter to enable base64 encoding for cookie values.
*
* @since 9.0.0
*
* @param bool $use_base64_cookies True to enable base64 encoding, default is false.
*/
$use_base64_cookies = apply_filters( 'wc_order_attribution_use_base64_cookies', false );
/**
* Filter to allow tracking.
*
* @since 8.5.0
*
* @param bool $allow_tracking True to allow tracking, false to disable.
*/
$allow_tracking = wc_bool_to_string( apply_filters( 'wc_order_attribution_allow_tracking', true ) );
// Create Order Attribution JS namespace with parameters.
$namespace = array(
'params' => array(
'lifetime' => $lifetime,
'session' => $session_length,
'base64' => $use_base64_cookies,
'ajaxurl' => admin_url( 'admin-ajax.php' ),
'prefix' => $this->field_prefix,
'allowTracking' => 'yes' === $allow_tracking,
),
'fields' => $this->fields,
);
wp_localize_script( 'wc-order-attribution', 'wc_order_attribution', $namespace );
}
/**
* Enqueue the stylesheet for admin pages.
*
* @return void
*/
private function enqueue_admin_scripts_and_styles() {
$screen = get_current_screen();
if ( $screen->id !== $this->get_order_screen_id() ) {
return;
}
// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter
wp_enqueue_script(
'woocommerce-order-attribution-admin-js',
plugins_url( "assets/js/admin/order-attribution-admin{$this->get_script_suffix()}.js", WC_PLUGIN_FILE ),
array( 'jquery' ),
Constants::get_constant( 'WC_VERSION' )
);
}
/**
* Display the origin column in the orders table.
*
* @param int $order_id The order ID.
*
* @return void
*/
private function display_origin_column( $order_id ): void {
try {
// Ensure we've got a valid order.
$order = $this->get_hpos_order_object( $order_id );
$this->output_origin_column( $order );
} catch ( Exception $e ) {
return;
}
}
/**
* Output the translated origin label for the Origin column in the orders table.
*
* Default to "Unknown" if no origin is set.
*
* @param WC_Order $order The order object.
*
* @return void
*/
private function output_origin_column( WC_Order $order ) {
$source_type = $order->get_meta( $this->get_meta_prefixed_field_name( 'source_type' ) );
$source = $order->get_meta( $this->get_meta_prefixed_field_name( 'utm_source' ) );
$origin = $this->get_origin_label( $source_type, $source );
echo esc_html( $origin );
}
/**
* Handles the `` element for checkout forms.
*
* @since 9.0.0
* @deprecated 10.5.0 Use stamp_html_element() instead.
*
* @return void
*/
public function stamp_checkout_html_element_once() {
wc_deprecated_function( __METHOD__, '10.5.0', 'stamp_html_element' );
$this->stamp_html_element();
}
/**
* Output `` element that contributes the order attribution values to the enclosing form.
*
* Used for customer register forms and checkout forms.
*
* Note: By default, this method may output multiple instances of the element when called
* multiple times (e.g., during checkout form pre-generation and actual rendering).
* The JavaScript layer will remove duplicate elements and ensure only one set of data is submitted.
*
* @return void
*/
public function stamp_html_element() {
/**
* Filter to allow sites to opt back into single-output behavior.
*
* @since 10.5.0
*
* @param bool $allow_multiple_elements True to allow multiple elements (new behavior), false for single element (old behavior).
*/
$allow_multiple = apply_filters( 'wc_order_attribution_allow_multiple_elements', true );
// If single-output mode is enabled, use the static flag to prevent multiple outputs.
if ( ! $allow_multiple && self::$is_stamp_html_called ) {
return;
}
printf( '' );
if ( ! $allow_multiple ) {
self::$is_stamp_html_called = true;
}
}
/**
* Save source data for a Customer object.
*
* @param WC_Customer $customer The customer object.
*
* @return void
*/
private function set_customer_source_data( WC_Customer $customer ) {
// Nonce check is handled before user_register hook.
// phpcs:ignore WordPress.Security.NonceVerification
foreach ( $this->get_source_values( $this->get_unprefixed_field_values( $_POST ) ) as $key => $value ) {
$customer->add_meta_data( $this->get_meta_prefixed_field_name( $key ), $value );
}
$customer->save_meta_data();
}
/**
* Save source data for an Order object.
*
* @param array $source_data The source data.
* @param WC_Order $order The order object.
*
* @return void
*/
private function set_order_source_data( array $source_data, WC_Order $order ) {
// If all the values are empty, bail.
if ( empty( array_filter( $source_data ) ) ) {
return;
}
foreach ( $source_data as $key => $value ) {
$order->add_meta_data( $this->get_meta_prefixed_field_name( $key ), $value );
}
$order->save_meta_data();
}
/**
* Log a message as a debug log entry.
*
* @param string $message The message to log.
* @param string $method The method that is logging the message.
* @param string $level The log level.
*/
private function log( string $message, string $method, string $level = WC_Log_Levels::DEBUG ) {
/**
* Filter to enable debug mode.
*
* @since 8.5.0
*
* @param string $enabled 'yes' to enable debug mode, 'no' to disable.
*/
if ( 'yes' !== apply_filters( 'wc_order_attribution_debug_mode_enabled', 'no' ) ) {
return;
}
$this->logger->log(
$level,
sprintf( '%s %s', $method, $message ),
array( 'source' => 'woocommerce-order-attribution' )
);
}
/**
* Send order source data to Tracks.
*
* @param array $source_data The source data.
* @param WC_Order $order The order object.
*
* @return void
*/
private function send_order_tracks( array $source_data, WC_Order $order ) {
$origin_label = $this->get_origin_label(
$source_data['source_type'] ?? '',
$source_data['utm_source'] ?? '',
false
);
$tracks_data = array(
'order_id' => $order->get_id(),
'source_type' => $source_data['source_type'] ?? '',
'medium' => $source_data['utm_medium'] ?? '',
'source' => $source_data['utm_source'] ?? '',
'device_type' => strtolower( $source_data['device_type'] ?? 'unknown' ),
'origin_label' => strtolower( $origin_label ),
'session_pages' => $source_data['session_pages'] ?? 0,
'session_count' => $source_data['session_count'] ?? 0,
'order_total' => $order->get_total(),
'customer_registered' => $order->get_customer_id() ? 'yes' : 'no',
);
if ( function_exists( 'wc_admin_record_tracks_event' ) ) {
wc_admin_record_tracks_event( 'order_attribution', $tracks_data );
}
}
/**
* Get the screen ID for the orders page.
*
* @return string
*/
private function get_order_screen_id(): string {
return OrderUtil::custom_orders_table_usage_is_enabled() ? wc_get_page_screen_id( 'shop-order' ) : 'shop_order';
}
/**
* Register the origin column in the orders table.
*
* This accounts for the differences in hooks based on whether HPOS is enabled or not.
*
* @return void
*/
private function register_order_origin_column() {
$screen_id = $this->get_order_screen_id();
$add_column = function ( $columns ) {
$columns['origin'] = esc_html__( 'Origin', 'woocommerce' );
return $columns;
};
// HPOS and non-HPOS use different hooks.
add_filter( "manage_{$screen_id}_columns", $add_column );
add_filter( "manage_edit-{$screen_id}_columns", $add_column );
$display_column = function ( $column_name, $order_id ) {
if ( 'origin' !== $column_name ) {
return;
}
$this->display_origin_column( $order_id );
};
// HPOS and non-HPOS use different hooks.
add_action( "manage_{$screen_id}_custom_column", $display_column, 10, 2 );
add_action( "manage_{$screen_id}_posts_custom_column", $display_column, 10, 2 );
}
/**
* Check if this order already has any attribution data
*
* @param WC_Order $order The order object.
*
* @return bool
* @since 9.8.0
*/
public function has_attribution( $order ) {
foreach ( $this->field_names as $field ) {
if ( $order->meta_exists( $this->get_meta_prefixed_field_name( $field ) ) ) {
return true;
}
}
return false;
}
}
PK [1]3Ŗ Orders/OrderNoteGroup.phpnu calc_line_taxes( $_POST );
include __DIR__ . '/../../../includes/admin/meta-boxes/views/html-order-items.php';
wp_die();
}
/**
* Calculate line taxes programmatically.
*
* @param array $post_variables Contents of the $_POST array that would be passed in an Ajax call.
* @return object The retrieved order object.
*/
public function calc_line_taxes( array $post_variables ): object {
$order_id = absint( $post_variables['order_id'] );
$calculate_tax_args = array(
'country' => isset( $post_variables['country'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['country'] ) ) ) : '',
'state' => isset( $post_variables['state'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['state'] ) ) ) : '',
'postcode' => isset( $post_variables['postcode'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['postcode'] ) ) ) : '',
'city' => isset( $post_variables['city'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['city'] ) ) ) : '',
);
// Parse the jQuery serialized items.
$items = array();
parse_str( wp_unslash( $post_variables['items'] ), $items );
// Save order items first.
wc_save_order_items( $order_id, $items );
// Grab the order and recalculate taxes.
$order = wc_get_order( $order_id );
$order->calculate_taxes( $calculate_tax_args );
$order->calculate_totals( false );
return $order;
}
}
PK [1](HZ Orders/PointOfSaleOrderUtil.phpnu get_created_via();
}
}
PK [1]QuB Orders/PaymentInfo.phpnu get_payment_method();
/**
* Filter to allow payment gateways to provide payment card info for an order.
*
* @since 9.5.0
*
* @param array|null $info The card info.
* @param WC_Abstract_Order $order The order.
*/
$info = apply_filters( 'wc_order_payment_card_info', array(), $order );
if ( ! is_array( $info ) ) {
$info = array();
}
// Fallback for WooPayments.
if ( empty( $info ) && 'woocommerce_payments' === $method ) {
$info = self::get_wcpay_card_info( $order );
}
$defaults = array(
'payment_method' => $method,
'brand' => '',
'icon' => '',
'last4' => '',
);
$info = wp_parse_args( $info, $defaults );
if ( empty( $info['icon'] ) ) {
$info['icon'] = self::get_card_icon( $info['brand'] );
}
return $info;
}
/**
* Generate a CSS-compatible SVG icon of a card brand.
*
* @param string $brand The brand of the card.
*
* @return string
*/
private static function get_card_icon( ?string $brand ): string {
$brand = strtolower( (string) $brand );
if ( ! in_array( $brand, self::KNOWN_CARD_BRANDS, true ) ) {
$brand = 'unknown';
}
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
return base64_encode( file_get_contents( __DIR__ . "/CardIcons/{$brand}.svg" ) );
}
/**
* Get info about the card used for payment on an order, when the payment gateway is WooPayments.
*
* @see https://docs.stripe.com/api/charges/object#charge_object-payment_method_details
*
* @param WC_Abstract_Order $order The order in question.
*
* @return array
*/
private static function get_wcpay_card_info( WC_Abstract_Order $order ): array {
if ( 'woocommerce_payments' !== $order->get_payment_method() ) {
return array();
}
// This is a Woo-specific meta key, not used within WooPayments.
$cache_meta_key = '_wcpay_raw_payment_method_details';
$payment_details = null;
$stored_payment_details = $order->get_meta( $cache_meta_key );
if ( is_string( $stored_payment_details ) && strlen( $stored_payment_details ) > 0 ) {
$payment_details = json_decode( $stored_payment_details, true );
}
if ( ! $payment_details ) {
if ( ! class_exists( \WC_Payments::class ) ) {
return array();
}
$payment_method_id = $order->get_meta( '_payment_method_id' );
if ( ! $payment_method_id ) {
return array();
}
try {
$payment_details = \WC_Payments::get_payments_api_client()->get_payment_method( $payment_method_id );
} catch ( \Throwable $ex ) {
$order_id = $order->get_id();
$message = $ex->getMessage();
wc_get_logger()->error(
sprintf(
'%s - retrieving info for payment method %s for order %s: %s',
StringUtil::class_name_without_namespace( static::class ),
$payment_method_id,
$order_id,
$message
),
array(
'source' => 'payment-info',
)
);
return array();
}
// Cache payment method details.
$order->update_meta_data( $cache_meta_key, wp_json_encode( $payment_details ) );
$order->save_meta_data();
}
$card_info = array();
if ( isset( $payment_details['type'], $payment_details[ $payment_details['type'] ] ) ) {
$details = $payment_details[ $payment_details['type'] ];
switch ( $payment_details['type'] ) {
case 'card':
default:
$card_info['brand'] = $details['brand'] ?? '';
$card_info['last4'] = $details['last4'] ?? '';
break;
case 'card_present':
case 'interac_present':
$card_info['brand'] = $details['brand'] ?? '';
$card_info['last4'] = $details['last4'] ?? '';
$card_info['account_type'] = $details['receipt']['account_type'] ?? '';
$card_info['aid'] = $details['receipt']['dedicated_file_name'] ?? '';
$card_info['app_name'] = $details['receipt']['application_preferred_name'] ?? '';
break;
}
}
return array_map( 'sanitize_text_field', $card_info );
}
}
PK [1]_:4I I Orders/CouponsController.phpnu add_coupon_discount( $_POST );
ob_start();
include __DIR__ . '/../../../includes/admin/meta-boxes/views/html-order-items.php';
$response['html'] = ob_get_clean();
ob_start();
$notes = wc_get_order_notes( array( 'order_id' => $order->get_id() ) );
include __DIR__ . '/../../../includes/admin/meta-boxes/views/html-order-notes.php';
$response['notes_html'] = ob_get_clean();
} catch ( Exception $e ) {
wp_send_json_error( array( 'error' => $e->getMessage() ) );
}
// wp_send_json_success must be outside the try block not to break phpunit tests.
wp_send_json_success( $response );
}
/**
* Add order discount programmatically.
*
* @param array $post_variables Contents of the $_POST array that would be passed in an Ajax call.
* @return object The retrieved order object.
* @throws \Exception Invalid order or coupon.
*/
public function add_coupon_discount( array $post_variables ): object {
$order_id = isset( $post_variables['order_id'] ) ? absint( $post_variables['order_id'] ) : 0;
$order = wc_get_order( $order_id );
$calculate_tax_args = array(
'country' => isset( $post_variables['country'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['country'] ) ) ) : '',
'state' => isset( $post_variables['state'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['state'] ) ) ) : '',
'postcode' => isset( $post_variables['postcode'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['postcode'] ) ) ) : '',
'city' => isset( $post_variables['city'] ) ? wc_strtoupper( wc_clean( wp_unslash( $post_variables['city'] ) ) ) : '',
);
if ( ! $order ) {
throw new Exception( __( 'Invalid order', 'woocommerce' ) );
}
$coupon = ArrayUtil::get_value_or_default( $post_variables, 'coupon' );
if ( StringUtil::is_null_or_whitespace( $coupon ) ) {
throw new Exception( __( 'Invalid coupon', 'woocommerce' ) );
}
// Add user ID and/or email so validation for coupon limits works.
$user_id_arg = isset( $post_variables['user_id'] ) ? absint( $post_variables['user_id'] ) : 0;
$user_email_arg = isset( $post_variables['user_email'] ) ? sanitize_email( wp_unslash( $post_variables['user_email'] ) ) : '';
if ( $user_id_arg ) {
$order->set_customer_id( $user_id_arg );
}
if ( $user_email_arg ) {
$order->set_billing_email( $user_email_arg );
}
$order->calculate_taxes( $calculate_tax_args );
$order->calculate_totals( false );
$code = wc_format_coupon_code( wp_unslash( $coupon ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$result = $order->apply_coupon( $code );
if ( is_wp_error( $result ) ) {
throw new Exception( html_entity_decode( wp_strip_all_tags( $result->get_error_message() ) ) );
}
// translators: %s coupon code.
$order->add_order_note( esc_html( sprintf( __( 'Coupon applied: "%s".', 'woocommerce' ), $code ) ), 0, true, array( 'note_group' => OrderNoteGroup::ORDER_UPDATE ) );
return $order;
}
}
PK [1]e+T +T % Orders/OrderActionsRestController.phpnu route_namespace,
'/orders/(?P[\d]+)/actions/email_templates',
array(
'args' => array(
'id' => array(
'description' => __( 'Unique identifier of the order.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_email_templates' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(),
),
'schema' => array( $this, 'get_schema_for_email_templates' ),
)
);
register_rest_route(
$this->route_namespace,
'/orders/(?P[\d]+)/actions/send_email',
array(
'args' => array(
'id' => array(
'description' => __( 'Unique identifier of the order.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'send_email' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => $this->get_args_for_order_actions( 'send_email', WP_REST_Server::CREATABLE ),
),
'schema' => array( $this, 'get_schema_for_order_actions' ),
)
);
register_rest_route(
$this->route_namespace,
'/orders/(?P[\d]+)/actions/send_order_details',
array(
'args' => array(
'id' => array(
'description' => __( 'Unique identifier of the order.', 'woocommerce' ),
'type' => 'integer',
),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'send_order_details' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => $this->get_args_for_order_actions( 'send_order_details', WP_REST_Server::CREATABLE ),
),
'schema' => array( $this, 'get_schema_for_order_actions' ),
)
);
}
/**
* Validate the order ID that is part of the endpoint URL.
*
* @param WP_REST_Request $request The incoming HTTP REST request.
*
* @return int|WP_Error
*/
private function validate_order_id( WP_REST_Request $request ) {
$order_id = $request->get_param( 'id' );
$order = wc_get_order( $order_id );
if ( ! $order ) {
return new WP_Error( 'woocommerce_rest_not_found', __( 'Order not found', 'woocommerce' ), array( 'status' => 404 ) );
}
return $order_id;
}
/**
* Handle a request for one of the provided REST API endpoints.
*
* @param WP_REST_Request $request The incoming HTTP REST request.
* @param string $method_name The name of the class method to execute.
*
* @return WP_REST_Response|WP_Error
*/
protected function run( WP_REST_Request $request, string $method_name ) {
$order_id = $this->validate_order_id( $request );
if ( is_wp_error( $order_id ) ) {
return $order_id;
}
return parent::run( $request, $method_name );
}
/**
* Permission check for REST API endpoint.
*
* @param WP_REST_Request $request The request for which the permission is checked.
* @return bool|WP_Error True if the current user has the capability, otherwise a WP_Error object.
*/
private function check_permissions( WP_REST_Request $request ) {
$order_id = $this->validate_order_id( $request );
if ( is_wp_error( $order_id ) ) {
return $order_id;
}
return $this->check_permission( $request, 'read_shop_order', $order_id );
}
/**
* Get the accepted arguments for the POST request.
*
* @param string $action_slug The endpoint slug for the order action.
*
* @return array[]
*/
private function get_args_for_order_actions( string $action_slug ): array {
$args = array(
'email' => array(
'description' => __( 'Email address to send the order details to.', 'woocommerce' ),
'type' => 'string',
'format' => 'email',
'context' => array( 'edit' ),
'required' => false,
'validate_callback' => 'rest_validate_request_arg',
),
'force_email_update' => array(
'description' => __( 'Whether to update the billing email of the order, even if it already has one.', 'woocommerce' ),
'type' => 'boolean',
'context' => array( 'edit' ),
'required' => false,
'sanitize_callback' => 'rest_sanitize_boolean',
'validate_callback' => 'rest_validate_request_arg',
),
);
if ( 'send_email' === $action_slug ) {
$args['template_id'] = array(
'description' => __( 'The ID of the template to use for sending the email.', 'woocommerce' ),
'type' => 'string',
'enum' => $this->get_template_id_enum(),
'context' => array( 'edit' ),
'required' => true,
'validate_callback' => 'rest_validate_request_arg',
);
}
return $args;
}
/**
* Get the schema for the email_templates action.
*
* @return array
*/
public function get_schema_for_email_templates(): array {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => __( 'Email Template', 'woocommerce' ),
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'A unique ID string for the email template.', 'woocommerce' ),
'type' => 'string',
'enum' => $this->get_template_id_enum(),
'context' => array( 'view', 'embed' ),
),
'title' => array(
'description' => __( 'The display name of the email template.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
),
'description' => array(
'description' => __( 'A description of the purpose of the email template.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
),
),
);
return $schema;
}
/**
* Get the schema for all order actions that don't have a separate schema.
*
* @return array
*/
public function get_schema_for_order_actions(): array {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => __( 'Order Actions', 'woocommerce' ),
'type' => 'object',
'properties' => array(
'message' => array(
'description' => __( 'A message indicating that the action completed successfully.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'edit' ),
'readonly' => true,
),
),
);
return $schema;
}
/**
* Get the list of possible template ID values.
*
* Note that this gets the IDs of all email templates. This does not mean all of these templates are available to
* send through the API endpoint.
*
* @return string[]
*/
private function get_template_id_enum(): array {
$enum = array();
if ( is_array( WC()->mailer()->emails ) ) {
$enum = array_map(
function ( $template ) {
if ( ! $template instanceof WC_Email || empty( $template->id ) ) {
return null;
}
return $template->id;
},
WC()->mailer()->emails,
array() // Strip off the associative array keys.
);
}
return array_filter( $enum );
}
/**
* Determine which email templates are available for the given order.
*
* @param WC_Order $order The order in question.
*
* @return WC_Email[]
*/
private function get_available_email_templates( WC_Order $order ): array {
$all_email_templates = WC()->mailer()->emails;
$order_status = $order->get_status( 'edit' );
$unavailable_statuses = array(
OrderStatus::AUTO_DRAFT,
OrderStatus::DRAFT,
OrderStatus::NEW,
OrderStatus::TRASH,
);
if ( ! $order->get_billing_email() || in_array( $order_status, $unavailable_statuses, true ) ) {
return array();
}
$valid_template_classes = array(
'WC_Email_Customer_Invoice',
);
if ( $this->order_is_partially_refunded( $order ) ) {
$valid_template_classes[] = 'WC_Email_Customer_Refunded_Order';
}
switch ( $order_status ) {
case OrderStatus::COMPLETED:
$valid_template_classes[] = 'WC_Email_Customer_Completed_Order';
break;
case OrderStatus::FAILED:
$valid_template_classes[] = 'WC_Email_Customer_Failed_Order';
break;
case OrderStatus::ON_HOLD:
$valid_template_classes[] = 'WC_Email_Customer_On_Hold_Order';
break;
case OrderStatus::PROCESSING:
$valid_template_classes[] = 'WC_Email_Customer_Processing_Order';
break;
case OrderStatus::REFUNDED:
$valid_template_classes[] = 'WC_Email_Customer_Refunded_Order';
break;
}
/**
* Filter the list of valid email templates for a given order.
*
* Note that the email class must also exist in WC_Emails::$emails.
*
* When adding a custom email template to this list, a callback must also be added to trigger the sending
* of the email. See the `woocommerce_rest_order_actions_email_send` action hook.
*
* @since 9.8.0
*
* @param string[] $valid_template_classes Array of email template class names that are valid for a given order.
* @param WC_Order $order The order.
*/
$valid_template_classes = apply_filters(
'woocommerce_rest_order_actions_email_valid_template_classes',
$valid_template_classes,
$order
);
$valid_template_classes = array_filter( array_unique( $valid_template_classes ), 'is_string' );
$valid_templates = array_fill_keys( $valid_template_classes, '' );
return array_intersect_key( $all_email_templates, $valid_templates );
}
/**
* Retrieve an email template class using its ID, if it is available.
*
* @param string $template_id The ID of the desired email template class.
* @param array|null $available_templates Optional. An array of available email template classes in the same
* associative format as WC_Emails::$emails. If not provided, all classes
* in WC_Emails::$emails will be considered available.
*
* @return WC_Email|null The email template class if it is available, otherwise null.
*/
private function get_email_template_by_id( string $template_id, ?array $available_templates = null ): ?WC_Email {
if ( is_null( $available_templates ) ) {
$available_templates = WC()->mailer()->emails;
}
$matching_templates = array_filter(
$available_templates,
fn( $template ) => $template->id === $template_id
);
if ( empty( $matching_templates ) ) {
return null;
}
return reset( $matching_templates );
}
/**
* Callback to run for GET wc/v3/orders/(?P[\d]+)/actions/email_templates.
*
* @param WP_REST_Request $request The incoming HTTP REST request.
*
* @return array
*/
protected function get_email_templates( WP_REST_Request $request ): array {
$order = wc_get_order( $request->get_param( 'id' ) );
$available_templates = $this->get_available_email_templates( $order );
$templates = array();
foreach ( $available_templates as $template ) {
$templates[] = array(
'id' => $template->id,
'title' => $template->get_title(),
'description' => $template->get_description(),
);
}
usort(
$templates,
fn( $a, $b ) => strcmp( $a['id'], $b['id'] )
);
$schema = $this->get_schema_for_email_templates();
$context = $request->get_param( 'context' ) ?? 'view';
$filtered_response = array_map(
function ( $template ) use ( $schema, $context ) {
return rest_filter_response_by_context( $template, $schema, $context );
},
$templates
);
return $filtered_response;
}
/**
* Callback to run for POST wc/v3/orders/(?P[\d]+)/actions/send_email.
*
* @param WP_REST_Request $request The incoming HTTP REST request.
*
* @return array|WP_Error
*/
protected function send_email( WP_REST_Request $request ) {
$order = wc_get_order( $request->get_param( 'id' ) );
$email = $request->get_param( 'email' );
$force = wp_validate_boolean( $request->get_param( 'force_email_update' ) );
$template_id = $request->get_param( 'template_id' );
$messages = array();
if ( $email ) {
$message = $this->maybe_update_billing_email( $order, $email, $force );
if ( is_wp_error( $message ) ) {
return $message;
}
$messages[] = $message;
}
if ( ! is_email( $order->get_billing_email() ) ) {
return new WP_Error(
'woocommerce_rest_missing_email',
__( 'Order does not have an email address.', 'woocommerce' ),
array( 'status' => 400 )
);
}
$available_templates = $this->get_available_email_templates( $order );
$template = $this->get_email_template_by_id( $template_id, $available_templates );
if ( is_null( $template ) ) {
return new WP_Error(
'woocommerce_rest_invalid_email_template',
sprintf(
// translators: %s is a string ID for an email template.
__( '%s is not a valid template for this order.', 'woocommerce' ),
esc_html( $template_id )
),
array( 'status' => 400 )
);
}
switch ( $template_id ) {
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
case 'customer_completed_order':
/** This action is documented in includes/class-wc-emails.php */
do_action( 'woocommerce_order_status_completed_notification', $order->get_id(), $order );
break;
case 'customer_failed_order':
/** This action is documented in includes/class-wc-emails.php */
do_action( 'woocommerce_order_status_failed_notification', $order->get_id(), $order );
break;
case 'customer_on_hold_order':
/** This action is documented in includes/class-wc-emails.php */
do_action( 'woocommerce_order_status_pending_to_on-hold_notification', $order->get_id(), $order ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
break;
case 'customer_processing_order':
/** This action is documented in includes/class-wc-emails.php */
do_action( 'woocommerce_order_status_pending_to_processing_notification', $order->get_id(), $order );
break;
case 'customer_refunded_order':
if ( $this->order_is_partially_refunded( $order ) ) {
/** This action is documented in includes/class-wc-emails.php */
do_action( 'woocommerce_order_partially_refunded_notification', $order->get_id() );
} else {
/** This action is documented in includes/class-wc-emails.php */
do_action( 'woocommerce_order_fully_refunded_notification', $order->get_id() );
}
break;
// phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment
case 'customer_invoice':
return $this->send_order_details( $request );
default:
/**
* Action to trigger sending a custom order email template from a REST API request.
*
* The email template must first be made available for the associated order.
* See the `woocommerce_rest_order_actions_email_valid_template_classes` filter hook.
*
* @since 9.8.0
*
* @param int $order_id The ID of the order.
* @param string $template_id The ID of the template specified in the API request.
*/
do_action( 'woocommerce_rest_order_actions_email_send', $order->get_id(), $template_id );
break;
}
$user_agent = esc_html( $request->get_header( 'User-Agent' ) );
$messages[] = sprintf(
// translators: 1. The name of an email template; 2. Email address.
esc_html__( 'Email template "%1$s" sent to %2$s.', 'woocommerce' ),
esc_html( $template->get_title() ),
esc_html( $order->get_billing_email() )
);
$messages = array_filter( $messages );
foreach ( $messages as $message ) {
$order->add_order_note(
$message,
false,
true,
array(
'user_agent' => $user_agent ? $user_agent : 'REST API',
'note_group' => OrderNoteGroup::EMAIL_NOTIFICATION,
)
);
}
return array(
'message' => implode( ' ', $messages ),
);
}
/**
* Handle the POST /orders/{id}/actions/send_order_details.
*
* @param WP_REST_Request $request The received request.
* @return array|WP_Error Request response or an error.
*/
protected function send_order_details( WP_REST_Request $request ) {
$order = wc_get_order( $request->get_param( 'id' ) );
$email = $request->get_param( 'email' );
$force = wp_validate_boolean( $request->get_param( 'force_email_update' ) );
$messages = array();
if ( $email ) {
$message = $this->maybe_update_billing_email( $order, $email, $force );
if ( is_wp_error( $message ) ) {
return $message;
}
$messages[] = $message;
}
if ( ! is_email( $order->get_billing_email() ) ) {
return new WP_Error(
'woocommerce_rest_missing_email',
__( 'Order does not have an email address.', 'woocommerce' ),
array( 'status' => 400 )
);
}
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
/** This action is documented in includes/admin/meta-boxes/class-wc-meta-box-order-actions.php */
do_action( 'woocommerce_before_resend_order_emails', $order, 'customer_invoice' );
WC()->payment_gateways();
WC()->shipping();
WC()->mailer()->customer_invoice( $order );
$user_agent = esc_html( $request->get_header( 'User-Agent' ) );
$messages[] = sprintf(
// translators: %s is an email address.
esc_html__( 'Order details sent to %s.', 'woocommerce' ),
esc_html( $order->get_billing_email() )
);
$messages = array_filter( $messages );
foreach ( $messages as $message ) {
$order->add_order_note(
$message,
false,
true,
array(
'user_agent' => $user_agent ? $user_agent : 'REST API',
'note_title' => __( 'Order confirmation email', 'woocommerce' ),
'note_group' => OrderNoteGroup::EMAIL_NOTIFICATION,
)
);
}
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
/** This action is documented in includes/admin/meta-boxes/class-wc-meta-box-order-actions.php */
do_action( 'woocommerce_after_resend_order_email', $order, 'customer_invoice' );
return array(
'message' => implode( ' ', $messages ),
);
}
/**
* Update the billing email of an order when certain conditions are met.
*
* If the order does not already have a billing email, it will be updated. If it does have one, but `$force` is set
* to `true`, it will be updated. Otherwise this will return an error. This can also return an error if the given
* email address is not valid.
*
* @param WC_Order $order The order to update.
* @param string $email The email address to maybe add to the order.
* @param bool $force Optional. True to update the order even if it already has a billing email. Default false.
*
* @return string|WP_Error A message upon success, otherwise an error.
*/
private function maybe_update_billing_email( WC_Order $order, string $email, ?bool $force = false ) {
$existing_email = $order->get_billing_email( 'edit' );
if ( $existing_email === $email ) {
return '';
}
if ( $existing_email && true !== $force ) {
return new WP_Error(
'woocommerce_rest_order_billing_email_exists',
__( 'Order already has a billing email.', 'woocommerce' ),
array( 'status' => 400 )
);
}
try {
$order->set_billing_email( $email );
$order->save();
} catch ( WC_Data_Exception $e ) {
return new WP_Error(
$e->getErrorCode(),
$e->getMessage()
);
}
return sprintf(
// translators: %s is an email address.
__( 'Billing email updated to %s.', 'woocommerce' ),
esc_html( $email )
);
}
/**
* Check if a given order has any partial refunds.
*
* Based on heuristics in the `wc_create_refund()` function.
*
* @param WC_Order $order An order object.
*
* @return bool
*/
private function order_is_partially_refunded( WC_Order $order ): bool {
$remaining_amount = $order->get_remaining_refund_amount();
$remaining_items = $order->get_remaining_refund_items();
$refunds = $order->get_refunds();
$last_refund = reset( $refunds );
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
/** This filter is documented in includes/wc-order-functions.php */
$partially_refunded = apply_filters(
'woocommerce_order_is_partially_refunded',
count( $refunds ) > 0 && ( $remaining_amount > 0 || ( $order->has_free_item() && $remaining_items > 0 ) ),
$order->get_id(),
$last_refund ? $last_refund->get_id() : 0
);
return (bool) $partially_refunded;
}
}
PK [1]5 5 $ ProductAttributesLookup/Filterer.phpnu data_store = $data_store;
$this->lookup_table_name = $data_store->get_lookup_table_name();
}
/**
* Checks if the product attribute filtering via lookup table feature is enabled.
*
* @return bool
*/
public function filtering_via_lookup_table_is_active() {
return 'yes' === get_option( 'woocommerce_attribute_lookup_enabled' );
}
/**
* Adds post clauses for filtering via lookup table.
* This method should be invoked within a 'posts_clauses' filter.
*
* @param array $args Product query clauses as supplied to the 'posts_clauses' filter.
* @param \WP_Query $wp_query Current product query as supplied to the 'posts_clauses' filter.
* @param array $attributes_to_filter_by Attribute filtering data as generated by WC_Query::get_layered_nav_chosen_attributes.
* @return array The updated product query clauses.
*/
public function filter_by_attribute_post_clauses( array $args, \WP_Query $wp_query, array $attributes_to_filter_by ) {
global $wpdb;
/**
* Filter whether to add the filter post clauses
*
* @param bool $is_main_query Whether the current query is 'is_main_query'.
* @param WP_Query $wp_query The current WP_Query object.
*
* @since 9.9.0
*/
$enable_filtering = apply_filters( 'woocommerce_enable_post_clause_filtering', $wp_query->is_main_query(), $wp_query );
if ( ! $enable_filtering || ! $this->filtering_via_lookup_table_is_active() ) {
return $args;
}
// The extra derived table ("SELECT product_or_parent_id FROM") is needed for performance
// (causes the filtering subquery to be executed only once).
$clause_root = " {$wpdb->posts}.ID IN ( SELECT product_or_parent_id FROM (";
/**
* Filters the woocommerce_hide_out_of_stock_items option to override the default behavior in product filtering by attribute.
*
* @param bool $option_value The behavior configured in WooCommerce settings.
* @return bool The behavior to use in the catalog when product filtering by attribute.
*
* @since 9.8.0.
*/
$hide_out_of_stock = apply_filters( 'woocommerce_product_attributes_filterer_hide_out_of_stock', 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) );
if ( $hide_out_of_stock ) {
$in_stock_clause = ' AND in_stock = 1';
} else {
$in_stock_clause = '';
}
$attribute_ids_for_and_filtering = array();
$clauses = array();
foreach ( $attributes_to_filter_by as $taxonomy => $data ) {
$all_terms = get_terms( $taxonomy, array( 'hide_empty' => false ) );
$term_ids_by_slug = wp_list_pluck( $all_terms, 'term_id', 'slug' );
$term_ids_to_filter_by = array_values( array_intersect_key( $term_ids_by_slug, array_flip( $data['terms'] ) ) );
$term_ids_to_filter_by = array_map( 'absint', $term_ids_to_filter_by );
$term_ids_to_filter_by_list = '(' . join( ',', $term_ids_to_filter_by ) . ')';
$is_and_query = 'and' === $data['query_type'];
$count = count( $term_ids_to_filter_by );
if ( 0 !== $count ) {
if ( $is_and_query && $count > 1 ) {
$attribute_ids_for_and_filtering = array_merge( $attribute_ids_for_and_filtering, $term_ids_to_filter_by );
} else {
$clauses[] = "
{$clause_root}
SELECT product_or_parent_id
FROM {$this->lookup_table_name} lt
WHERE term_id in {$term_ids_to_filter_by_list}
{$in_stock_clause}
)";
}
}
}
if ( ! empty( $attribute_ids_for_and_filtering ) ) {
$count = count( $attribute_ids_for_and_filtering );
$term_ids_to_filter_by_list = '(' . join( ',', $attribute_ids_for_and_filtering ) . ')';
$clauses[] = "
{$clause_root}
SELECT product_or_parent_id
FROM {$this->lookup_table_name} lt
WHERE is_variation_attribute=0
{$in_stock_clause}
AND term_id in {$term_ids_to_filter_by_list}
GROUP BY product_id
HAVING COUNT(product_id)={$count}
UNION
SELECT product_or_parent_id
FROM {$this->lookup_table_name} lt
WHERE is_variation_attribute=1
{$in_stock_clause}
AND term_id in {$term_ids_to_filter_by_list}
GROUP BY product_or_parent_id
HAVING COUNT(DISTINCT term_id)={$count}
)";
}
if ( ! empty( $clauses ) ) {
// "temp" is needed because the extra derived tables require an alias.
$args['where'] .= ' AND (' . join( ' temp ) AND ', $clauses ) . ' temp ))';
} elseif ( ! empty( $attributes_to_filter_by ) ) {
$args['where'] .= ' AND 1=0';
}
return $args;
}
/**
* Count products within certain terms, taking the main WP query into consideration,
* for the WC_Widget_Layered_Nav widget.
*
* This query allows counts to be generated based on the viewed products, not all products.
*
* @param array $term_ids Term IDs.
* @param string $taxonomy Taxonomy.
* @param string $query_type Query Type.
* @return array
*/
public function get_filtered_term_product_counts( $term_ids, $taxonomy, $query_type ) {
global $wpdb;
$use_lookup_table = $this->filtering_via_lookup_table_is_active();
$tax_query = \WC_Query::get_main_tax_query();
$meta_query = \WC_Query::get_main_meta_query();
if ( 'or' === $query_type ) {
foreach ( $tax_query as $key => $query ) {
if ( is_array( $query ) && $taxonomy === $query['taxonomy'] ) {
unset( $tax_query[ $key ] );
}
}
}
$meta_query = new \WP_Meta_Query( $meta_query );
$tax_query = new \WP_Tax_Query( $tax_query );
if ( $use_lookup_table ) {
$query = $this->get_product_counts_query_using_lookup_table( $tax_query, $meta_query, $taxonomy, $term_ids );
} else {
$query = $this->get_product_counts_query_not_using_lookup_table( $tax_query, $meta_query, $term_ids );
}
$query = apply_filters( 'woocommerce_get_filtered_term_product_counts_query', $query );
$query_sql = implode( ' ', $query );
// We have a query - let's see if cached results of this query already exist.
$query_hash = md5( $query_sql );
// Maybe store a transient of the count values.
$cache = apply_filters( 'woocommerce_layered_nav_count_maybe_cache', true );
if ( true === $cache ) {
$cached_counts = (array) get_transient( 'wc_layered_nav_counts_' . sanitize_title( $taxonomy ) );
} else {
$cached_counts = array();
}
if ( ! isset( $cached_counts[ $query_hash ] ) ) {
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$results = $wpdb->get_results( $query_sql, ARRAY_A );
$counts = array_map( 'absint', wp_list_pluck( $results, 'term_count', 'term_count_id' ) );
$cached_counts[ $query_hash ] = $counts;
if ( true === $cache ) {
set_transient( 'wc_layered_nav_counts_' . sanitize_title( $taxonomy ), $cached_counts, DAY_IN_SECONDS );
}
}
return array_map( 'absint', (array) $cached_counts[ $query_hash ] );
}
/**
* Get the query for counting products by terms using the product attributes lookup table.
*
* @param \WP_Tax_Query $tax_query The current main tax query.
* @param \WP_Meta_Query $meta_query The current main meta query.
* @param string $taxonomy The attribute name to get the term counts for.
* @param string $term_ids The term ids to include in the search.
* @return array An array of SQL query parts.
*/
private function get_product_counts_query_using_lookup_table( $tax_query, $meta_query, $taxonomy, $term_ids ) {
global $wpdb;
$meta_query_sql = $meta_query->get_sql( 'post', $this->lookup_table_name, 'product_or_parent_id' );
$tax_query_sql = $tax_query->get_sql( $this->lookup_table_name, 'product_or_parent_id' );
/**
* Filters the woocommerce_hide_out_of_stock_items option to override the default behavior in product filtering by attribute.
*
* @param bool $option_value The behavior configured in WooCommerce settings.
* @return bool The behavior to use in the catalog when product filtering by attribute.
*
* @since 9.5.0.
*/
$hide_out_of_stock = apply_filters( 'woocommerce_product_attributes_filterer_hide_out_of_stock', 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) );
$in_stock_clause = $hide_out_of_stock ? ' AND in_stock = 1' : '';
$query = array();
$query['select'] = 'SELECT COUNT(DISTINCT product_or_parent_id) as term_count, term_id as term_count_id';
$query['from'] = "FROM {$this->lookup_table_name}";
$query['join'] = "
{$tax_query_sql['join']} {$meta_query_sql['join']}
INNER JOIN {$wpdb->posts} ON {$wpdb->posts}.ID = {$this->lookup_table_name}.product_or_parent_id";
$encoded_taxonomy = sanitize_title( $taxonomy );
$term_ids_sql = $this->get_term_ids_sql( $term_ids );
$query['where'] = "
WHERE {$wpdb->posts}.post_type IN ( 'product' )
AND {$wpdb->posts}.post_status = 'publish'
{$tax_query_sql['where']} {$meta_query_sql['where']}
AND {$this->lookup_table_name}.taxonomy='{$encoded_taxonomy}'
AND {$this->lookup_table_name}.term_id IN $term_ids_sql
{$in_stock_clause}";
if ( ! empty( $term_ids ) ) {
$attributes_to_filter_by = \WC_Query::get_layered_nav_chosen_attributes();
if ( ! empty( $attributes_to_filter_by ) ) {
$and_term_ids = array();
foreach ( $attributes_to_filter_by as $taxonomy => $data ) {
if ( 'and' !== $data['query_type'] ) {
continue;
}
$all_terms = get_terms( $taxonomy, array( 'hide_empty' => false ) );
$term_ids_by_slug = wp_list_pluck( $all_terms, 'term_id', 'slug' );
$term_ids_to_filter_by = array_values( array_intersect_key( $term_ids_by_slug, array_flip( $data['terms'] ) ) );
$and_term_ids = array_merge( $and_term_ids, $term_ids_to_filter_by );
}
if ( ! empty( $and_term_ids ) ) {
$terms_count = count( $and_term_ids );
$term_ids_list = '(' . join( ',', $and_term_ids ) . ')';
// The extra derived table ("SELECT product_or_parent_id FROM") is needed for performance
// (causes the filtering subquery to be executed only once).
$query['where'] .= "
AND product_or_parent_id IN ( SELECT product_or_parent_id FROM (
SELECT product_or_parent_id
FROM {$this->lookup_table_name} lt
WHERE is_variation_attribute=0
{$in_stock_clause}
AND term_id in {$term_ids_list}
GROUP BY product_id
HAVING COUNT(product_id)={$terms_count}
UNION
SELECT product_or_parent_id
FROM {$this->lookup_table_name} lt
WHERE is_variation_attribute=1
{$in_stock_clause}
AND term_id in {$term_ids_list}
GROUP BY product_or_parent_id
HAVING COUNT(DISTINCT term_id)={$terms_count}
) temp )";
}
} else {
$query['where'] .= $in_stock_clause;
}
} elseif ( $hide_out_of_stock ) {
$query['where'] .= " AND {$this->lookup_table_name}.in_stock=1";
}
$search_query_sql = \WC_Query::get_main_search_query_sql();
if ( $search_query_sql ) {
$query['where'] .= ' AND ' . $search_query_sql;
}
$query['group_by'] = 'GROUP BY terms.term_id';
$query['group_by'] = "GROUP BY {$this->lookup_table_name}.term_id";
return $query;
}
/**
* Get the query for counting products by terms NOT using the product attributes lookup table.
*
* @param \WP_Tax_Query $tax_query The current main tax query.
* @param \WP_Meta_Query $meta_query The current main meta query.
* @param string $term_ids The term ids to include in the search.
* @return array An array of SQL query parts.
*/
private function get_product_counts_query_not_using_lookup_table( $tax_query, $meta_query, $term_ids ) {
global $wpdb;
$meta_query_sql = $meta_query->get_sql( 'post', $wpdb->posts, 'ID' );
$tax_query_sql = $tax_query->get_sql( $wpdb->posts, 'ID' );
// Generate query.
$query = array();
$query['select'] = "SELECT COUNT( DISTINCT {$wpdb->posts}.ID ) AS term_count, terms.term_id AS term_count_id";
$query['from'] = "FROM {$wpdb->posts}";
$query['join'] = "
INNER JOIN {$wpdb->term_relationships} AS term_relationships ON {$wpdb->posts}.ID = term_relationships.object_id
INNER JOIN {$wpdb->term_taxonomy} AS term_taxonomy USING( term_taxonomy_id )
INNER JOIN {$wpdb->terms} AS terms USING( term_id )
" . $tax_query_sql['join'] . $meta_query_sql['join'];
$term_ids_sql = $this->get_term_ids_sql( $term_ids );
$query['where'] = "
WHERE {$wpdb->posts}.post_type IN ( 'product' )
AND {$wpdb->posts}.post_status = 'publish'
{$tax_query_sql['where']} {$meta_query_sql['where']}
AND terms.term_id IN $term_ids_sql";
$search_query_sql = \WC_Query::get_main_search_query_sql();
if ( $search_query_sql ) {
$query['where'] .= ' AND ' . $search_query_sql;
}
$query['group_by'] = 'GROUP BY terms.term_id';
return $query;
}
/**
* Formats a list of term ids as "(id,id,id)".
*
* @param array $term_ids The list of terms to format.
* @return string The formatted list.
*/
private function get_term_ids_sql( $term_ids ) {
return '(' . implode( ',', array_map( 'absint', $term_ids ) ) . ')';
}
}
PK [1]=! + ProductAttributesLookup/LookupDataStore.phpnu lookup_table_name = $wpdb->prefix . 'wc_product_attributes_lookup';
$this->optimized_db_access_is_enabled =
$this->can_use_optimized_db_access() &&
'yes' === get_option( 'woocommerce_attribute_lookup_optimized_updates' );
$this->init_hooks();
}
/**
* Initialize the hooks used by the class.
*/
private function init_hooks() {
add_action( 'woocommerce_run_product_attribute_lookup_update_callback', array( $this, 'run_update_callback' ), 10, 2 );
add_filter( 'woocommerce_get_sections_products', array( $this, 'add_advanced_section_to_product_settings' ), 100, 1 );
add_action( 'woocommerce_rest_insert_product', array( $this, 'on_product_created_or_updated_via_rest_api' ), 100, 2 );
add_filter( 'woocommerce_get_settings_products', array( $this, 'add_product_attributes_lookup_table_settings' ), 100, 2 );
}
/**
* Check if optimized database access can be used when creating lookup table entries.
*
* @return bool True if optimized database access can be used.
*/
public function can_use_optimized_db_access() {
try {
return is_a( \WC_Data_Store::load( 'product' )->get_current_class_name(), 'WC_Product_Data_Store_CPT', true );
} catch ( \Exception $ex ) {
return false;
}
}
/**
* Check if the lookup table exists in the database.
*
* @return bool
*/
public function check_lookup_table_exists() {
global $wpdb;
$query = $wpdb->prepare( 'SHOW TABLES LIKE %s', $wpdb->esc_like( $this->lookup_table_name ) );
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
return $this->lookup_table_name === $wpdb->get_var( $query );
}
/**
* Get the name of the lookup table.
*
* @return string
*/
public function get_lookup_table_name() {
return $this->lookup_table_name;
}
/**
* Check if the last lookup data creation operation failed.
*
* @return bool True if the last lookup data creation operation failed.
*/
public function get_last_create_operation_failed() {
return $this->last_create_operation_failed;
}
/**
* Insert/update the appropriate lookup table entries for a new or modified product or variation.
* This must be invoked after a product or a variation is created (including untrashing and duplication)
* or modified.
*
* @param int|\WC_Product $product Product object or product id.
* @param null|array $changeset Changes as provided by 'get_changes' method in the product object, null if it's being created.
*/
public function on_product_changed( $product, $changeset = null ) {
if ( ! $this->check_lookup_table_exists() ) {
return;
}
if ( ! is_a( $product, \WC_Product::class ) ) {
$product = WC()->call_function( 'wc_get_product', $product );
}
$action = $this->get_update_action( $changeset );
if ( self::ACTION_NONE !== $action ) {
$this->maybe_schedule_update( $product->get_id(), $action );
}
}
/**
* Schedule an update of the product attributes lookup table for a given product.
* If an update for the same action is already scheduled, nothing is done.
*
* If the 'woocommerce_attribute_lookup_direct_update' option is set to 'yes',
* the update is done directly, without scheduling.
*
* @param int $product_id The product id to schedule the update for.
* @param int $action The action to perform, one of the ACTION_ constants.
*/
private function maybe_schedule_update( int $product_id, int $action ) {
if ( get_option( 'woocommerce_attribute_lookup_direct_updates' ) === 'yes' ) {
$this->run_update_callback( $product_id, $action );
return;
}
$args = array( $product_id, $action );
$queue = WC()->get_instance_of( \WC_Queue::class );
$already_scheduled = $queue->search(
array(
'hook' => 'woocommerce_run_product_attribute_lookup_update_callback',
'args' => $args,
'status' => \ActionScheduler_Store::STATUS_PENDING,
),
'ids'
);
if ( empty( $already_scheduled ) ) {
$queue->schedule_single(
WC()->call_function( 'time' ) + 1,
'woocommerce_run_product_attribute_lookup_update_callback',
$args,
'woocommerce-db-updates'
);
}
}
/**
* Perform an update of the lookup table for a specific product.
*
* @param int $product_id The product id to perform the update for.
* @param int $action The action to perform, one of the ACTION_ constants.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function run_update_callback( int $product_id, int $action ) {
if ( ! $this->check_lookup_table_exists() ) {
return;
}
$product = WC()->call_function( 'wc_get_product', $product_id );
if ( ! $product ) {
$action = self::ACTION_DELETE;
}
switch ( $action ) {
case self::ACTION_INSERT:
$this->delete_data_for( $product_id );
if ( $this->optimized_db_access_is_enabled ) {
$this->create_data_for_product_cpt( $product_id );
} else {
$this->create_data_for( $product );
}
break;
case self::ACTION_UPDATE_STOCK:
$this->update_stock_status_for( $product );
break;
case self::ACTION_DELETE:
$this->delete_data_for( $product_id );
break;
}
}
/**
* Determine the type of action to perform depending on the received changeset.
*
* @param array|null $changeset The changeset received by on_product_changed.
* @return int One of the ACTION_ constants.
*/
private function get_update_action( $changeset ) {
if ( is_null( $changeset ) ) {
// No changeset at all means that the product is new.
return self::ACTION_INSERT;
}
$keys = array_keys( $changeset );
// Order matters:
// - The change with the most precedence is a change in catalog visibility
// (which will result in all data being regenerated or deleted).
// - Then a change in attributes (all data will be regenerated).
// - And finally a change in stock status (existing data will be updated).
// Thus these conditions must be checked in that same order.
if ( in_array( 'catalog_visibility', $keys, true ) ) {
$new_visibility = $changeset['catalog_visibility'];
if ( CatalogVisibility::VISIBLE === $new_visibility || CatalogVisibility::CATALOG === $new_visibility ) {
return self::ACTION_INSERT;
} else {
return self::ACTION_DELETE;
}
}
if ( in_array( 'attributes', $keys, true ) ) {
return self::ACTION_INSERT;
}
if ( array_intersect( $keys, array( 'stock_quantity', 'stock_status', 'manage_stock' ) ) ) {
return self::ACTION_UPDATE_STOCK;
}
return self::ACTION_NONE;
}
/**
* Update the stock status of the lookup table entries for a given product.
*
* @param \WC_Product $product The product to update the entries for.
*/
private function update_stock_status_for( \WC_Product $product ) {
global $wpdb;
$in_stock = $product->is_in_stock();
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
$wpdb->query(
$wpdb->prepare(
'UPDATE ' . $this->lookup_table_name . ' SET in_stock = %d WHERE product_id = %d',
$in_stock ? 1 : 0,
$product->get_id()
)
);
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Delete the lookup table contents related to a given product or variation,
* if it's a variable product it deletes the information for variations too.
* This must be invoked after a product or a variation is trashed or deleted.
*
* @param int|\WC_Product $product Product object or product id.
*/
public function on_product_deleted( $product ) {
if ( ! $this->check_lookup_table_exists() ) {
return;
}
if ( is_a( $product, \WC_Product::class ) ) {
$product_id = $product->get_id();
} else {
$product_id = $product;
}
$this->maybe_schedule_update( $product_id, self::ACTION_DELETE );
}
/**
* Create the lookup data for a given product, if a variable product is passed
* the information is created for all of its variations.
* This method is intended to be called from the data regenerator.
*
* @param int|WC_Product $product Product object or id.
* @param bool $use_optimized_db_access Use direct database access for data retrieval if possible.
*/
public function create_data_for_product( $product, $use_optimized_db_access = false ) {
if ( $use_optimized_db_access ) {
$product_id = intval( ( $product instanceof \WC_Product ) ? $product->get_id() : $product );
$this->create_data_for_product_cpt( $product_id );
} else {
if ( ! is_a( $product, \WC_Product::class ) ) {
$product = WC()->call_function( 'wc_get_product', $product );
}
$this->delete_data_for( $product->get_id() );
$this->create_data_for( $product );
}
}
/**
* Create lookup table data for a given product.
*
* @param \WC_Product $product The product to create the data for.
*/
private function create_data_for( \WC_Product $product ) {
$this->last_create_operation_failed = false;
try {
if ( $this->is_variation( $product ) ) {
$this->create_data_for_variation( $product );
} elseif ( $this->is_variable_product( $product ) ) {
$this->create_data_for_variable_product( $product );
} else {
$this->create_data_for_simple_product( $product );
}
} catch ( \Exception $e ) {
$product_id = $product->get_id();
WC()->call_function( 'wc_get_logger' )->error(
"Lookup data creation (not optimized) failed for product $product_id: " . $e->getMessage(),
array(
'source' => 'palt-updates',
'exception' => $e,
'product_id' => $product_id,
)
);
$this->last_create_operation_failed = true;
}
}
/**
* Delete all the lookup table entries for a given product,
* if it's a variable product information for variations is deleted too.
*
* @param int $product_id Simple product id, or main/parent product id for variable products.
*/
private function delete_data_for( int $product_id ) {
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
$wpdb->query(
$wpdb->prepare(
'DELETE FROM ' . $this->lookup_table_name . ' WHERE product_id = %d OR product_or_parent_id = %d',
$product_id,
$product_id
)
);
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Create lookup table entries for a simple (non variable) product.
* Assumes that no entries exist yet.
*
* @param \WC_Product $product The product to create the entries for.
*/
private function create_data_for_simple_product( \WC_Product $product ) {
$product_attributes_data = $this->get_attribute_taxonomies( $product );
$has_stock = $product->is_in_stock();
$product_id = $product->get_id();
foreach ( $product_attributes_data as $taxonomy => $data ) {
$term_ids = $data['term_ids'];
foreach ( $term_ids as $term_id ) {
$this->insert_lookup_table_data( $product_id, $product_id, $taxonomy, $term_id, false, $has_stock );
}
}
}
/**
* Create lookup table entries for a variable product.
* Assumes that no entries exist yet.
*
* @param \WC_Product_Variable $product The product to create the entries for.
*/
private function create_data_for_variable_product( \WC_Product_Variable $product ) {
$product_attributes_data = $this->get_attribute_taxonomies( $product );
$variation_attributes_data = array_filter(
$product_attributes_data,
function ( $item ) {
return $item['used_for_variations'];
}
);
$non_variation_attributes_data = array_filter(
$product_attributes_data,
function ( $item ) {
return ! $item['used_for_variations'];
}
);
$main_product_has_stock = $product->is_in_stock();
$main_product_id = $product->get_id();
foreach ( $non_variation_attributes_data as $taxonomy => $data ) {
$term_ids = $data['term_ids'];
foreach ( $term_ids as $term_id ) {
$this->insert_lookup_table_data( $main_product_id, $main_product_id, $taxonomy, $term_id, false, $main_product_has_stock );
}
}
$term_ids_by_slug_cache = $this->get_term_ids_by_slug_cache( array_keys( $variation_attributes_data ) );
$variations = $this->get_variations_of( $product );
foreach ( $variation_attributes_data as $taxonomy => $data ) {
foreach ( $variations as $variation ) {
$this->insert_lookup_table_data_for_variation( $variation, $taxonomy, $main_product_id, $data['term_ids'], $term_ids_by_slug_cache );
}
}
}
/**
* Create all the necessary lookup data for a given variation.
*
* @param \WC_Product_Variation $variation The variation to create entries for.
* @throws \Exception Can't retrieve the details of the parent product.
*/
private function create_data_for_variation( \WC_Product_Variation $variation ) {
$main_product = WC()->call_function( 'wc_get_product', $variation->get_parent_id() );
if ( false === $main_product ) {
// phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
throw new \Exception( "The product is a variation, and the retrieval of data for the parent product (id {$variation->get_parent_id()}) failed." );
}
$product_attributes_data = $this->get_attribute_taxonomies( $main_product );
$variation_attributes_data = array_filter(
$product_attributes_data,
function ( $item ) {
return $item['used_for_variations'];
}
);
$term_ids_by_slug_cache = $this->get_term_ids_by_slug_cache( array_keys( $variation_attributes_data ) );
foreach ( $variation_attributes_data as $taxonomy => $data ) {
$this->insert_lookup_table_data_for_variation( $variation, $taxonomy, $main_product->get_id(), $data['term_ids'], $term_ids_by_slug_cache );
}
}
/**
* Create lookup table entries for a given variation, corresponding to a given taxonomy and a set of term ids.
*
* @param \WC_Product_Variation $variation The variation to create entries for.
* @param string $taxonomy The taxonomy to create the entries for.
* @param int $main_product_id The parent product id.
* @param array $term_ids The term ids to create entries for.
* @param array $term_ids_by_slug_cache A dictionary of term ids by term slug, as returned by 'get_term_ids_by_slug_cache'.
*/
private function insert_lookup_table_data_for_variation( \WC_Product_Variation $variation, string $taxonomy, int $main_product_id, array $term_ids, array $term_ids_by_slug_cache ) {
$variation_id = $variation->get_id();
$variation_has_stock = $variation->is_in_stock();
$variation_definition_term_id = $this->get_variation_definition_term_id( $variation, $taxonomy, $term_ids_by_slug_cache );
if ( $variation_definition_term_id ) {
$this->insert_lookup_table_data( $variation_id, $main_product_id, $taxonomy, $variation_definition_term_id, true, $variation_has_stock );
} else {
$term_ids_for_taxonomy = $term_ids;
foreach ( $term_ids_for_taxonomy as $term_id ) {
$this->insert_lookup_table_data( $variation_id, $main_product_id, $taxonomy, $term_id, true, $variation_has_stock );
}
}
}
/**
* Get a cache of term ids by slug for a set of taxonomies, with this format:
*
* [
* 'taxonomy' => [
* 'slug_1' => id_1,
* 'slug_2' => id_2,
* ...
* ], ...
* ]
*
* @param array $taxonomies List of taxonomies to build the cache for.
* @return array A dictionary of taxonomies => dictionary of term slug => term id.
*/
private function get_term_ids_by_slug_cache( $taxonomies ) {
$result = array();
foreach ( $taxonomies as $taxonomy ) {
$terms = WC()->call_function(
'get_terms',
array(
'taxonomy' => wc_sanitize_taxonomy_name( $taxonomy ),
'hide_empty' => false,
'fields' => 'id=>slug',
)
);
$result[ $taxonomy ] = array_flip( $terms );
}
return $result;
}
/**
* Get the id of the term that defines a variation for a given taxonomy,
* or null if there's no such defining id (for variations having "Any " as the definition)
*
* @param \WC_Product_Variation $variation The variation to get the defining term id for.
* @param string $taxonomy The taxonomy to get the defining term id for.
* @param array $term_ids_by_slug_cache A term ids by slug as generated by get_term_ids_by_slug_cache.
* @return int|null The term id, or null if there's no defining id for that taxonomy in that variation.
*/
private function get_variation_definition_term_id( \WC_Product_Variation $variation, string $taxonomy, array $term_ids_by_slug_cache ) {
$variation_attributes = $variation->get_attributes();
$term_slug = ArrayUtil::get_value_or_default( $variation_attributes, $taxonomy );
if ( $term_slug ) {
return $term_ids_by_slug_cache[ $taxonomy ][ $term_slug ];
} else {
return null;
}
}
/**
* Get the variations of a given variable product.
*
* @param \WC_Product_Variable $product The product to get the variations for.
* @return array An array of WC_Product_Variation objects.
*/
private function get_variations_of( \WC_Product_Variable $product ) {
$variation_ids = $product->get_children();
return array_map(
function ( $id ) {
return WC()->call_function( 'wc_get_product', $id );
},
$variation_ids
);
}
/**
* Check if a given product is a variable product.
*
* @param \WC_Product $product The product to check.
* @return bool True if it's a variable product, false otherwise.
*/
private function is_variable_product( \WC_Product $product ) {
return is_a( $product, \WC_Product_Variable::class );
}
/**
* Check if a given product is a variation.
*
* @param \WC_Product $product The product to check.
* @return bool True if it's a variation, false otherwise.
*/
private function is_variation( \WC_Product $product ) {
return is_a( $product, \WC_Product_Variation::class );
}
/**
* Return the list of taxonomies used for variations on a product together with
* the associated term ids, with the following format:
*
* [
* 'taxonomy_name' =>
* [
* 'term_ids' => [id, id, ...],
* 'used_for_variations' => true|false
* ], ...
* ]
*
* @param \WC_Product $product The product to get the attribute taxonomies for.
* @return array Information about the attribute taxonomies of the product.
*/
private function get_attribute_taxonomies( \WC_Product $product ) {
$product_attributes = $product->get_attributes();
$result = array();
foreach ( $product_attributes as $taxonomy_name => $attribute_data ) {
if ( ! $attribute_data->get_id() ) {
// Custom product attribute, not suitable for attribute-based filtering.
continue;
}
$result[ $taxonomy_name ] = array(
'term_ids' => $attribute_data->get_options(),
'used_for_variations' => $attribute_data->get_variation(),
);
}
return $result;
}
/**
* Insert one entry in the lookup table.
*
* @param int $product_id The product id.
* @param int $product_or_parent_id The product id for non-variable products, the main/parent product id for variations.
* @param string $taxonomy Taxonomy name.
* @param int $term_id Term id.
* @param bool $is_variation_attribute True if the taxonomy corresponds to an attribute used to define variations.
* @param bool $has_stock True if the product is in stock.
*/
private function insert_lookup_table_data( int $product_id, int $product_or_parent_id, string $taxonomy, int $term_id, bool $is_variation_attribute, bool $has_stock ) {
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
$wpdb->query(
$wpdb->prepare(
'INSERT INTO ' . $this->lookup_table_name . ' (
product_id,
product_or_parent_id,
taxonomy,
term_id,
is_variation_attribute,
in_stock)
VALUES
( %d, %d, %s, %d, %d, %d )',
$product_id,
$product_or_parent_id,
$taxonomy,
$term_id,
$is_variation_attribute ? 1 : 0,
$has_stock ? 1 : 0
)
);
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Handler for the woocommerce_rest_insert_product hook.
* Needed to update the lookup table when the REST API batch insert/update endpoints are used.
*
* @param \WP_Post $product The post representing the created or updated product.
* @param \WP_REST_Request $request The REST request that caused the hook to be fired.
* @return void
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function on_product_created_or_updated_via_rest_api( \WP_Post $product, \WP_REST_Request $request ): void {
if ( StringUtil::ends_with( $request->get_route(), '/batch' ) ) {
$this->on_product_changed( $product->ID );
}
}
/**
* Tells if a lookup table regeneration is currently in progress.
*
* @return bool True if a lookup table regeneration is already in progress.
*/
public function regeneration_is_in_progress() {
return get_option( 'woocommerce_attribute_lookup_regeneration_in_progress', null ) === 'yes';
}
/**
* Set a permanent flag (via option) indicating that the lookup table regeneration is in process.
*/
public function set_regeneration_in_progress_flag() {
update_option( 'woocommerce_attribute_lookup_regeneration_in_progress', 'yes' );
}
/**
* Remove the flag indicating that the lookup table regeneration is in process.
*/
public function unset_regeneration_in_progress_flag() {
delete_option( 'woocommerce_attribute_lookup_regeneration_in_progress' );
}
/**
* Set a flag indicating that the last lookup table regeneration process started was aborted.
*/
public function set_regeneration_aborted_flag() {
update_option( 'woocommerce_attribute_lookup_regeneration_aborted', 'yes' );
}
/**
* Remove the flag indicating that the last lookup table regeneration process started was aborted.
*/
public function unset_regeneration_aborted_flag() {
delete_option( 'woocommerce_attribute_lookup_regeneration_aborted' );
}
/**
* Tells if the last lookup table regeneration process started was aborted
* (via deleting the 'woocommerce_attribute_lookup_regeneration_in_progress' option).
*
* @return bool True if the last lookup table regeneration process was aborted.
*/
public function regeneration_was_aborted(): bool {
return get_option( 'woocommerce_attribute_lookup_regeneration_aborted' ) === 'yes';
}
/**
* Check if the lookup table contains any entry at all.
*
* @return bool True if the table contains entries, false if the table is empty.
*/
public function lookup_table_has_data(): bool {
global $wpdb;
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return ( (int) $wpdb->get_var( "SELECT EXISTS (SELECT 1 FROM {$this->lookup_table_name})" ) ) !== 0;
}
/**
* Handler for 'woocommerce_get_sections_products', adds the "Advanced" section to the product settings.
*
* @param array $products Original array of settings sections.
* @return array New array of settings sections.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function add_advanced_section_to_product_settings( array $products ): array {
if ( $this->check_lookup_table_exists() ) {
$products['advanced'] = __( 'Advanced', 'woocommerce' );
}
return $products;
}
/**
* Handler for 'woocommerce_get_settings_products', adds the settings related to the product attributes lookup table.
*
* @param array $settings Original settings configuration array.
* @param string $section_id Settings section identifier.
* @return array New settings configuration array.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function add_product_attributes_lookup_table_settings( array $settings, string $section_id ): array {
if ( 'advanced' === $section_id && $this->check_lookup_table_exists() ) {
$title_item = array(
'title' => __( 'Product attributes lookup table', 'woocommerce' ),
'type' => 'title',
);
$regeneration_is_in_progress = $this->regeneration_is_in_progress();
if ( $regeneration_is_in_progress ) {
$title_item['desc'] = __( 'These settings are not available while the lookup table regeneration is in progress.', 'woocommerce' );
}
$settings[] = $title_item;
if ( ! $regeneration_is_in_progress ) {
$regeneration_aborted_warning =
$this->regeneration_was_aborted() ?
sprintf(
"
%s
%s
",
__( 'WARNING: The product attributes lookup table regeneration process was aborted.', 'woocommerce' ),
__( 'This means that the table is probably in an inconsistent state. It\'s recommended to run a new regeneration process or to resume the aborted process (Status - Tools - Regenerate the product attributes lookup table/Resume the product attributes lookup table regeneration) before enabling the table usage.', 'woocommerce' )
) : null;
$settings[] = array(
'title' => __( 'Enable table usage', 'woocommerce' ),
'desc' => __( 'Use the product attributes lookup table for catalog filtering.', 'woocommerce' ),
'desc_tip' => $regeneration_aborted_warning,
'id' => 'woocommerce_attribute_lookup_enabled',
'default' => 'no',
'type' => 'checkbox',
'checkboxgroup' => 'start',
);
$settings[] = array(
'title' => __( 'Direct updates', 'woocommerce' ),
'desc' => __( 'Update the table directly upon product changes, instead of scheduling a deferred update.', 'woocommerce' ),
'id' => 'woocommerce_attribute_lookup_direct_updates',
'default' => 'no',
'type' => 'checkbox',
'checkboxgroup' => 'start',
);
$settings[] = array(
'title' => __( 'Optimized updates', 'woocommerce' ),
'desc' => __( 'Uses much more performant queries to update the lookup table, but may not be compatible with some extensions.', 'woocommerce' ),
'desc_tip' => __( 'This setting only works when product data is stored in the posts table.', 'woocommerce' ),
'id' => 'woocommerce_attribute_lookup_optimized_updates',
'default' => 'no',
'type' => 'checkbox',
'checkboxgroup' => 'start',
);
}
$settings[] = array( 'type' => 'sectionend' );
}
return $settings;
}
/**
* Check if the optimized database access setting is enabled.
*
* @return bool True if the optimized database access setting is enabled.
*/
public function optimized_data_access_is_enabled() {
return 'yes' === get_option( 'woocommerce_attribute_lookup_optimized_updates' );
}
/**
* Create the lookup table data for a product or variation using optimized database access.
* For variable products entries are created for the main product and for all the variations.
*
* @param int $product_id Product or variation id.
*/
private function create_data_for_product_cpt( int $product_id ) {
$this->last_create_operation_failed = false;
try {
$this->create_data_for_product_cpt_core( $product_id );
} catch ( \Exception $e ) {
$data = array(
'source' => 'palt-updates',
'product_id' => $product_id,
);
if ( $e instanceof \WC_Data_Exception ) {
$data = array_merge( $data, $e->getErrorData() );
} else {
$data['exception'] = $e;
}
WC()->call_function( 'wc_get_logger' )
->error( "Lookup data creation (optimized) failed for product $product_id: " . $e->getMessage(), $data );
$this->last_create_operation_failed = true;
}
}
/**
* Core version of create_data_for_product_cpt (doesn't catch exceptions).
*
* @param int $product_id Product or variation id.
* @return void
* @throws \WC_Data_Exception Wrongly serialized attribute data found, or INSERT statement failed.
*/
private function create_data_for_product_cpt_core( int $product_id ) {
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL
$sql = $wpdb->prepare(
"delete from {$this->lookup_table_name} where product_or_parent_id=%d",
$product_id
);
$wpdb->query( $sql );
// phpcs:enable WordPress.DB.PreparedSQL
// * Obtain list of product variations, together with stock statuses; also get the product type.
// For a variation this will return just one entry, with type 'variation'.
// Output: $product_ids_with_stock_status = associative array where 'id' is the key and values are the stock status (1 for "in stock", 0 otherwise).
// $variation_ids = raw list of variation ids.
// $is_variable_product = true or false.
// $is_variation = true or false.
$sql = $wpdb->prepare(
"(select p.ID as id, null parent, m.meta_value as stock_status, t.name as product_type from {$wpdb->posts} p
left join {$wpdb->postmeta} m on p.id=m.post_id and m.meta_key='_stock_status'
left join {$wpdb->term_relationships} tr on tr.object_id=p.id
left join {$wpdb->term_taxonomy} tt on tt.term_taxonomy_id=tr.term_taxonomy_id
left join {$wpdb->terms} t on t.term_id=tt.term_id
where p.post_type = 'product'
and p.post_status in ('publish', 'draft', 'pending', 'private')
and tt.taxonomy='product_type'
and t.name != 'exclude-from-search'
and p.id=%d
limit 1)
union
(select p.ID as id, p.post_parent as parent, m.meta_value as stock_status, 'variation' as product_type from {$wpdb->posts} p
left join {$wpdb->postmeta} m on p.id=m.post_id and m.meta_key='_stock_status'
where p.post_type = 'product_variation'
and p.post_status in ('publish', 'draft', 'pending', 'private')
and (p.ID=%d or p.post_parent=%d));
",
$product_id,
$product_id,
$product_id
);
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$product_ids_with_stock_status = $wpdb->get_results( $sql, ARRAY_A );
$main_product_row = array_filter( $product_ids_with_stock_status, fn( $item ) => ProductType::VARIATION !== $item['product_type'] );
$is_variation = empty( $main_product_row );
$main_product_id =
$is_variation ?
current( $product_ids_with_stock_status )['parent'] :
$product_id;
$is_variable_product = ! $is_variation && ( ProductType::VARIABLE === current( $main_product_row )['product_type'] );
$product_ids_with_stock_status = ArrayUtil::group_by_column( $product_ids_with_stock_status, 'id', true );
$variation_ids = $is_variation ? array( $product_id ) : array_keys( array_diff_key( $product_ids_with_stock_status, array( $product_id => null ) ) );
$product_ids_with_stock_status = ArrayUtil::select( $product_ids_with_stock_status, 'stock_status' );
$product_ids_with_stock_status = array_map( fn( $item ) => ProductStockStatus::IN_STOCK === $item ? 1 : 0, $product_ids_with_stock_status );
// * Obtain the list of attributes used for variations and not.
// Output: two lists of attribute slugs, all starting with 'pa_'.
$sql = $wpdb->prepare(
"select meta_value from {$wpdb->postmeta} where post_id=%d and meta_key=%s",
$main_product_id,
'_product_attributes'
);
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$temp = $wpdb->get_var( $sql );
if ( is_null( $temp ) ) {
// The product has no attributes, thus there's no attributes lookup data to generate.
return;
}
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
$temp = unserialize( $temp );
if ( false === $temp ) {
throw new \WC_Data_Exception( 0, 'The product attributes metadata row is not properly serialized' );
}
$temp = array_filter( $temp, fn( $item, $slug ) => StringUtil::starts_with( $slug, 'pa_' ) && '' === $item['value'], ARRAY_FILTER_USE_BOTH );
$attributes_not_for_variations =
$is_variation || $is_variable_product ?
array_keys( array_filter( $temp, fn( $item ) => 0 === $item['is_variation'] ) ) :
array_keys( $temp );
// * Obtain the terms used for each attribute.
// Output: $terms_used_per_attribute =
// [
// 'pa_...' => [
// [
// 'term_id' => ,
// 'attribute' => 'pa_...'
// 'slug' =>
// ],...
// ],...
// ]
$sql = $wpdb->prepare(
"select tt.term_id, tt.taxonomy as attribute, t.slug from {$wpdb->prefix}term_relationships tr
join {$wpdb->term_taxonomy} tt on tt.term_taxonomy_id = tr.term_taxonomy_id
join {$wpdb->terms} t on t.term_id=tt.term_id
where tr.object_id=%d and taxonomy like %s;",
$main_product_id,
'pa_%'
);
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$terms_used_per_attribute = $wpdb->get_results( $sql, ARRAY_A );
foreach ( $terms_used_per_attribute as &$term ) {
$term['attribute'] = strtolower( rawurlencode( $term['attribute'] ) );
}
$terms_used_per_attribute = ArrayUtil::group_by_column( $terms_used_per_attribute, 'attribute' );
// * Obtain the actual variations defined (only if variations exist).
// Output: $variations_defined =
// [
// => [
// [
// 'variation_id' => ,
// 'attribute' => 'pa_...'
// 'slug' =>
// ],...
// ],...
// ]
//
// Note that this does NOT include "any..." attributes!
if ( ! $is_variation && ( ! $is_variable_product || empty( $variation_ids ) ) ) {
$variations_defined = array();
} else {
$sql = $wpdb->prepare(
"select post_id as variation_id, substr(meta_key,11) as attribute, meta_value as slug from {$wpdb->postmeta}
where post_id in (select ID from {$wpdb->posts} where (id=%d or post_parent=%d) and post_type = 'product_variation')
and meta_key like %s
and meta_value != ''",
$product_id,
$product_id,
'attribute_pa_%'
);
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$variations_defined = $wpdb->get_results( $sql, ARRAY_A );
$variations_defined = ArrayUtil::group_by_column( $variations_defined, 'variation_id' );
}
// Now we'll fill an array with all the data rows to be inserted in the lookup table.
$insert_data = array();
// * Insert data for the main product
if ( ! $is_variation ) {
foreach ( $attributes_not_for_variations as $attribute_name ) {
foreach ( ( $terms_used_per_attribute[ $attribute_name ] ?? array() ) as $attribute_data ) {
$insert_data[] = array( $product_id, $main_product_id, $attribute_name, $attribute_data['term_id'], 0, $product_ids_with_stock_status[ $product_id ] );
}
}
}
// * Insert data for the variations defined
// Remove the non-variation attributes data first.
$terms_used_per_attribute = array_diff_key( $terms_used_per_attribute, array_flip( $attributes_not_for_variations ) );
$used_attributes_per_variation = array();
foreach ( $variations_defined as $variation_id => $variation_data ) {
$used_attributes_per_variation[ $variation_id ] = array();
foreach ( $variation_data as $variation_attribute_data ) {
$attribute_name = $variation_attribute_data['attribute'];
$used_attributes_per_variation[ $variation_id ][] = $attribute_name;
$term_id = current( array_filter( ( $terms_used_per_attribute[ $attribute_name ] ?? array() ), fn( $item ) => $item['slug'] === $variation_attribute_data['slug'] ) )['term_id'] ?? null;
if ( is_null( $term_id ) ) {
continue;
}
$insert_data[] = array( $variation_id, $main_product_id, $attribute_name, $term_id, 1, $product_ids_with_stock_status[ $variation_id ] ?? false );
}
}
// * Insert data for variations that have "any..." attributes and at least one defined attribute
foreach ( $used_attributes_per_variation as $variation_id => $attributes_list ) {
$any_attributes = array_diff_key( $terms_used_per_attribute, array_flip( $attributes_list ) );
foreach ( $any_attributes as $attributes_data ) {
foreach ( $attributes_data as $attribute_data ) {
$insert_data[] = array( $variation_id, $main_product_id, $attribute_data['attribute'], $attribute_data['term_id'], 1, $product_ids_with_stock_status[ $variation_id ] ?? false );
}
}
}
// * Insert data for variations that have all their attributes defined as "any..."
$variations_with_all_any = array_keys( array_diff_key( array_flip( $variation_ids ), $used_attributes_per_variation ) );
foreach ( $variations_with_all_any as $variation_id ) {
foreach ( $terms_used_per_attribute as $attribute_name => $attribute_terms ) {
foreach ( $attribute_terms as $attribute_term ) {
$insert_data[] = array( $variation_id, $main_product_id, $attribute_name, $attribute_term['term_id'], 1, $product_ids_with_stock_status[ $variation_id ] ?? false );
}
}
}
// * We have all the data to insert, let's go and insert it.
$insert_data_chunks = array_chunk( $insert_data, 100 );
foreach ( $insert_data_chunks as $insert_data_chunk ) {
$sql = 'INSERT INTO ' . $this->lookup_table_name . ' (
product_id,
product_or_parent_id,
taxonomy,
term_id,
is_variation_attribute,
in_stock)
VALUES (';
$values_strings = array();
foreach ( $insert_data_chunk as $dataset ) {
$attribute_name = esc_sql( $dataset[2] );
$values_strings[] = "{$dataset[0]},{$dataset[1]},'{$attribute_name}',{$dataset[3]},{$dataset[4]},{$dataset[5]}";
}
$sql .= implode( '),(', $values_strings ) . ')';
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$result = $wpdb->query( $sql );
if ( false === $result ) {
throw new \WC_Data_Exception(
0,
'INSERT statement failed',
0,
array(
'db_error' => esc_html( $wpdb->last_error ),
'db_query' => esc_html( $wpdb->last_query ),
)
);
}
}
}
}
PK [1]C]S ]S % ProductAttributesLookup/CLIRunner.phpnu data_regenerator = $container->get( DataRegenerator::class );
$this->lookup_data_store = $container->get( LookupDataStore::class );
}
// phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
/**
* Enable the usage of the product attributes lookup table.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function enable( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'enable_core', $args, $assoc_args );
}
/**
* Core method for the "enable" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function enable_core( array $args, array $assoc_args ) {
$table_name = $this->lookup_data_store->get_lookup_table_name();
if ( 'yes' === get_option( 'woocommerce_attribute_lookup_enabled' ) ) {
$this->warning( "The usage of the of the %W{$table_name}%n table is already enabled." );
return;
}
if ( ! array_key_exists( 'force', $assoc_args ) ) {
$must_confirm = true;
if ( $this->lookup_data_store->regeneration_is_in_progress() ) {
$this->warning( "The regeneration of the %W{$table_name}%n table is currently in process." );
} elseif ( $this->lookup_data_store->regeneration_was_aborted() ) {
$this->warning( "The regeneration of the %W{$table_name}%n table was aborted." );
} elseif ( 0 === $this->get_lookup_table_info()['total_rows'] ) {
$this->warning( "The %W{$table_name}%n table is empty." );
} else {
$must_confirm = false;
}
if ( $must_confirm ) {
WP_CLI::confirm( 'Are you sure that you want to enable the table usage?' );
}
}
update_option( 'woocommerce_attribute_lookup_enabled', 'yes' );
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->success( "The usage of the %W{$table_name}%n table for product attribute lookup has been enabled." );
}
/**
* Disable the usage of the product attributes lookup table.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function disable( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'disable_core', $args, $assoc_args );
}
/**
* Core method for the "disable" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function disable_core( array $args, array $assoc_args ) {
if ( 'yes' !== get_option( 'woocommerce_attribute_lookup_enabled' ) ) {
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->warning( "The usage of the of the %W{$table_name}%n table is already disabled." );
return;
}
update_option( 'woocommerce_attribute_lookup_enabled', 'no' );
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->success( "The usage of the %W{$table_name}%n table for product attribute lookup has been disabled." );
}
/**
* Regenerate the product attributes lookup table data for one single product.
*
* ## OPTIONS
*
*
* : The id of the product for which the data will be regenerated.
*
* [--disable-db-optimization]
* : Don't use optimized database access even if products are stored as custom post types.
*
* ## EXAMPLES
*
* wp wc palt regenerate_for_product 34 --disable-db-optimization
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function regenerate_for_product( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'regenerate_for_product_core', $args, $assoc_args );
}
/**
* Core method for the "regenerate_for_product" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function regenerate_for_product_core( array $args = array(), array $assoc_args = array() ) {
$product_id = current( $args );
$this->data_regenerator->check_can_do_lookup_table_regeneration( $product_id );
$use_db_optimization = ! array_key_exists( 'disable-db-optimization', $assoc_args );
$this->check_can_use_db_optimization( $use_db_optimization );
$start_time = microtime( true );
$this->lookup_data_store->create_data_for_product( $product_id, $use_db_optimization );
if ( $this->lookup_data_store->get_last_create_operation_failed() ) {
$this->error( "Lookup data regeneration failed.\nSee the WooCommerce logs (source is %9palt-updates%n) for details." );
} else {
$total_time = microtime( true ) - $start_time;
WP_CLI::success( sprintf( 'Attributes lookup data for product %d regenerated in %f seconds.', $product_id, $total_time ) );
}
}
/**
* If database access optimization is requested but can't be used, show a warning.
*
* @param bool $use_db_optimization True if database access optimization is requested.
*/
private function check_can_use_db_optimization( bool $use_db_optimization ) {
if ( $use_db_optimization && ! $this->lookup_data_store->can_use_optimized_db_access() ) {
$this->warning( "Optimized database access can't be used (products aren't stored as custom post types)." );
}
}
/**
* Obtain information about the product attributes lookup table.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function info( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'info_core', $args, $assoc_args );
}
/**
* Core method for the "info" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function info_core( array $args, array $assoc_args ) {
global $wpdb;
$enabled = 'yes' === get_option( 'woocommerce_attribute_lookup_enabled' );
$table_name = $this->lookup_data_store->get_lookup_table_name();
$info = $this->get_lookup_table_info();
$this->log( "Table name: %W{$table_name}%n" );
$this->log( 'Table usage is ' . ( $enabled ? '%Genabled%n' : '%Ydisabled%n' ) );
$this->log( "The table contains %C{$info['total_rows']}%n rows corresponding to %G{$info['products_count']}%n products." );
if ( $info['total_rows'] > 0 ) {
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$highest_product_id_in_table = $wpdb->get_var( 'select max(product_or_parent_id) from ' . $table_name );
$this->log( "The highest product id in the table is %B{$highest_product_id_in_table}%n." );
}
if ( $this->lookup_data_store->regeneration_is_in_progress() ) {
$max_product_id_to_process = get_option( 'woocommerce_attribute_lookup_last_product_id_to_process', '???' );
WP_CLI::log( '' );
$this->warning( 'Full regeneration of the table is currently %Gin progress.%n' );
if ( ! $this->data_regenerator->has_scheduled_action_for_regeneration_step() ) {
$this->log( 'However, there are %9NO%n actions scheduled to run the regeneration steps (a %9wp cli palt regenerate%n command was aborted?).' );
}
$this->log( "The last product id that will be processed is %Y{$max_product_id_to_process}%n." );
$this->log( "\nRun %9wp cli palt abort_regeneration%n to abort the regeneration process," );
$this->log( "then you'll be able to run %9wp cli palt resume_regeneration%n to resume the regeneration process," );
} elseif ( $this->lookup_data_store->regeneration_was_aborted() ) {
$max_product_id_to_process = get_option( 'woocommerce_attribute_lookup_last_product_id_to_process', '???' );
WP_CLI::log( '' );
$this->warning( "Full regeneration of the table has been %Raborted.%n\nThe last product id that will be processed is %Y{$max_product_id_to_process}%n." );
$this->log( "\nRun %9wp cli palt resume_regeneration%n to resume the regeneration process." );
}
}
/**
* Abort the background regeneration of the product attributes lookup table that is happening in the background.
*
* [--cleanup]
* : Also cleanup temporary data (so regeneration can't be resumed, but it can be restarted).
*
* ## EXAMPLES
*
* wp wc palt abort_regeneration --cleanup
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function abort_regeneration( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'abort_regeneration_core', $args, $assoc_args );
}
/**
* Core method for the "abort_regeneration" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function abort_regeneration_core( array $args, array $assoc_args ) {
$this->data_regenerator->abort_regeneration( false );
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->success( "The regeneration of the data in the %W{$table_name}%n table has been aborted." );
if ( array_key_exists( 'cleanup', $assoc_args ) ) {
$this->cleanup_regeneration_progress( array(), array() );
}
}
/**
* Resume the background regeneration of the product attributes lookup table after it has been aborted.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function resume_regeneration( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'resume_regeneration_core', $args, $assoc_args );
}
/**
* Core method for the "resume_regeneration" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function resume_regeneration_core( array $args, array $assoc_args ) {
$this->data_regenerator->resume_regeneration( false );
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->success( "The regeneration of the data in the %W{$table_name}%n table has been resumed." );
}
/**
* Delete the temporary data used during the regeneration of the product attributes lookup table. This data is normally deleted automatically after the regeneration process finishes.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function cleanup_regeneration_progress( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'cleanup_regeneration_progress_core', $args, $assoc_args );
}
/**
* Core method for the "cleanup_regeneration_progress" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function cleanup_regeneration_progress_core( array $args, array $assoc_args ) {
$this->data_regenerator->finalize_regeneration( false );
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->success( "The temporary data used for regeneration of the data in the %W{$table_name}%n table has been deleted." );
}
/**
* Initiate the background regeneration of the product attributes lookup table. The regeneration will happen in the background, using scheduled actions.
*
* ## OPTIONS
*
* [--force]
* : Don't prompt for confirmation if the product attributes lookup table isn't empty.
*
* ## EXAMPLES
*
* wp wc palt initiate_regeneration --force
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function initiate_regeneration( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'initiate_regeneration_core', $args, $assoc_args );
}
/**
* Core method for the "initiate_regeneration" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
private function initiate_regeneration_core( array $args, array $assoc_args ) {
$this->data_regenerator->check_can_do_lookup_table_regeneration();
$info = $this->get_lookup_table_info();
if ( $info['total_rows'] > 0 && ! array_key_exists( 'force', $assoc_args ) ) {
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->warning( "The %W{$table_name}%n table contains %C{$info['total_rows']}%n rows corresponding to %G{$info['products_count']}%n products." );
WP_CLI::confirm( 'Initiating the regeneration will first delete the data. Are you sure?' );
}
$this->data_regenerator->initiate_regeneration();
$table_name = $this->lookup_data_store->get_lookup_table_name();
$this->log( "%GSuccess:%n The regeneration of the data in the %W{$table_name}%n table has been initiated." );
}
/**
* Regenerate the product attributes lookup table immediately, without using scheduled tasks.
*
* ## OPTIONS
*
* [--force]
* : Don't prompt for confirmation if the product attributes lookup table isn't empty.
*
* [--from-scratch]
* : Start table regeneration from scratch even if a regeneration is already in progress.
*
* [--disable-db-optimization]
* : Don't use optimized database access even if products are stored as custom post types.
*
* [--batch-size=]
* : How many products to process in each iteration of the loop.
* ---
* default: 10
* ---
*
* ## EXAMPLES
*
* wp wc palt regenerate --force --from-scratch --batch-size=20
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function regenerate( array $args = array(), array $assoc_args = array() ) {
return $this->invoke( 'regenerate_core', $args, $assoc_args );
}
/**
* Core method for the "regenerate" command.
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
* @throws \Exception Invalid batch size argument.
*/
private function regenerate_core( array $args = array(), array $assoc_args = array() ) {
global $wpdb;
$table_name = $this->lookup_data_store->get_lookup_table_name();
$batch_size = $assoc_args['batch-size'] ?? DataRegenerator::PRODUCTS_PER_GENERATION_STEP;
if ( ! is_numeric( $batch_size ) || $batch_size < 1 ) {
throw new \Exception( 'batch_size must be a number bigger than 0' );
}
$was_enabled = 'yes' === get_option( 'woocommerce_attribute_lookup_enabled' );
// phpcs:ignore Generic.Commenting.Todo.TaskFound
// TODO: adjust for non-CPT datastores (this is only used for the progress bar, though).
$products_count = wp_count_posts( 'product' );
$products_count = intval( $products_count->publish ) + intval( $products_count->pending ) + intval( $products_count->draft );
if ( ! $this->lookup_data_store->regeneration_is_in_progress() || array_key_exists( 'from-scratch', $assoc_args ) ) {
$info = $this->get_lookup_table_info();
if ( $info['total_rows'] > 0 && ! array_key_exists( 'force', $assoc_args ) ) {
$this->warning( "The %W{$table_name}%n table contains %C{$info['total_rows']}%n rows corresponding to %G{$info['products_count']}%n products." );
WP_CLI::confirm( 'Triggering the regeneration will first delete the data. Are you sure?' );
}
$this->data_regenerator->finalize_regeneration( false );
$last_product_id = $this->data_regenerator->initiate_regeneration( false );
if ( 0 === $last_product_id ) {
$this->data_regenerator->finalize_regeneration( $was_enabled );
WP_CLI::log( 'No products exist in the database, the table is left empty.' );
return;
}
$processed_count = 0;
} else {
$last_product_id = get_option( 'woocommerce_attribute_lookup_last_product_id_to_process' );
if ( false === $last_product_id ) {
WP_CLI::error( 'Regeneration seems to be already in progress, but the woocommerce_attribute_lookup_last_product_id_to_process option isn\'t there. Try %9wp cli palt cleanup_regeneration_progress%n first." );' );
return 1;
}
$processed_count = get_option( 'woocommerce_attribute_lookup_processed_count', 0 );
$this->log( "Resuming regeneration, %C{$processed_count}%n products have been processed already" );
$this->lookup_data_store->set_regeneration_in_progress_flag();
}
$this->data_regenerator->cancel_regeneration_scheduled_action();
$use_db_optimization = ! array_key_exists( 'disable-db-optimization', $assoc_args );
$this->check_can_use_db_optimization( $use_db_optimization );
$progress = WP_CLI\Utils\make_progress_bar( '', $products_count );
$this->log( "Regenerating %W{$table_name}%n..." );
$progress->tick( $processed_count );
$regeneration_step_failed = false;
while ( $this->data_regenerator->do_regeneration_step( $batch_size, $use_db_optimization ) ) {
$progress->tick( $batch_size );
$regeneration_step_failed = $regeneration_step_failed || $this->data_regenerator->get_last_regeneration_step_failed();
}
$this->data_regenerator->finalize_regeneration( $was_enabled );
$time = $progress->formatTime( $progress->elapsed() );
$progress->finish();
if ( $regeneration_step_failed ) {
$this->warning( "Lookup data regeneration failed for at least one product.\nSee the WooCommerce logs (source is %9palt-updates%n) for details.\n" );
$this->log( "Table %W{$table_name}%n regenerated in {$time}." );
} else {
$this->log( "%GSuccess:%n Table %W{$table_name}%n regenerated in {$time}." );
}
$info = $this->get_lookup_table_info();
$this->log( "The table contains now %C{$info['total_rows']}%n rows corresponding to %G{$info['products_count']}%n products." );
}
// phpcs:enable Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
/**
* Get information about the product attributes lookup table.
*
* @return array Array containing the 'total_rows' and 'products_count' keys.
*/
private function get_lookup_table_info(): array {
global $wpdb;
$table_name = $this->lookup_data_store->get_lookup_table_name();
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$info = $wpdb->get_row( 'select count(1), count(distinct(product_or_parent_id)) from ' . $table_name, ARRAY_N );
return array(
'total_rows' => absint( $info[0] ),
'products_count' => absint( $info[1] ),
);
}
/**
* Invoke a method from the class, and if an exception is thrown, show it using WP_CLI::error.
*
* @param string $method_name Name of the method to invoke.
* @param array $args Positional arguments to pass to the method.
* @param array $assoc_args Associative arguments to pass to the method.
* @return mixed Result from the method, or 1 if an exception is thrown.
*/
private function invoke( string $method_name, array $args, array $assoc_args ) {
try {
return call_user_func( array( $this, $method_name ), $args, $assoc_args );
} catch ( \Exception $e ) {
WP_CLI::error( $e->getMessage() );
return 1;
}
}
/**
* Show a log message using the WP_CLI text colorization feature.
*
* @param string $text Text to show.
*/
private function log( string $text ) {
WP_CLI::log( WP_CLI::colorize( $text ) );
}
/**
* Show a warning message using the WP_CLI text colorization feature.
*
* @param string $text Text to show.
*/
private function warning( string $text ) {
WP_CLI::warning( WP_CLI::colorize( $text ) );
}
/**
* Show a success message using the WP_CLI text colorization feature.
*
* @param string $text Text to show.
*/
private function success( string $text ) {
WP_CLI::success( WP_CLI::colorize( $text ) );
}
/**
* Show an error message using the WP_CLI text colorization feature.
*
* @param string $text Text to show.
*/
private function error( string $text ) {
WP_CLI::error( WP_CLI::colorize( $text ) );
}
}
PK [1]ZY Y + ProductAttributesLookup/DataRegenerator.phpnu lookup_table_name = $wpdb->prefix . 'wc_product_attributes_lookup';
add_filter( 'woocommerce_debug_tools', array( $this, 'add_initiate_regeneration_entry_to_tools_array' ), 1, 999 );
add_action( 'woocommerce_run_product_attribute_lookup_regeneration_callback', array( $this, 'run_regeneration_step_callback' ) );
add_action( 'woocommerce_installed', array( $this, 'run_woocommerce_installed_callback' ) );
}
/**
* Class initialization, invoked by the DI container.
*
* @internal
* @param LookupDataStore $data_store The data store to use.
*/
final public function init( LookupDataStore $data_store ) {
$this->data_store = $data_store;
}
/**
* Check if the last regeneration step failed.
*
* @return bool True if the last regeneration step failed.
*/
public function get_last_regeneration_step_failed() {
return $this->last_regeneration_step_failed;
}
/**
* Initialize the regeneration procedure:
* deletes the lookup table and related options if they exist,
* then it creates the table and runs the first step of the regeneration process.
*
* If $in_background is true, regeneration will continue in the background using scheduled actions.
* If $in_background is false, do_regeneration_step and finalize_regeneration must be invoked explicitly.
*
* This method is intended to be used as a callback for a db update in wc-update-functions
* and in the CLI commands, regeneration triggered from the tools page will use
* initiate_regeneration_from_tools_page instead.
*
* @param bool $in_background True if regeneration will continue in the background using scheduled actions.
* @return int Highest product id that will be processed.
*/
public function initiate_regeneration( bool $in_background = true ): int {
$this->check_can_do_lookup_table_regeneration();
$this->enable_or_disable_lookup_table_usage( false );
$this->delete_all_attributes_lookup_data( true );
$last_product_id = $this->initialize_table_and_data();
if ( $last_product_id > 0 ) {
$this->data_store->set_regeneration_in_progress_flag();
if ( $in_background ) {
$this->enqueue_regeneration_step_run();
}
} else {
$this->finalize_regeneration( true );
}
return $last_product_id;
}
/**
* Delete all the existing data related to the lookup table, optionally including the table itself.
*
* @param bool $truncate_table True to truncate the lookup table too.
*/
private function delete_all_attributes_lookup_data( bool $truncate_table ) {
global $wpdb;
delete_option( 'woocommerce_attribute_lookup_enabled' );
delete_option( 'woocommerce_attribute_lookup_last_product_id_to_process' );
delete_option( 'woocommerce_attribute_lookup_processed_count' );
$this->data_store->unset_regeneration_in_progress_flag();
$this->data_store->unset_regeneration_aborted_flag();
if ( $truncate_table && $this->data_store->check_lookup_table_exists() ) {
$this->truncate_lookup_table();
}
}
/**
* Delete all the data from the lookup table.
*/
public function truncate_lookup_table() {
global $wpdb;
$wpdb->query( "TRUNCATE TABLE {$this->lookup_table_name}" ); // phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Create the lookup table and initialize the options that will be temporarily used
* while the regeneration is in progress.
*
* @return int Id of the last product id that will be processed.
*/
private function initialize_table_and_data(): int {
$database_util = wc_get_container()->get( DatabaseUtil::class );
$database_util->dbdelta( $this->get_table_creation_sql() );
$last_existing_product_id = $this->get_last_existing_product_id();
if ( ! $last_existing_product_id ) {
// No products exist, nothing to (re)generate.
return 0;
}
update_option( 'woocommerce_attribute_lookup_last_product_id_to_process', $last_existing_product_id );
update_option( 'woocommerce_attribute_lookup_processed_count', 0 );
return $last_existing_product_id;
}
/**
* Get the highest existing product id.
*
* @return int|null Highest existing product id, or null if no products exist at all.
*/
private function get_last_existing_product_id(): ?int {
$last_existing_product_id_array =
WC()->call_function(
'wc_get_products',
array(
'return' => 'ids',
'limit' => 1,
'orderby' => array(
'ID' => 'DESC',
),
)
);
return empty( $last_existing_product_id_array ) ? null : current( $last_existing_product_id_array );
}
/**
* Action scheduler callback, performs one regeneration step and then
* schedules the next step if necessary.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function run_regeneration_step_callback() {
if ( ! $this->data_store->regeneration_is_in_progress() ) {
// No regeneration in progress at this point means that the regeneration process
// was manually aborted via deleting the 'woocommerce_attribute_lookup_regeneration_in_progress' option.
$this->data_store->set_regeneration_aborted_flag();
$this->finalize_regeneration( false );
return;
}
$result = $this->do_regeneration_step( null, $this->data_store->optimized_data_access_is_enabled() );
if ( $result ) {
$this->enqueue_regeneration_step_run();
} else {
$this->finalize_regeneration( true );
}
}
/**
* Enqueue one regeneration step in action scheduler.
*/
private function enqueue_regeneration_step_run() {
$queue = WC()->get_instance_of( \WC_Queue::class );
$queue->schedule_single(
WC()->call_function( 'time' ) + 1,
'woocommerce_run_product_attribute_lookup_regeneration_callback',
array(),
'woocommerce-db-updates'
);
}
/**
* Perform one regeneration step: grabs a chunk of products and creates
* the appropriate entries for them in the lookup table.
*
* @param int|null $step_size How many products to process, by default PRODUCTS_PER_GENERATION_STEP will be used.
* @param bool $use_optimized_db_access Use direct database access for data retrieval if possible.
* @return bool True if more steps need to be run, false otherwise.
*/
public function do_regeneration_step( ?int $step_size = null, bool $use_optimized_db_access = false ) {
/**
* Filter to alter the count of products that will be processed in each step of the product attributes lookup table regeneration process.
*
* @since 6.3
* @param int $count Default processing step size.
*/
$products_per_generation_step = apply_filters( 'woocommerce_attribute_lookup_regeneration_step_size', $step_size ?? self::PRODUCTS_PER_GENERATION_STEP );
$products_already_processed = get_option( 'woocommerce_attribute_lookup_processed_count', 0 );
$product_ids = WC()->call_function(
'wc_get_products',
array(
'limit' => $products_per_generation_step,
'offset' => $products_already_processed,
'orderby' => array(
'ID' => 'ASC',
),
'return' => 'ids',
)
);
if ( ! is_array( $product_ids ) || empty( $product_ids ) ) {
return false;
}
$this->last_regeneration_step_failed = false;
foreach ( $product_ids as $id ) {
$this->data_store->create_data_for_product( $id, $use_optimized_db_access );
$this->last_regeneration_step_failed = $this->last_regeneration_step_failed || $this->data_store->get_last_create_operation_failed();
}
$products_already_processed += count( $product_ids );
update_option( 'woocommerce_attribute_lookup_processed_count', $products_already_processed );
$last_product_id_to_process = get_option( 'woocommerce_attribute_lookup_last_product_id_to_process', PHP_INT_MAX );
return end( $product_ids ) < $last_product_id_to_process;
}
/**
* Cleanup/final option setup after the regeneration has been completed.
*
* @param bool $enable_usage Whether the table usage should be enabled or not.
*/
public function finalize_regeneration( bool $enable_usage ) {
$this->cancel_regeneration_scheduled_action();
$this->delete_all_attributes_lookup_data( false );
update_option( 'woocommerce_attribute_lookup_enabled', $enable_usage ? 'yes' : 'no' );
}
/**
* Add a 'Regenerate product attributes lookup table' entry to the Status - Tools page.
*
* @param array $tools_array The tool definitions array that is passed ro the woocommerce_debug_tools filter.
* @return array The tools array with the entry added.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function add_initiate_regeneration_entry_to_tools_array( array $tools_array ) {
if ( ! $this->data_store->check_lookup_table_exists() ) {
return $tools_array;
}
$generation_is_in_progress = $this->data_store->regeneration_is_in_progress();
$generation_was_aborted = $this->data_store->regeneration_was_aborted();
$entry = array(
'name' => __( 'Regenerate the product attributes lookup table', 'woocommerce' ),
'desc' => __( 'This tool will regenerate the product attributes lookup table data from existing product(s) data. This process may take a while.', 'woocommerce' ),
'requires_refresh' => true,
'callback' => function () {
$this->initiate_regeneration_from_tools_page();
return __( 'Product attributes lookup table data is regenerating', 'woocommerce' );
},
'selector' => array(
'description' => __( 'Select a product to regenerate the data for, or leave empty for a full table regeneration:', 'woocommerce' ),
'class' => 'wc-product-search',
'search_action' => 'woocommerce_json_search_products',
'name' => 'regenerate_product_attribute_lookup_data_product_id',
'placeholder' => esc_attr__( 'Search for a product…', 'woocommerce' ),
),
);
if ( $generation_is_in_progress ) {
$entry['button'] = sprintf(
/* translators: %d: How many products have been processed so far. */
__( 'Filling in progress (%d)', 'woocommerce' ),
get_option( 'woocommerce_attribute_lookup_processed_count', 0 )
);
$entry['disabled'] = true;
} else {
$entry['button'] = __( 'Regenerate', 'woocommerce' );
}
$tools_array['regenerate_product_attributes_lookup_table'] = $entry;
if ( $generation_is_in_progress ) {
$entry = array(
'name' => __( 'Abort the product attributes lookup table regeneration', 'woocommerce' ),
'desc' => __( 'This tool will abort the regenerate product attributes lookup table regeneration. After this is done the process can be either started over, or resumed to continue where it stopped.', 'woocommerce' ),
'requires_refresh' => true,
'callback' => function () {
$this->abort_regeneration( true );
return __( 'Product attributes lookup table regeneration process has been aborted.', 'woocommerce' );
},
'button' => __( 'Abort', 'woocommerce' ),
);
$tools_array['abort_product_attributes_lookup_table_regeneration'] = $entry;
} elseif ( $generation_was_aborted ) {
$processed_count = get_option( 'woocommerce_attribute_lookup_processed_count', 0 );
$entry = array(
'name' => __( 'Resume the product attributes lookup table regeneration', 'woocommerce' ),
'desc' =>
sprintf(
/* translators: %1$s = count of products already processed. */
__( 'This tool will resume the product attributes lookup table regeneration at the point in which it was aborted (%1$s products were already processed).', 'woocommerce' ),
$processed_count
),
'requires_refresh' => true,
'callback' => function () {
$this->resume_regeneration( true );
return __( 'Product attributes lookup table regeneration process has been resumed.', 'woocommerce' );
},
'button' => __( 'Resume', 'woocommerce' ),
);
$tools_array['resume_product_attributes_lookup_table_regeneration'] = $entry;
}
return $tools_array;
}
/**
* Callback to initiate the regeneration process from the Status - Tools page.
*
* @throws \Exception The regeneration is already in progress.
*/
private function initiate_regeneration_from_tools_page() {
$this->verify_tool_execution_nonce();
//phpcs:disable WordPress.Security.NonceVerification.Recommended
if ( isset( $_REQUEST['regenerate_product_attribute_lookup_data_product_id'] ) ) {
$product_id = (int) $_REQUEST['regenerate_product_attribute_lookup_data_product_id'];
$this->check_can_do_lookup_table_regeneration( $product_id );
$this->data_store->create_data_for_product( $product_id, $this->data_store->optimized_data_access_is_enabled() );
} else {
$this->initiate_regeneration();
}
//phpcs:enable WordPress.Security.NonceVerification.Recommended
}
/**
* Enable or disable the actual lookup table usage.
*
* @param bool $enable True to enable, false to disable.
* @throws \Exception A lookup table regeneration is currently in progress.
*/
private function enable_or_disable_lookup_table_usage( $enable ) {
if ( $this->data_store->regeneration_is_in_progress() ) {
throw new \Exception( "Can't enable or disable the attributes lookup table usage while it's regenerating." );
}
update_option( 'woocommerce_attribute_lookup_enabled', $enable ? 'yes' : 'no' );
}
/**
* Check if everything is good to go to perform a complete or per product lookup table data regeneration
* and throw an exception if not.
*
* @param mixed $product_id The product id to check the regeneration viability for, or null to check if a complete regeneration is possible.
* @throws \Exception Something prevents the regeneration from starting.
*/
public function check_can_do_lookup_table_regeneration( $product_id = null ) {
if ( $product_id && ! $this->data_store->check_lookup_table_exists() ) {
throw new \Exception( "Can't do product attribute lookup data regeneration: lookup table doesn't exist" );
}
if ( $this->data_store->regeneration_is_in_progress() ) {
throw new \Exception( "Can't do product attribute lookup data regeneration: regeneration is already in progress" );
}
if ( $product_id && ! wc_get_product( $product_id ) ) {
throw new \Exception( "Can't do product attribute lookup data regeneration: product doesn't exist" );
}
}
/**
* Callback to abort the regeneration process from the Status - Tools page or from CLI.
*
* @param bool $verify_nonce True to perform nonce verification (needed when running the tool from the tools page).
* @throws \Exception The lookup table doesn't exist, or there's no regeneration process in progress to abort.
*/
public function abort_regeneration( bool $verify_nonce ) {
if ( $verify_nonce ) {
$this->verify_tool_execution_nonce();
}
if ( ! $this->data_store->check_lookup_table_exists() ) {
throw new \Exception( "Can't abort the product attribute lookup data regeneration process: lookup table doesn't exist" );
}
if ( ! $this->data_store->regeneration_is_in_progress() ) {
throw new \Exception( "Can't abort the product attribute lookup data regeneration process since it's not currently in progress" );
}
$this->cancel_regeneration_scheduled_action();
$this->data_store->unset_regeneration_in_progress_flag();
$this->data_store->set_regeneration_aborted_flag();
$this->enable_or_disable_lookup_table_usage( false );
// Note that we are NOT deleting the options that track the regeneration progress (processed count, last product id to process).
// This is on purpose so that the regeneration can be resumed where it stopped.
}
/**
* Cancel any existing regeneration step scheduled action.
*/
public function cancel_regeneration_scheduled_action() {
$queue = WC()->get_instance_of( \WC_Queue::class );
$queue->cancel_all( 'woocommerce_run_product_attribute_lookup_regeneration_callback' );
}
/**
* Check if any pending regeneration step scheduled action exists.
*
* @return bool True if any pending regeneration step scheduled action exists.
*/
public function has_scheduled_action_for_regeneration_step(): bool {
$queue = WC()->get_instance_of( \WC_Queue::class );
$actions = $queue->search(
array(
'hook' => 'woocommerce_run_product_attribute_lookup_regeneration_callback',
'status' => \ActionScheduler_Store::STATUS_PENDING,
),
'ids'
);
return ! empty( $actions );
}
/**
* Callback to resume the regeneration process from the Status - Tools page or from CLI.
*
* @param bool $verify_nonce True to perform nonce verification (needed when running the tool from the tools page).
* @throws \Exception The lookup table doesn't exist, or a regeneration process is already in place or hasn't been aborted.
*/
public function resume_regeneration( bool $verify_nonce ) {
if ( $verify_nonce ) {
$this->verify_tool_execution_nonce();
}
if ( ! $this->data_store->check_lookup_table_exists() ) {
throw new \Exception( "Can't resume the product attribute lookup data regeneration process: lookup table doesn't exist" );
}
if ( $this->data_store->regeneration_is_in_progress() ) {
throw new \Exception( "Can't resume the product attribute lookup data regeneration process: regeneration is already in progress" );
}
if ( ! $this->data_store->regeneration_was_aborted() ) {
throw new \Exception( "Can't resume the product attribute lookup data regeneration process: no aborted regeneration process exists" );
}
$this->data_store->unset_regeneration_aborted_flag();
$this->data_store->set_regeneration_in_progress_flag();
$this->enqueue_regeneration_step_run();
}
/**
* Verify the validity of the nonce received when executing a tool from the Status - Tools page.
*
* @throws \Exception Missing or invalid nonce received.
*/
private function verify_tool_execution_nonce() {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput
if ( ! isset( $_REQUEST['_wpnonce'] ) || wp_verify_nonce( $_REQUEST['_wpnonce'], 'debug_action' ) === false ) {
throw new \Exception( 'Invalid nonce' );
}
}
/**
* Get the name of the product attributes lookup table.
*
* @return string
*/
public function get_lookup_table_name() {
return $this->lookup_table_name;
}
/**
* Get the SQL statement that creates the product attributes lookup table, including the indices.
*
* @return string
*/
public function get_table_creation_sql() {
global $wpdb;
$collate = $wpdb->has_cap( 'collation' ) ? $wpdb->get_charset_collate() : '';
return "CREATE TABLE {$this->lookup_table_name} (
product_id bigint(20) NOT NULL,
product_or_parent_id bigint(20) NOT NULL,
taxonomy varchar(32) NOT NULL,
term_id bigint(20) NOT NULL,
is_variation_attribute tinyint(1) NOT NULL,
in_stock tinyint(1) NOT NULL,
INDEX is_variation_attribute_term_id (is_variation_attribute, term_id),
PRIMARY KEY ( `product_or_parent_id`, `term_id`, `product_id`, `taxonomy` )
) $collate;";
}
/**
* Create the primary key for the table if it doesn't exist already.
* It also deletes the product_or_parent_id_term_id index if it exists, since it's now redundant.
*
* @return void
*/
public function create_table_primary_index() {
$database_util = wc_get_container()->get( DatabaseUtil::class );
$database_util->create_primary_key( $this->lookup_table_name, array( 'product_or_parent_id', 'term_id', 'product_id', 'taxonomy' ) );
$database_util->drop_table_index( $this->lookup_table_name, 'product_or_parent_id_term_id' );
if ( empty( $database_util->get_index_columns( $this->lookup_table_name ) ) ) {
wc_get_logger()->error( "The creation of the primary key for the {$this->lookup_table_name} table failed" );
}
if ( ! empty( $database_util->get_index_columns( $this->lookup_table_name, 'product_or_parent_id_term_id' ) ) ) {
wc_get_logger()->error( "Dropping the product_or_parent_id_term_id index from the {$this->lookup_table_name} table failed" );
}
}
/**
* Run additional setup needed after a WooCommerce install or update finishes.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function run_woocommerce_installed_callback() {
// The table must exist at this point (created via dbDelta), but we check just in case.
if ( ! $this->data_store->check_lookup_table_exists() ) {
return;
}
// If a table regeneration is in progress, leave it alone.
if ( $this->data_store->regeneration_is_in_progress() ) {
return;
}
// If the lookup table has data, or if it's empty because there are no products yet, we're good.
// Otherwise (lookup table is empty but products exist) we need to initiate a regeneration if one isn't already in progress.
if ( $this->data_store->lookup_table_has_data() || ! $this->get_last_existing_product_id() ) {
$must_enable = get_option( 'woocommerce_attribute_lookup_enabled' ) !== 'no';
$this->delete_all_attributes_lookup_data( false );
update_option( 'woocommerce_attribute_lookup_enabled', $must_enable ? 'yes' : 'no' );
} else {
$this->initiate_regeneration();
}
}
}
PK [1] : ProductFeed/ProductFeed.phpnu integration_registry = $integration_registry;
$this->integration_registry->register_integration( $pos_integration );
}
/**
* Allows extensions to register integrations.
*
* @since 10.5.0
* @param IntegrationInterface $integration The integration to register.
* @return void
*/
public function register_integration( IntegrationInterface $integration ): void {
$this->integration_registry->register_integration( $integration );
}
/**
* Initialize plugin components
*
* @since 10.5.0
*/
public function register(): void {
// Let all integrations register their hooks.
foreach ( $this->integration_registry->get_integrations() as $integration ) {
$integration->register_hooks();
}
}
/**
* Plugin activation
*
* @since 10.5.0
*/
public function activate(): void {
foreach ( $this->integration_registry->get_integrations() as $integration ) {
$integration->activate();
}
}
/**
* Plugin deactivation
*
* @since 10.5.0
*/
public function deactivate(): void {
foreach ( $this->integration_registry->get_integrations() as $integration ) {
$integration->deactivate();
}
}
}
PK [1]h + ProductFeed/Feed/ProductMapperInterface.phpnu mapper = $mapper;
$this->validator = $validator;
$this->feed = $feed;
$this->product_loader = $product_loader;
$this->memory_manager = $memory_manager;
$this->query_args = $query_args;
}
/**
* Creates a new instance of the ProductWalker class based on an integration.
*
* The walker will mostly be set up based on the integration.
* The feed is provided externally, as it might be based on the context (CLI, REST, Action Scheduler, etc.).
*
* @since 10.5.0
*
* @param IntegrationInterface $integration The integration.
* @param FeedInterface $feed The feed.
* @return self The ProductWalker instance.
*/
public static function from_integration(
IntegrationInterface $integration,
FeedInterface $feed
): self {
$query_args = array_merge(
array(
'status' => array( 'publish' ),
'return' => 'objects',
),
$integration->get_product_feed_query_args()
);
/**
* Allows the base arguments for querying products for product feeds to be changed.
*
* Variable products are not included by default, as their variations will be included.
*
* @since 10.5.0
*
* @param array $query_args The arguments to pass to wc_get_products().
* @param IntegrationInterface $integration The integration that the query belongs to.
* @return array
*/
$query_args = apply_filters(
'woocommerce_product_feed_args',
$query_args,
$integration
);
$instance = new self(
$integration->get_product_mapper(),
$integration->get_feed_validator(),
$feed,
wc_get_container()->get( ProductLoader::class ),
wc_get_container()->get( MemoryManager::class ),
$query_args
);
return $instance;
}
/**
* Set the number of products to iterate through per batch.
*
* @since 10.5.0
*
* @param int $batch_size The number of products to iterate through per batch.
* @return self
*/
public function set_batch_size( int $batch_size ): self {
if ( $batch_size < 1 ) {
$batch_size = 1;
}
$this->per_page = $batch_size;
return $this;
}
/**
* Set the time limit to extend the execution time limit per batch.
*
* @since 10.5.0
*
* @param int $time_limit Time limit in seconds.
* @return self
*/
public function add_time_limit( int $time_limit ): self {
if ( $time_limit < 0 ) {
$time_limit = 0;
}
$this->time_limit = $time_limit;
return $this;
}
/**
* Walks through all products.
*
* @since 10.5.0
*
* @param callable $callback The callback to call after each batch of products is processed.
* @return int The total number of products processed.
*/
public function walk( ?callable $callback = null ): int {
$progress = null;
// Instruct the feed to start.
$this->feed->start();
// Check how much memory is available at first.
$initial_available_memory = $this->memory_manager->get_available_memory();
do {
$result = $this->iterate( $this->query_args, $progress ? $progress->processed_batches + 1 : 1, $this->per_page );
$iterated = count( $result->products );
// Only done when the progress is not set. Will be modified otherwise.
if ( is_null( $progress ) ) {
$progress = WalkerProgress::from_wc_get_products_result( $result );
}
$progress->processed_items += $iterated;
++$progress->processed_batches;
if ( is_callable( $callback ) && $iterated > 0 ) {
$callback( $progress );
}
if ( $this->time_limit > 0 ) {
set_time_limit( $this->time_limit );
}
// We don't want to use more than half of the available memory at the beginning of the script.
$current_memory = $this->memory_manager->get_available_memory();
if ( $initial_available_memory - $current_memory >= $initial_available_memory / 2 ) {
$this->memory_manager->flush_caches();
}
} while (
// If `wc_get_products()` returns less than the batch size, it was the last page.
$iterated === $this->per_page
// For the cases where the above is true, make sure that we do not exceed the total number of pages.
&& $progress->processed_batches < $progress->total_batch_count
);
// Instruct the feed to end.
$this->feed->end();
return $progress->processed_items;
}
/**
* Iterates through a batch of products.
*
* @param array $args The arguments to pass to wc_get_products().
* @param int $page The page number to iterate through.
* @param int $limit The maximum number of products to iterate through.
* @return \stdClass The result of the query with properties: products, total, max_num_pages.
*/
private function iterate( array $args = array(), int $page = 1, int $limit = 100 ): \stdClass {
/**
* Result is always stdClass when paginate=true.
*
* @var \stdClass $result
*/
$result = $this->product_loader->get_products(
array_merge(
$args,
array(
'page' => $page,
'limit' => $limit,
'paginate' => true,
)
)
);
foreach ( $result->products as $product ) {
$mapped_data = $this->mapper->map_product( $product );
if ( ! empty( $this->validator->validate_entry( $mapped_data, $product ) ) ) {
continue;
}
$this->feed->add_entry( $mapped_data );
}
return $result;
}
}
PK [1]H(& # ProductFeed/Feed/WalkerProgress.phpnu total_count = $result->total;
$progress->total_batch_count = $result->max_num_pages;
$progress->processed_items = 0;
$progress->processed_batches = 0;
return $progress;
}
}
PK [1] SbdZ Z + ProductFeed/Feed/FeedValidatorInterface.phpnu container = $container;
}
/**
* {@inheritdoc}
*/
public function get_id(): string {
return 'pos';
}
/**
* {@inheritdoc}
*/
public function get_product_feed_query_args(): array {
return array(
'type' => array( 'simple', 'variable', 'variation' ),
// phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
'tax_query' => array(
array(
'taxonomy' => 'pos_product_visibility',
'field' => 'slug',
'terms' => 'pos-hidden',
'operator' => 'NOT IN',
),
),
);
}
/**
* {@inheritdoc}
*/
public function register_hooks(): void {
add_action( 'rest_api_init', array( $this, 'rest_api_init' ) );
$this->container->get( AsyncGenerator::class )->register_hooks();
$this->container->get( POSProductVisibilitySync::class )->register_hooks();
}
/**
* Initialize the REST API.
*
* @return void
*/
public function rest_api_init(): void {
// Only load the controller when necessary.
$this->container->get( ApiController::class )->register_routes();
}
/**
* {@inheritdoc}
*/
public function activate(): void {
// At the moment, there are no activation steps for the POS catalog.
}
/**
* {@inheritdoc}
*/
public function deactivate(): void {
// At the moment, there are no deactivation steps for the POS catalog.
}
/**
* {@inheritdoc}
*/
public function create_feed(): FeedInterface {
return new JsonFileFeed( 'pos-catalog-feed' );
}
/**
* {@inheritdoc}
*/
public function get_product_mapper(): ProductMapper {
return $this->container->get( ProductMapper::class );
}
/**
* {@inheritdoc}
*/
public function get_feed_validator(): FeedValidatorInterface {
return $this->container->get( FeedValidator::class );
}
}
PK [1]? 5 ProductFeed/Integrations/POSCatalog/ApiController.phpnu container = $container;
}
/**
* Register the routes for the API controller.
*/
public function register_routes(): void {
register_rest_route(
self::ROUTE_NAMESPACE,
'/create',
array(
'methods' => 'POST',
'callback' => array( $this, 'generate_feed' ),
'permission_callback' => array( $this, 'is_authorized' ),
'args' => array(
'force' => array(
'type' => 'boolean',
'default' => false,
'description' => 'Force regeneration of the feed. NOOP if generation is in progress.',
),
'_product_fields' => array(
'type' => 'string',
'description' => 'Comma-separated list of fields to include for non-variable products.',
'required' => false,
),
'_variation_fields' => array(
'type' => 'string',
'description' => 'Comma-separated list of fields to include for variations.',
'required' => false,
),
),
)
);
}
/**
* Checks if the current user has the necessary permissions to access the API.
*
* @return bool True if the user has the necessary permissions, false otherwise.
*/
public function is_authorized() {
return is_user_logged_in() && (
current_user_can( 'manage_woocommerce' ) || current_user_can( 'manage_options' )
);
}
/**
* Starts generating a feed.
*
* @param WP_REST_Request> $request The request object.
* @return WP_REST_Response The response object.
*/
public function generate_feed( WP_REST_Request $request ): WP_REST_Response { // phpcs:ignore Squiz.Commenting.FunctionComment.IncorrectTypeHint
$generator = $this->container->get( AsyncGenerator::class );
try {
$params = array();
if ( null !== $request['_product_fields'] ) {
$params['_product_fields'] = $request['_product_fields'];
}
if ( null !== $request['_variation_fields'] ) {
$params['_variation_fields'] = $request['_variation_fields'];
}
$response = $request->get_param( 'force' )
? $generator->force_regeneration( $params )
: $generator->get_status( $params );
// Use the right datetime format.
if ( isset( $response['scheduled_at'] ) ) {
$response['scheduled_at'] = wc_rest_prepare_date_response( $response['scheduled_at'] );
}
if ( isset( $response['completed_at'] ) ) {
$response['completed_at'] = wc_rest_prepare_date_response( $response['completed_at'] );
}
// Remove sensitive data from the response.
if ( isset( $response['action_id'] ) ) {
unset( $response['action_id'] );
}
if ( isset( $response['path'] ) ) {
unset( $response['path'] );
}
} catch ( \Exception $e ) {
wc_get_logger()->error(
'Feed generation failed',
array( 'error' => $e->getMessage() )
);
return new WP_REST_Response(
array(
'success' => false,
'message' => __( 'An error occurred while generating the feed.', 'woocommerce' ),
),
500
);
}
return new WP_REST_Response( $response );
}
}
PK [1]L9+ + 6 ProductFeed/Integrations/POSCatalog/AsyncGenerator.phpnu integration = $integration;
}
/**
* Register hooks for the async generator.
*
* @since 10.5.0
*
* @return void
*/
public function register_hooks(): void {
add_action( self::FEED_GENERATION_ACTION, array( $this, 'feed_generation_action' ) );
add_action( self::FEED_DELETION_ACTION, array( $this, 'feed_deletion_action' ), 10, 2 );
}
/**
* Returns the current feed generation status.
* Initiates one if not already running.
*
* @since 10.5.0
*
* @param array|null $args The arguments to pass to the action.
* @return array The feed generation status.
*/
public function get_status( ?array $args = null ): array {
// Determine the option key based on the integration ID and arguments.
$option_key = $this->get_option_key( $args );
$status = get_option( $option_key );
// For existing jobs, make sure that everything in the status makes sense.
if ( is_array( $status ) && ! $this->validate_status( $status ) ) {
$status = false;
}
// If the status is an array, it means that there is nothing to schedule in this method.
if ( is_array( $status ) ) {
return $status;
}
// Clear all previous actions to avoid race conditions.
as_unschedule_all_actions( self::FEED_GENERATION_ACTION, array( $option_key ), 'woo-product-feed' ); // @phpstan-ignore function.notFound
$status = array(
'scheduled_at' => time(),
'completed_at' => null,
'state' => self::STATE_SCHEDULED,
'progress' => 0,
'processed' => 0,
'total' => -1,
'args' => $args ?? array(),
);
update_option(
$option_key,
$status
);
// Start an immediate async action to generate the feed.
// @phpstan-ignore-next-line function.notFound -- Action Scheduler.
as_enqueue_async_action(
self::FEED_GENERATION_ACTION,
array( $option_key ),
'woo-product-feed',
true,
1
);
// Manually force an async request to be dispatched to process the action immediately.
if ( class_exists( ActionScheduler_AsyncRequest_QueueRunner::class ) && class_exists( ActionScheduler_Store::class ) ) {
$store = ActionScheduler_Store::instance();
$async_request = new ActionScheduler_AsyncRequest_QueueRunner( $store );
$async_request->dispatch();
}
return $status;
}
/**
* Action scheduler callback for the feed generation.
*
* @since 10.5.0
*
* @param string $option_key The option key for the feed generation status.
* @return void
*/
public function feed_generation_action( string $option_key ) {
$status = get_option( $option_key );
if ( ! is_array( $status ) || ! isset( $status['state'] ) || self::STATE_SCHEDULED !== $status['state'] ) {
wc_get_logger()->error( 'Invalid feed generation status', array( 'status' => $status ) );
return;
}
$status['state'] = self::STATE_IN_PROGRESS;
update_option( $option_key, $status );
try {
$feed = $this->integration->create_feed();
$walker = ProductWalker::from_integration( $this->integration, $feed );
// Add dynamic args to the mapper.
$args = $status['args'] ?? array();
if (
isset( $args['_product_fields'] )
&& is_string( $args['_product_fields'] ) &&
! empty( $args['_product_fields'] )
) {
$this->integration->get_product_mapper()->set_fields( $args['_product_fields'] );
}
if (
isset( $args['_variation_fields'] )
&& is_string( $args['_variation_fields'] ) &&
! empty( $args['_variation_fields'] )
) {
$this->integration->get_product_mapper()->set_variation_fields( $args['_variation_fields'] );
}
$walker->walk(
function ( WalkerProgress $progress ) use ( &$status, $option_key ) {
$status = $this->update_feed_progress( $status, $progress );
update_option( $option_key, $status );
}
);
// Store the final details.
$status['state'] = self::STATE_COMPLETED;
$status['url'] = $feed->get_file_url();
$status['path'] = $feed->get_file_path();
$status['completed_at'] = time();
update_option( $option_key, $status );
// Schedule another action to delete the file after the expiry time.
// @phpstan-ignore-next-line function.notFound -- Action Scheduler.
as_schedule_single_action(
time() + self::FEED_EXPIRY,
self::FEED_DELETION_ACTION,
array(
$option_key,
$feed->get_file_path(),
),
'woo-product-feed',
true
);
} catch ( \Throwable $e ) {
wc_get_logger()->error(
'Feed generation failed',
array(
'error' => $e->getMessage(),
'option_key' => $option_key,
)
);
$status['state'] = self::STATE_FAILED;
$status['error'] = $e->getMessage();
$status['failed_at'] = time();
update_option( $option_key, $status );
}
}
/**
* Forces a regeneration of the feed.
*
* @since 10.5.0
*
* @param array|null $args The arguments to pass to the action.
* @return array The feed generation status.
* @throws \Exception When there is a reason why the regeneration cannot be forced.
*/
public function force_regeneration( ?array $args = null ): array {
$option_key = $this->get_option_key( $args );
$status = get_option( $option_key );
// If there is no option, there is nothing to force. If the option is invalid, we can restart.
if ( ! is_array( $status ) || ! $this->validate_status( $status ) ) {
return $this->get_status( $args );
}
switch ( $status['state'] ?? '' ) {
case self::STATE_SCHEDULED:
// If generation is scheduled, we can just let it be and return the current status.
// It should start shortly.
return $status;
case self::STATE_IN_PROGRESS:
throw new \Exception( 'Feed generation is already in progress and cannot be stopped.' );
case self::STATE_COMPLETED:
// Delete the existing file, clear the option and let generation start again.
wp_delete_file( (string) $status['path'] );
delete_option( $option_key );
return $this->get_status( $args );
case self::STATE_FAILED:
// Clear the failed status and restart generation.
delete_option( $option_key );
return $this->get_status( $args );
default:
throw new \Exception( 'Unknown feed generation state.' );
}
}
/**
* Action scheduler callback for the feed deletion after expiry.
*
* @since 10.5.0
*
* @param string $option_key The option key for the feed generation status.
* @param string $path The path to the feed file.
* @return void
*/
public function feed_deletion_action( string $option_key, string $path ) {
delete_option( $option_key );
wp_delete_file( $path );
}
/**
* Returns the option key for the feed generation status.
*
* @param array|null $args The arguments to pass to the action.
* @return string The option key.
*/
private function get_option_key( ?array $args = null ): string {
$normalized_args = $args ?? array();
if ( ! empty( $normalized_args ) ) {
ksort( $normalized_args );
}
return 'feed_status_' . md5(
// WPCS dislikes serialize for security reasons, but it will be hashed immediately.
// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
serialize(
array(
'integration' => $this->integration->get_id(),
'args' => $normalized_args,
)
)
);
}
/**
* Updates the feed progress while the feed is being generated.
*
* @param array $status The last previously known status.
* @param WalkerProgress $progress The progress of the walker.
* @return array Updated status of the feed generation.
*/
private function update_feed_progress( array $status, WalkerProgress $progress ): array {
$status['progress'] = $progress->total_count > 0
? round( ( $progress->processed_items / $progress->total_count ) * 100, 2 )
: 0;
$status['processed'] = $progress->processed_items;
$status['total'] = $progress->total_count;
return $status;
}
/**
* Validates the status of the feed generation.
*
* Makes sure that the file exists for completed jobs,
* that scheduled jobs are not stuck, etc.
*
* @param array $status The status of the feed generation.
* @return bool True if the status is valid, false otherwise.
*/
private function validate_status( array $status ): bool {
/**
* For completed jobs, make sure the file still exists. Regenerate otherwise.
*
* The file should typically get deleted at the same time as the status is cleared.
* However, something else could cause the file to disappear in the meantime (ex. manual delete).
*
* Also, if the cleanup job failed, the feed might appear as complete, but be expired.
*/
if ( self::STATE_COMPLETED === $status['state'] ) {
if ( ! file_exists( $status['path'] ) ) {
return false;
}
if ( ! isset( $status['completed_at'] ) ) {
return false;
}
if ( $status['completed_at'] + self::FEED_EXPIRY < time() ) {
return false;
}
}
/**
* If the job has been scheduled more than 10 minutes ago but has not
* transitioned to IN_PROGRESS yet, ActionScheduler is typically stuck.
*/
/**
* Allows the timeout for a feed to remain in `scheduled` state to be changed.
*
* @param int $stuck_time The stuck time in seconds.
* @return int The stuck time in seconds.
* @since 10.5.0
*/
$scheduled_timeout = apply_filters( 'woocommerce_product_feed_scheduled_timeout', 10 * MINUTE_IN_SECONDS );
if (
self::STATE_SCHEDULED === $status['state']
&& (
! isset( $status['scheduled_at'] )
|| time() - $status['scheduled_at'] > $scheduled_timeout
)
) {
return false;
}
// All good.
return true;
}
}
PK [1]GW W 5 ProductFeed/Integrations/POSCatalog/FeedValidator.phpnu >|null
*/
private ?WP_REST_Request $products_request = null;
/**
* Cached REST request instance for variations.
*
* @var WP_REST_Request>|null
*/
private ?WP_REST_Request $variations_request = null;
/**
* Initialize the mapper.
*
* @internal
* @return void
*/
final public function init(): void {
$this->products_controller = new WC_REST_Products_Controller();
$this->variations_controller = new WC_REST_Product_Variations_Controller();
}
/**
* Set fields to include in the product mapping.
*
* @since 10.5.0
*
* @param string|null $fields Fields to include in the product mapping.
* @return void
*/
public function set_fields( ?string $fields = null ): void {
$this->fields = $fields;
$this->products_request = null; // Invalidate the cached request.
}
/**
* Set fields to include in the variation mapping.
*
* @since 10.5.0
*
* @param string|null $fields Fields to include in the variation mapping.
* @return void
*/
public function set_variation_fields( ?string $fields = null ): void {
$this->variation_fields = $fields;
$this->variations_request = null; // Invalidate the cached request.
}
/**
* Map WooCommerce product to catalog row
*
* @since 10.5.0
*
* @param WC_Product $product Product to map.
* @return array Mapped product data array.
* @throws \RuntimeException If the controller is not initialized.
*/
public function map_product( WC_Product $product ): array {
$is_variation = $product->is_type( 'variation' );
$controller = $is_variation
? $this->variations_controller
: $this->products_controller;
// This should never be the case, as the class should be loaded through DI.
if ( null === $controller ) {
throw new \RuntimeException( 'ProductMapper::init() must be called before map_product().' );
}
$request = $is_variation ? $this->get_variations_request() : $this->get_products_request();
$response = $controller->prepare_object_for_response( $product, $request );
// Apply _fields filtering (normally done by REST server dispatch).
$fields = $is_variation ? $this->variation_fields : $this->fields;
if ( null !== $fields ) {
$response = rest_filter_response_fields( $response, rest_get_server(), $request );
}
$row = array(
'type' => $product->get_type(),
'data' => $response->get_data(),
);
/**
* Filter mapped catalog product data.
*
* @since 10.5.0
* @param array $row Mapped product data.
* @param WC_Product $product Product object.
*/
return apply_filters( 'woocommerce_pos_catalog_map_product', $row, $product );
}
/**
* Get the REST request instance for products.
*
* @return WP_REST_Request>
*/
protected function get_products_request(): WP_REST_Request {
if ( null === $this->products_request ) {
/**
* Type hint for PHPStan generics.
*
* @var WP_REST_Request> $request
* */
$request = new WP_REST_Request( 'GET' );
$this->products_request = $request;
$this->products_request->set_param( 'context', 'view' );
if ( null !== $this->fields ) {
$this->products_request->set_param( '_fields', $this->fields );
}
}
return $this->products_request;
}
/**
* Get the REST request instance for variations.
*
* @return WP_REST_Request>
*/
protected function get_variations_request(): WP_REST_Request {
if ( null === $this->variations_request ) {
/**
* Type hint for PHPStan generics.
*
* @var WP_REST_Request> $request
*/
$request = new WP_REST_Request( 'GET' );
$this->variations_request = $request;
$this->variations_request->set_param( 'context', 'view' );
if ( null !== $this->variation_fields ) {
$this->variations_request->set_param( '_fields', $this->variation_fields );
}
}
return $this->variations_request;
}
}
PK [1] @ ProductFeed/Integrations/POSCatalog/POSProductVisibilitySync.phpnu is_type( 'variable' ) ) {
$this->sync_pos_visibility_to_variations( $product, $visible_in_pos );
}
}
/**
* Sync POS visibility to all variations of a variable product.
*
* @since 10.5.0
*
* @param \WC_Product $product The variable product.
* @param bool $visible_in_pos Whether the product should be visible in POS.
* @return void
*/
private function sync_pos_visibility_to_variations( \WC_Product $product, bool $visible_in_pos ): void {
$variation_ids = $product->get_children();
foreach ( $variation_ids as $variation_id ) {
if ( $visible_in_pos ) {
wp_remove_object_terms( $variation_id, 'pos-hidden', 'pos_product_visibility' );
} else {
wp_set_object_terms( $variation_id, 'pos-hidden', 'pos_product_visibility' );
}
// Save variation to update date_modified.
$variation = wc_get_product( $variation_id );
if ( $variation ) {
$variation->save();
}
}
}
/**
* Inherit POS visibility from parent when a new variation is created.
*
* When a new variation is created, check if the parent product has the
* pos-hidden term and apply it to the variation if so.
*
* @since 10.5.0
*
* @param int $variation_id The variation ID.
* @param \WC_Product_Variation|null $variation The variation object.
* @return void
*/
public function inherit_parent_pos_visibility( $variation_id, $variation ): void {
if ( ! $variation instanceof \WC_Product_Variation ) {
return;
}
$parent_id = $variation->get_parent_id();
if ( has_term( 'pos-hidden', 'pos_product_visibility', $parent_id ) ) {
wp_set_object_terms( $variation_id, 'pos-hidden', 'pos_product_visibility' );
}
}
}
PK [1]0#%= = 1 ProductFeed/Integrations/IntegrationInterface.phpnu
*/
private array $integrations = array();
/**
* Register an Integration.
*
* @since 10.5.0
*
* @param IntegrationInterface $integration The integration to register.
*/
public function register_integration( IntegrationInterface $integration ): void {
$this->integrations[ $integration->get_id() ] = $integration;
}
/**
* Get an Integration by ID.
*
* @since 10.5.0
*
* @param string $id The ID of the Integration.
* @return IntegrationInterface|null The Integration, or null if it is not registered.
*/
public function get_integration( string $id ): ?IntegrationInterface {
return $this->integrations[ $id ] ?? null;
}
/**
* Get all registered integrations.
*
* @since 10.5.0
*
* @return array
*/
public function get_integrations(): array {
return $this->integrations;
}
}
PK [1]7$ $ $ ProductFeed/Storage/JsonFileFeed.phpnu base_name = $base_name;
}
/**
* Start the feed.
*
* @return void
* @throws Exception If the feed directory cannot be created.
*/
public function start(): void {
/**
* Allows the current time to be overridden before a feed is stored.
*
* @param int $time The current time.
* @param FeedInterface $feed The feed instance.
* @return int The current time.
* @since 10.5.0
*/
$current_time = apply_filters( 'woocommerce_product_feed_time', time(), $this );
$hash_data = $this->base_name . gmdate( 'r', $current_time );
$this->file_name = sprintf(
'%s-%s-%s.json',
$this->base_name,
gmdate( 'Y-m-d', $current_time ),
wp_hash( $hash_data )
);
// Start by trying to use a temp directory to generate the feed.
$this->file_path = get_temp_dir() . DIRECTORY_SEPARATOR . $this->file_name;
$this->file_handle = fopen( $this->file_path, 'w' );
if ( false === $this->file_handle ) {
// Fall back to immediately using the upload directory for generation.
$upload_dir = $this->get_upload_dir();
$this->file_path = $upload_dir['path'] . $this->file_name;
$this->file_handle = fopen( $this->file_path, 'w' );
} else {
$this->is_temp_filepath = true;
}
if ( false === $this->file_handle ) {
throw new Exception(
esc_html(
sprintf(
/* translators: %s: directory path */
__( 'Unable to open feed file for writing: %s', 'woocommerce' ),
$this->file_path
)
)
);
}
// Open the array.
fwrite( $this->file_handle, '[' );
}
/**
* Add an entry to the feed.
*
* @param array $entry The entry to add.
* @return void
*/
public function add_entry( array $entry ): void {
if ( ! is_resource( $this->file_handle ) ) {
return;
}
if ( ! $this->has_entries ) {
$this->has_entries = true;
} else {
fwrite( $this->file_handle, ',' );
}
$json = wp_json_encode( $entry );
if ( false !== $json ) {
fwrite( $this->file_handle, $json );
}
}
/**
* End the feed.
*
* @return void
*/
public function end(): void {
if ( ! is_resource( $this->file_handle ) ) {
return;
}
// Close the array and the file.
fwrite( $this->file_handle, ']' );
fclose( $this->file_handle );
// Indicate that we have a complete file.
$this->file_completed = true;
}
/**
* {@inheritDoc}
*/
public function get_file_path(): ?string {
if ( ! $this->file_completed ) {
return null;
}
return $this->file_path;
}
/**
* {@inheritDoc}
*
* @throws Exception If the feed file cannot be moved to the upload directory.
*/
public function get_file_url(): ?string {
if ( ! $this->file_completed ) {
return null;
}
$upload_dir = $this->get_upload_dir();
// Move the file to the upload directory if it is in temp.
if ( $this->is_temp_filepath ) {
$tmp_path = $this->file_path;
$this->file_path = $upload_dir['path'] . $this->file_name;
// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
if ( ! @copy( $tmp_path, $this->file_path ) ) {
$error = error_get_last();
$error_message = is_array( $error ) ? $error['message'] : 'Unknown error';
throw new Exception(
esc_html(
sprintf(
/* translators: %1$s: file path, %2$s: error message */
__( 'Unable to move feed file %1$s to upload directory: %2$s', 'woocommerce' ),
$this->file_path,
$error_message
)
)
);
}
unlink( $tmp_path );
$this->is_temp_filepath = false;
}
// Generate the URL.
$this->file_url = $upload_dir['url'] . $this->file_name;
return $this->file_url;
}
/**
* Get the upload directory for the feed.
*
* @return array {
* The upload directory for the feed. Both fields end with the right trailing slash.
*
* @type string $path The path to the upload directory.
* @type string $url The URL to the upload directory.
* }
* @throws Exception If the upload directory cannot be created.
*/
private function get_upload_dir(): array {
// Only generate everything once.
static $prepared;
if ( isset( $prepared ) ) {
return $prepared;
}
$upload_dir = wp_upload_dir( null, true );
$directory_path = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . self::UPLOAD_DIR . DIRECTORY_SEPARATOR;
// Try to create the directory if it does not exist.
if ( ! is_dir( $directory_path ) ) {
FilesystemUtil::mkdir_p_not_indexable( $directory_path );
}
// `mkdir_p_not_indexable()` returns `void`, we have to check again.
if ( ! is_dir( $directory_path ) ) {
throw new Exception(
esc_html(
sprintf(
/* translators: %s: directory path */
__( 'Unable to create feed directory: %s', 'woocommerce' ),
$directory_path
)
)
);
}
$directory_url = $upload_dir['baseurl'] . '/' . self::UPLOAD_DIR . '/';
// Follow the format, returned by `wp_upload_dir()`.
$prepared = array(
'path' => $directory_path,
'url' => $directory_url,
);
return $prepared;
}
}
PK [1]2SC # ProductFeed/Utils/MemoryManager.phpnu = $memory_limit ) {
// Some systems have "unlimited" memory.
// We should treat that as if there is none left.
return 0;
}
return (int) round( 100 - ( memory_get_usage( true ) / $memory_limit ) * 100 );
}
/**
* Flush all caches.
*
* @since 10.5.0
*/
public function flush_caches(): void {
global $wpdb, $wp_object_cache;
$wpdb->queries = array();
wp_cache_flush();
if ( ! is_object( $wp_object_cache ) ) {
return;
}
// These properties exist on various object cache implementations.
$wp_object_cache->group_ops = array(); // @phpstan-ignore property.notFound
$wp_object_cache->stats = array(); // @phpstan-ignore property.notFound
$wp_object_cache->memcache_debug = array(); // @phpstan-ignore property.notFound
$wp_object_cache->cache = array(); // @phpstan-ignore property.notFound
// This method is specific to certain memcached implementations.
if ( method_exists( $wp_object_cache, '__remoteset' ) ) {
$wp_object_cache->__remoteset(); // important.
}
$this->collect_garbage();
}
/**
* Collect garbage.
*/
private function collect_garbage(): void {
static $gc_threshold = 5000;
static $gc_too_low_in_a_row = 0;
static $gc_too_high_in_a_row = 0;
$gc_threshold_step = 2_500;
$gc_status = gc_status();
if ( $gc_threshold > $gc_status['threshold'] ) {
// If PHP managed to collect memory in the meantime and established threshold lower than ours, just use theirs.
$gc_threshold = $gc_status['threshold'];
}
if ( $gc_status['roots'] > $gc_threshold ) {
$collected = gc_collect_cycles();
if ( $collected < 100 ) {
if ( $gc_too_low_in_a_row > 0 ) {
$gc_too_low_in_a_row = 0;
// Raise GC threshold if we collected too little twice in a row.
$gc_threshold += $gc_threshold_step;
$gc_threshold = min( $gc_threshold, 1_000_000_000, $gc_status['threshold'] );
} else {
++$gc_too_low_in_a_row;
}
$gc_too_high_in_a_row = 0;
} else {
if ( $gc_too_high_in_a_row > 0 ) {
$gc_too_high_in_a_row = 0;
// Lower GC threshold if we collected more than enough twice in a row.
$gc_threshold -= $gc_threshold_step;
$gc_threshold = max( $gc_threshold, 5_000 );
} else {
++$gc_too_high_in_a_row;
}
$gc_too_low_in_a_row = 0;
}
}
}
}
PK [1]q; " ProductFeed/Utils/StringHelper.phpnu $max_length ) {
return mb_substr( $text, 0, $max_length );
}
return $text;
}
}
PK [1][!
3 CLI/Migrator/Interfaces/PlatformMapperInterface.phpnu array Raw items fetched from the platform.
* 'cursor' => ?string The cursor for the next page, or null if no more pages.
* 'has_next_page' => bool Indicates if there are more pages to fetch.
*/
public function fetch_batch( array $args ): array;
/**
* Fetches the estimated total count of items available for migration.
*
* Used primarily for progress indicators. If a total count is not available,
* this method should return 0.
*
* @param array $args Arguments for filtering the count (e.g., status, date range).
* Specific arguments depend on the implementation.
*
* @return int The total estimated count.
*/
public function fetch_total_count( array $args ): int;
}
PK [1]A|l ( CLI/Migrator/Core/ProductsController.phpnu credential_manager = $credential_manager;
$this->platform_registry = $platform_registry;
$this->product_importer = $product_importer;
$this->tracker = $tracker;
}
/**
* Main entry point for migrating products.
*
* @param array $assoc_args Command-line arguments.
* @param string $platform Optional pre-resolved platform (to avoid duplicate resolution).
* @return void
*/
public function migrate_products( array $assoc_args, string $platform = '' ): void {
$this->parsed_args = $this->parse_and_validate_args( $assoc_args, $platform );
if ( empty( $this->parsed_args ) ) {
return;
}
$this->session_start_time = time();
if ( $this->parsed_args['dry_run'] ) {
WP_CLI::line( WP_CLI::colorize( '%Y--- DRY RUN MODE ENABLED ---%n' ) );
WP_CLI::line( 'No products will be created or modified. This is a simulation only.' );
WP_CLI::line( '' );
}
if ( ! $this->parsed_args['dry_run'] ) {
$this->session = $this->manage_session_lifecycle( $this->parsed_args );
if ( ! $this->session ) {
return;
}
/**
* Fires when a migration session starts.
*
* @since 10.3.0
*
* @param string $platform The platform being migrated from.
* @param array $metadata Session metadata including session_id, filters, and fields.
*/
do_action(
'wc_migrator_session_started',
$this->parsed_args['platform'],
array(
'session_id' => $this->session->get_id(),
'filters' => $this->parsed_args['filters'],
'fields' => $this->fields_to_process,
'is_dry_run' => $this->parsed_args['dry_run'],
'resume' => $this->parsed_args['resume'],
)
);
}
$fetcher = $this->platform_registry->get_fetcher( $this->parsed_args['platform'] );
$mapper = $this->platform_registry->get_mapper( $this->parsed_args['platform'], array( 'fields' => $this->fields_to_process ) );
$total_count = $fetcher->fetch_total_count( $this->parsed_args['filters'] );
if ( ! $this->parsed_args['dry_run'] ) {
$existing_total = $this->session->count_all_total_entities();
if ( 0 < $total_count && 0 === $existing_total ) {
$this->session->bump_total_number_of_entities( array( 'post' => $total_count ) );
}
}
WP_CLI::line( "Total entities found: {$total_count}" );
$progress_label = $this->parsed_args['dry_run']
? 'Simulating Products from ' . ucfirst( $this->parsed_args['platform'] )
: 'Importing Products from ' . ucfirst( $this->parsed_args['platform'] );
$progress = \WP_CLI\Utils\make_progress_bar( $progress_label, $total_count );
// Set initial progress - either show resumed progress or 1% for new sessions.
$initial_tick = max( 1, (int) ceil( $total_count * 0.01 ) );
if ( ! $this->parsed_args['dry_run'] ) {
$already_imported = $this->session->count_all_imported_entities();
if ( $already_imported > 0 ) {
// Show actual resumed progress.
$progress->tick( $already_imported );
} else {
// Show 1% for new sessions to indicate activity has started.
$progress->tick( $initial_tick );
}
} else {
// For dry runs, show initial 1% tick.
$progress->tick( $initial_tick );
}
$this->configure_product_importer();
$this->execute_migration_loop( $fetcher, $mapper, $progress );
$progress->finish();
$this->display_migration_summary();
$this->display_feedback_survey();
if ( ! $this->parsed_args['dry_run'] ) {
$final_stats = array(
'total_found' => $total_count,
'total_imported' => $this->session->count_all_imported_entities(),
);
/**
* Fires when a migration session completes.
*
* @since 10.3.0
*
* @param string $platform The platform being migrated from.
* @param array $final_stats Final migration statistics.
*/
do_action( 'wc_migrator_session_completed', $this->parsed_args['platform'], $final_stats );
$this->log_session_time_metrics( $final_stats );
}
if ( $this->parsed_args['dry_run'] ) {
WP_CLI::success( 'Dry-run completed successfully. No products were actually created or modified.' );
} else {
WP_CLI::success( 'Migration completed successfully.' );
}
}
/**
* Execute the main cursor-based migration loop.
*
* @param object $fetcher The platform fetcher instance.
* @param object $mapper The platform mapper instance.
* @param object $progress The WP_CLI progress bar instance.
* @return void
*/
private function execute_migration_loop( $fetcher, $mapper, $progress ): void {
$limit_remaining = $this->parsed_args['limit'];
$session_cursor = $this->parsed_args['dry_run'] ? null : $this->session->get_reentrancy_cursor();
$after_cursor = ! empty( $session_cursor ) ? $session_cursor : null;
$has_next_page = true;
$total_processed_in_session = 0;
do {
$batch_limit = min( $this->parsed_args['batch_size'], $limit_remaining );
if ( $batch_limit <= 0 ) {
break;
}
$batch_args = array(
'limit' => $batch_limit,
'after_cursor' => $after_cursor,
);
if ( ! empty( $this->parsed_args['filters'] ) ) {
$batch_args = array_merge( $batch_args, $this->parsed_args['filters'] );
}
try {
$batch_data = $fetcher->fetch_batch( $batch_args );
} catch ( Exception $e ) {
/**
* Fires when an error occurs during migration.
*
* @since 10.3.0
*
* @param string $error_type The type of error (fetch, mapping, import).
* @param string $message The error message.
* @param array $context Additional error context.
*/
do_action(
'wc_migrator_error_occurred',
'fetch',
$e->getMessage(),
array(
'batch_args' => $batch_args,
'platform' => $this->parsed_args['platform'],
)
);
WP_CLI::warning( "Error fetching batch: {$e->getMessage()}" );
break;
}
if ( empty( $batch_data['items'] ) ) {
break;
}
$processed_count = $this->process_batch( $batch_data['items'], $mapper );
$total_processed_in_session += $processed_count;
if ( ! $this->parsed_args['dry_run'] ) {
$this->session->bump_imported_entities_counts( array( 'post' => $processed_count ) );
$after_cursor = $batch_data['cursor'];
$this->session->set_reentrancy_cursor( $after_cursor );
} else {
$after_cursor = $batch_data['cursor'];
}
$limit_remaining -= count( $batch_data['items'] );
$has_next_page = $batch_data['has_next_page'] ?? false;
$progress->tick( $processed_count, sprintf( 'Processed %d products', $total_processed_in_session ) );
} while ( $has_next_page && $limit_remaining > 0 );
if ( ! $has_next_page && ! $this->parsed_args['dry_run'] ) {
$this->session->set_stage( ImportSession::STAGE_FINISHED );
}
}
/**
* Parse and validate command-line arguments.
*
* @param array $assoc_args Raw associative arguments.
* @param string $platform Optional pre-resolved platform.
* @return array Parsed and validated arguments or empty array on error.
*/
private function parse_and_validate_args( array $assoc_args, string $platform = '' ): array {
$parsed = array();
// Platform validation - use pre-resolved platform if provided, otherwise resolve.
if ( empty( $platform ) ) {
$platform = $this->platform_registry->resolve_platform( $assoc_args );
if ( empty( $platform ) ) {
return array();
}
}
$parsed['platform'] = $platform;
$this->fields_to_process = $this->parse_field_selection( $assoc_args );
$parsed['fields'] = $this->fields_to_process;
$parsed['limit'] = isset( $assoc_args['limit'] ) ? max( 1, (int) $assoc_args['limit'] ) : PHP_INT_MAX;
$parsed['batch_size'] = isset( $assoc_args['batch-size'] ) ? max( 1, min( 250, (int) $assoc_args['batch-size'] ) ) : 20;
$parsed['skip_existing'] = isset( $assoc_args['skip-existing'] );
$parsed['dry_run'] = isset( $assoc_args['dry-run'] );
$parsed['resume'] = isset( $assoc_args['resume'] );
$parsed['verbose'] = isset( $assoc_args['verbose'] );
$parsed['assign_default_category'] = isset( $assoc_args['assign-default-category'] );
$parsed['filters'] = $this->parse_query_filters( $assoc_args );
if ( ! $this->credential_manager->has_credentials( $platform ) ) {
$platform_display_name = $this->platform_registry->get_platform_display_name( $platform );
WP_CLI::error(
sprintf(
"No credentials found for platform '%s'. Please run: wp wc migrate setup --platform=%s",
$platform_display_name,
$platform
)
);
return array();
}
return $parsed;
}
/**
* Parse field selection from command arguments.
*
* @param array $assoc_args Command arguments.
* @return array Selected fields to process.
*/
private function parse_field_selection( array $assoc_args ): array {
$default_fields = array(
'name',
'slug',
'description',
'status',
'date_created',
'catalog_visibility',
'categories',
'tags',
'price',
'sku',
'stock',
'weight',
'brand',
'images',
'attributes',
'metafields',
);
$excluded_fields = array();
$explicitly_selected = false;
if ( isset( $assoc_args['fields'] ) ) {
$explicitly_selected = true;
$selected_fields = array_map( 'trim', explode( ',', $assoc_args['fields'] ) );
$selected_fields = array_filter( $selected_fields );
$invalid_fields = array_diff( $selected_fields, $default_fields );
if ( ! empty( $invalid_fields ) ) {
WP_CLI::warning(
sprintf(
'Invalid field names: %s. Valid fields: %s',
implode( ', ', $invalid_fields ),
implode( ', ', $default_fields )
)
);
}
$fields = array_intersect( $selected_fields, $default_fields );
$excluded_fields = array_diff( $default_fields, $fields );
} else {
$fields = $default_fields;
}
// Handle --exclude-fields argument.
if ( isset( $assoc_args['exclude-fields'] ) ) {
$exclude_fields_input = array_map( 'trim', explode( ',', $assoc_args['exclude-fields'] ) );
$excluded_fields = array_merge( $excluded_fields, $exclude_fields_input );
$fields = array_diff( $fields, $exclude_fields_input );
}
if ( empty( $fields ) ) {
WP_CLI::error( 'No valid fields selected for migration.' );
return array();
}
// Log field selection information.
if ( $explicitly_selected || isset( $assoc_args['exclude-fields'] ) || ! empty( $assoc_args['verbose'] ) ) {
$include_message = sprintf( 'Including fields: %s', implode( ', ', $fields ) );
WP_CLI::log( $include_message );
wc_get_logger()->info( $include_message, array( 'source' => 'wc-migrator' ) );
if ( ! empty( $excluded_fields ) ) {
$exclude_message = sprintf( 'Excluding fields: %s', implode( ', ', array_unique( $excluded_fields ) ) );
WP_CLI::log( $exclude_message );
wc_get_logger()->info( $exclude_message, array( 'source' => 'wc-migrator' ) );
}
}
return $fields;
}
/**
* Parse query filters for platform-agnostic filtering.
*
* @param array $assoc_args Command arguments.
* @return array Parsed query filters.
*/
private function parse_query_filters( array $assoc_args ): array {
$filters = array();
if ( isset( $assoc_args['status'] ) ) {
$valid_statuses = array( 'active', 'archived', 'draft' );
$status = strtolower( $assoc_args['status'] );
if ( in_array( $status, $valid_statuses, true ) ) {
$filters['status'] = $status;
} else {
WP_CLI::warning(
sprintf(
'Invalid status "%s". Valid options: %s',
$status,
implode( ', ', $valid_statuses )
)
);
}
}
if ( isset( $assoc_args['created-after'] ) ) {
$date = $this->validate_date_filter( $assoc_args['created-after'], 'created-after' );
if ( $date ) {
$filters['created_after'] = $date;
}
}
if ( isset( $assoc_args['created-before'] ) ) {
$date = $this->validate_date_filter( $assoc_args['created-before'], 'created-before' );
if ( $date ) {
$filters['created_before'] = $date;
}
}
if ( isset( $assoc_args['product-type'] ) && 'all' !== $assoc_args['product-type'] ) {
$filters['product_type'] = $assoc_args['product-type'];
}
if ( isset( $assoc_args['handle'] ) ) {
$filters['handle'] = sanitize_title( $assoc_args['handle'] );
}
if ( isset( $assoc_args['vendor'] ) ) {
$filters['vendor'] = $assoc_args['vendor'];
}
if ( isset( $assoc_args['ids'] ) ) {
$filters['ids'] = $assoc_args['ids'];
}
return $filters;
}
/**
* Validate date filter input.
*
* @param string $date_input The date input string.
* @param string $filter_name The filter name for error messages.
* @return string|null Formatted date string or null on error.
*/
private function validate_date_filter( string $date_input, string $filter_name ): ?string {
$timestamp = strtotime( $date_input );
if ( false === $timestamp ) {
WP_CLI::warning(
sprintf( 'Invalid date format for --%s: %s', $filter_name, $date_input )
);
return null;
}
return gmdate( 'Y-m-d\\TH:i:s\\Z', $timestamp );
}
/**
* Manage the session lifecycle - create new or resume existing.
*
* @param array $parsed_args Parsed command arguments.
* @return ImportSession|null Import session instance or null on error.
*/
private function manage_session_lifecycle( array $parsed_args ): ?ImportSession {
$active_session = ImportSession::get_active();
if ( $active_session && ! $active_session->is_finished() ) {
return $this->handle_existing_session( $active_session, $parsed_args );
}
return $this->create_new_session( $parsed_args );
}
/**
* Handle existing session with user prompt for resume decision.
*
* @param ImportSession $session The existing session.
* @param array $parsed_args Parsed command arguments.
* @return ImportSession|null Session to use or null on error.
*/
private function handle_existing_session( ImportSession $session, array $parsed_args ): ?ImportSession {
// Display session information.
$metadata = $session->get_metadata();
$total_imported = $session->count_all_imported_entities();
$total_entities = $session->count_all_total_entities();
$started_timestamp = $session->get_started_at();
$started_at = is_numeric( $started_timestamp ) ?
get_date_from_gmt( gmdate( 'Y-m-d H:i:s', (int) $started_timestamp ) ) :
$started_timestamp;
WP_CLI::line( '' );
WP_CLI::line( WP_CLI::colorize( '%YExisting Migration Session Found:%n' ) );
WP_CLI::line( sprintf( ' Session ID: %d', $session->get_id() ) );
WP_CLI::line( sprintf( ' Platform: %s', $metadata['data_source'] ) );
WP_CLI::line( sprintf( ' Started: %s', $started_at ) );
WP_CLI::line( sprintf( ' Progress: %d / %d products imported', $total_imported, $total_entities ) );
if ( ( $parsed_args['verbose'] ?? false ) && $session->get_reentrancy_cursor() ) {
WP_CLI::line( sprintf( ' Last Cursor: %s', substr( $session->get_reentrancy_cursor(), 0, 50 ) . '...' ) );
}
$original_args = $session->get_original_arguments();
if ( $original_args ) {
WP_CLI::line( '' );
WP_CLI::line( WP_CLI::colorize( '%YOriginal Command Arguments:%n' ) );
$this->display_saved_arguments( $original_args );
}
WP_CLI::line( '' );
$should_resume = $parsed_args['resume'] ?? false;
if ( ! $should_resume ) {
WP_CLI::out( 'Do you want to resume this migration session? [y/n] ' );
$answer = $this->get_user_input();
if ( 'y' === $answer ) {
$should_resume = true;
} else {
$should_resume = false;
}
}
if ( $should_resume ) {
WP_CLI::success( sprintf( 'Resuming migration session %d', $session->get_id() ) );
$original_args = $session->get_original_arguments();
if ( $original_args ) {
$this->restore_original_arguments( $original_args );
WP_CLI::line( 'Original command arguments have been restored.' );
}
return $session;
} else {
$session->archive();
WP_CLI::line( 'Previous session archived. Starting a new import session.' );
$new_session = $this->create_new_session( $parsed_args );
if ( $new_session ) {
WP_CLI::success( sprintf( 'Starting fresh migration from the beginning (Session %d)', $new_session->get_id() ) );
}
return $new_session;
}
}
/**
* Create a new import session.
*
* @param array $parsed_args Parsed command arguments.
* @return ImportSession|null New session instance or null on error.
*/
private function create_new_session( array $parsed_args ): ?ImportSession {
try {
$session = ImportSession::create(
array(
'data_source' => $parsed_args['platform'],
'file_name' => sprintf(
'%s Migration - %s',
ucfirst( $parsed_args['platform'] ),
current_time( 'mysql' )
),
)
);
$session->set_original_arguments( $parsed_args );
return $session;
} catch ( Exception $e ) {
WP_CLI::error( sprintf( 'Failed to create migration session: %s', $e->getMessage() ) );
return null;
}
}
/**
* Process a batch of items using the mapper and importer.
*
* @param array $batch_items Array of source platform items.
* @param object $mapper Platform mapper instance.
* @return int Number of successfully processed items.
*/
private function process_batch( array $batch_items, $mapper ): int {
$processed_count = 0;
$mapped_products = array();
$source_data_batch = array();
foreach ( $batch_items as $item ) {
try {
// Extract the actual product node from GraphQL response structure.
// Handle both object and array GraphQL shapes.
if ( is_object( $item ) && isset( $item->node ) ) {
$product_data = $item->node;
} elseif ( is_array( $item ) && isset( $item['node'] ) ) {
$product_data = $item['node'];
} else {
$product_data = $item;
}
$mapped_product = $mapper->map_product_data( $product_data );
if ( ! empty( $mapped_product ) ) {
$mapped_products[] = $mapped_product;
$source_data_batch[] = is_object( $product_data ) ? (array) $product_data : $product_data;
}
} catch ( Exception $e ) {
/**
* Fires when an error occurs during migration.
*
* @since 10.3.0
*
* @param string $error_type The type of error (fetch, mapping, import).
* @param string $message The error message.
* @param array $context Additional error context.
*/
do_action(
'wc_migrator_error_occurred',
'mapping',
$e->getMessage(),
array(
'product_data' => $product_data,
'platform' => $this->parsed_args['platform'],
)
);
WP_CLI::warning( sprintf( 'Error mapping product: %s', $e->getMessage() ) );
continue;
}
}
if ( ! empty( $mapped_products ) ) {
if ( $this->parsed_args['dry_run'] ) {
$batch_results = $this->simulate_import_batch( $mapped_products );
} else {
$batch_results = $this->product_importer->import_batch( $mapped_products, $source_data_batch );
}
/**
* Fires when a batch has been processed during migration.
*
* @since 10.3.0
*
* @param array $batch_results Results from the batch import.
* @param array $source_data Source platform data for the batch.
* @param array $mapped_products Mapped WooCommerce data for the batch.
*/
do_action( 'wc_migrator_batch_processed', $batch_results, $source_data_batch, $mapped_products );
$this->log_batch_results( $batch_results );
$processed_count = $batch_results['stats']['successful'];
if ( $processed_count > 0 && ! $this->parsed_args['dry_run'] ) {
$current_count = get_option( 'wc_migrator_products_count', 0 );
update_option( 'wc_migrator_products_count', $current_count + $processed_count );
}
}
return $processed_count;
}
/**
* Simulate the import process for dry-run mode.
*
* @param array $mapped_products Array of mapped product data.
* @return array Simulated batch results matching real import format.
*/
private function simulate_import_batch( array $mapped_products ): array {
$results = array();
$stats = array(
'successful' => 0,
'failed' => 0,
'skipped' => 0,
);
foreach ( $mapped_products as $product_data ) {
$product_name = $product_data['name'] ?? 'Unknown Product';
if ( empty( $product_data['name'] ) ) {
$results[] = array(
'status' => 'error',
'message' => 'Product name is required',
'data' => $product_data,
);
++$stats['failed'];
$this->simulate_stats_increment( 'errors_encountered' );
continue;
}
$existing_product_id = null;
if ( ! empty( $product_data['sku'] ) ) {
$existing_product_id = wc_get_product_id_by_sku( $product_data['sku'] );
}
$would_skip = false;
if ( $existing_product_id && $this->parsed_args['skip_existing'] ) {
$would_skip = true;
}
if ( $would_skip ) {
$results[] = array(
'status' => 'skipped',
'message' => "Product '{$product_name}' would be skipped (already exists)",
'data' => $product_data,
);
++$stats['skipped'];
$this->simulate_stats_increment( 'products_skipped' );
} else {
$results[] = array(
'status' => 'success',
'message' => "Product '{$product_name}' would be imported",
'data' => $product_data,
);
++$stats['successful'];
if ( $existing_product_id ) {
$this->simulate_stats_increment( 'products_updated' );
} else {
$this->simulate_stats_increment( 'products_created' );
}
if ( in_array( 'images', $this->fields_to_process, true ) && ! empty( $product_data['images'] ) ) {
$image_count = is_array( $product_data['images'] ) ? count( $product_data['images'] ) : 1;
for ( $i = 0; $i < $image_count; $i++ ) {
$this->simulate_stats_increment( 'images_processed' );
}
}
}
wc_get_logger()->info( "DRY RUN: Would import product '{$product_name}'", array( 'source' => 'wc-migrator' ) );
}
return array(
'results' => $results,
'stats' => $stats,
);
}
/**
* Simulate incrementing stats by using reflection to access private properties.
* This ensures dry-run stats match what the real import would show.
*
* @param string $stat_key The stat key to increment.
*/
private function simulate_stats_increment( string $stat_key ): void {
try {
$reflection = new \ReflectionClass( $this->product_importer );
$stats_property = $reflection->getProperty( 'import_stats' );
$stats_property->setAccessible( true );
$current_stats = $stats_property->getValue( $this->product_importer );
if ( isset( $current_stats[ $stat_key ] ) ) {
++$current_stats[ $stat_key ];
$stats_property->setValue( $this->product_importer, $current_stats );
}
} catch ( \ReflectionException $e ) {
wc_get_logger()->warning(
"DRY RUN: Could not update import stats for '{$stat_key}': " . $e->getMessage(),
array( 'source' => 'wc-migrator' )
);
}
}
/**
* Configure the injected product importer with options based on parsed arguments.
*/
private function configure_product_importer(): void {
$import_options = array(
'skip_existing' => $this->parsed_args['skip_existing'] ?? false,
'update_existing' => ! ( $this->parsed_args['skip_existing'] ?? false ),
'import_images' => in_array( 'images', $this->fields_to_process, true ),
'skip_duplicate_images' => true,
'create_categories' => in_array( 'categories', $this->fields_to_process, true ),
'create_tags' => in_array( 'tags', $this->fields_to_process, true ),
'handle_variations' => in_array( 'attributes', $this->fields_to_process, true ),
'assign_default_category' => $this->parsed_args['assign_default_category'] ?? false,
'verbose' => $this->parsed_args['verbose'] ?? false,
);
$this->product_importer->configure( $import_options );
if ( $this->parsed_args['verbose'] ?? false ) {
$this->product_importer->set_progress_callback( array( $this, 'display_product_progress' ) );
}
}
/**
* Display progress indicator for individual product imports.
*
* @param int $current_index Current product index (1-based).
* @param int $total_count Total number of products in batch.
* @param string $product_name Name of the product being processed.
* @param array|null $result Import result (null when starting, array when finished).
*/
public function display_product_progress( int $current_index, int $total_count, string $product_name, ?array $result ): void {
if ( null === $result ) {
return;
}
$display_name = strlen( $product_name ) > 40 ? substr( $product_name, 0, 37 ) . '...' : $product_name;
$status_char = '✓';
$status_color = '%G';
if ( 'error' === $result['status'] ) {
$status_char = '✗';
$status_color = '%R';
} elseif ( 'success' === $result['status'] && 'skipped' === $result['action'] ) {
$status_char = '−';
$status_color = '%Y';
}
$progress = sprintf( '[%d/%d]', $current_index, $total_count );
if ( 1 === $current_index ) {
WP_CLI::line( '' );
}
WP_CLI::line(
WP_CLI::colorize(
sprintf( '%s%s%s %s %s', $status_color, $status_char, '%n', $progress, $display_name )
)
);
}
/**
* Log batch import results.
*
* @param array $batch_results Results from batch import.
*/
private function log_batch_results( array $batch_results ): void {
$stats = $batch_results['stats'];
// Only log failures and errors when verbose flag is set.
if ( $this->parsed_args['verbose'] && $stats['failed'] > 0 ) {
WP_CLI::warning( sprintf( '%d products failed to import', $stats['failed'] ) );
// Log first few errors for debugging.
$error_count = 0;
foreach ( $batch_results['results'] as $result ) {
if ( 'error' === $result['status'] && $error_count < 3 ) {
WP_CLI::warning( sprintf( 'Import error: %s', $result['message'] ) );
++$error_count;
}
}
}
// Only log skipped products if there are many and verbose is enabled.
if ( $this->parsed_args['verbose'] && $stats['skipped'] > 5 ) {
WP_CLI::log( sprintf( 'Skipped %d existing products', $stats['skipped'] ) );
}
}
/**
* Display final migration summary statistics.
*/
private function display_migration_summary(): void {
if ( null === $this->product_importer ) {
return;
}
$stats = $this->product_importer->get_import_stats();
WP_CLI::line( '' );
if ( $this->parsed_args['dry_run'] ) {
WP_CLI::line( WP_CLI::colorize( '%YDry-Run Summary:%n' ) );
WP_CLI::line( sprintf( ' Products Would Be Created: %d', $stats['products_created'] ) );
WP_CLI::line( sprintf( ' Products Would Be Updated: %d', $stats['products_updated'] ) );
WP_CLI::line( sprintf( ' Products Would Be Skipped: %d', $stats['products_skipped'] ) );
WP_CLI::line( sprintf( ' Images Would Be Processed: %d', $stats['images_processed'] ) );
} else {
WP_CLI::line( WP_CLI::colorize( '%YMigration Summary:%n' ) );
WP_CLI::line( sprintf( ' Products Created: %d', $stats['products_created'] ) );
WP_CLI::line( sprintf( ' Products Updated: %d', $stats['products_updated'] ) );
WP_CLI::line( sprintf( ' Products Skipped: %d', $stats['products_skipped'] ) );
WP_CLI::line( sprintf( ' Images Processed: %d', $stats['images_processed'] ) );
}
if ( $stats['errors_encountered'] > 0 ) {
if ( $this->parsed_args['dry_run'] ) {
WP_CLI::line( WP_CLI::colorize( sprintf( ' %%RValidation Errors Found: %d%%n', $stats['errors_encountered'] ) ) );
} else {
WP_CLI::line( WP_CLI::colorize( sprintf( ' %%RErrors Encountered: %d%%n', $stats['errors_encountered'] ) ) );
}
}
WP_CLI::line( '' );
}
/**
* Log session time metrics using session-specific data.
*
* @param array $final_stats Final migration statistics.
*/
private function log_session_time_metrics( array $final_stats ): void {
$session_products = $final_stats['total_imported'] ?? 0;
if ( empty( $session_products ) ) {
return;
}
if ( empty( $this->session_start_time ) ) {
return;
}
$session_duration_seconds = time() - $this->session_start_time;
$platform = $this->parsed_args['platform'];
$avg_time_per_product = $session_duration_seconds / $session_products;
$session_time_formatted = human_time_diff( 0, $session_duration_seconds );
$avg_time_formatted = number_format( $avg_time_per_product, 2 );
$platform_display_name = $this->platform_registry->get_platform_display_name( $platform );
$metrics_message = sprintf(
'Session completed for %s: %d products in %s (avg: %s seconds per product)',
$platform_display_name,
$session_products,
$session_time_formatted,
$avg_time_formatted
);
wc_get_logger()->info( $metrics_message, array( 'source' => 'wc-migrator' ) );
}
/**
* Display feedback survey link to collect user feedback.
*/
private function display_feedback_survey(): void {
WP_CLI::line( '' );
WP_CLI::line( WP_CLI::colorize( '%GHelp us improve the WooCommerce Migrator!%n' ) );
WP_CLI::line( 'Please share your feedback about this migration experience:' );
WP_CLI::line( WP_CLI::colorize( '%Chttps://developer.woocommerce.com/migrator-feedback/%n' ) );
WP_CLI::line( '' );
}
/**
* Get user input from STDIN. Separate method for easier testing.
*
* @return string User input, trimmed and lowercased.
*/
protected function get_user_input(): string {
return strtolower( trim( fgets( STDIN ) ) );
}
/**
* Display the saved arguments from a previous session.
*
* @param array $args The saved arguments to display.
*/
private function display_saved_arguments( array $args ): void {
$important_args = array(
'platform' => 'Platform',
'limit' => 'Product Limit',
'batch_size' => 'Batch Size',
'skip_existing' => 'Skip Existing',
'dry_run' => 'Dry Run',
'verbose' => 'Verbose',
'assign_default_category' => 'Assign Default Category',
);
foreach ( $important_args as $key => $label ) {
if ( isset( $args[ $key ] ) ) {
$value = $args[ $key ];
if ( is_bool( $value ) ) {
$value = $value ? 'Yes' : 'No';
} elseif ( is_array( $value ) ) {
$value = implode( ', ', $value );
} elseif ( 'limit' === $key && PHP_INT_MAX === (int) $value ) {
$value = 'All';
}
WP_CLI::line( sprintf( ' %s: %s', $label, $value ) );
}
}
if ( ! empty( $args['filters'] ) && is_array( $args['filters'] ) ) {
WP_CLI::line( ' Filters:' );
foreach ( $args['filters'] as $filter_key => $filter_value ) {
if ( is_array( $filter_value ) ) {
$filter_value = implode( ', ', $filter_value );
}
WP_CLI::line( sprintf( ' %s: %s', $filter_key, $filter_value ) );
}
}
if ( ! empty( $args['fields'] ) && is_array( $args['fields'] ) ) {
WP_CLI::line( sprintf( ' Fields: %s', implode( ', ', $args['fields'] ) ) );
}
}
/**
* Restore the original arguments to the current parsed args.
*
* @param array $original_args The original arguments to restore.
*/
private function restore_original_arguments( array $original_args ): void {
foreach ( $original_args as $key => $value ) {
if ( 'resume' !== $key ) {
$this->parsed_args[ $key ] = $value;
}
}
if ( isset( $original_args['fields'] ) ) {
$this->fields_to_process = $original_args['fields'];
}
}
}
PK [1]6]9& & & CLI/Migrator/Core/PlatformRegistry.phpnu load_platforms();
}
/**
* Initialize the registry with dependencies.
*
* @internal
* @param CredentialManager $credential_manager The credential manager.
*/
final public function init( CredentialManager $credential_manager ): void {
$this->credential_manager = $credential_manager;
}
/**
* Loads platforms discovered via a filter.
*
* It also validates that each registered platform provides both a fetcher and a mapper class.
*/
private function load_platforms(): void {
/**
* Filters the list of registered migration platforms.
*
* External platform plugins should hook into this filter to register themselves.
* Each platform plugin is responsible for its own autoloading and initialization.
*
* @param array $platforms An associative array of platform configurations.
* Each key is a unique platform ID (e.g., 'shopify'), and the value
* is another array containing 'name', 'fetcher', and 'mapper' class names.
* @since 1.0.0
*/
$platforms = apply_filters( 'woocommerce_migrator_platforms', array() );
if ( ! is_array( $platforms ) ) {
return;
}
foreach ( $platforms as $platform_id => $config ) {
// Validate that required keys exist and have valid values.
if ( isset( $config['fetcher'], $config['mapper'] ) &&
is_string( $config['fetcher'] ) && ! empty( $config['fetcher'] ) &&
is_string( $config['mapper'] ) && ! empty( $config['mapper'] ) ) {
$this->platforms[ $platform_id ] = $config;
}
}
}
/**
* Returns the entire array of registered platform configurations.
*
* @return array
*/
public function get_platforms(): array {
return $this->platforms;
}
/**
* Returns the configuration array for a single, specified platform ID.
*
* @param string $platform_id The ID of the platform (e.g., 'shopify').
*
* @return array|null The platform configuration or null if not found.
*/
public function get_platform( string $platform_id ): ?array {
return $this->platforms[ $platform_id ] ?? null;
}
/**
* Retrieves and instantiates the fetcher class for a given platform.
*
* @param string $platform_id The ID of the platform.
*
* @return PlatformFetcherInterface An instance of the platform's fetcher class.
*
* @throws InvalidArgumentException If the platform is not found, fetcher class is invalid, or credentials are not configured.
*/
public function get_fetcher( string $platform_id ): PlatformFetcherInterface {
$platform = $this->get_platform( $platform_id );
if ( ! $platform ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %s: Platform ID */
esc_html__( 'Platform %s not found.', 'woocommerce' ),
esc_html( $platform_id )
)
);
}
$fetcher_class = $platform['fetcher'];
// Validate that fetcher class is a non-empty string.
if ( ! is_string( $fetcher_class ) || empty( $fetcher_class ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %s: Platform ID */
esc_html__( 'Invalid fetcher class for platform %s. Fetcher must be a non-empty string.', 'woocommerce' ),
esc_html( $platform_id )
)
);
}
if ( ! class_exists( $fetcher_class ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %1$s: Platform ID, %2$s: Class name */
esc_html__( 'Invalid fetcher class for platform %1$s. Class %2$s does not exist.', 'woocommerce' ),
esc_html( $platform_id ),
esc_html( $fetcher_class )
)
);
}
if ( ! in_array( PlatformFetcherInterface::class, class_implements( $fetcher_class ), true ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %1$s: Platform ID, %2$s: Class name, %3$s: Interface name */
esc_html__( 'Invalid fetcher class for platform %1$s. Class %2$s does not implement %3$s.', 'woocommerce' ),
esc_html( $platform_id ),
esc_html( $fetcher_class ),
esc_html( PlatformFetcherInterface::class )
)
);
}
// Get credentials from credential manager and pass to fetcher constructor.
$credentials = $this->credential_manager->get_credentials( $platform_id );
if ( ! is_array( $credentials ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %s: platform ID */
'No credentials found for platform "%s". Please configure credentials using: wp wc migrate setup',
esc_html( $platform_id )
)
);
}
return new $fetcher_class( $credentials );
}
/**
* Retrieves and instantiates the mapper class for a given platform.
*
* @param string $platform_id The ID of the platform.
* @param array $args Optional arguments to pass to the mapper constructor.
*
* @return PlatformMapperInterface An instance of the platform's mapper class.
*
* @throws InvalidArgumentException If the platform is not found or the mapper class is invalid.
*/
public function get_mapper( string $platform_id, array $args = array() ): PlatformMapperInterface {
$platform = $this->get_platform( $platform_id );
if ( ! $platform ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %s: Platform ID */
esc_html__( 'Platform %s not found.', 'woocommerce' ),
esc_html( $platform_id )
)
);
}
$mapper_class = $platform['mapper'];
// Validate that mapper class is a non-empty string.
if ( ! is_string( $mapper_class ) || empty( $mapper_class ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %s: Platform ID */
esc_html__( 'Invalid mapper class for platform %s. Mapper must be a non-empty string.', 'woocommerce' ),
esc_html( $platform_id )
)
);
}
if ( ! class_exists( $mapper_class ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %1$s: Platform ID, %2$s: Class name */
esc_html__( 'Invalid mapper class for platform %1$s. Class %2$s does not exist.', 'woocommerce' ),
esc_html( $platform_id ),
esc_html( $mapper_class )
)
);
}
if ( ! in_array( PlatformMapperInterface::class, class_implements( $mapper_class ), true ) ) {
throw new InvalidArgumentException(
sprintf(
/* translators: %1$s: Platform ID, %2$s: Class name, %3$s: Interface name */
esc_html__( 'Invalid mapper class for platform %1$s. Class %2$s does not implement %3$s.', 'woocommerce' ),
esc_html( $platform_id ),
esc_html( $mapper_class ),
esc_html( PlatformMapperInterface::class )
)
);
}
// If arguments are provided, instantiate manually to pass constructor args.
// Otherwise, use the WooCommerce DI container for dependency injection.
if ( ! empty( $args ) ) {
return new $mapper_class( $args );
} else {
$container = wc_get_container();
return $container->get( $mapper_class );
}
}
/**
* Determines the platform to use from command arguments, with validation and fallback.
*
* @param array $assoc_args Associative arguments from the command.
* @param string $default_platform The default platform to use if none specified.
*
* @return string The validated platform slug.
*/
public function resolve_platform( array $assoc_args, string $default_platform = 'shopify' ): string {
$platform = $assoc_args['platform'] ?? null;
if ( empty( $platform ) ) {
$platform = $default_platform;
$platform_display_name = $this->get_platform_display_name( $platform );
WP_CLI::log( "Platform not specified, using default: '{$platform_display_name}'." );
}
// Validate the platform exists.
if ( ! $this->get_platform( $platform ) ) {
$available_platforms = array_keys( $this->get_platforms() );
if ( empty( $available_platforms ) ) {
WP_CLI::error( 'No platforms are currently registered. Please ensure platform plugins are installed and activated.' );
} else {
WP_CLI::error(
sprintf(
"Platform '%s' is not registered. Available platforms: %s",
$platform,
implode( ', ', $available_platforms )
)
);
}
}
return $platform;
}
/**
* Get platform-specific credential fields for setup prompts.
*
* @param string $platform_slug The platform identifier.
*
* @return array Array of field_name => prompt_text pairs.
*/
public function get_platform_credential_fields( string $platform_slug ): array {
$platform = $this->get_platform( $platform_slug );
if ( ! is_array( $platform ) ) {
return array();
}
$credentials = $platform['credentials'] ?? array();
return is_array( $credentials ) ? $credentials : array();
}
/**
* Gets the display name for a platform.
*
* @param string $platform_slug The platform identifier (e.g., 'shopify').
*
* @return string The proper display name (e.g., 'Shopify').
*/
public function get_platform_display_name( string $platform_slug ): string {
$platform = $this->get_platform( $platform_slug );
if ( is_array( $platform ) && isset( $platform['name'] ) ) {
return $platform['name'];
}
// Fallback to ucfirst if platform not found or no name configured.
return ucfirst( $platform_slug );
}
}
PK [1]m)
)
' CLI/Migrator/Core/CredentialManager.phpnu get_credentials( $platform_slug );
return ! empty( $credentials );
}
/**
* Prompts the user for credentials via the command line.
*
* @param array $fields An associative array of fields to prompt for.
*
* @return array The collected credentials.
*/
public function prompt_for_credentials( array $fields ): array {
$credentials = array();
foreach ( $fields as $key => $prompt ) {
$credentials[ $key ] = $this->readline( $prompt . ' ' );
}
return $credentials;
}
/**
* Saves credentials to the database for a given platform.
*
* @param string $platform_slug The slug for the platform.
* @param array $credentials An associative array of credentials.
*/
public function save_credentials( string $platform_slug, array $credentials ): void {
$option_name = "wc_migrator_credentials_{$platform_slug}";
update_option( $option_name, wp_json_encode( $credentials ) );
}
/**
* Deletes credentials from the database for a given platform.
*
* @param string $platform_slug The slug for the platform.
*/
public function delete_credentials( string $platform_slug ): void {
$option_name = "wc_migrator_credentials_{$platform_slug}";
delete_option( $option_name );
}
/**
* Handles the interactive credential setup process for a platform.
*
* @param string $platform_slug The platform slug to set up credentials for.
* @param array $required_fields An array of field_key => prompt_text for credentials to collect.
*
* @return void
*/
public function setup_credentials( string $platform_slug, array $required_fields ): void {
if ( empty( $required_fields ) ) {
WP_CLI::error( 'No credential fields specified for setup.' );
return;
}
WP_CLI::log( 'Configuring credentials for ' . ucfirst( $platform_slug ) . '...' );
$credentials = $this->prompt_for_credentials( $required_fields );
$this->save_credentials( $platform_slug, $credentials );
}
/**
* Reads a line from STDIN.
*
* A backward-compatible wrapper for WP_CLI::readline().
*
* @param string $prompt The prompt to show to the user.
*
* @return string
*/
private function readline( string $prompt ): string {
if ( method_exists( 'WP_CLI', 'readline' ) ) {
return WP_CLI::readline( $prompt );
}
WP_CLI::line( $prompt );
return trim( fgets( STDIN ) );
}
}
PK [1]3~6 6 0 CLI/Migrator/Core/WooCommerceProductImporter.phpnu 0,
'products_updated' => 0,
'products_skipped' => 0,
'images_processed' => 0,
'errors_encountered' => 0,
);
/**
* Migration data including image and variation mappings for session persistence.
*
* @var array
*/
private array $migration_data = array(
'images_mapping' => array(),
'variations_mapping' => array(),
);
/**
* Mapping of original attribute names to taxonomy names for current product.
*
* @var array
*/
private array $current_attribute_mapping = array();
/**
* Constructor - parameterless to support WooCommerce DI container.
*/
public function __construct() {
$this->import_options = $this->get_default_options();
}
/**
* Configure the importer with options.
*
* @param array $options Import options and configuration.
*/
public function configure( array $options ): void {
$this->import_options = array_merge( $this->import_options, $options );
}
/**
* Set progress callback for per-product import updates.
*
* @param callable|null $callback Function to call with progress updates.
* Receives: (current_index, total_count, product_name, result).
*/
public function set_progress_callback( ?callable $callback ): void {
$this->progress_callback = $callback;
}
/**
* Import a single product from mapped data.
*
* @param array $product_data Mapped WooCommerce product data.
* @param array $source_data Original source platform data for reference.
* @return array Import result with status and details.
*/
public function import_product( array $product_data, array $source_data = array() ): array {
$start_time = microtime( true );
$product_name = $product_data['name'] ?? 'Unknown Product';
$this->current_attribute_mapping = array();
try {
wc_get_logger()->info( "Starting import for product: {$product_name}", array( 'source' => 'wc-migrator' ) );
$validation_result = $this->validate_product_data( $product_data );
if ( ! $validation_result['valid'] ) {
wc_get_logger()->error( "Validation failed for product: {$product_name} - " . $validation_result['message'], array( 'source' => 'wc-migrator' ) );
return $this->create_error_result( 'validation_failed', $validation_result['message'], $product_data );
}
$existing_product_id = $this->find_existing_product( $product_data, $source_data );
if ( $existing_product_id && $this->import_options['skip_existing'] ) {
++$this->import_stats['products_skipped'];
return $this->create_success_result( 'skipped', $existing_product_id, 'Product already exists and skip_existing is enabled' );
}
$product_type = $this->determine_product_type( $product_data );
$product = $this->get_or_create_product_object( $existing_product_id, $product_type );
if ( ! $product ) {
return $this->create_error_result( 'product_creation_failed', 'Failed to create product object', $product_data );
}
if ( $existing_product_id ) {
$existing_migration_data = $product->get_meta( '_migration_data' );
if ( is_array( $existing_migration_data ) ) {
$this->migration_data['images_mapping'] = $existing_migration_data['images_mapping'] ?? array();
$this->migration_data['variations_mapping'] = $existing_migration_data['variations_mapping'] ?? array();
}
}
$this->set_basic_product_properties( $product, $product_data );
$this->set_product_taxonomies( $product, $product_data );
$this->handle_product_images( $product, $product_data['images'] ?? array() );
wc_get_logger()->debug( "Processing {$product_type} product: {$product_name}", array( 'source' => 'wc-migrator' ) );
switch ( $product_type ) {
case 'variable':
$this->handle_variable_product( $product, $product_data );
break;
case 'simple':
default:
$this->handle_simple_product( $product, $product_data );
break;
}
$product_id = $product->save();
if ( ! $product_id ) {
return $this->create_error_result( 'save_failed', 'Failed to save product to database', $product_data );
}
$this->handle_post_save_operations( $product_id, $product_data, $source_data );
if ( $existing_product_id ) {
++$this->import_stats['products_updated'];
} else {
++$this->import_stats['products_created'];
}
$duration = microtime( true ) - $start_time;
$action = $existing_product_id ? 'updated' : 'created';
wc_get_logger()->info(
"Successfully {$action} product: {$product_name} (ID: {$product_id}) in {$duration}s",
array( 'source' => 'wc-migrator' )
);
return $this->create_success_result( $action, $product_id, "Product {$action} successfully in {$duration}s" );
} catch ( Exception $e ) {
++$this->import_stats['errors_encountered'];
$duration = microtime( true ) - $start_time;
wc_get_logger()->error(
"Exception importing product: {$product_name} after {$duration}s - " . $e->getMessage(),
array(
'source' => 'wc-migrator',
'exception' => $e,
)
);
return $this->create_error_result( 'exception', $e->getMessage(), $product_data );
}
}
/**
* Import a batch of products.
*
* @param array $products_data Array of mapped product data.
* @param array $source_data_batch Array of original source data for reference.
* @return array Batch import results.
*/
public function import_batch( array $products_data, array $source_data_batch = array() ): array {
$results = array();
$batch_stats = array(
'successful' => 0,
'failed' => 0,
'skipped' => 0,
);
$total_count = count( $products_data );
foreach ( $products_data as $index => $product_data ) {
$source_data = $source_data_batch[ $index ] ?? array();
$product_name = $product_data['name'] ?? 'Unknown Product';
$result = $this->import_product( $product_data, $source_data );
$results[] = $result;
if ( 'success' === $result['status'] ) {
if ( 'skipped' === $result['action'] ) {
++$batch_stats['skipped'];
} else {
++$batch_stats['successful'];
}
} else {
++$batch_stats['failed'];
}
if ( $this->progress_callback ) {
call_user_func( $this->progress_callback, $index + 1, $total_count, $product_name, $result );
}
}
return array(
'results' => $results,
'stats' => $batch_stats,
);
}
/**
* Get current import statistics.
*
* @return array Import statistics.
*/
public function get_import_stats(): array {
return $this->import_stats;
}
/**
* Reset import statistics.
*/
public function reset_stats(): void {
$this->import_stats = array(
'products_created' => 0,
'products_updated' => 0,
'products_skipped' => 0,
'images_processed' => 0,
'errors_encountered' => 0,
);
}
/**
* Get default import options.
*
* @return array Default options.
*/
private function get_default_options(): array {
return array(
'skip_existing' => false,
'update_existing' => true,
'import_images' => true,
'image_timeout' => self::DEFAULT_IMAGE_TIMEOUT,
'max_images_per_product' => self::MAX_IMAGES_PER_PRODUCT,
'skip_duplicate_images' => false,
'create_categories' => true,
'create_tags' => true,
'handle_variations' => true,
'assign_default_category' => false,
'dry_run' => false,
);
}
/**
* Validate product data before import.
*
* @param array $product_data Product data to validate.
* @return array Validation result.
*/
private function validate_product_data( array $product_data ): array {
$required_fields = array( 'name' );
$missing_fields = array();
foreach ( $required_fields as $field ) {
if ( empty( $product_data[ $field ] ) ) {
$missing_fields[] = $field;
}
}
if ( ! empty( $missing_fields ) ) {
return array(
'valid' => false,
'message' => 'Missing required fields: ' . implode( ', ', $missing_fields ),
);
}
return array( 'valid' => true );
}
/**
* Find existing product by various identifiers.
*
* @param array $product_data Mapped product data.
* @return int|null Existing product ID or null if not found.
*/
private function find_existing_product( array $product_data ): ?int {
if ( ! empty( $product_data['original_product_id'] ) ) {
$existing_posts = get_posts(
array(
'post_type' => 'product',
'post_status' => 'any', // Find regardless of status.
'meta_key' => '_original_product_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'meta_value' => $product_data['original_product_id'], // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
'fields' => 'ids',
'numberposts' => 1,
)
);
if ( ! empty( $existing_posts ) ) {
return (int) $existing_posts[0];
}
}
if ( ! empty( $product_data['sku'] ) ) {
$product_id = wc_get_product_id_by_sku( $product_data['sku'] );
if ( $product_id ) {
return $product_id;
}
}
if ( ! empty( $product_data['slug'] ) ) {
$post = get_page_by_path( $product_data['slug'], OBJECT, 'product' );
if ( $post ) {
return $post->ID;
}
}
return null;
}
/**
* Determine product type from product data.
*
* @param array $product_data Product data.
* @return string Product type.
*/
private function determine_product_type( array $product_data ): string {
if ( isset( $product_data['is_variable'] ) ) {
return $product_data['is_variable'] ? 'variable' : 'simple';
}
if ( ! empty( $product_data['variations'] ) && count( $product_data['variations'] ) >= 1 ) {
return 'variable';
}
if ( ! empty( $product_data['attributes'] ) ) {
foreach ( $product_data['attributes'] as $attribute ) {
if ( ! empty( $attribute['is_variation'] ) || ! empty( $attribute['variation'] ) ) {
return 'variable';
}
}
}
return 'simple';
}
/**
* Get or create product object with proper type conversion handling.
*
* @param int|null $existing_product_id Existing product ID if updating.
* @param string $required_type Required product type.
* @return WC_Product|null Product object or null on failure.
*/
private function get_or_create_product_object( ?int $existing_product_id, string $required_type ): ?WC_Product {
if ( ! $existing_product_id ) {
return $this->create_product_object( $required_type );
}
$existing_product = wc_get_product( $existing_product_id );
if ( ! $existing_product ) {
return $this->create_product_object( $required_type );
}
$current_type = $existing_product->get_type();
if ( $current_type === $required_type ) {
return $existing_product;
}
wc_get_logger()->info(
"Converting product ID {$existing_product_id} from {$current_type} to {$required_type}",
array( 'source' => 'wc-migrator' )
);
switch ( $required_type ) {
case 'variable':
return new WC_Product_Variable( $existing_product_id );
case 'simple':
default:
return new WC_Product_Simple( $existing_product_id );
}
}
/**
* Create appropriate product object based on type.
*
* @param string $product_type Product type.
* @return WC_Product|null Product object or null on failure.
*/
private function create_product_object( string $product_type ): ?WC_Product {
switch ( $product_type ) {
case 'variable':
return new WC_Product_Variable();
case 'simple':
default:
return new WC_Product_Simple();
}
}
/**
* Set basic product properties common to all product types.
*
* @param WC_Product $product Product object.
* @param array $product_data Product data.
*/
private function set_basic_product_properties( WC_Product $product, array $product_data ): void {
$product->set_name( $product_data['name'] );
if ( ! empty( $product_data['slug'] ) ) {
$product->set_slug( $product_data['slug'] );
}
if ( ! empty( $product_data['description'] ) ) {
$product->set_description( $product_data['description'] );
}
if ( ! empty( $product_data['short_description'] ) ) {
$product->set_short_description( $product_data['short_description'] );
}
if ( ! empty( $product_data['status'] ) ) {
$product->set_status( $product_data['status'] );
}
if ( ! empty( $product_data['sku'] ) ) {
$product->set_sku( $product_data['sku'] );
}
if ( isset( $product_data['catalog_visibility'] ) ) {
$product->set_catalog_visibility( $product_data['catalog_visibility'] );
}
if ( ! empty( $product_data['date_created_gmt'] ) ) {
$product->set_date_created( $product_data['date_created_gmt'] );
}
if ( ! empty( $product_data['weight'] ) ) {
$product->set_weight( $product_data['weight'] );
}
if ( ! empty( $product_data['tax_status'] ) ) {
$product->set_tax_status( $product_data['tax_status'] );
}
if ( ! empty( $product_data['metafields'] ) ) {
foreach ( $product_data['metafields'] as $key => $value ) {
if ( ! empty( $key ) ) {
$product->add_meta_data( $key, $value, true );
}
}
}
if ( ! empty( $product_data['meta_data'] ) ) {
foreach ( $product_data['meta_data'] as $meta ) {
if ( ! empty( $meta['key'] ) ) {
$product->add_meta_data( $meta['key'], $meta['value'] ?? '', true );
}
}
}
}
/**
* Handle simple product specific data.
*
* @param WC_Product_Simple $product Simple product object.
* @param array $product_data Product data.
*/
private function handle_simple_product( WC_Product_Simple $product, array $product_data ): void {
if ( ! empty( $product_data['regular_price'] ) ) {
$product->set_regular_price( $product_data['regular_price'] );
$product->set_price( $product_data['regular_price'] );
}
if ( ! empty( $product_data['sale_price'] ) ) {
$product->set_sale_price( $product_data['sale_price'] );
$product->set_price( $product_data['sale_price'] );
}
if ( ! empty( $product_data['sku'] ) ) {
add_filter( 'wc_product_has_unique_sku', '__return_false', 999 );
$product->set_sku( $product_data['sku'] );
remove_filter( 'wc_product_has_unique_sku', '__return_false', 999 );
}
if ( isset( $product_data['manage_stock'] ) ) {
$product->set_manage_stock( $product_data['manage_stock'] );
}
if ( ! empty( $product_data['stock_quantity'] ) ) {
$product->set_stock_quantity( (int) $product_data['stock_quantity'] );
}
if ( ! empty( $product_data['stock_status'] ) ) {
$product->set_stock_status( $product_data['stock_status'] );
}
if ( array_key_exists( 'cost_of_goods', $product_data ) ) {
$cogs_is_enabled = FeaturesUtil::feature_is_enabled( 'cost_of_goods_sold' );
if ( $cogs_is_enabled ) {
$product->set_cogs_value( (float) $product_data['cost_of_goods'] );
} else {
$this->set_cogs_value_direct( $product, (float) $product_data['cost_of_goods'] );
}
}
}
/**
* Handle variable product specific data.
*
* @param WC_Product_Variable $product Variable product object.
* @param array $product_data Product data.
*/
private function handle_variable_product( WC_Product_Variable $product, array $product_data ): void {
$product->set_sku( '' );
$product->set_regular_price( '' );
$product->set_sale_price( '' );
$product->set_manage_stock( false );
$product->set_weight( '' );
$product->set_stock_quantity( null );
if ( ! empty( $product_data['attributes'] ) ) {
$this->setup_attributes( $product, $product_data['attributes'] );
}
$product_id = $product->save();
if ( ! empty( $product_data['variations'] ) && $this->import_options['handle_variations'] ) {
$this->sync_variations( $product, $product_data['variations'] );
}
}
/**
* Set product attributes.
*
* @param WC_Product $product Product object.
* @param array $attributes Attributes data.
*/
private function set_product_attributes( WC_Product $product, array $attributes ): void {
$product_attributes = array();
foreach ( $attributes as $attribute_data ) {
if ( empty( $attribute_data['name'] ) ) {
continue;
}
$attribute = new \WC_Product_Attribute();
$attribute->set_name( $attribute_data['name'] );
$attribute->set_options( $attribute_data['options'] ?? array() );
$attribute->set_variation( $attribute_data['is_variation'] ?? $attribute_data['variation'] ?? false );
$attribute->set_visible( $attribute_data['is_visible'] ?? $attribute_data['visible'] ?? true );
$product_attributes[] = $attribute;
}
$product->set_attributes( $product_attributes );
}
/**
* Sets up product attributes for variable products with global taxonomy creation.
*
* @param WC_Product_Variable $product The variable product object.
* @param array $attributes_data Standardized attribute data from mapper.
*/
private function setup_attributes( WC_Product_Variable $product, array $attributes_data ): void {
$woo_attributes = array();
$this->current_attribute_mapping = array();
foreach ( $attributes_data as $attribute_info ) {
$attr_name = $attribute_info['name'] ?? null;
$attr_options = $attribute_info['options'] ?? array();
if ( empty( $attr_name ) || empty( $attr_options ) ) {
continue;
}
$taxonomy_slug = sanitize_title( $attr_name );
$taxonomy_name = 'pa_' . $taxonomy_slug;
$attribute_id = 0;
if ( ! taxonomy_exists( $taxonomy_name ) ) {
$attribute_id = wc_create_attribute(
array(
'name' => $attr_name,
'slug' => $taxonomy_slug,
'type' => 'select',
'order_by' => 'menu_order',
'has_archives' => false,
)
);
if ( is_wp_error( $attribute_id ) ) {
wc_get_logger()->warning( "Failed to create attribute '{$attr_name}': " . $attribute_id->get_error_message(), array( 'source' => 'wc-migrator' ) );
continue;
}
register_taxonomy(
$taxonomy_name,
/**
* Filters the object types associated with the attribute taxonomy.
*
* @since 10.2.0
* @param array $object_types Array of object types.
*/
apply_filters( 'woocommerce_taxonomy_objects_' . $taxonomy_name, array( 'product' ) ),
/**
* Filters the arguments for registering the attribute taxonomy.
*
* @since 10.2.0
* @param array $args Array of taxonomy registration arguments.
*/
apply_filters(
'woocommerce_taxonomy_args_' . $taxonomy_name,
array(
'labels' => array(
'name' => $attr_name,
),
'hierarchical' => false,
'show_ui' => false,
'show_in_rest' => true,
'query_var' => true,
'rewrite' => false,
'public' => false,
)
)
);
} else {
$attribute_id = wc_attribute_taxonomy_id_by_name( $taxonomy_name );
}
$term_ids = array();
$term_slugs = array();
foreach ( $attr_options as $value ) {
$term_slug = sanitize_title( $value );
$term = get_term_by( 'slug', $term_slug, $taxonomy_name );
if ( ! $term ) {
$term_result = wp_insert_term( $value, $taxonomy_name, array( 'slug' => $term_slug ) );
if ( is_wp_error( $term_result ) ) {
wc_get_logger()->warning( "Failed to insert term '{$value}' (slug: {$term_slug}) into {$taxonomy_name}: " . $term_result->get_error_message(), array( 'source' => 'wc-migrator' ) );
continue;
}
$term_ids[] = $term_result['term_id'];
$term_slugs[] = $term_slug;
} else {
$term_ids[] = $term->term_id;
$term_slugs[] = $term->slug;
}
}
$woo_attribute = new \WC_Product_Attribute();
$woo_attribute->set_name( $taxonomy_name );
$woo_attribute->set_id( $attribute_id );
$woo_attribute->set_options( $term_ids );
$woo_attribute->set_position( $attribute_info['position'] ?? 0 );
$woo_attribute->set_visible( $attribute_info['is_visible'] ?? true );
$woo_attribute->set_variation( $attribute_info['is_variation'] ?? true );
$woo_attributes[] = $woo_attribute;
$this->current_attribute_mapping[ $attr_name ] = $taxonomy_name;
}
$product->set_attributes( $woo_attributes );
}
/**
* Creates or updates product variations with proper mapping and lookup.
*
* @param WC_Product_Variable $product The parent variable product.
* @param array $variations_data Standardized variation data from mapper.
*/
private function sync_variations( WC_Product_Variable $product, array $variations_data ): void {
$parent_product_id = $product->get_id();
$parent_original_id = $product->get_meta( '_original_product_id' );
$processed_variation_ids = array();
$variation_count = count( $variations_data );
wc_get_logger()->debug( "Syncing {$variation_count} variations for product ID {$parent_product_id}", array( 'source' => 'wc-migrator' ) );
$attribute_taxonomy_map = $this->current_attribute_mapping;
// Build fallback mapping from product attributes if current mapping is empty.
if ( empty( $attribute_taxonomy_map ) ) {
$product_attributes = $product->get_attributes();
foreach ( $product_attributes as $taxonomy => $attribute_obj ) {
if ( $attribute_obj->get_variation() ) {
$attribute_label = wc_attribute_label( $taxonomy, $product );
// Store mapping with both original case and lowercase for case-insensitive lookup.
$attribute_taxonomy_map[ $attribute_label ] = $taxonomy;
$attribute_taxonomy_map[ strtolower( $attribute_label ) ] = $taxonomy;
}
}
}
foreach ( $variations_data as $var_data ) {
$original_variant_id = $var_data['original_id'] ?? null;
if ( ! $original_variant_id ) {
wc_get_logger()->warning( 'Skipping variation: Missing original ID.', array( 'source' => 'wc-migrator' ) );
continue;
}
$variation_id = null;
$variation = null;
if ( isset( $this->migration_data['variations_mapping'][ $original_variant_id ] ) ) {
$_variation_id = $this->migration_data['variations_mapping'][ $original_variant_id ];
$_variation = wc_get_product( $_variation_id );
if ( $_variation instanceof WC_Product_Variation && $_variation->get_parent_id() === $parent_product_id ) {
$variation = $_variation;
$variation_id = $_variation_id;
} else {
unset( $this->migration_data['variations_mapping'][ $original_variant_id ] );
}
}
if ( ! $variation ) {
$query_args = array(
'post_parent' => $parent_product_id,
'post_type' => 'product_variation',
'numberposts' => 1,
'post_status' => 'any',
'meta_key' => '_original_variant_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'meta_value' => $original_variant_id, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
'fields' => 'ids',
);
$found_ids = get_posts( $query_args );
if ( ! empty( $found_ids ) ) {
$variation_id = $found_ids[0];
$variation = wc_get_product( $variation_id );
if ( ! ( $variation instanceof WC_Product_Variation ) ) {
wc_get_logger()->warning( "Found post ID {$variation_id} for original variant {$original_variant_id}, but it's not a WC_Product_Variation.", array( 'source' => 'wc-migrator' ) );
$variation = null;
$variation_id = null;
}
}
}
if ( ! $variation ) {
$variation = new WC_Product_Variation();
$variation->set_parent_id( $parent_product_id );
}
$variation->set_status( 'publish' );
$variation->set_menu_order( $var_data['menu_order'] ?? 0 );
$variation->set_regular_price( $var_data['regular_price'] ?? '' );
$variation->set_sale_price( $var_data['sale_price'] ?? '' );
if ( ! empty( $var_data['sku'] ) ) {
add_filter( 'wc_product_has_unique_sku', '__return_false', 999 );
$variation->set_sku( $var_data['sku'] );
remove_filter( 'wc_product_has_unique_sku', '__return_false', 999 );
}
$variation->set_manage_stock( $var_data['manage_stock'] ?? false );
$variation->set_stock_quantity( $var_data['stock_quantity'] ?? null );
$variation->set_stock_status( $var_data['stock_status'] ?? 'instock' );
$variation->set_weight( $var_data['weight'] ?? '' );
if ( ! empty( $var_data['tax_status'] ) ) {
$variation->set_tax_status( $var_data['tax_status'] );
}
$image_original_id = $var_data['image_original_id'] ?? null;
if ( $image_original_id && isset( $this->migration_data['images_mapping'][ $image_original_id ] ) ) {
$variation->set_image_id( $this->migration_data['images_mapping'][ $image_original_id ] );
} else {
$variation->set_image_id( '' );
}
$wc_variation_attributes = array();
if ( ! empty( $var_data['attributes'] ) && is_array( $var_data['attributes'] ) ) {
foreach ( $var_data['attributes'] as $attr_name => $attr_value ) {
if ( isset( $attribute_taxonomy_map[ $attr_name ] ) ) {
$taxonomy = $attribute_taxonomy_map[ $attr_name ];
$term_slug = sanitize_title( $attr_value );
$normalized_attribute_name = wc_variation_attribute_name( $taxonomy );
$wc_variation_attributes[ $normalized_attribute_name ] = $term_slug;
} else {
wc_get_logger()->warning( "Attribute taxonomy mapping not found for option '{$attr_name}' while processing variation {$original_variant_id}.", array( 'source' => 'wc-migrator' ) );
}
}
}
$variation->set_attributes( $wc_variation_attributes );
$variation->update_meta_data( '_original_variant_id', $original_variant_id );
if ( $parent_original_id ) {
$variation->update_meta_data( '_original_product_id', $parent_original_id );
}
$saved_variation_id = $variation->save();
if ( $saved_variation_id ) {
$processed_variation_ids[] = $saved_variation_id;
$this->migration_data['variations_mapping'][ $original_variant_id ] = $saved_variation_id;
if ( ! empty( $var_data['cost_of_goods'] ) ) {
update_post_meta( $saved_variation_id, '_cogs_total_value', (float) $var_data['cost_of_goods'] );
}
} else {
wc_get_logger()->error( "Failed to save variation for original variant {$original_variant_id}", array( 'source' => 'wc-migrator' ) );
}
}
WC_Product_Variable::sync( $parent_product_id );
$processed_count = count( $processed_variation_ids );
wc_get_logger()->debug( "Successfully synced {$processed_count}/{$variation_count} variations for product ID {$parent_product_id}", array( 'source' => 'wc-migrator' ) );
}
/**
* Create product variations (legacy method - keeping for backward compatibility).
*
* @param int $parent_id Parent product ID.
* @param array $variations Variations data.
*/
private function create_product_variations( int $parent_id, array $variations ): void {
$product = wc_get_product( $parent_id );
if ( $product instanceof WC_Product_Variable ) {
$this->sync_variations( $product, $variations );
}
}
/**
* Handle post-save operations like metadata and migration tracking.
*
* @param int $product_id Product ID.
* @param array $product_data Product data.
*/
private function handle_post_save_operations( int $product_id, array $product_data ): void {
if ( ! empty( $product_data['original_product_id'] ) ) {
update_post_meta( $product_id, '_original_product_id', $product_data['original_product_id'] );
}
if ( ! empty( $product_data['original_url'] ) ) {
update_post_meta( $product_id, '_original_url', $product_data['original_url'] );
}
update_post_meta( $product_id, '_migration_data', $this->migration_data );
if ( ! empty( $product_data['metafields'] ) ) {
$this->update_seo_meta( $product_id, $product_data['metafields'], $product_data );
}
}
/**
* Set product taxonomies (categories, tags, brand) before product save.
*
* @param WC_Product $product The product object.
* @param array $product_data Standardized data containing taxonomies.
*/
private function set_product_taxonomies( WC_Product $product, array $product_data ): void {
$product_id = $product->get_id();
if ( ! $product_id ) {
$product_id = $product->save();
if ( ! $product_id ) {
wc_get_logger()->warning( 'Could not save product to set taxonomies.', array( 'source' => 'wc-migrator' ) );
return;
}
}
$taxonomies_to_set = array();
if ( isset( $product_data['categories'] ) && is_array( $product_data['categories'] ) && $this->import_options['create_categories'] ) {
$term_ids = $this->get_or_create_terms( $product_data['categories'], 'product_cat' );
if ( ! empty( $term_ids ) ) {
$taxonomies_to_set['product_cat'] = $term_ids;
} elseif ( $this->import_options['assign_default_category'] ) {
$default_cat_id = get_option( 'default_product_cat' );
if ( $default_cat_id ) {
$taxonomies_to_set['product_cat'] = array( $default_cat_id );
wc_get_logger()->info( "Assigned default category (ID: {$default_cat_id}) to product with no categories", array( 'source' => 'wc-migrator' ) );
}
} else {
wc_get_logger()->debug( 'Product has no categories and assign_default_category is disabled', array( 'source' => 'wc-migrator' ) );
}
}
if ( isset( $product_data['tags'] ) && is_array( $product_data['tags'] ) && $this->import_options['create_tags'] ) {
$term_ids = $this->get_or_create_terms( $product_data['tags'], 'product_tag' );
if ( ! empty( $term_ids ) ) {
$taxonomies_to_set['product_tag'] = $term_ids;
}
}
if ( ! empty( $product_data['brand']['name'] ) && taxonomy_exists( 'product_brand' ) ) {
$brand_data = array( $product_data['brand'] );
$term_ids = $this->get_or_create_terms( $brand_data, 'product_brand' );
if ( ! empty( $term_ids ) ) {
$taxonomies_to_set['product_brand'] = $term_ids;
}
}
foreach ( $taxonomies_to_set as $taxonomy => $ids ) {
wp_set_object_terms( $product_id, $ids, $taxonomy, false );
}
}
/**
* Helper to get or create term IDs for a given taxonomy.
*
* @param array $terms_data Array of ['name' => ..., 'slug' => ...].
* @param string $taxonomy Taxonomy slug.
* @return array Array of term IDs.
*/
private function get_or_create_terms( array $terms_data, string $taxonomy ): array {
$term_ids = array();
foreach ( $terms_data as $term_info ) {
$term_name = $term_info['name'] ?? null;
$term_slug = $term_info['slug'] ?? sanitize_title( $term_name );
if ( empty( $term_name ) || empty( $term_slug ) ) {
continue;
}
$term = get_term_by( 'slug', $term_slug, $taxonomy );
if ( ! $term ) {
$term_result = wp_insert_term( $term_name, $taxonomy, array( 'slug' => $term_slug ) );
if ( is_wp_error( $term_result ) ) {
wc_get_logger()->warning( "Failed to insert term '{$term_name}' (slug: {$term_slug}) into {$taxonomy}: " . $term_result->get_error_message(), array( 'source' => 'wc-migrator' ) );
continue;
}
$term_ids[] = $term_result['term_id'];
} else {
$term_ids[] = $term->term_id;
}
}
return array_unique( $term_ids );
}
/**
* Handle product images using product object methods.
*
* @param WC_Product $product The product object.
* @param array $images_data Standardized image data from mapper.
*/
private function handle_product_images( WC_Product $product, array $images_data ): void {
if ( empty( $images_data ) ) {
return;
}
$gallery_ids = array();
$featured_id = null;
$product_id = $product->get_id();
$processed_count = 0;
foreach ( $images_data as $index => $image ) {
if ( $processed_count >= $this->import_options['max_images_per_product'] ) {
break;
}
$original_id = $image['original_id'] ?? null;
$image_url = $image['src'] ?? null;
$image_alt = $image['alt'] ?? '';
$is_featured = $image['is_featured'] ?? ( 0 === $index );
if ( empty( $original_id ) || empty( $image_url ) ) {
wc_get_logger()->warning( 'Skipping image: Missing original ID or URL.', array( 'source' => 'wc-migrator' ) );
continue;
}
if ( isset( $this->migration_data['images_mapping'][ $original_id ] ) && wp_attachment_is_image( $this->migration_data['images_mapping'][ $original_id ] ) ) {
$attachment_id = $this->migration_data['images_mapping'][ $original_id ];
} else {
if ( ! $product_id ) {
$product_id = $product->save();
if ( ! $product_id ) {
wc_get_logger()->warning( "Skipping image upload {$original_id}: Could not get product ID before sideloading.", array( 'source' => 'wc-migrator' ) );
continue;
}
}
$start_time = microtime( true );
$image_desc = $image_alt ? $image_alt : $product->get_name();
$attachment_id = $this->import_image( $image_url, $image_alt, $product_id );
$duration = microtime( true ) - $start_time;
if ( is_wp_error( $attachment_id ) ) {
wc_get_logger()->error( "Error uploading {$image_url}: " . $attachment_id->get_error_message() . " (Duration: {$duration}s)", array( 'source' => 'wc-migrator' ) );
continue;
}
if ( ! $attachment_id ) {
wc_get_logger()->warning( "Image upload failed for {$image_url} (Duration: {$duration}s)", array( 'source' => 'wc-migrator' ) );
continue;
}
$this->migration_data['images_mapping'][ $original_id ] = $attachment_id;
if ( $image_alt ) {
update_post_meta( $attachment_id, '_wp_attachment_image_alt', $image_alt );
}
}
if ( $is_featured ) {
$featured_id = $attachment_id;
} else {
$gallery_ids[] = $attachment_id;
}
++$processed_count;
++$this->import_stats['images_processed'];
}
if ( $featured_id ) {
$product->set_image_id( $featured_id );
}
if ( ! empty( $gallery_ids ) ) {
$product->set_gallery_image_ids( array_unique( $gallery_ids ) );
}
}
/**
* Import image from URL with mapping optimization.
*
* @param string $image_url Image URL.
* @param string $alt_text Alt text for the image.
* @param string|null $original_id Original platform image ID.
* @param int $product_id Product ID for sideloading.
* @return int|null Attachment ID or null on failure.
*/
private function import_image_with_mapping( string $image_url, string $alt_text = '', ?string $original_id = null, int $product_id = 0 ): ?int {
if ( $original_id && isset( $this->migration_data['images_mapping'][ $original_id ] ) ) {
$attachment_id = $this->migration_data['images_mapping'][ $original_id ];
if ( wp_attachment_is_image( $attachment_id ) ) {
return $attachment_id;
} else {
unset( $this->migration_data['images_mapping'][ $original_id ] );
}
}
$start_time = microtime( true );
$attachment_id = $this->import_image( $image_url, $alt_text, $product_id );
$duration = microtime( true ) - $start_time;
if ( $attachment_id && $original_id ) {
$this->migration_data['images_mapping'][ $original_id ] = $attachment_id;
}
if ( $attachment_id ) {
$message = sprintf( 'Image uploaded successfully in %.2fs: %s -> %d', $duration, $image_url, $attachment_id );
if ( $this->import_options['verbose'] ?? false ) {
\WP_CLI::log( $message );
}
wc_get_logger()->info( $message, array( 'source' => 'wc-migrator-images' ) );
} else {
$message = sprintf( 'Image upload failed in %.2fs: %s', $duration, $image_url );
if ( $this->import_options['verbose'] ?? false ) {
\WP_CLI::warning( $message );
}
wc_get_logger()->error( $message, array( 'source' => 'wc-migrator-images' ) );
}
return $attachment_id;
}
/**
* Import image from URL.
*
* @param string $image_url Image URL.
* @param string $alt_text Alt text for the image.
* @param int $product_id Product ID for sideloading.
* @return int|null Attachment ID or null on failure.
*/
private function import_image( string $image_url, string $alt_text = '', int $product_id = 0 ): ?int {
if ( $this->import_options['dry_run'] ) {
return null;
}
if ( ! $this->import_options['skip_duplicate_images'] ) {
$existing_attachment = $this->get_attachment_by_url( $image_url );
if ( $existing_attachment ) {
return $existing_attachment;
}
}
require_once ABSPATH . 'wp-admin/includes/media.php';
require_once ABSPATH . 'wp-admin/includes/file.php';
require_once ABSPATH . 'wp-admin/includes/image.php';
add_filter( 'http_request_timeout', array( $this, 'set_image_download_timeout' ) );
add_filter( 'http_request_args', array( $this, 'optimize_http_request_args' ) );
add_filter( 'image_sideload_extensions', array( $this, 'add_avif_support_to_sideload' ) );
try {
$attachment_id = media_sideload_image( $image_url, $product_id, null, 'id' );
if ( is_wp_error( $attachment_id ) ) {
$message = sprintf( 'Image import failed for URL %s: %s', $image_url, $attachment_id->get_error_message() );
if ( $this->import_options['verbose'] ?? false ) {
\WP_CLI::warning( $message );
}
wc_get_logger()->error( $message, array( 'source' => 'wc-migrator-images' ) );
return null;
}
if ( $alt_text ) {
update_post_meta( $attachment_id, '_wp_attachment_image_alt', $alt_text );
}
return $attachment_id;
} finally {
remove_filter( 'http_request_timeout', array( $this, 'set_image_download_timeout' ) );
remove_filter( 'http_request_args', array( $this, 'optimize_http_request_args' ) );
remove_filter( 'image_sideload_extensions', array( $this, 'add_avif_support_to_sideload' ) );
}
}
/**
* Set HTTP timeout for image downloads.
*
* @return int Modified timeout.
*/
public function set_image_download_timeout(): int {
return $this->import_options['image_timeout'];
}
/**
* Optimize HTTP request arguments for faster image downloads.
*
* @param array $args HTTP request arguments.
* @return array Optimized arguments.
*/
public function optimize_http_request_args( array $args ): array {
$args['redirection'] = 3;
$args['timeout'] = $this->import_options['image_timeout'] ?? 30;
return $args;
}
/**
* Add AVIF support to image sideload extensions.
*
* @param array $allowed_extensions Array of allowed file extensions.
* @return array Modified array with AVIF support.
*/
public function add_avif_support_to_sideload( array $allowed_extensions ): array {
if ( ! in_array( 'avif', $allowed_extensions, true ) ) {
$allowed_extensions[] = 'avif';
}
return $allowed_extensions;
}
/**
* Get existing attachment by URL.
*
* @param string $image_url Image URL.
* @return int|null Attachment ID or null if not found.
*/
private function get_attachment_by_url( string $image_url ): ?int {
global $wpdb;
$basename = wp_basename( $image_url );
$attachment_id = $wpdb->get_var(
$wpdb->prepare(
"SELECT post_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attached_file' AND meta_value LIKE %s",
'%' . $wpdb->esc_like( $basename )
)
);
return $attachment_id ? (int) $attachment_id : null;
}
/**
* Create success result array.
*
* @param string $action Action performed (created, updated, skipped).
* @param int $product_id Product ID.
* @param string $message Success message.
* @return array Success result.
*/
private function create_success_result( string $action, int $product_id, string $message ): array {
return array(
'status' => 'success',
'action' => $action,
'product_id' => $product_id,
'message' => $message,
);
}
/**
* Updates SEO meta fields if Yoast SEO is active.
*
* @param int $product_id The product ID.
* @param array $metafields Key-value array of metafields from standardized data.
* @param array $product_data Full product data for fallbacks.
*/
private function update_seo_meta( int $product_id, array $metafields, array $product_data ): void {
if ( ! defined( 'WPSEO_VERSION' ) ) {
return;
}
$seo_title = $metafields['global_title_tag'] ?? null;
$seo_description = $metafields['global_description_tag'] ?? null;
$final_seo_title = $seo_title ? $seo_title : ( $product_data['name'] ?? '' );
$fallback_desc = $product_data['description'] ? $product_data['description'] : ( $product_data['short_description'] ?? '' );
$final_seo_description = $seo_description ? $seo_description : wp_strip_all_tags( $fallback_desc );
$current_title = get_post_meta( $product_id, '_yoast_wpseo_title', true );
if ( $current_title !== $final_seo_title && ! empty( $final_seo_title ) ) {
update_post_meta( $product_id, '_yoast_wpseo_title', $final_seo_title );
}
$current_desc = get_post_meta( $product_id, '_yoast_wpseo_metadesc', true );
if ( $current_desc !== $final_seo_description && ! empty( $final_seo_description ) ) {
$truncated_desc = mb_substr( $final_seo_description, 0, 160 );
update_post_meta( $product_id, '_yoast_wpseo_metadesc', $truncated_desc );
}
}
/**
* Set COGS value directly using meta data.
*
* @param WC_Product $product The product object.
* @param float $cogs_value The COGS value to set.
*/
private function set_cogs_value_direct( WC_Product $product, float $cogs_value ): void {
$product->update_meta_data( '_cogs_total_value', $cogs_value );
}
/**
* Create error result array.
*
* @param string $error_code Error code.
* @param string $message Error message.
* @param array $product_data Product data that failed.
* @return array Error result.
*/
private function create_error_result( string $error_code, string $message, array $product_data ): array {
return array(
'status' => 'error',
'error_code' => $error_code,
'message' => $message,
'product_data' => $product_data,
);
}
}
PK [1] . . % CLI/Migrator/Core/MigratorTracker.phpnu init_hooks();
}
/**
* Initialize WordPress hooks.
*/
private function init_hooks(): void {
add_action( 'wc_migrator_session_started', array( $this, 'on_session_started' ), 10, 2 );
add_action( 'wc_migrator_batch_processed', array( $this, 'on_batch_processed' ), 10, 3 );
add_action( 'wc_migrator_session_completed', array( $this, 'on_session_completed' ), 10, 2 );
}
/**
* Handle migration session start.
*
* @param string $platform Platform identifier (e.g., 'shopify').
* @param array $metadata Session metadata.
*/
public function on_session_started( string $platform, array $metadata ): void { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
$this->current_session = array(
'platform' => $platform,
'started_at' => time(),
'products_total' => 0,
'products_attempted' => 0,
'products_successful' => 0,
'products_failed' => 0,
'products_skipped' => 0,
'product_types' => array(),
'total_time' => 0,
'is_dry_run' => $metadata['is_dry_run'] ?? false,
);
}
/**
* Handle batch processing completion.
*
* @param array $batch_results Results from the batch import.
* @param array $source_data Source platform data for the batch.
* @param array $mapped_data Mapped WooCommerce data for the batch.
*/
public function on_batch_processed( array $batch_results, array $source_data, array $mapped_data ): void {
if ( empty( $this->current_session ) ) {
return;
}
// Track detailed statistics for better telemetry accuracy.
$batch_stats = $batch_results['stats'] ?? array();
$this->current_session['products_attempted'] += count( $mapped_data );
$this->current_session['products_successful'] += $batch_stats['successful'] ?? 0;
$this->current_session['products_failed'] += $batch_stats['failed'] ?? 0;
$this->current_session['products_skipped'] += $batch_stats['skipped'] ?? 0;
$this->track_product_types( $mapped_data, $batch_results );
}
/**
* Handle migration session completion.
*
* @param string $platform Platform identifier.
* @param array $final_stats Final migration statistics.
*/
public function on_session_completed( string $platform, array $final_stats ): void {
if ( empty( $this->current_session ) ) {
// Log warning for debugging - session completed without active session.
if ( function_exists( 'wc_get_logger' ) ) {
wc_get_logger()->warning(
'Migration session completed event fired without active session.',
array( 'source' => 'migrator_tracker' )
);
}
return;
}
// Use consistent time() calls to avoid any timezone issues.
$completion_time = time();
$this->current_session['total_time'] = $completion_time - $this->current_session['started_at'];
$this->current_session['completed_at'] = $completion_time;
$this->current_session['products_total'] = $final_stats['total_found'] ?? $this->current_session['products_attempted'];
$this->save_session_data();
$this->current_session = array();
}
/**
* Track product types from mapped data and import results.
*
* Only count product types for successfully imported products to ensure
* telemetry accuracy.
*
* @param array $mapped_data Array of mapped product data.
* @param array $batch_results Results from the batch import.
*/
private function track_product_types( array $mapped_data, array $batch_results ): void {
$successful_results = array_filter(
$batch_results['results'] ?? array(),
function ( $result ) {
return 'success' === ( $result['status'] ?? '' ) && 'skipped' !== ( $result['action'] ?? '' );
}
);
// Only track types for successfully imported products.
foreach ( $successful_results as $index => $result ) {
if ( ! isset( $mapped_data[ $index ] ) ) {
continue;
}
$product = $mapped_data[ $index ];
$type = $product['type'] ?? 'simple';
if ( ! isset( $this->current_session['product_types'][ $type ] ) ) {
$this->current_session['product_types'][ $type ] = 0;
}
++$this->current_session['product_types'][ $type ];
}
}
/**
* Save current session data to persistent storage.
*/
private function save_session_data(): void {
$analytics = $this->get_stored_analytics();
$platform = $this->current_session['platform'];
if ( ! isset( $analytics['platforms'][ $platform ] ) ) {
$analytics['platforms'][ $platform ] = array(
'total_products_attempted' => 0,
'total_products_successful' => 0,
'total_products_failed' => 0,
'total_products_skipped' => 0,
'total_sessions' => 0,
'total_time' => 0,
'product_types' => array(),
'last_migration' => null,
'dry_run_sessions' => 0,
);
}
$platform_data = &$analytics['platforms'][ $platform ];
$products_attempted = $this->current_session['products_attempted'] ?? 0;
$products_successful = $this->current_session['products_successful'] ?? 0;
$products_failed = $this->current_session['products_failed'] ?? 0;
$products_skipped = $this->current_session['products_skipped'] ?? 0;
$total_time = $this->current_session['total_time'] ?? 0;
$completed_at = $this->current_session['completed_at'] ?? time();
$product_types = $this->current_session['product_types'] ?? array();
$is_dry_run = $this->current_session['is_dry_run'] ?? false;
// Update platform statistics.
if ( ! $is_dry_run ) {
$platform_data['total_products_attempted'] += $products_attempted;
$platform_data['total_products_successful'] += $products_successful;
$platform_data['total_products_failed'] += $products_failed;
$platform_data['total_products_skipped'] += $products_skipped;
$platform_data['last_migration'] = $completed_at;
} else {
++$platform_data['dry_run_sessions'];
}
++$platform_data['total_sessions'];
$platform_data['total_time'] += $total_time;
foreach ( $product_types as $type => $count ) {
if ( ! isset( $platform_data['product_types'][ $type ] ) ) {
$platform_data['product_types'][ $type ] = 0;
}
$platform_data['product_types'][ $type ] += $count;
}
if ( ! isset( $analytics['totals'] ) || ! is_array( $analytics['totals'] ) ) {
$analytics['totals'] = array();
}
// Only update global totals for non-dry-run sessions.
if ( ! $is_dry_run ) {
$analytics['totals']['products_attempted'] = ( $analytics['totals']['products_attempted'] ?? 0 ) + $products_attempted;
$analytics['totals']['products_successful'] = ( $analytics['totals']['products_successful'] ?? 0 ) + $products_successful;
$analytics['totals']['products_failed'] = ( $analytics['totals']['products_failed'] ?? 0 ) + $products_failed;
$analytics['totals']['products_skipped'] = ( $analytics['totals']['products_skipped'] ?? 0 ) + $products_skipped;
}
$analytics['totals']['total_sessions'] = ( $analytics['totals']['total_sessions'] ?? 0 ) + 1;
$analytics['totals']['total_migration_time'] = ( $analytics['totals']['total_migration_time'] ?? 0 ) + $total_time;
$analytics['totals']['dry_run_sessions'] = ( $analytics['totals']['dry_run_sessions'] ?? 0 ) + ( $is_dry_run ? 1 : 0 );
$this->save_analytics( $analytics );
}
/**
* Get comprehensive migration data for WC_Tracker integration.
*
* @return array Formatted data for telemetry reporting.
*/
public function get_data(): array {
$analytics = $this->get_stored_analytics();
$totals = $analytics['totals'] ?? array();
$data = array(
'products_attempted' => $totals['products_attempted'] ?? 0,
'products_successful' => $totals['products_successful'] ?? 0,
'products_failed' => $totals['products_failed'] ?? 0,
'products_skipped' => $totals['products_skipped'] ?? 0,
'total_migration_sessions' => $totals['total_sessions'] ?? 0,
'total_migration_time' => $totals['total_migration_time'] ?? 0,
'dry_run_sessions' => $totals['dry_run_sessions'] ?? 0,
'platforms_used' => array_keys( $analytics['platforms'] ?? array() ),
'platform_breakdown' => array(),
'success_rate' => $this->calculate_success_rate( $totals ),
);
$platforms = $analytics['platforms'] ?? array();
foreach ( $platforms as $platform => $platform_data ) {
$data['platform_breakdown'][ $platform ] = array(
'products_attempted' => $platform_data['total_products_attempted'] ?? 0,
'products_successful' => $platform_data['total_products_successful'] ?? 0,
'products_failed' => $platform_data['total_products_failed'] ?? 0,
'products_skipped' => $platform_data['total_products_skipped'] ?? 0,
'sessions_count' => $platform_data['total_sessions'] ?? 0,
'dry_run_sessions' => $platform_data['dry_run_sessions'] ?? 0,
'total_time' => $platform_data['total_time'] ?? 0,
'product_types' => $platform_data['product_types'] ?? array(),
'last_migration' => $platform_data['last_migration'] ?? null,
'success_rate' => $this->calculate_success_rate( $platform_data ),
);
}
return $data;
}
/**
* Calculate success rate as a percentage.
*
* @param array $stats Statistics array containing attempted and successful counts.
* @return float Success rate as a percentage (0-100).
*/
private function calculate_success_rate( array $stats ): float {
$attempted = $stats['total_products_attempted'] ?? $stats['products_attempted'] ?? 0;
$successful = $stats['total_products_successful'] ?? $stats['products_successful'] ?? 0;
if ( 0 === $attempted ) {
return 0.0;
}
return round( ( $successful / $attempted ) * 100, 2 );
}
/**
* Get stored analytics data with defaults.
*
* @return array Analytics data structure.
*/
private function get_stored_analytics(): array {
$defaults = array(
'totals' => array(
'products_attempted' => 0,
'products_successful' => 0,
'products_failed' => 0,
'products_skipped' => 0,
'total_sessions' => 0,
'total_migration_time' => 0,
'dry_run_sessions' => 0,
),
'platforms' => array(),
);
$stored = get_option( self::OPTION_NAME, array() );
return wp_parse_args( $stored, $defaults );
}
/**
* Save analytics data to WordPress options.
*
* @param array $analytics Analytics data to save.
*/
private function save_analytics( array $analytics ): void {
if ( false === get_option( self::OPTION_NAME ) ) {
add_option( self::OPTION_NAME, $analytics, '', 'no' );
} else {
update_option( self::OPTION_NAME, $analytics, 'no' );
}
}
/**
* Clear all stored analytics data.
* Useful for development/testing or user privacy requests.
*/
public function clear_data(): void {
delete_option( self::OPTION_NAME );
$this->current_session = array();
}
}
PK [1]s CLI/Migrator/Runner.phpnu get( ProductsCommand::class ),
array(
'shortdesc' => 'Migrate products from a source platform to WooCommerce.',
'longdesc' => 'Migrate products from a source platform to WooCommerce. The migrator will fetch products from the source platform, map them to the WooCommerce product schema, and then import them into WooCommerce.',
)
);
WP_CLI::add_command(
'wc migrate reset',
$container->get( ResetCommand::class ),
array(
'shortdesc' => 'Resets (deletes) the credentials for a given platform.',
)
);
WP_CLI::add_command(
'wc migrate setup',
$container->get( SetupCommand::class ),
array(
'shortdesc' => 'Interactively sets up the credentials for a given platform.',
)
);
WP_CLI::add_command(
'wc migrate list',
$container->get( ListCommand::class ),
array(
'shortdesc' => 'Lists all registered migration platforms.',
)
);
}
/**
* Initialize built-in migration platforms.
*
* @return void
*/
private static function init_platforms(): void {
ShopifyPlatform::init();
}
}
PK [1]$}J }J " CLI/Migrator/Lib/ImportSession.phpnu self::POST_TYPE,
'post_status' => 'publish',
'post_title' => sprintf(
'Import from %s - %s',
$args['data_source'],
$args['file_name'] ?? $args['source_url'] ?? 'Unknown source'
),
'meta_input' => array(
'data_source' => $args['data_source'],
'started_at' => time(),
'file_name' => $args['file_name'] ?? null,
'source_url' => $args['source_url'] ?? null,
'attachment_id' => $args['attachment_id'] ?? null,
),
),
true
);
if ( is_wp_error( $post_id ) ) {
throw new \Exception( 'Error creating an import session: ' . $post_id->get_error_message() );
}
if ( ! empty( $args['attachment_id'] ) ) {
wp_update_post(
array(
'ID' => $post_id,
'post_parent' => $args['attachment_id'],
)
);
}
return new self( $post_id );
}
/**
* Gets an existing import session by ID.
*
* @param int $post_id The import session post ID
*
* @return WP_Import_Model|null The import model instance or null if not found
*/
public static function by_id( $post_id ) {
$post = get_post( $post_id );
if ( ! $post || $post->post_type !== self::POST_TYPE ) {
return false;
}
return new self( $post_id );
}
/**
* Gets the most recent active import session.
*
* @return WP_Import_Session|null The most recent import or null if none found
*/
public static function get_active() {
$posts = get_posts(
array(
'post_type' => self::POST_TYPE,
'post_status' => array( 'publish' ),
'posts_per_page' => 1,
'orderby' => 'date',
'order' => 'DESC',
'meta_query' => array(
// @TODO: This somehow makes $post empty.
// array(
// 'key' => 'current_stage',
// 'value' => WP_Stream_Importer::STAGE_FINISHED,
// 'compare' => '!='
// )
),
)
);
if ( empty( $posts ) ) {
return false;
}
return new self( $posts[0]->ID );
}
public function __construct( $post_id ) {
$this->post_id = $post_id;
}
/**
* Gets the import session ID.
*
* @return int The post ID
*/
public function get_id() {
return $this->post_id;
}
public function get_metadata() {
$cursor = $this->get_reentrancy_cursor();
return array(
'post_id' => $this->post_id,
'cursor' => $cursor ? $cursor : null,
'data_source' => get_post_meta( $this->post_id, 'data_source', true ),
'source_url' => get_post_meta( $this->post_id, 'source_url', true ),
'attachment_id' => get_post_meta( $this->post_id, 'attachment_id', true ),
);
}
public function get_data_source() {
return get_post_meta( $this->post_id, 'data_source', true );
}
public function get_human_readable_file_reference() {
switch ( $this->get_data_source() ) {
case 'wxr_file':
case 'markdown_zip':
return get_post_meta( $this->post_id, 'file_name', true );
case 'wxr_url':
return get_post_meta( $this->post_id, 'source_url', true );
}
return '';
}
public function archive() {
wp_update_post(
array(
'ID' => $this->post_id,
'post_status' => 'archived',
)
);
}
/**
* Gets the current progress information.
*
* @return array The progress data
*/
public function count_imported_entities() {
$progress = array();
foreach ( self::PROGRESS_ENTITIES as $entity ) {
$progress[] = array(
'label' => $entity,
'imported' => (int) get_post_meta( $this->post_id, 'imported_' . $entity, true ),
'total' => (int) get_post_meta( $this->post_id, 'total_' . $entity, true ),
);
}
return $progress;
}
public function count_all_imported_entities() {
$counts = $this->count_imported_entities();
return array_sum( array_column( $counts, 'imported' ) );
}
public function count_all_total_entities() {
$counts = $this->count_imported_entities();
return array_sum( array_column( $counts, 'total' ) );
}
public function count_remaining_entities() {
$counts = $this->count_imported_entities();
return array_sum( array_column( $counts, 'total' ) ) - array_sum( array_column( $counts, 'imported' ) );
}
/**
* Cache of imported entity counts to avoid repeated database queries
*
* @var array
*/
private $cached_imported_counts = array();
/**
* Updates the progress information.
*
* @param array $newly_imported_entities The new progress data with keys: posts, comments, terms, attachments, users
*/
public function bump_imported_entities_counts( $newly_imported_entities ) {
foreach ( $newly_imported_entities as $field => $count ) {
if ( ! in_array( $field, static::PROGRESS_ENTITIES, true ) ) {
_doing_it_wrong(
__METHOD__,
'Cannot bump imported entities count for unknown entity type: ' . $field,
'1.0.0'
);
continue;
}
// Get current count from cache or database
if ( ! isset( $this->cached_imported_counts[ $field ] ) ) {
$this->cached_imported_counts[ $field ] = (int) get_post_meta( $this->post_id, 'imported_' . $field, true );
}
// Add new count to total
$new_count = $this->cached_imported_counts[ $field ] + $count;
// Update database and cache
update_post_meta( $this->post_id, 'imported_' . $field, $new_count );
$this->cached_imported_counts[ $field ] = $new_count;
/*
@TODO run an atomic query instead:
$sql = $wpdb->prepare(
"INSERT INTO {$wpdb->postmeta} (post_id, meta_key, meta_value)
VALUES (%d, %s, %d)
ON DUPLICATE KEY UPDATE meta_value = meta_value + %d",
$this->post_id,
'imported_' . $field,
$count,
$count
);
$wpdb->query($sql);
*/
}
}
public function count_awaiting_frontloading_stubs() {
global $wpdb;
return (int) $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(*) FROM $wpdb->posts
WHERE post_type = 'frontloading_stub'
AND post_parent = %d
AND post_status = %s",
$this->post_id,
self::FRONTLOAD_STATUS_AWAITING_DOWNLOAD
)
);
}
public function count_unfinished_frontloading_stubs() {
global $wpdb;
return (int) $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(*) FROM $wpdb->posts
WHERE post_type = 'frontloading_stub'
AND post_parent = %d
AND post_status != %s
AND post_status != %s",
$this->post_id,
self::FRONTLOAD_STATUS_SUCCEEDED,
self::FRONTLOAD_STATUS_IGNORED
)
);
}
public function mark_frontloading_errors_as_ignored() {
global $wpdb;
$wpdb->update(
$wpdb->posts,
array( 'post_status' => self::FRONTLOAD_STATUS_IGNORED ),
array(
'post_type' => 'frontloading_stub',
// 'post_status !=' => self::FRONTLOAD_STATUS_SUCCEEDED,
)
);
}
public function get_frontloading_stubs( $options = array() ) {
$query = new WP_Query(
array(
'post_type' => 'frontloading_stub',
'post_status' => 'any',
'post_parent' => $this->post_id,
'posts_per_page' => $options['per_page'] ?? 25,
'paged' => $options['page'] ?? 1,
'orderby' => array(
'post_status' => array(
self::FRONTLOAD_STATUS_ERROR => 0,
self::FRONTLOAD_STATUS_AWAITING_DOWNLOAD => 1,
'any' => 2,
),
'ID' => 'ASC',
),
)
);
if ( ! $query->have_posts() ) {
return array();
}
$posts = $query->posts;
$ids = array_map(
function ( $post ) {
return $post->ID;
},
$posts
);
update_meta_cache( 'post', $ids );
foreach ( $posts as $post ) {
$post->meta = get_all_post_meta_flat( $post->ID );
}
return $posts;
}
public function get_total_number_of_entities() {
$totals = array();
foreach ( static::PROGRESS_ENTITIES as $field ) {
$totals[ $field ] = (int) get_post_meta( $this->post_id, 'total_' . $field, true );
}
$totals['download'] = $this->get_total_number_of_assets();
return $totals;
}
public function get_total_number_of_assets() {
global $wpdb;
return (int) $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(*) FROM $wpdb->posts
WHERE post_type = 'frontloading_stub'
AND post_parent = %d",
$this->post_id
)
);
}
public function get_frontloading_stub( $url ) {
global $wpdb;
$id = $wpdb->get_var(
$wpdb->prepare(
"SELECT p.ID FROM $wpdb->posts p
INNER JOIN $wpdb->postmeta pm ON p.ID = pm.post_id
WHERE p.post_type = 'frontloading_stub'
AND p.post_parent = %d
AND pm.meta_key = 'current_url'
AND pm.meta_value = %s
LIMIT 1",
$this->post_id,
$url
)
);
return get_post( $id );
}
/**
* Creates placeholder attachments for the assets to be downloaded in the
* frontloading stage.
*/
public function create_frontloading_stubs( $urls ) {
global $wpdb;
foreach ( $urls as $url => $_ ) {
/**
* Check if placeholder with this URL already exists
* There's a race condition here – another insert may happen
* between the check and the insert.
*
* @TODO: Explore solutions. A custom table with a UNIQUE constraint
* may or may not be an option, depending on the performance impact
* on 100GB+ VIP databases.
*/
$exists = $wpdb->get_var(
$wpdb->prepare(
"SELECT ID FROM $wpdb->posts
WHERE post_type = 'frontloading_stub'
AND post_parent = %d
AND guid = %s
LIMIT 1",
$this->post_id,
$url
)
);
if ( $exists ) {
continue;
}
$post_data = array(
'post_type' => 'frontloading_stub',
'post_parent' => $this->post_id,
'post_title' => basename( $url ),
'post_status' => self::FRONTLOAD_STATUS_AWAITING_DOWNLOAD,
'guid' => $url,
'meta_input' => array(
'original_url' => $url,
'current_url' => $url,
'attempts' => 0,
'last_error' => null,
'target_path' => '',
),
);
$insertion_result = wp_insert_post( $post_data );
if ( is_wp_error( $insertion_result ) ) {
throw new \Exception( 'Failed to insert frontloading placeholder' );
}
}
}
/**
* Sets the total number of entities to import for each type.
*
* @param array $totals The total number of entities for each type
*/
private $cached_totals = array();
public function bump_total_number_of_entities( $newly_indexed_entities ) {
foreach ( $newly_indexed_entities as $field => $count ) {
if ( ! in_array( $field, static::PROGRESS_ENTITIES, true ) ) {
_doing_it_wrong(
__METHOD__,
'Cannot set total number of entities for unknown entity type: ' . $field,
'1.0.0'
);
continue;
}
// Get current total from cache or database
if ( ! isset( $this->cached_totals[ $field ] ) ) {
$this->cached_totals[ $field ] = (int) get_post_meta( $this->post_id, 'total_' . $field, true );
}
// Add new count to total
$new_total = $this->cached_totals[ $field ] + $count;
// Update database and cache
update_post_meta( $this->post_id, 'total_' . $field, $new_total );
$this->cached_totals[ $field ] = $new_total;
}
}
/**
* Saves an array of [$url => ['received' => $downloaded_bytes, 'total' => $total_bytes | null]]
* of the currently fetched files. The list is ephemeral and changes as we stream the data. There
* will never be more than $concurrency_limit files in the list at any given time.
*/
public function bump_frontloading_progress( $frontloading_progress, $events = array() ) {
update_post_meta( $this->post_id, 'frontloading_progress', $frontloading_progress );
foreach ( $events as $event ) {
$url = $event->resource_id;
$placeholder = $this->get_frontloading_stub( $url );
if ( ! $placeholder ) {
_doing_it_wrong(
__METHOD__,
'Frontloading placeholder post not found for URL: ' . $url,
'1.0.0'
);
continue;
}
update_post_meta( $placeholder->ID, 'last_error', $event->error );
$attempts = get_post_meta( $placeholder->ID, 'attempts', true );
$new_attempts = $attempts;
$new_status = $placeholder->post_status;
switch ( $event->type ) {
case self::EVENT_SUCCESS:
$new_status = self::FRONTLOAD_STATUS_SUCCEEDED;
$new_attempts = $attempts + 1;
break;
case self::EVENT_ALREADY_EXISTS:
$new_status = self::FRONTLOAD_STATUS_SUCCEEDED;
break;
case self::EVENT_FAILURE:
$new_status = self::FRONTLOAD_STATUS_ERROR;
$new_attempts = $attempts + 1;
break;
}
if ( $new_attempts !== $attempts ) {
update_post_meta( $placeholder->ID, 'attempts', $new_attempts );
}
if ( $new_status !== $placeholder->post_status ) {
wp_update_post(
array(
'ID' => $placeholder->ID,
'post_status' => $new_status,
)
);
}
}
}
public function get_frontloading_progress() {
$meta = get_post_meta( $this->post_id, 'frontloading_progress', true );
return $meta ? $meta : array();
}
public function is_stage_completed( $stage ) {
$current_stage = $this->get_stage();
$stage_index = array_search( $stage, self::STAGES_IN_ORDER, true );
$current_stage_index = array_search( $current_stage, self::STAGES_IN_ORDER, true );
return $current_stage_index > $stage_index;
}
/**
* Gets the current import stage.
*
* @return string The current stage
*/
public function get_stage() {
if ( ! isset( $this->cached_stage ) ) {
$meta = get_post_meta( $this->post_id, 'current_stage', true );
$this->cached_stage = $meta ? $meta : self::STAGE_INITIAL;
}
return $this->cached_stage;
}
/**
* Updates the current import stage.
*
* @param string $stage The new stage
*/
public function set_stage( $stage ) {
if ( $stage === $this->get_stage() ) {
return;
}
if ( self::STAGE_FINISHED === $stage ) {
update_post_meta( $this->post_id, 'finished_at', time() );
}
update_post_meta( $this->post_id, 'current_stage', $stage );
$this->cached_stage = $stage;
}
public function get_started_at() {
return get_post_meta( $this->post_id, 'started_at', true );
}
public function get_finished_at() {
return get_post_meta( $this->post_id, 'finished_at', true );
}
public function is_finished() {
return ! empty( get_post_meta( $this->post_id, 'finished_at', true ) );
}
/**
* Gets the importer cursor for resuming imports.
*
* @return string|null The cursor data
*/
public function get_reentrancy_cursor() {
return get_post_meta( $this->post_id, 'importer_cursor', true );
}
/**
* Updates the importer cursor.
*
* @param string $cursor The new cursor data
*/
public function set_reentrancy_cursor( $cursor ) {
// WordPress, sadly, removes single slashes from the meta value and
// requires an addslashes() call to preserve them.
update_post_meta( $this->post_id, 'importer_cursor', addslashes( $cursor ) );
}
/**
* Save the original command arguments for session resumption.
*
* @param array $args The original command arguments
*/
public function set_original_arguments( array $args ) {
update_post_meta( $this->post_id, 'original_arguments', $args );
}
/**
* Get the original command arguments for session resumption.
*
* @return array|null The original arguments or null if not found
*/
public function get_original_arguments() {
$args = get_post_meta( $this->post_id, 'original_arguments', true );
return ( is_array( $args ) && ! empty( $args ) ) ? $args : null;
}
}
PK [1]| 0 CLI/Migrator/Platforms/Shopify/ShopifyClient.phpnu credentials = $credentials;
}
/**
* Makes a request to the Shopify REST API.
*
* @param string $path The API path (e.g., '/products/count.json').
* @param array $query_params Optional query parameters.
* @param string $method HTTP method (GET, POST, PUT, DELETE).
* @param array $body Request body for POST/PUT.
* @return object|\WP_Error Decoded JSON response object or WP_Error on failure.
*/
public function rest_request( string $path, array $query_params = array(), string $method = 'GET', array $body = array() ) {
$credentials = $this->get_credentials();
if ( is_wp_error( $credentials ) ) {
return $credentials;
}
$rest_endpoint = $this->build_rest_url( $credentials['domain'], $path, $query_params );
$request_args = $this->build_request_args( $credentials['access_token'], $method, $body );
$response = wp_remote_request( $rest_endpoint, $request_args );
return $this->process_response( $response, $path );
}
/**
* Makes a request to the Shopify GraphQL API.
*
* @param string $query The GraphQL query string.
* @param array $variables The variables for the query.
* @return object|\WP_Error Decoded JSON response data or WP_Error on failure.
*/
public function graphql_request( string $query, array $variables = array() ) {
$credentials = $this->get_credentials();
if ( is_wp_error( $credentials ) ) {
return $credentials;
}
$graphql_endpoint = $this->build_graphql_url( $credentials['domain'] );
$request_args = $this->build_graphql_request_args( $credentials['access_token'], $query, $variables );
$response = wp_remote_request( $graphql_endpoint, $request_args );
return $this->process_graphql_response( $response );
}
/**
* Get Shopify API credentials.
*
* @return array|\WP_Error Array with 'domain' and 'access_token' keys, or WP_Error on failure.
*/
private function get_credentials() {
if ( empty( $this->credentials['shop_url'] ) || empty( $this->credentials['access_token'] ) ) {
return new \WP_Error(
'api_error',
'Shopify API credentials (shop_url, access_token) are not configured. Please run: wp wc migrate setup'
);
}
// Map the stored credential keys to the expected format.
return array(
'domain' => $this->credentials['shop_url'],
'access_token' => $this->credentials['access_token'],
);
}
/**
* Build the REST API URL.
*
* @param string $domain The Shopify domain.
* @param string $path The API path.
* @param array $query_params Query parameters.
* @return string The complete API URL.
*/
private function build_rest_url( string $domain, string $path, array $query_params ): string {
// Ensure the domain has the protocol.
if ( ! preg_match( '~^https?://~i', $domain ) ) {
$domain = 'https://' . $domain;
}
$shop_url = untrailingslashit( $domain );
// Use the latest stable API version.
$api_version = '2025-04';
$rest_endpoint = "{$shop_url}/admin/api/{$api_version}{$path}";
if ( ! empty( $query_params ) ) {
$rest_endpoint = add_query_arg( $query_params, $rest_endpoint );
}
return $rest_endpoint;
}
/**
* Build the request arguments.
*
* @param string $access_token The Shopify access token.
* @param string $method HTTP method.
* @param array $body Request body.
* @return array Request arguments for wp_remote_request.
*/
private function build_request_args( string $access_token, string $method, array $body ): array {
$request_args = array(
'method' => $method,
'headers' => array(
'Content-Type' => 'application/json',
'X-Shopify-Access-Token' => $access_token,
),
'timeout' => 60,
);
if ( ! empty( $body ) && ( 'POST' === $method || 'PUT' === $method ) ) {
$request_args['body'] = wp_json_encode( $body );
}
return $request_args;
}
/**
* Process the API response.
*
* @param array|WP_Error $response The HTTP response.
* @param string $path The API path for error reporting.
* @return object|\WP_Error Decoded response or WP_Error.
*/
private function process_response( $response, string $path ) {
if ( is_wp_error( $response ) ) {
return new \WP_Error( 'api_error', 'REST request failed: ' . $response->get_error_message() );
}
$response_code = wp_remote_retrieve_response_code( $response );
$response_body = wp_remote_retrieve_body( $response );
if ( $response_code >= 300 ) {
$error_details = json_decode( $response_body );
$error_message = isset( $error_details->errors ) ? wp_json_encode( $error_details->errors ) : $response_body;
return new \WP_Error(
'api_error',
"REST request to {$path} failed with status code {$response_code}: " . $error_message
);
}
$data = json_decode( $response_body );
if ( json_last_error() !== JSON_ERROR_NONE ) {
return new \WP_Error( 'api_error', 'Failed to decode REST JSON response: ' . json_last_error_msg() );
}
return $data;
}
/**
* Build the GraphQL API URL.
*
* @param string $domain The Shopify domain.
* @return string The complete GraphQL API URL.
*/
private function build_graphql_url( string $domain ): string {
// Ensure the domain has the protocol.
if ( ! preg_match( '~^https?://~i', $domain ) ) {
$domain = 'https://' . $domain;
}
$shop_url = untrailingslashit( $domain );
// Use the same API version as REST.
$api_version = '2025-04';
return "{$shop_url}/admin/api/{$api_version}/graphql.json";
}
/**
* Build the request arguments for GraphQL requests.
*
* @param string $access_token The Shopify access token.
* @param string $query The GraphQL query.
* @param array $variables The GraphQL variables.
* @return array Request arguments for wp_remote_request.
*
* @phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
*/
private function build_graphql_request_args( string $access_token, string $query, array $variables ): array {
$request_body = compact( 'query', 'variables' );
return array(
'method' => 'POST',
'headers' => array(
'Content-Type' => 'application/json',
'X-Shopify-Access-Token' => $access_token,
),
'body' => wp_json_encode( $request_body ),
'timeout' => 60,
);
}
/**
* Process the GraphQL API response.
*
* @param array|\WP_Error $response The HTTP response.
* @return object|\WP_Error Decoded response data or WP_Error.
*/
private function process_graphql_response( $response ) {
if ( is_wp_error( $response ) ) {
return new \WP_Error( 'api_error', 'GraphQL request failed: ' . $response->get_error_message() );
}
$response_code = wp_remote_retrieve_response_code( $response );
$response_body = wp_remote_retrieve_body( $response );
if ( $response_code >= 300 ) {
$error_details = json_decode( $response_body );
$error_message = isset( $error_details->errors ) ? wp_json_encode( $error_details->errors ) : $response_body;
return new \WP_Error(
'api_error',
"GraphQL request failed with status code {$response_code}: " . $error_message
);
}
$data = json_decode( $response_body );
if ( json_last_error() !== JSON_ERROR_NONE ) {
return new \WP_Error( 'api_error', 'Failed to decode GraphQL JSON response: ' . json_last_error_msg() );
}
// Check for GraphQL-specific errors.
if ( ! empty( $data->errors ) ) {
return new \WP_Error( 'graphql_error', 'GraphQL API returned errors: ' . wp_json_encode( $data->errors ) );
}
if ( empty( $data->data ) ) {
return new \WP_Error( 'api_error', 'GraphQL response missing "data" field.' );
}
return $data->data;
}
}
PK [1]N[?m m 0 CLI/Migrator/Platforms/Shopify/ShopifyMapper.phpnu 'g',
'KILOGRAMS' => 'kg',
'POUNDS' => 'lb',
'OUNCES' => 'oz',
);
/**
* Weight conversion factors between units.
* Structure: [from_unit][to_unit] = factor
*
* @var array
*/
private const WEIGHT_CONVERSION_FACTORS = array(
'kg' => array(
'kg' => 1,
'g' => 1000,
'lb' => 2.20462,
'oz' => 35.274,
),
'g' => array(
'kg' => 0.001,
'g' => 1,
'lb' => 0.00220462,
'oz' => 0.035274,
),
'lb' => array(
'kg' => 0.453592,
'g' => 453.592,
'lb' => 1,
'oz' => 16,
),
'oz' => array(
'kg' => 0.0283495,
'g' => 28.3495,
'lb' => 0.0625,
'oz' => 1,
),
);
/**
* Fields to process during mapping.
*
* @var array
*/
private $fields_to_process = array();
/**
* Constructor.
*
* @param array $args Optional arguments including 'fields' array for selective processing.
*/
public function __construct( array $args = array() ) {
$this->fields_to_process = $args['fields'] ?? $this->get_default_product_fields();
}
/**
* Maps raw Shopify product data to a standardized array format.
*
* @param object $shopify_product The raw Shopify product node from GraphQL.
* @return array Standardized data array for WooCommerce_Product_Importer.
*/
public function map_product_data( object $shopify_product ): array {
$is_variable = $this->is_variable_product( $shopify_product );
$wc_data = $this->map_basic_product_fields( $shopify_product, $is_variable );
// Map simple product data (for non-variable products).
if ( ! $is_variable ) {
$simple_data = $this->map_simple_product_data( $shopify_product );
$wc_data = array_merge( $wc_data, $simple_data );
}
// Map product images.
$wc_data['images'] = $this->map_product_images( $shopify_product );
// Map metafields and SEO data.
$wc_data['metafields'] = $this->map_metafields( $shopify_product );
// Map variable product data (attributes and variations).
$variable_data = $this->map_variable_product_data( $shopify_product, $is_variable );
$wc_data = array_merge( $wc_data, $variable_data );
return $wc_data;
}
/**
* Checks if a product is a variable product.
*
* @param object $shopify_product The Shopify product data.
* @return bool True if the product is a variable product, false otherwise.
*/
private function is_variable_product( object $shopify_product ): bool {
return isset( $shopify_product->variants->edges ) && count( $shopify_product->variants->edges ) > 1;
}
/**
* Converts the Shopify product status into WooCommerce product status.
*
* @param object $shopify_product The Shopify product data.
* @return string The WooCommerce product status.
*/
private function get_woo_product_status( object $shopify_product ): string {
$woo_product_status = 'draft';
if ( 'ACTIVE' === $shopify_product->status ) {
$woo_product_status = 'publish';
}
return $woo_product_status;
}
/**
* Maps enhanced publication status fields from Shopify.
*
* @param object $shopify_product The Shopify product data.
* @return array Enhanced status data.
*/
private function map_enhanced_status( object $shopify_product ): array {
$status_data = array();
// Publication date.
if ( property_exists( $shopify_product, 'publishedAt' ) && $shopify_product->publishedAt ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$status_data['date_published_gmt'] = $shopify_product->publishedAt; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
// Available for sale flag.
if ( property_exists( $shopify_product, 'availableForSale' ) ) {
$status_data['available_for_sale'] = $shopify_product->availableForSale; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
return $status_data;
}
/**
* Maps product classification fields from Shopify.
*
* @param object $shopify_product The Shopify product data.
* @return array Product classification data.
*/
private function map_product_classification( object $shopify_product ): array {
$classification = array();
// Product type - check both camelCase and snake_case for compatibility.
$product_type = null;
if ( property_exists( $shopify_product, 'productType' ) && $shopify_product->productType ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$product_type = $shopify_product->productType; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
} elseif ( property_exists( $shopify_product, 'product_type' ) && $shopify_product->product_type ) {
$product_type = $shopify_product->product_type;
}
if ( $product_type ) {
$classification['product_type'] = array(
'name' => $product_type,
'slug' => sanitize_title( $product_type ),
);
}
// Standard category.
if ( property_exists( $shopify_product, 'category' ) && is_object( $shopify_product->category ) ) {
$classification['standard_category'] = array(
'name' => $shopify_product->category->name ?? '',
'slug' => sanitize_title( $shopify_product->category->name ?? '' ),
);
}
// Gift card detection - check both camelCase and snake_case for compatibility.
if ( property_exists( $shopify_product, 'isGiftCard' ) ) {
$classification['is_gift_card'] = $shopify_product->isGiftCard; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
} elseif ( property_exists( $shopify_product, 'is_gift_card' ) ) {
$classification['is_gift_card'] = $shopify_product->is_gift_card;
}
if ( property_exists( $shopify_product, 'requiresSellingPlan' ) ) {
$classification['requires_subscription'] = $shopify_product->requiresSellingPlan; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
} elseif ( property_exists( $shopify_product, 'requires_selling_plan' ) ) {
$classification['requires_subscription'] = $shopify_product->requires_selling_plan;
}
return $classification;
}
/**
* Maps SEO fields from Shopify product data.
*
* @param object $shopify_product The Shopify product data.
* @return array SEO metafields data.
*/
private function map_seo_fields( object $shopify_product ): array {
$seo_data = array();
if ( property_exists( $shopify_product, 'seo' ) && is_object( $shopify_product->seo ) ) {
if ( ! empty( $shopify_product->seo->title ) ) {
$seo_data['global_title_tag'] = $shopify_product->seo->title;
}
if ( ! empty( $shopify_product->seo->description ) ) {
$seo_data['global_description_tag'] = $shopify_product->seo->description;
}
}
return $seo_data;
}
/**
* Gets mapped WooCommerce product categories from Shopify collections.
*
* @param object $shopify_product The Shopify product data.
* @return array Mapped category data.
*/
private function get_mapped_categories( object $shopify_product ): array {
$categories = array();
if ( ! property_exists( $shopify_product, 'collections' ) || empty( $shopify_product->collections->edges ) ) {
return $categories;
}
foreach ( $shopify_product->collections->edges as $collection_edge ) {
$collection_node = $collection_edge->node;
$categories[] = array(
'name' => wc_clean( $collection_node->title ),
'slug' => sanitize_title( $collection_node->handle ),
);
}
return $categories;
}
/**
* Gets mapped WooCommerce product tags from Shopify tags.
*
* @param object $shopify_product The Shopify product data.
* @return array Mapped tag data.
*/
private function get_mapped_tags( object $shopify_product ): array {
$tags = array();
if ( empty( $shopify_product->tags ) ) {
return $tags;
}
foreach ( $shopify_product->tags as $tag ) {
$trimmed_tag = trim( $tag );
if ( ! empty( $trimmed_tag ) ) {
$tags[] = array(
'name' => wc_clean( $trimmed_tag ),
'slug' => sanitize_title( $trimmed_tag ),
);
}
}
return $tags;
}
/**
* Converts weight based on Shopify weight unit to store's weight unit.
*
* @param float|null $weight The weight value from Shopify.
* @param string|null $weight_unit The weight unit from Shopify.
* @return float|null The converted weight, or null if input is invalid/zero.
*/
private function get_converted_weight( $weight, $weight_unit ): ?float {
if ( null === $weight || null === $weight_unit || (float) $weight <= 0 ) {
return null;
}
$shopify_unit_key = self::WEIGHT_UNIT_MAP[ $weight_unit ] ?? null;
if ( ! $shopify_unit_key ) {
return (float) $weight;
}
$store_weight_unit = get_option( 'woocommerce_weight_unit' );
if ( 'lbs' === $store_weight_unit ) {
$store_weight_unit = 'lb';
}
if ( $shopify_unit_key === $store_weight_unit ) {
return (float) $weight;
}
// Use wc_get_weight for conversion if possible.
if ( function_exists( 'wc_get_weight' ) ) {
$converted = wc_get_weight( (float) $weight, $store_weight_unit, $shopify_unit_key );
return is_numeric( $converted ) ? (float) $converted : null;
}
// Fallback manual conversion using class constants.
if ( ! isset( self::WEIGHT_CONVERSION_FACTORS[ $shopify_unit_key ][ $store_weight_unit ] ) ) {
return (float) $weight;
}
return (float) $weight * self::WEIGHT_CONVERSION_FACTORS[ $shopify_unit_key ][ $store_weight_unit ];
}
/**
* Checks if a specific field should be processed based on constructor args.
*
* @param string $field_key The field key.
* @return bool True if the field should be processed.
*/
private function should_process( string $field_key ): bool {
if ( empty( $this->fields_to_process ) ) {
return true;
}
return in_array( $field_key, $this->fields_to_process, true );
}
/**
* Maps basic product fields from Shopify to WooCommerce format.
*
* @param object $shopify_product The Shopify product data.
* @param bool $is_variable Whether this is a variable product.
* @return array Basic product field mappings.
*/
private function map_basic_product_fields( object $shopify_product, bool $is_variable ): array {
$basic_data = array();
$basic_data['is_variable'] = $is_variable;
$basic_data['original_product_id'] = ! empty( $shopify_product->id ) ? basename( $shopify_product->id ) : null;
// Basic Product Fields.
$basic_data['name'] = wc_clean( $shopify_product->title );
$basic_data['slug'] = sanitize_title( $shopify_product->handle );
$basic_data['description'] = wp_kses_post( $shopify_product->descriptionHtml ?? '' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$basic_data['short_description'] = wp_kses_post( $shopify_product->descriptionPlainSummary ?? '' ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$basic_data['status'] = $this->get_woo_product_status( $shopify_product );
$basic_data['date_created_gmt'] = $shopify_product->createdAt; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
// Enhanced date handling.
if ( property_exists( $shopify_product, 'updatedAt' ) ) {
$basic_data['date_modified_gmt'] = $shopify_product->updatedAt; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
// Catalog Visibility & Original URL.
$basic_data['catalog_visibility'] = 'visible';
$basic_data['original_url'] = null;
if ( property_exists( $shopify_product, 'onlineStoreUrl' ) ) {
if ( null === $shopify_product->onlineStoreUrl ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$basic_data['catalog_visibility'] = 'hidden';
} else {
$basic_data['original_url'] = $shopify_product->onlineStoreUrl; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
}
$enhanced_status = $this->map_enhanced_status( $shopify_product );
$basic_data = array_merge( $basic_data, $enhanced_status );
// Taxonomies.
$basic_data['categories'] = $this->get_mapped_categories( $shopify_product );
$basic_data['tags'] = $this->get_mapped_tags( $shopify_product );
// Enhanced product classification.
$classification = $this->map_product_classification( $shopify_product );
$basic_data = array_merge( $basic_data, $classification );
// Brand (Vendor).
$brand_name = $shopify_product->vendor ?? null;
$basic_data['brand'] = $brand_name ? array(
'name' => wc_clean( $brand_name ),
'slug' => sanitize_title( $brand_name ),
) : null;
return $basic_data;
}
/**
* Maps simple product data (price, SKU, stock, weight) from Shopify variant.
*
* @param object $shopify_product The Shopify product data.
* @return array Simple product data mappings.
*/
private function map_simple_product_data( object $shopify_product ): array {
$simple_data = array();
if ( ! empty( $shopify_product->variants->edges ) ) {
$variant_node = $shopify_product->variants->edges[0]->node;
if ( $this->should_process( 'price' ) ) {
if ( $variant_node->compareAtPrice && $variant_node->compareAtPrice > $variant_node->price ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$simple_data['sale_price'] = $variant_node->price;
$simple_data['regular_price'] = $variant_node->compareAtPrice; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
} else {
$simple_data['sale_price'] = null;
$simple_data['regular_price'] = $variant_node->price;
}
}
if ( $this->should_process( 'sku' ) ) {
$simple_data['sku'] = wc_clean( $variant_node->sku );
}
if ( $this->should_process( 'stock' ) ) {
$manage_stock = property_exists( $variant_node, 'inventoryItem' ) && $variant_node->inventoryItem->tracked; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$simple_data['manage_stock'] = $manage_stock;
$stock_quantity = $variant_node->inventoryQuantity ?? 0; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$allow_oversell = $manage_stock && 'CONTINUE' === $variant_node->inventoryPolicy; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$simple_data['stock_status'] = ( $stock_quantity > 0 || $allow_oversell ) ? 'instock' : 'outofstock';
$simple_data['stock_quantity'] = $stock_quantity;
}
if ( $this->should_process( 'weight' ) ) {
$weight_data = null;
if ( property_exists( $variant_node, 'inventoryItem' ) && is_object( $variant_node->inventoryItem ) && // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
property_exists( $variant_node->inventoryItem, 'measurement' ) && is_object( $variant_node->inventoryItem->measurement ) && // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
property_exists( $variant_node->inventoryItem->measurement, 'weight' ) && is_object( $variant_node->inventoryItem->measurement->weight ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
) {
$weight_data = $variant_node->inventoryItem->measurement->weight; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
$weight = $weight_data ? $weight_data->value : null;
$weight_unit = $weight_data ? $weight_data->unit : null;
$simple_data['weight'] = $this->get_converted_weight( $weight, $weight_unit );
}
if ( property_exists( $variant_node, 'inventoryItem' ) && is_object( $variant_node->inventoryItem ) && // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
property_exists( $variant_node->inventoryItem, 'unitCost' ) && is_object( $variant_node->inventoryItem->unitCost ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
) {
$simple_data['cost_of_goods'] = $variant_node->inventoryItem->unitCost->amount; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
if ( property_exists( $variant_node, 'taxable' ) ) {
$simple_data['tax_status'] = $variant_node->taxable ? 'taxable' : 'none';
}
$simple_data['original_variant_id'] = ! empty( $variant_node->id ) ? basename( $variant_node->id ) : null;
} else {
$simple_data['sku'] = null;
$simple_data['regular_price'] = null;
$simple_data['sale_price'] = null;
$simple_data['stock_quantity'] = null;
$simple_data['manage_stock'] = false;
$simple_data['stock_status'] = 'instock';
$simple_data['weight'] = null;
if ( property_exists( $shopify_product, 'taxable' ) ) {
$simple_data['tax_status'] = $shopify_product->taxable ? 'taxable' : 'none';
}
$simple_data['original_variant_id'] = null;
}
return $simple_data;
}
/**
* Maps variable product data (attributes and variations) from Shopify.
*
* @param object $shopify_product The Shopify product data.
* @param bool $is_variable Whether this is a variable product.
* @return array Variable product data mappings.
*/
private function map_variable_product_data( object $shopify_product, bool $is_variable ): array {
$variable_data = array();
// Attributes (Variable Only).
$variable_data['attributes'] = array();
if ( $is_variable && property_exists( $shopify_product, 'options' ) && ! empty( $shopify_product->options ) ) {
foreach ( $shopify_product->options as $option ) {
$variable_data['attributes'][] = array(
'name' => wc_clean( $option->name ),
'options' => array_map( 'wc_clean', $option->values ),
'position' => $option->position,
'is_visible' => true,
'is_variation' => true,
);
}
}
// Variations (Variable Only).
$variable_data['variations'] = array();
if ( $is_variable && property_exists( $shopify_product, 'variants' ) && ! empty( $shopify_product->variants->edges ) ) {
foreach ( $shopify_product->variants->edges as $variant_edge ) {
$variant_node = $variant_edge->node;
$variation_data = array();
$variation_data['original_id'] = ! empty( $variant_node->id ) ? basename( $variant_node->id ) : null;
if ( $this->should_process( 'price' ) ) {
if ( $variant_node->compareAtPrice && (float) $variant_node->compareAtPrice > (float) $variant_node->price ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$variation_data['regular_price'] = $variant_node->compareAtPrice; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$variation_data['sale_price'] = $variant_node->price;
} else {
$variation_data['regular_price'] = $variant_node->price;
$variation_data['sale_price'] = null;
}
}
if ( $this->should_process( 'sku' ) ) {
$variation_data['sku'] = wc_clean( $variant_node->sku ?? '' );
}
if ( $this->should_process( 'stock' ) ) {
$manage_stock = property_exists( $variant_node, 'inventoryItem' ) && $variant_node->inventoryItem->tracked; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$variation_data['manage_stock'] = $manage_stock;
$stock_quantity = $variant_node->inventoryQuantity ?? 0; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$allow_oversell = $manage_stock && 'CONTINUE' === $variant_node->inventoryPolicy; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$variation_data['stock_status'] = ( $stock_quantity > 0 || $allow_oversell ) ? 'instock' : 'outofstock';
$variation_data['stock_quantity'] = $stock_quantity;
}
if ( $this->should_process( 'weight' ) ) {
$weight_data = null;
if ( property_exists( $variant_node, 'inventoryItem' ) && is_object( $variant_node->inventoryItem ) && // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
property_exists( $variant_node->inventoryItem, 'measurement' ) && is_object( $variant_node->inventoryItem->measurement ) && // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
property_exists( $variant_node->inventoryItem->measurement, 'weight' ) && is_object( $variant_node->inventoryItem->measurement->weight ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
) {
$weight_data = $variant_node->inventoryItem->measurement->weight; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
$weight = $weight_data ? $weight_data->value : null;
$weight_unit = $weight_data ? $weight_data->unit : null;
$variation_data['weight'] = $this->get_converted_weight( $weight, $weight_unit );
}
if ( property_exists( $variant_node, 'inventoryItem' ) && is_object( $variant_node->inventoryItem ) && // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
property_exists( $variant_node->inventoryItem, 'unitCost' ) && is_object( $variant_node->inventoryItem->unitCost ) // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
) {
$variation_data['cost_of_goods'] = $variant_node->inventoryItem->unitCost->amount; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
if ( property_exists( $variant_node, 'taxable' ) ) {
$variation_data['tax_status'] = $variant_node->taxable ? 'taxable' : 'none';
}
if ( $this->should_process( 'attributes' ) ) {
$variation_data['attributes'] = array();
if ( ! empty( $variant_node->selectedOptions ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
foreach ( $variant_node->selectedOptions as $selectedOption ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase,WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase -- GraphQL uses camelCase.
$variation_data['attributes'][ wc_clean( $selectedOption->name ) ] = wc_clean( $selectedOption->value ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase -- GraphQL uses camelCase.
}
}
}
if ( $this->should_process( 'images' ) ) {
$variation_data['image_original_id'] = null;
if ( ! empty( $variant_node->media->edges ) ) {
$variant_media_node = $variant_node->media->edges[0]->node ?? null;
if ( $variant_media_node && property_exists( $variant_media_node, 'image' ) && is_object( $variant_media_node->image ) && ! empty( $variant_media_node->id ) ) {
$variation_data['image_original_id'] = $variant_media_node->id;
}
}
}
// Menu Order / Position.
$variation_data['menu_order'] = $variant_node->position;
$variable_data['variations'][] = $variation_data;
}
}
return $variable_data;
}
/**
* Maps product images from Shopify media data.
*
* @param object $shopify_product The Shopify product data.
* @return array Product images data.
*/
private function map_product_images( object $shopify_product ): array {
$images_data = array();
$featured_media_id = null;
if ( ! empty( $shopify_product->featuredMedia ) && is_object( $shopify_product->featuredMedia ) && ! empty( $shopify_product->featuredMedia->id ) ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
$featured_media_id = $shopify_product->featuredMedia->id; // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL uses camelCase.
}
if ( ! empty( $shopify_product->media->edges ) ) {
foreach ( $shopify_product->media->edges as $media_edge ) {
$media_node = $media_edge->node;
if ( property_exists( $media_node, 'image' ) && is_object( $media_node->image ) && ! empty( $media_node->id ) && ! empty( $media_node->image->url ) ) {
$images_data[] = array(
'original_id' => $media_node->id,
'src' => $media_node->image->url,
'alt' => $media_node->image->altText ?? null,
'is_featured' => ( $media_node->id === $featured_media_id ),
);
}
}
}
return $images_data;
}
/**
* Maps metafields and SEO data from Shopify product.
*
* @param object $shopify_product The Shopify product data.
* @return array Metafields data.
*/
private function map_metafields( object $shopify_product ): array {
$metafields_data = array();
if ( property_exists( $shopify_product, 'metafields' ) && ! empty( $shopify_product->metafields->edges ) ) {
foreach ( $shopify_product->metafields->edges as $edge ) {
$field_node = $edge->node;
$key = sprintf( '%s_%s', $field_node->namespace, $field_node->key );
$metafields_data[ $key ] = $field_node->value;
}
}
// Enhanced SEO mapping.
$seo_data = $this->map_seo_fields( $shopify_product );
$metafields_data = array_merge( $metafields_data, $seo_data );
return $metafields_data;
}
/**
* Gets the default product fields to process if not specified.
*
* @return array Default fields.
*/
private function get_default_product_fields(): array {
return array(
'title',
'slug',
'description',
'short_description',
'status',
'date_created',
'catalog_visibility',
'category',
'tag',
'price',
'sku',
'stock',
'weight',
'brand',
'images',
'seo',
'attributes',
);
}
}
PK [1]=~: : 2 CLI/Migrator/Platforms/Shopify/ShopifyPlatform.phpnu 'Shopify',
'description' => 'Import products and data from Shopify stores',
'fetcher' => ShopifyFetcher::class,
'mapper' => ShopifyMapper::class,
'credentials' => array(
'shop_url' => 'Enter shop URL (e.g., mystore.myshopify.com):',
'access_token' => 'Enter access token:',
),
);
return $platforms;
}
}
PK [1]܉f$ $ 1 CLI/Migrator/Platforms/Shopify/ShopifyFetcher.phpnu credentials = $credentials;
$this->shopify_client = new ShopifyClient( $credentials );
}
/**
* Fetches a batch of products from the Shopify GraphQL API.
*
* @param array $args Arguments for fetching. Supported keys:
* - 'limit': Max number of items per batch (default: 50).
* - 'after_cursor': Cursor for pagination (optional).
* - 'query_filter': GraphQL query filter string (optional).
* - 'variants_per_product': Max variants per product (default: 100).
*
* @return array An array containing:
* 'items' => array Raw product edges fetched from Shopify.
* 'cursor' => ?string The cursor for the next page, or null if no more pages.
* 'has_next_page' => bool Indicates if there are more pages to fetch.
*/
public function fetch_batch( array $args ): array {
$variables = $this->build_graphql_variables( $args );
$response_data = $this->shopify_client->graphql_request( self::SHOPIFY_PRODUCT_QUERY, $variables );
if ( is_wp_error( $response_data ) ) {
\WP_CLI::warning( 'Failed to fetch products via GraphQL: ' . $response_data->get_error_message() );
return array(
'items' => array(),
'cursor' => null,
'has_next_page' => false,
);
}
if ( ! isset( $response_data->products->edges ) ) {
\WP_CLI::warning( 'Invalid GraphQL response structure - missing products.edges field.' );
return array(
'items' => array(),
'cursor' => null,
'has_next_page' => false,
);
}
$items = $response_data->products->edges;
$page_info = $response_data->products->pageInfo ?? null;
$last_cursor = null;
if ( ! empty( $items ) ) {
$last_edge = end( $items );
$last_cursor = $last_edge->cursor ?? null;
}
return array(
'items' => $items,
'cursor' => $last_cursor,
// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase -- GraphQL response property
'has_next_page' => $page_info ? $page_info->hasNextPage : false,
);
}
/**
* Build GraphQL variables from fetch arguments.
*
* @param array $args The fetch arguments.
* @return array The GraphQL variables.
*/
private function build_graphql_variables( array $args ): array {
$variables = array(
'first' => $args['limit'] ?? 50,
'after' => $args['after_cursor'] ?? null,
'query' => $this->build_graphql_query_string( $args ),
'variantsFirst' => $args['variants_per_product'] ?? 100,
);
// Remove null values to avoid GraphQL issues.
return array_filter(
$variables,
function ( $value ) {
return null !== $value && '' !== $value;
}
);
}
/**
* Build GraphQL query string from filter arguments.
*
* @param array $args Filter arguments.
* @return string GraphQL query string.
*/
private function build_graphql_query_string( array $args ): string {
$query_parts = array();
if ( isset( $args['status'] ) ) {
$query_parts[] = 'status:' . strtoupper( $args['status'] );
}
if ( isset( $args['product_type'] ) ) {
$query_parts[] = 'product_type:"' . $args['product_type'] . '"';
}
if ( isset( $args['vendor'] ) ) {
$query_parts[] = 'vendor:"' . $args['vendor'] . '"';
}
if ( isset( $args['handle'] ) ) {
$query_parts[] = 'handle:' . $args['handle'];
}
if ( isset( $args['created_after'] ) ) {
$query_parts[] = 'created_at:>=' . $args['created_after'];
}
if ( isset( $args['created_before'] ) ) {
$query_parts[] = 'created_at:<=' . $args['created_before'];
}
if ( isset( $args['ids'] ) ) {
$ids = is_array( $args['ids'] ) ? $args['ids'] : explode( ',', $args['ids'] );
$ids = array_filter( array_map( 'trim', $ids ) );
if ( ! empty( $ids ) ) {
$formatted_ids = array_map(
function ( $id ) {
return 'gid://shopify/Product/' . $id;
},
$ids
);
$query_parts[] = 'id:(' . implode( ' OR ', $formatted_ids ) . ')';
}
}
return implode( ' AND ', $query_parts );
}
/**
* Fetches the total count of products from the Shopify REST API.
*
* @param array $args Arguments for filtering the count (e.g., status, date range).
*
* @return int The total count, or 0 on failure.
*/
public function fetch_total_count( array $args ): int {
// Handle special case: if specific IDs are provided, count them directly.
if ( isset( $args['ids'] ) ) {
\WP_CLI::debug( 'Calculating total count based on provided product IDs.' );
$ids = is_array( $args['ids'] ) ? $args['ids'] : explode( ',', $args['ids'] );
return count( array_filter( $ids ) );
}
$rest_api_path = '/products/count.json';
$query_params = $this->build_count_query_params( $args );
$response = $this->shopify_client->rest_request( $rest_api_path, $query_params );
if ( is_wp_error( $response ) ) {
\WP_CLI::warning( 'Could not fetch total product count from Shopify REST API: ' . $response->get_error_message() );
return 0;
}
if ( ! isset( $response->count ) ) {
\WP_CLI::warning( 'Unexpected response format from Shopify count API - missing count field.' );
return 0;
}
return (int) $response->count;
}
/**
* Build query parameters for the count API request.
*
* @param array $args Filter arguments.
* @return array Query parameters for the REST API.
*/
private function build_count_query_params( array $args ): array {
$query_params = array();
// Map standard filter args to Shopify REST count query params.
if ( isset( $args['status'] ) ) {
$query_params['status'] = strtolower( $args['status'] ); // REST uses lowercase.
}
if ( isset( $args['created_at_min'] ) ) {
$query_params['created_at_min'] = $args['created_at_min'];
}
if ( isset( $args['created_at_max'] ) ) {
$query_params['created_at_max'] = $args['created_at_max'];
}
if ( isset( $args['updated_at_min'] ) ) {
$query_params['updated_at_min'] = $args['updated_at_min'];
}
if ( isset( $args['updated_at_max'] ) ) {
$query_params['updated_at_max'] = $args['updated_at_max'];
}
if ( isset( $args['vendor'] ) ) {
$query_params['vendor'] = $args['vendor'];
}
if ( isset( $args['product_type'] ) ) {
$query_params['product_type'] = $args['product_type'];
}
return $query_params;
}
}
PK [1]M & CLI/Migrator/Commands/ResetCommand.phpnu credential_manager = $credential_manager;
$this->platform_registry = $platform_registry;
}
/**
* Resets (deletes) the credentials for a given platform.
*
* ## OPTIONS
*
* [--platform=]
* : The platform to reset credentials for. Defaults to 'shopify'.
*
* ## EXAMPLES
*
* wp wc migrate reset
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function __invoke( array $args, array $assoc_args ) {
// Resolve and validate the platform.
$platform = $this->platform_registry->resolve_platform( $assoc_args );
$platform_display_name = $this->platform_registry->get_platform_display_name( $platform );
if ( ! $this->credential_manager->has_credentials( $platform ) ) {
WP_CLI::warning( "No credentials found for '{$platform_display_name}' to reset." );
return;
}
$this->credential_manager->delete_credentials( $platform );
WP_CLI::success( "Credentials for the '{$platform_display_name}' platform have been cleared." );
}
}
PK [1]Vi_ ) CLI/Migrator/Commands/ProductsCommand.phpnu credential_manager = $credential_manager;
$this->platform_registry = $platform_registry;
$this->products_controller = $products_controller;
}
/**
* The main execution logic for the command.
*
* [--platform=]
* : The platform to migrate products from.
* ---
* default: shopify
* ---
*
* [--count]
* : Only fetch and display the total product count.
*
* [--limit=]
* : Maximum number of products to migrate.
*
* [--status=]
* : Filter products by status (active, archived, draft).
*
* [--product-type=]
* : Filter products by type (for Shopify: any product type name, or 'single'/'variable' for WooCommerce equivalents).
*
* [--vendor=]
* : Filter products by vendor name.
*
* [--ids=]
* : Comma-separated list of product IDs to migrate.
*
* [--batch-size=]
* : Number of products to process per batch (default: 20, max: 250).
*
* [--fields=]
* : Comma-separated list of fields to migrate.
*
* [--exclude-fields=]
* : Comma-separated list of fields to exclude from migration.
*
* [--resume]
* : Resume from previous migration session without prompting.
*
* [--skip-existing]
* : Skip products that already exist in WooCommerce.
*
* [--dry-run]
* : Perform a dry run without creating products.
*
* [--verbose]
* : Show detailed progress information including warnings and errors.
*
* [--assign-default-category]
* : Assign WooCommerce default category to products that have no categories.
*
* ## EXAMPLES
*
* wp wc migrate products --count
* wp wc migrate products --count --status=active
* wp wc migrate products --count --product-type="T-Shirt"
* wp wc migrate products --count --vendor="My Brand"
* wp wc migrate products --limit=100 --batch-size=25
* wp wc migrate products --product-type="single" --status=active --limit=50
* wp wc migrate products --ids="123,456,789"
* wp wc migrate products --fields=name,price,sku --resume
* wp wc migrate products --verbose --limit=50
* wp wc migrate products --assign-default-category --limit=100
*
* @param array $args The positional arguments.
* @param array $assoc_args The associative arguments.
*
* @return void
*/
public function __invoke( array $args, array $assoc_args ): void {
// Resolve and validate the platform.
$platform = $this->platform_registry->resolve_platform( $assoc_args );
$platform_display_name = $this->platform_registry->get_platform_display_name( $platform );
if ( ! $this->credential_manager->has_credentials( $platform ) ) {
WP_CLI::log( "Credentials for '{$platform_display_name}' not found. Let's set them up." );
// Get platform-specific credential fields and set them up.
$required_fields = $this->platform_registry->get_platform_credential_fields( $platform );
if ( empty( $required_fields ) ) {
WP_CLI::error( "The platform '{$platform_display_name}' does not have configured credential fields." );
return;
}
$this->credential_manager->setup_credentials( $platform, $required_fields );
WP_CLI::success( 'Credentials saved successfully. Please run the command again to begin the migration.' );
return;
}
// Handle count request if specified.
if ( isset( $assoc_args['count'] ) ) {
$this->handle_count_request( $platform, $platform_display_name, $assoc_args );
return;
}
// Delegate actual migration logic to ProductsController with resolved platform.
$this->products_controller->migrate_products( $assoc_args, $platform );
}
/**
* Handle the count request.
*
* @param string $platform The platform name.
* @param string $platform_display_name The platform display name.
* @param array $assoc_args The associative arguments.
*/
private function handle_count_request( string $platform, string $platform_display_name, array $assoc_args ): void {
WP_CLI::log( "Fetching product count from {$platform_display_name}..." );
$fetcher = $this->platform_registry->get_fetcher( $platform );
if ( ! $fetcher ) {
WP_CLI::error( "Could not get fetcher for platform '{$platform_display_name}'" );
return;
}
// Build filter arguments.
$filter_args = array();
if ( isset( $assoc_args['status'] ) ) {
$filter_args['status'] = $assoc_args['status'];
}
if ( isset( $assoc_args['product-type'] ) ) {
$filter_args['product_type'] = $assoc_args['product-type'];
}
if ( isset( $assoc_args['vendor'] ) ) {
$filter_args['vendor'] = $assoc_args['vendor'];
}
if ( isset( $assoc_args['ids'] ) ) {
$filter_args['ids'] = $assoc_args['ids'];
}
$count = $fetcher->fetch_total_count( $filter_args );
if ( 0 === $count ) {
WP_CLI::log( 'No products found or unable to fetch count.' );
} else {
$filters = array();
if ( isset( $assoc_args['status'] ) ) {
$filters[] = "status '{$assoc_args['status']}'";
}
if ( isset( $assoc_args['product-type'] ) ) {
$filters[] = "type '{$assoc_args['product-type']}'";
}
if ( isset( $assoc_args['vendor'] ) ) {
$filters[] = "vendor '{$assoc_args['vendor']}'";
}
if ( isset( $assoc_args['ids'] ) ) {
$filters[] = "IDs '{$assoc_args['ids']}'";
}
$filter_description = empty( $filters ) ? '' : ' with ' . implode( ', ', $filters );
WP_CLI::success( "Found {$count} products{$filter_description} on {$platform_display_name}." );
}
}
}
PK [1] % CLI/Migrator/Commands/ListCommand.phpnu platform_registry = $platform_registry;
}
/**
* Lists all registered migration platforms.
*
* ## EXAMPLES
*
* $ wp wc migrate list
*
* @param array $args The positional arguments (unused).
* @param array $assoc_args The associative arguments (unused).
*
* @return void
*/
public function __invoke( array $args, array $assoc_args ): void {
// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
unset( $args, $assoc_args );
$platforms = $this->platform_registry->get_platforms();
if ( empty( $platforms ) ) {
WP_CLI::line( 'No migration platforms are registered.' );
return;
}
$formatted_items = array();
$platform_count = count( $platforms );
$current_index = 0;
foreach ( $platforms as $id => $details ) {
$formatted_items[] = array(
'id' => $id,
'name' => $details['name'] ?? '',
'fetcher' => $details['fetcher'] ?? '',
'mapper' => $details['mapper'] ?? '',
);
// Add separator row between platforms (but not after the last one).
++$current_index;
if ( $current_index < $platform_count ) {
$formatted_items[] = array(
'id' => str_repeat( '-', 20 ),
'name' => str_repeat( '-', 25 ),
'fetcher' => str_repeat( '-', 30 ),
'mapper' => str_repeat( '-', 30 ),
);
}
}
WP_CLI\Utils\format_items(
'table',
$formatted_items,
array( 'id', 'name', 'fetcher', 'mapper' )
);
}
}
PK [1]q
1 1 & CLI/Migrator/Commands/SetupCommand.phpnu credential_manager = $credential_manager;
$this->platform_registry = $platform_registry;
}
/**
* Sets up the credentials for a given platform.
*
* ## OPTIONS
*
* [--platform=]
* : The platform to set up credentials for. Defaults to 'shopify'.
*
* ## EXAMPLES
*
* wp wc migrate setup
*
* @param array $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function __invoke( array $args, array $assoc_args ) {
// Resolve and validate the platform.
$platform = $this->platform_registry->resolve_platform( $assoc_args );
$platform_display_name = $this->platform_registry->get_platform_display_name( $platform );
// Get platform-specific credential fields and set them up.
$required_fields = $this->platform_registry->get_platform_credential_fields( $platform );
if ( empty( $required_fields ) ) {
WP_CLI::error( "The platform '{$platform_display_name}' does not have configured credential fields." );
}
$this->credential_manager->setup_credentials( $platform, $required_fields );
WP_CLI::success( 'Credentials saved successfully.' );
}
}
PK [1]f{ WCCom/ConnectionHelper.phpnu get( FeaturesController::class );
// If fulfillments feature is not enabled, do not add the DB tables, and don't register the controller.
if ( ! $features_controller->feature_is_enabled( 'fulfillments' ) ) {
return;
}
// Create the database tables if they do not exist.
$this->maybe_create_db_tables();
// Register the classes that this controller provides.
foreach ( $this->provides as $class ) {
$class = $container->get( $class );
if ( method_exists( $class, 'register' ) ) {
$class->register();
}
}
}
/**
* Create the database tables if they do not exist.
*
* @return void
*/
private function maybe_create_db_tables(): void {
global $wpdb;
if ( get_option( 'woocommerce_fulfillments_db_tables_created', false ) ) {
// The tables already exist, no need to create them again.
return;
}
// Drop the tables if they exist, to ensure a clean slate.
// If one table exists and the other does not, it will be an issue.
$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}wc_order_fulfillments" );
$wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}wc_order_fulfillment_meta" );
// Bulk delete order fulfillment status meta from legacy and HPOS order tables.
$this->bulk_delete_order_fulfillment_status_meta();
$collate = '';
$container = wc_get_container();
$database_util = $container->get( DatabaseUtil::class );
$max_index_length = $database_util->get_max_index_length();
if ( $wpdb->has_cap( 'collation' ) ) {
$collate = $wpdb->get_charset_collate();
}
$schema = "CREATE TABLE {$wpdb->prefix}wc_order_fulfillments (
fulfillment_id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
entity_type varchar(255) NOT NULL,
entity_id bigint(20) unsigned NOT NULL,
status varchar(255) NOT NULL,
is_fulfilled tinyint(1) NOT NULL DEFAULT 0,
date_updated datetime NOT NULL,
date_deleted datetime NULL,
PRIMARY KEY (fulfillment_id),
KEY entity_type_id (entity_type({$max_index_length}), entity_id)
) $collate;
CREATE TABLE {$wpdb->prefix}wc_order_fulfillment_meta (
meta_id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
fulfillment_id bigint(20) unsigned NOT NULL,
meta_key varchar(255) NULL,
meta_value longtext NULL,
date_updated datetime NOT NULL,
date_deleted datetime NULL,
PRIMARY KEY (meta_id),
KEY meta_key (meta_key({$max_index_length})),
KEY fulfillment_id (fulfillment_id)
) $collate;";
$database_util->dbdelta( $schema );
// Update the option to indicate that the tables have been created.
update_option( 'woocommerce_fulfillments_db_tables_created', true );
}
/**
* Bulk delete fulfillment status meta for specific order IDs, or all orders if no order ID specified.
*
* This method deletes the fulfillment status meta for the specified order IDs from both the legacy postmeta table
* and the HPOS meta table.
*
* @param array $order_ids Array of order IDs to delete fulfillment status meta for.
*/
private function bulk_delete_order_fulfillment_status_meta( $order_ids = array() ): void {
$this->delete_legacy_order_fulfillment_meta( $order_ids );
$this->delete_hpos_order_fulfillment_meta( $order_ids );
}
/**
* Delete fulfillment status meta from legacy postmeta table.
*
* @param array $order_ids Array of order IDs to delete fulfillment status meta for.
*/
private function delete_legacy_order_fulfillment_meta( $order_ids = array() ) {
global $wpdb;
if ( ! empty( $order_ids ) ) {
$order_params = array_merge( array( '_fulfillment_status' ), $order_ids );
$wpdb->query(
$wpdb->prepare(
"DELETE pm FROM {$wpdb->postmeta} pm
INNER JOIN {$wpdb->posts} p ON pm.post_id = p.ID
WHERE p.post_type = 'shop_order'
AND pm.meta_key = %s
AND pm.post_id IN (" . implode( ',', array_fill( 0, count( $order_ids ), '%d' ) ) . ')',
...$order_params
)
);
} else {
$wpdb->query(
$wpdb->prepare(
"DELETE pm FROM {$wpdb->postmeta} pm
INNER JOIN {$wpdb->posts} p ON pm.post_id = p.ID
WHERE p.post_type = 'shop_order'
AND pm.meta_key = %s",
'_fulfillment_status'
)
);
}
}
/**
* Delete fulfillment status meta from HPOS meta table.
*
* @param array $order_ids Array of order IDs to delete fulfillment status meta for.
*/
private function delete_hpos_order_fulfillment_meta( $order_ids = array() ): void {
global $wpdb;
// Check if HPOS meta table exists.
$table_name = $wpdb->prefix . 'wc_orders_meta';
if ( $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $table_name ) ) !== $table_name ) {
return;
}
if ( ! empty( $order_ids ) ) {
$order_params = array_merge( array( '_fulfillment_status' ), $order_ids );
$wpdb->query(
$wpdb->prepare(
"DELETE FROM {$wpdb->prefix}wc_orders_meta
WHERE meta_key = %s
AND order_id IN (" . implode( ',', array_fill( 0, count( $order_ids ), '%d' ) ) . ')',
...$order_params
)
);
} else {
$wpdb->query(
$wpdb->prepare(
"DELETE FROM {$wpdb->prefix}wc_orders_meta
WHERE meta_key = %s",
'_fulfillment_status'
)
);
}
}
}
PK [1]O2= = $ Fulfillments/FulfillmentsManager.phpnu init_fulfillment_status_hooks();
$this->init_refund_hooks();
}
/**
* Hook fulfillment status events.
*
* This method hooks into the fulfillment status events to update the order fulfillment status
* when a fulfillment is created, updated, or deleted.
*/
private function init_fulfillment_status_hooks() {
// Update order fulfillment status when a fulfillment is created, updated, or deleted.
add_action( 'woocommerce_fulfillment_after_create', array( $this, 'update_order_fulfillment_status_on_fulfillment_update' ), 10, 1 );
add_action( 'woocommerce_fulfillment_after_update', array( $this, 'update_order_fulfillment_status_on_fulfillment_update' ), 10, 1 );
add_action( 'woocommerce_fulfillment_after_delete', array( $this, 'update_order_fulfillment_status_on_fulfillment_update' ), 10, 1 );
}
/**
* Initialize refund-related hooks.
*
* This method initializes the hooks related to refunds, such as updating fulfillments after a refund is created
*/
private function init_refund_hooks() {
add_action( 'woocommerce_refund_created', array( $this, 'update_fulfillments_after_refund' ), 10, 1 );
add_action( 'woocommerce_delete_order_refund', array( $this, 'update_fulfillment_status_after_refund_deleted' ), 10, 1 );
}
/**
* Translate fulfillment meta keys.
*
* @param string $meta_key The meta key to translate.
* @return string Translated meta key.
*/
public function translate_fulfillment_meta_key( $meta_key ) {
/**
* Filter to translate fulfillment meta keys.
*
* This filter allows us to translate fulfillment meta keys
* to make them more user-friendly in the admin interface and emails.
*
* @since 10.1.0
*/
$meta_key_translations = apply_filters(
'woocommerce_fulfillment_meta_key_translations',
array(
'fulfillment_status' => __( 'Fulfillment Status', 'woocommerce' ),
'shipment_tracking' => __( 'Shipment Tracking', 'woocommerce' ),
'shipment_provider' => __( 'Shipment Provider', 'woocommerce' ),
)
);
return isset( $meta_key_translations[ $meta_key ] ) ? $meta_key_translations[ $meta_key ] : $meta_key;
}
/**
* Get initial shipping providers.
*
* This method provides the initial shipping providers that feeds the `woocommerce_fulfillment_shipping_providers` filter,
* which is used to populate the list of available shipping providers on the fulfillment UI.
*
* @param array $shipping_providers The current list of shipping providers.
*
* @return array The modified list of shipping providers.
*/
public function get_initial_shipping_providers( $shipping_providers ) {
if ( ! is_array( $shipping_providers ) ) {
$shipping_providers = array();
}
$shipping_providers = array_merge(
$shipping_providers,
include __DIR__ . '/ShippingProviders.php'
);
ksort( $shipping_providers );
return $shipping_providers;
}
/**
* Update order fulfillment status after a fulfillment is created, updated, or deleted.
*
* @param Fulfillment $data The fulfillment data.
*/
public function update_order_fulfillment_status_on_fulfillment_update( Fulfillment $data ) {
if ( ! $data instanceof Fulfillment ) {
return;
}
$order = $data->get_order();
if ( ! $order instanceof \WC_Order ) {
return;
}
/**
* Get the FulfillmentsDataStore instance.
*
* @var FulfillmentsDataStore $fulfillments_data_store
*/
$fulfillments_data_store = wc_get_container()->get( FulfillmentsDataStore::class );
// Read all fulfillments for the order.
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order->get_id() );
$this->update_fulfillment_status( $order, $fulfillments );
}
/**
* Update fulfillment status after a refund is deleted.
*
* This method updates the fulfillment status after a refund is deleted to ensure that the fulfillment status
* and items are correctly adjusted based on the refund deletion.
*
* @param int $refund_id The ID of the refund being deleted.
*
* @return void
*/
public function update_fulfillment_status_after_refund_deleted( int $refund_id ): void {
$refund = wc_get_order( $refund_id );
if ( ! $refund instanceof \WC_Order ) {
return; // If the refund is not a valid order, do nothing.
}
$order_id = $refund->get_parent_id();
if ( ! $order_id ) {
return; // If the refund does not have a parent order, do nothing.
}
$order = wc_get_order( $order_id );
if ( ! $order instanceof \WC_Order ) {
return; // If the order is not valid, do nothing.
}
$fulfillments_data_store = wc_get_container()->get( FulfillmentsDataStore::class );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order_id );
$this->update_fulfillment_status( $order, $fulfillments );
}
/**
* Update fulfillments after a refund is created.
*
* @param int $refund_id The ID of the refund created.
*
* @return void
*/
public function update_fulfillments_after_refund( int $refund_id ): void {
// Get the order object.
$refund = $refund_id ? wc_get_order( $refund_id ) : null;
if ( ! $refund instanceof WC_Order_Refund ) {
return; // If the order is not valid, do nothing.
}
$order_id = $refund->get_parent_id();
if ( ! $order_id ) {
return; // If the refund does not have a parent order, do nothing.
}
$order = wc_get_order( $order_id );
if ( ! $order instanceof \WC_Order ) {
return; // If the order is not valid, do nothing.
}
// If there are no refunded items, we can skip the fulfillment update.
$items_refunded = FulfillmentUtils::get_refunded_items( $order );
if ( empty( $items_refunded ) ) {
return; // No items were refunded, so no need to update fulfillments.
}
// Get the fulfillments data store and read all fulfillments for the order.
$fulfillments_data_store = wc_get_container()->get( FulfillmentsDataStore::class );
$fulfillments = $fulfillments_data_store->read_fulfillments( \WC_Order::class, (string) $order_id );
if ( empty( $fulfillments ) ) {
return; // No fulfillments found for the order.
}
// Get all refunded items from the order.
$pending_items_without_refunds = FulfillmentUtils::get_pending_items( $order, $fulfillments, false );
$pending_items_without_refunds = array_map(
function ( $item ) {
return array(
'item_id' => $item['item_id'],
'qty' => $item['qty'],
);
},
$pending_items_without_refunds
);
// Check if the refunded items can be removed from pending items.
foreach ( $items_refunded as $item_id => &$refunded_qty ) {
$pending_item_record = array_filter(
$pending_items_without_refunds,
function ( $item ) use ( $item_id ) {
return isset( $item['item_id'] ) && $item['item_id'] === $item_id;
}
);
if ( ! empty( $pending_item_record ) ) {
$pending_item_record = reset( $pending_item_record );
if ( isset( $pending_item_record['qty'] ) && $pending_item_record['qty'] > 0 ) {
// If the pending item quantity is greater than the refunded quantity, reduce it.
$refunded_qty -= $pending_item_record['qty'];
}
}
}
// If all refunded items can be removed from pending items, we can skip the fulfillment update.
$items_need_removal_from_fulfillments = array_filter(
$items_refunded,
function ( $actual_qty ) {
return $actual_qty > 0;
}
);
if ( empty( $items_need_removal_from_fulfillments ) ) {
return;
}
// Now we need to adjust the fulfillments based on the refunded items.
// Loop through each fulfillment and adjust the items based on the refunded quantities.
// We will remove items from fulfillments if they are fully refunded, or reduce their quantity if partially refunded.
// If a fulfillment has no items left after adjustment, we will delete it.
// If a fulfillment has items left, we will update the fulfillment with the new items.
foreach ( $fulfillments as $fulfillment ) {
if ( ! $fulfillment instanceof Fulfillment ) {
continue; // Skip if the fulfillment is not an instance of Fulfillment.
}
if ( $fulfillment->get_is_fulfilled() ) {
continue; // Skip if the fulfillment is already fulfilled. We don't remove items from fulfilled fulfillments.
}
// Get the items from the fulfillment.
$items = $fulfillment->get_items();
if ( empty( $items ) ) {
continue; // Skip if there are no items in the fulfillment.
}
// Adjust the items based on the refund.
$new_items = array();
foreach ( $items as $item ) {
if ( isset( $item['qty'] ) && isset( $item['item_id'] ) && isset( $items_need_removal_from_fulfillments[ $item['item_id'] ] ) ) {
if ( $items_need_removal_from_fulfillments[ $item['item_id'] ] <= $item['qty'] ) {
// If the refunded quantity is less than or equal to the item quantity, reduce the item quantity.
$item['qty'] -= $items_need_removal_from_fulfillments[ $item['item_id'] ];
$items_need_removal_from_fulfillments[ $item['item_id'] ] = 0; // Set refunded quantity to zero after adjustment.
} else {
// If the refunded quantity is greater than the item quantity, set the item quantity to zero.
$item['qty'] = 0;
$items_need_removal_from_fulfillments[ $item['item_id'] ] -= $item['qty']; // Reduce the refunded quantity.
}
$new_items[] = $item; // Add the adjusted item to the new items array.
} else {
$new_items[] = $item; // If the item is not in the refunded items, keep it as is.
}
}
$new_items = array_filter(
$new_items,
function ( $item ) {
return isset( $item['qty'] ) && $item['qty'] > 0; // Only keep items with a positive quantity.
}
);
if ( empty( $new_items ) ) {
// If no items remain after adjustment, delete the fulfillment.
$fulfillment->delete();
} else {
// Update the fulfillment items with the new items.
$fulfillment->set_items( $new_items );
$fulfillment->save();
}
}
$this->update_fulfillment_status( $order, $fulfillments );
}
/**
* Update the fulfillment status for the order.
*
* @param \WC_Order $order The order object.
* @param array $fulfillments The fulfillments data store.
*
* This method updates the fulfillment status for the order based on the fulfillments data store.
*/
private function update_fulfillment_status( $order, $fulfillments = array() ) {
$last_status = FulfillmentUtils::calculate_order_fulfillment_status( $order, $fulfillments );
if ( 'no_fulfillments' === $last_status ) {
$order->delete_meta_data( '_fulfillment_status' );
} else {
// Update the fulfillment status meta data.
$order->update_meta_data( '_fulfillment_status', $last_status );
}
$order->save();
}
/**
* Try to parse the tracking number with additional parameters.
*
* @param string $tracking_number The tracking number.
* @param string $shipping_from The country code from which the shipment is sent.
* @param string $shipping_to The country code to which the shipment is sent.
*
* @return array An array containing the provider as key, and the parsing results.
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): array {
// Validate the tracking number format and length.
if ( ! is_string( $tracking_number ) || empty( $tracking_number ) || strlen( $tracking_number ) > 50 ) {
$tracking_number = is_string( $tracking_number ) && ! empty( $tracking_number ) ? substr( $tracking_number, 0, 50 ) : '';
return array(
'tracking_number' => $tracking_number,
'shipping_provider' => '',
'tracking_url' => '',
);
}
// Normalize the tracking number to uppercase.
$tracking_number = strtoupper( $tracking_number );
$tracking_number = preg_replace( '/[^A-Z0-9]/', '', $tracking_number ); // Remove non-alphanumeric characters.
$shipping_providers = FulfillmentUtils::get_shipping_providers();
$results = array();
foreach ( $shipping_providers as $provider ) {
if ( class_exists( $provider ) && is_subclass_of( $provider, AbstractShippingProvider::class ) ) {
try {
/**
* Instantiate the shipping provider class.
*
* @var AbstractShippingProvider $provider_instance
*/
$provider_instance = wc_get_container()->get( $provider );
} catch ( \Throwable $e ) {
$logger = wc_get_logger();
$logger->error(
sprintf(
'Error instantiating shipping provider class %s: %s',
$provider,
$e->getMessage()
),
array( 'source' => 'woocommerce-fulfillments' )
);
continue; // Skip if the provider class cannot be instantiated.
}
} else {
continue; // Skip if the provider class does not exist or is not a valid shipping provider.
}
$parsing_result = $provider_instance->try_parse_tracking_number( $tracking_number, $shipping_from, $shipping_to );
if ( ! is_null( $parsing_result ) ) {
$results[ $provider_instance->get_key() ] = $parsing_result;
}
}
if ( 1 === count( $results ) ) {
$result = reset( $results );
$key = key( $results );
$results = array(
'tracking_number' => $tracking_number,
'shipping_provider' => $key,
'tracking_url' => $result['url'] ?? '',
);
} elseif ( 1 < count( $results ) ) {
// If multiple providers could parse the tracking number, find the one with the highest ambiguity score.
$possibilities = $results;
$results = $this->get_best_parsing_result( $results, $tracking_number );
$results['possibilities'] = $possibilities; // Include all possibilities for reference.
}
return $results;
}
/**
* Get the best parsing result from multiple results.
*
* This method finds the provider with the highest ambiguity score from the results.
*
* @param array $results The results from multiple providers.
* @param string $tracking_number The tracking number being parsed.
*
* @return array The best parsing result.
*/
private function get_best_parsing_result( array $results, string $tracking_number ): array {
$best_result = null;
$best_provider = '';
$best_score = 0;
foreach ( $results as $provider_key => $result ) {
if ( ! isset( $result['ambiguity_score'] ) || ! is_numeric( $result['ambiguity_score'] ) ) {
continue; // Skip if ambiguity score is not set or not numeric.
}
if ( is_null( $best_result ) || $result['ambiguity_score'] > $best_score ) {
$best_result = $result;
$best_provider = $provider_key;
$best_score = $result['ambiguity_score'];
}
}
return is_null( $best_result ) ? array() : array(
'tracking_number' => $tracking_number,
'shipping_provider' => $best_provider,
'tracking_url' => $best_result['url'],
);
}
}
PK [1]; Fulfillments/Fulfillment.phpnu set_id( absint( $data->get_id() ) );
} elseif ( is_numeric( $data ) ) {
$this->set_id( absint( $data ) );
} elseif ( is_array( $data ) && isset( $data['id'] ) ) {
$this->set_id( absint( $data['id'] ) );
} elseif ( is_string( $data ) && ! empty( $data ) ) {
$this->set_id( absint( $data ) );
} elseif ( is_object( $data ) && isset( $data->id ) ) {
$this->set_id( absint( $data->id ) );
} else {
$this->set_object_read( true );
}
// Load the items array.
$this->data_store = wc_get_container()->get( FulfillmentsDataStore::class );
if ( $this->get_id() > 0 ) {
$this->data_store->read( $this );
}
}
/**
* Get the fulfillment ID.
*
* @return int Fulfillment ID.
*/
public function get_id(): int {
return $this->data['id'] ?? 0;
}
/**
* Set the fulfillment ID.
*
* @param int $id Fulfillment ID.
*/
public function set_id( $id ): void {
$this->data['id'] = is_numeric( $id ) ? absint( $id ) : 0;
parent::set_id( $this->data['id'] );
}
/**
* Get the entity type.
*
* @return string|null Entity type.
*/
public function get_entity_type(): ?string {
return $this->data['entity_type'] ?? null;
}
/**
* Set the entity type.
*
* @param class-string|null $entity_type Entity type.
*/
public function set_entity_type( ?string $entity_type ): void {
$this->data['entity_type'] = $entity_type;
}
/**
* Get the entity ID.
*
* @return string|null Entity ID.
*/
public function get_entity_id(): ?string {
return $this->data['entity_id'] ?? null;
}
/**
* Set the entity ID.
*
* @param string|null $entity_id Entity ID.
*/
public function set_entity_id( ?string $entity_id ): void {
$this->data['entity_id'] = $entity_id;
}
/**
* Set fulfillment status.
*
* @param string|null $status Fulfillment status.
*
* @return void
*
* @throws \InvalidArgumentException If the status is invalid.
*/
public function set_status( ?string $status ): void {
$statuses = FulfillmentUtils::get_fulfillment_statuses();
if ( ! isset( $statuses[ $status ] ) ) {
// Change the status to an existing one if the provided status is not valid.
$status = $this->get_is_fulfilled() ? 'fulfilled' : 'unfulfilled';
}
// Set the fulfillment status.
$this->set_is_fulfilled( $statuses[ $status ]['is_fulfilled'] ?? false );
// Set the status in the data array.
$this->data['status'] = $status;
}
/**
* Get the fulfillment status.
*
* @return string|null Fulfillment status.
*/
public function get_status(): ?string {
return $this->data['status'] ?? null;
}
/**
* Set if the fulfillment is fulfilled. This is an internal method which is bound to the fulfillment status.
*
* @param bool $is_fulfilled Whether the fulfillment is fulfilled.
*
* @return void
*/
private function set_is_fulfilled( bool $is_fulfilled ): void {
$this->data['is_fulfilled'] = $is_fulfilled;
}
/**
* Get if the fulfillment is fulfilled.
*
* @return bool Whether the fulfillment is fulfilled.
*/
public function get_is_fulfilled(): bool {
return $this->data['is_fulfilled'] ?? false;
}
/**
* Check if the fulfillment is locked.
*
* @return bool Whether the fulfillment is locked.
*/
public function is_locked(): bool {
return boolval( $this->get_meta( '_is_locked' ) );
}
/**
* Get the lock message.
*
* @return string Lock message.
*/
public function get_lock_message(): string {
return $this->get_meta( '_lock_message' ) ?? '';
}
/**
* Set the lock status and message.
*
* @param bool $locked Whether the fulfillment is locked.
* @param string $message Optional. The lock message.
* Defaults to an empty string.
*
* @return void
*/
public function set_locked( bool $locked, string $message = '' ): void {
$this->update_meta_data( '_is_locked', $locked );
if ( $locked ) {
$this->update_meta_data( '_lock_message', $message );
} else {
$this->delete_meta_data( '_lock_message' );
}
}
/**
* Get the date updated.
*
* @return string|null Date updated.
*/
public function get_date_updated(): ?string {
return $this->data['date_updated'] ?? null;
}
/**
* Set the date updated.
*
* @param string|null $date_updated Date updated.
*/
public function set_date_updated( ?string $date_updated ): void {
$this->data['date_updated'] = $date_updated;
}
/**
* Get the date the fulfillment was fulfilled.
*/
public function get_date_fulfilled(): ?string {
return $this->meta_exists( '_date_fulfilled' ) ? $this->get_meta( '_date_fulfilled', true ) : null;
}
/**
* Set the date the fulfillment was fulfilled.
*
* @param string $date_fulfilled Date fulfilled.
*/
public function set_date_fulfilled( string $date_fulfilled ): void {
$this->add_meta_data( '_date_fulfilled', $date_fulfilled, true );
}
/**
* Get the date deleted.
*
* @return string|null Date deleted.
*/
public function get_date_deleted(): ?string {
return $this->data['date_deleted'] ?? null;
}
/**
* Set the date deleted.
*
* @param string|null $date_deleted Date deleted.
* @return void
*/
public function set_date_deleted( ?string $date_deleted ): void {
$this->data['date_deleted'] = $date_deleted;
}
/**
* Get the fulfillment items.
*
* @return array Fulfillment items.
*/
public function get_items(): array {
$items = $this->get_meta( '_items' );
return $items ? $items : array();
}
/**
* Set the fulfillment items.
*
* @param array $items Fulfillment items.
*/
public function set_items( array $items ): void {
$this->update_meta_data( '_items', array_values( $items ) );
}
/**
* Get the order associated with this fulfillment.
*
* This method retrieves the order based on the entity type and entity ID.
* If the entity type is `WC_Order`, it returns the order object.
*
* @return \WC_Order|null The order object or null if not found.
*/
public function get_order(): ?\WC_Order {
$entity_type = $this->get_entity_type();
$entity_id = $this->get_entity_id();
if ( ! $entity_type || ! $entity_id ) {
return null;
}
if ( \WC_Order::class === $entity_type ) {
$order = wc_get_order( (int) $entity_id );
if ( $order instanceof \WC_Order ) {
return $order;
}
}
return null;
}
/**
* Returns all data for this object as an associative array.
*
* @return array
*/
public function get_raw_data() {
return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_raw_meta_data() ) );
}
/**
* Returns the meta data as array for this object.
*
* @return array
*/
public function get_raw_meta_data() {
return array_map( fn( WC_Meta_Data $meta ) => (array) $meta->get_data(), $this->get_meta_data() );
}
}
PK [1]x % Fulfillments/FulfillmentsSettings.phpnu $setting ) {
if (
isset( $setting['type'], $setting['id'] ) &&
'sectionend' === $setting['type'] &&
'catalog_options' === $setting['id'] // Woo core's ID for Shop pages section.
) {
$insertion_index = $index + 1; // Insert after the sectionend.
break;
}
}
if ( is_null( $insertion_index ) ) {
return $settings; // fallback if not found.
}
$auto_fulfill_settings = array(
array(
'title' => 'Auto-fulfill items',
'desc' => '',
'type' => 'title',
'id' => 'auto_fulfill_options',
),
array(
'title' => 'Virtual and downloadable items',
'desc' => 'Automatically mark downloadable items as fulfilled when the order is created.',
'id' => 'auto_fulfill_downloadable',
'type' => 'checkbox',
'checkboxgroup' => 'start',
'default' => 'yes',
),
array(
'title' => 'Auto-fulfill items',
'desc' => 'Automatically mark virtual (non-downloadable) items as fulfilled when the order is created.',
'id' => 'auto_fulfill_virtual',
'type' => 'checkbox',
'checkboxgroup' => 'end',
'default' => 'no',
),
array(
'type' => 'sectionend',
'id' => 'auto_fulfill_options',
),
);
array_splice( $settings, $insertion_index, 0, $auto_fulfill_settings );
return $settings;
}
/**
* Automatically fulfill items in the order on the processing state.
*
* @param int $order_id The ID of the order being created.
* @param WC_Order $order The order object.
*/
public function auto_fulfill_items_on_processing( int $order_id, $order ): void {
$order = $order instanceof WC_Order ? $order : wc_get_order( $order_id );
if ( ! $order || empty( $order->get_items() ) ) {
return;
}
$auto_fulfill_downloadable = 'yes' === get_option( 'auto_fulfill_downloadable', 'yes' );
$auto_fulfill_virtual = 'yes' === get_option( 'auto_fulfill_virtual', 'no' );
/**
* Filter to get the list of the item, or variant ID's that should be auto-fulfilled.
*
* @since 10.1.0
*
* @param array $auto_fulfill_items List of product or variant ID's to auto-fulfill.
* @param \WC_Order $order The order object.
*
* @return array Filtered list of product or variant ID's to auto-fulfill
*/
$auto_fulfill_product_ids = apply_filters( 'woocommerce_fulfillments_auto_fulfill_products', array(), $order );
$auto_fulfill_items = array();
foreach ( $order->get_items() as $item ) {
/**
* Get the product associated with the item.
*
* @var \WC_Order_Item_Product $item
* @var \WC_Product $product
*/
$product = $item->get_product();
if ( ! $product ) {
continue;
}
if ( ( $product->is_downloadable() && $auto_fulfill_downloadable )
|| ( $product->is_virtual() && $auto_fulfill_virtual )
|| in_array( $product->get_id(), $auto_fulfill_product_ids, true ) ) {
$auto_fulfill_items[] = $item;
}
}
if ( ! empty( $auto_fulfill_items ) ) {
$fulfillment = new Fulfillment();
$fulfillment->set_entity_type( WC_Order::class );
$fulfillment->set_entity_id( (string) $order_id );
$fulfillment->set_status( 'fulfilled' );
$fulfillment->set_items(
array_map(
function ( $item ) {
return array(
'item_id' => $item->get_id(),
'qty' => $item->get_quantity(),
);
},
$auto_fulfill_items
)
);
$fulfillment->save();
}
$order->update_meta_data( '_auto_fulfill_processed', true );
}
/**
* Automatically fulfill items in the order for orders that skip the processing state.
*
* @param int $order_id The ID of the order being created.
* @param WC_Order $order The order object.
*/
public function auto_fulfill_items_on_completed( int $order_id, $order ): void {
$order = $order instanceof WC_Order ? $order : wc_get_order( $order_id );
if ( ! $order || empty( $order->get_items() ) ) {
return;
}
// If auto-fulfill already processed, skip.
if ( $order->get_meta( '_auto_fulfill_processed', true ) ) {
return;
}
// If fulfillments already exist, skip auto-fulfillment.
$fulfillments = wc_get_container()->get( FulfillmentsDataStore::class )->read_fulfillments( \WC_Order::class, (string) $order_id );
if ( ! empty( $fulfillments ) ) {
return;
}
// Auto-fulfill items.
$this->auto_fulfill_items_on_processing( $order_id, $order );
}
}
PK [1]B[ [ ! Fulfillments/FulfillmentUtils.phpnu $item->get_id(),
'item' => $item,
'qty' => $item->get_quantity() + ( $without_refunds ? $order->get_qty_refunded_for_item( $item->get_id() ) : 0 ),
);
},
$order->get_items() ?? array()
);
// If there are items in fulfillments, subtract their quantities from the order items.
if ( ! empty( $items_in_fulfillments ) ) {
foreach ( $order_items as $item_id => &$item ) {
if ( isset( $items_in_fulfillments[ $item_id ] ) ) {
$item['qty'] = $item['qty'] - $items_in_fulfillments[ $item_id ];
}
}
}
return array_filter(
$order_items,
function ( $item ) {
return $item['qty'] > 0; // Only return items with a positive quantity.
}
);
}
/**
* Get refunded items for an order.
*
* @param WC_Order $order The order object.
*
* @return array An array of refunded items with their IDs and quantities.
*/
public static function get_refunded_items( WC_Order $order ): array {
$items_refunded = array();
foreach ( $order->get_items() as $item ) {
$items_refunded[ $item->get_id() ] = -1 * $order->get_qty_refunded_for_item( $item->get_id() );
}
return array_filter(
$items_refunded,
function ( $qty ) {
return $qty > 0; // Only include items that have been refunded.
}
);
}
/**
* Get order items for a fulfillment.
*
* @param WC_Order $order The order object.
* @param Fulfillment $fulfillment The fulfillment object.
*
* @return array An array of order items.
*/
public static function get_fulfillment_items( WC_Order $order, Fulfillment $fulfillment ): array {
$fulfillment_items = array_combine(
array_column( $fulfillment->get_items(), 'item_id' ),
array_column( $fulfillment->get_items(), 'qty' )
);
$order_items = array_map(
function ( $item ) use ( $order ) {
return array(
'item_id' => $item->get_id(),
'item' => $item,
'qty' => $item->get_quantity() - $order->get_qty_refunded_for_item( $item ),
);
},
$order->get_items()
);
return array_map(
function ( $item ) use ( $fulfillment_items ) {
$item['qty'] = $fulfillment_items[ $item['item_id'] ];
return $item;
},
array_filter(
$order_items,
function ( $item ) use ( $fulfillment_items ) {
return isset( $fulfillment_items[ $item['item_id'] ] );
}
)
);
}
/**
* Check if an order has pending items.
*
* @param WC_Order $order The order object.
* @param array $fulfillments An array of fulfillments to check.
*
* @return bool True if there are pending items, false otherwise.
*/
public static function has_pending_items( WC_Order $order, array $fulfillments ): bool {
$pending_items = self::get_pending_items( $order, $fulfillments );
return ! empty( $pending_items );
}
/**
* Get the fulfillment status of the entity. This runs like a computed property, where
* it checks the fulfillment status of each fulfillment attached to the order,
* and computes the overall fulfillment status of the order.
*
* @param WC_Order $order The order object.
* @param array $fulfillments An array of fulfillments to check.
*
* @return string The fulfillment status.
*/
public static function calculate_order_fulfillment_status( WC_Order $order, $fulfillments = array() ): string {
$has_fulfillments = ! empty( $fulfillments );
if ( $has_fulfillments ) {
$pending_items = self::get_pending_items( $order, $fulfillments );
$all_fulfilled = true;
$some_fulfilled = false;
foreach ( $fulfillments as $fulfillment ) {
if ( ! $fulfillment->get_is_fulfilled() ) {
$all_fulfilled = false;
} else {
$some_fulfilled = true;
}
}
if ( $all_fulfilled && empty( $pending_items ) ) {
$status = 'fulfilled';
} elseif ( $some_fulfilled ) {
$status = 'partially_fulfilled';
} else {
$status = 'unfulfilled';
}
} else {
$status = 'no_fulfillments';
}
/**
* This filter allows plugins to modify the fulfillment status of an order.
*
* @since 10.1.0
*
* @param string $status The default fulfillment status.
* @param WC_Order $order The order object.
* @param array $fulfillments An array of fulfillments for the order.
*/
return apply_filters(
'woocommerce_fulfillment_calculate_order_fulfillment_status',
$status,
$order,
$fulfillments
);
}
/**
* Get all items from the fulfillments.
*
* @param array $fulfillments An array of fulfillments.
*
* @return array An associative array of item IDs and their quantities.
*/
public static function get_all_items_of_fulfillments( array $fulfillments ): array {
$items = array();
foreach ( $fulfillments as $fulfillment ) {
$fulfillment_items = $fulfillment->get_items();
foreach ( $fulfillment_items as $item ) {
if ( ! isset( $items[ $item['item_id'] ] ) ) {
$items[ $item['item_id'] ] = 0; // Initialize if not set.
}
// Sum the quantities for each item.
$items[ $item['item_id'] ] += $item['qty'];
}
}
return $items;
}
/**
* Get the HTML for the fulfillment tracking number.
*
* @param Fulfillment $fulfillment The fulfillment object.
*
* @return string The HTML for the tracking number.
*/
public static function get_tracking_info_html( Fulfillment $fulfillment ): string {
$tracking_html = '';
$tracking_url = $fulfillment->get_meta( '_tracking_url', true );
$tracking_number = $fulfillment->get_meta( '_tracking_number', true );
if ( ! empty( $tracking_url ) && ! empty( $tracking_number ) ) {
$tracking_html .= '';
$tracking_html .= esc_html( $tracking_number );
$tracking_html .= '';
} elseif ( ! empty( $tracking_number ) ) {
$tracking_html .= esc_html( $tracking_number );
} else {
$tracking_html .= '' . esc_html__( 'No tracking number available', 'woocommerce' ) . '';
}
return $tracking_html;
}
/**
* Get the fulfillment status of an order.
*
* @param WC_Order $order The order object.
* @return string The fulfillment status.
*/
public static function get_order_fulfillment_status( WC_Order $order ): string {
if ( ! $order instanceof WC_Order ) {
return 'no_fulfillments';
}
return $order->meta_exists( '_fulfillment_status' ) ? $order->get_meta( '_fulfillment_status', true ) : 'no_fulfillments';
}
/**
* Get the fulfillment status text for an order.
*
* @param WC_Order $order The order object.
*
* @return string The fulfillment status text.
*/
public static function get_order_fulfillment_status_text( WC_Order $order ): string {
// Ensure the order is a valid WC_Order object.
if ( ! $order instanceof WC_Order ) {
return '';
}
// Check if the order meta exists for fulfillment status.
$fulfillment_status = self::get_order_fulfillment_status( $order );
$fulfillment_status_text = '';
switch ( $fulfillment_status ) {
case 'fulfilled':
$fulfillment_status_text = ' ' . __( 'It has been Fulfilled.', 'woocommerce' );
break;
case 'partially_fulfilled':
$fulfillment_status_text = ' ' . __( 'It has been Partially fulfilled.', 'woocommerce' );
break;
case 'unfulfilled':
$fulfillment_status_text = ' ' . __( 'It is currently Unfulfilled.', 'woocommerce' );
break;
case 'no_fulfillments':
$fulfillment_status_text = ' ' . __( 'It has no fulfillments yet.', 'woocommerce' );
break;
}
/**
* This filter allows plugins to modify the fulfillment status text for an order for their custom fulfillment statuses.
*
* @since 10.1.0
*
* @param string $fulfillment_status_text The default fulfillment status text.
* @param string $fulfillment_status The fulfillment status of the order.
* @param WC_Order $order The order object.
*/
return apply_filters(
'woocommerce_fulfillment_order_fulfillment_status_text',
$fulfillment_status_text,
$fulfillment_status,
$order
);
}
/**
* Get the meta query for the order fulfillment status.
*
* @param array|string $statuses The fulfillment statuses, or single status.
* @return array The meta query.
*/
public static function get_order_fulfillment_status_meta_query( $statuses ): array {
if ( is_string( $statuses ) ) {
$statuses = array( $statuses );
}
$valid_statuses = array_filter( $statuses, array( self::class, 'is_valid_order_fulfillment_status' ) );
if ( empty( $valid_statuses ) ) {
return array();
}
if ( in_array( 'no_fulfillments', $valid_statuses, true ) ) {
return array(
'relation' => 'OR',
array(
'key' => '_fulfillment_status',
'value' => $valid_statuses,
'compare' => 'IN',
),
array(
'key' => '_fulfillment_status',
'compare' => 'NOT EXISTS',
),
);
}
return array(
'key' => '_fulfillment_status',
'value' => $valid_statuses,
'compare' => 'IN',
);
}
/**
* Check if the given fulfillment status is valid.
*
* @param string|null $status The fulfillment status to check.
*
* @return bool True if the status is valid, false otherwise.
*/
public static function is_valid_order_fulfillment_status( ?string $status ): bool {
if ( is_null( $status ) ) {
return false;
}
$order_fulfillment_statuses = self::get_order_fulfillment_statuses();
return in_array( $status, array_keys( $order_fulfillment_statuses ), true );
}
/**
* Check if the given fulfillment status is valid.
*
* @param string|null $status The fulfillment status to check.
*
* @return bool True if the status is valid, false otherwise.
*/
public static function is_valid_fulfillment_status( ?string $status ): bool {
if ( is_null( $status ) ) {
return false;
}
$fulfillment_statuses = self::get_fulfillment_statuses();
return in_array( $status, array_keys( $fulfillment_statuses ), true );
}
/**
* Get the order fulfillment statuses.
*
* This method provides the order fulfillment statuses that can be used
* in the WooCommerce Fulfillments system. It can be filtered using the
* `woocommerce_fulfillment_order_fulfillment_statuses` filter.
*
* @return array An associative array of order fulfillment statuses.
*/
public static function get_order_fulfillment_statuses(): array {
/**
* This filter allows plugins to modify the list of order fulfillment statuses.
* It can be used to add, remove, or change the order fulfillment statuses available in the
* WooCommerce Fulfillments system.
*
* @since 10.1.0
*
* @param array $order_fulfillment_statuses The default list of order fulfillment statuses.
*/
return apply_filters(
'woocommerce_fulfillment_order_fulfillment_statuses',
self::get_default_order_fulfillment_statuses()
);
}
/**
* Get the fulfillment statuses.
*
* This method provides the fulfillment statuses that can be used
* in the WooCommerce Fulfillments system. It can be filtered using the
* `woocommerce_fulfillment_fulfillment_statuses` filter.
*
* @return array An associative array of fulfillment statuses.
*/
public static function get_fulfillment_statuses(): array {
/**
* This filter allows plugins to modify the list of fulfillment statuses.
* It can be used to add, remove, or change the fulfillment statuses available in the
* WooCommerce Fulfillments system.
*
* @since 10.1.0
*
* @param array $fulfillment_statuses The default list of fulfillment statuses.
*/
return apply_filters(
'woocommerce_fulfillment_fulfillment_statuses',
self::get_default_fulfillment_statuses()
);
}
/**
* Get the shipping providers.
*
* This method retrieves the shipping providers registered in the WooCommerce Fulfillments system.
* It can be filtered using the `woocommerce_fulfillment_shipping_providers` filter.
*
* @return array An associative array of shipping providers with their details.
*/
public static function get_shipping_providers(): array {
/**
* This filter allows plugins to modify the list of shipping providers.
* It can be used to add, remove, or change the shipping providers available in the
* WooCommerce Fulfillments system.
*
* @since 10.1.0
*
* @param array $shipping_providers The default list of shipping providers.
*/
return apply_filters(
'woocommerce_fulfillment_shipping_providers',
array()
);
}
/**
* Get the shipping providers as an array of JS objects, for use in the fulfillment UI.
*
* @return array An associative array of shipping providers with their details.
*/
public static function get_shipping_providers_object(): array {
$shipping_providers = self::get_shipping_providers();
if ( ! is_array( $shipping_providers ) ) {
return array();
}
$shipping_providers_object = array();
foreach ( $shipping_providers as $shipping_provider ) {
if ( is_string( $shipping_provider )
&& class_exists( $shipping_provider )
&& is_subclass_of( $shipping_provider, AbstractShippingProvider::class )
) {
try {
// Instantiate the shipping provider class.
$shipping_provider_instance = wc_get_container()->get( $shipping_provider );
} catch ( \Throwable $e ) {
continue; // Skip if instantiation fails.
}
$shipping_providers_object[ $shipping_provider_instance->get_key() ] = array(
'label' => $shipping_provider_instance->get_name(),
'icon' => $shipping_provider_instance->get_icon(),
'value' => $shipping_provider_instance->get_key(),
'url' => $shipping_provider_instance->get_tracking_url( '__PLACEHOLDER__' ),
);
}
if ( is_object( $shipping_provider ) && $shipping_provider instanceof AbstractShippingProvider ) {
$shipping_providers_object[ $shipping_provider->get_key() ] = array(
'label' => $shipping_provider->get_name(),
'icon' => $shipping_provider->get_icon(),
'value' => $shipping_provider->get_key(),
'url' => $shipping_provider->get_tracking_url( '__PLACEHOLDER__' ),
);
}
}
return $shipping_providers_object;
}
/**
* Get the default order fulfillment statuses.
*
* This method provides the default order fulfillment statuses that can be used
* in the WooCommerce Fulfillments system. It can be filtered using the
* `woocommerce_fulfillment_order_fulfillment_statuses` filter.
*
* @return array An associative array of default order fulfillment statuses.
*/
protected static function get_default_order_fulfillment_statuses(): array {
return array(
'fulfilled' => array(
'label' => __( 'Fulfilled', 'woocommerce' ),
'background_color' => '#C6E1C6',
'text_color' => '#13550F',
),
'partially_fulfilled' => array(
'label' => __( 'Partially fulfilled', 'woocommerce' ),
'background_color' => '#C8D7E1',
'text_color' => '#003D66',
),
'unfulfilled' => array(
'label' => __( 'Unfulfilled', 'woocommerce' ),
'background_color' => '#FBE5E5',
'text_color' => '#CC1818',
),
'no_fulfillments' => array(
'label' => __( 'No fulfillments', 'woocommerce' ),
'background_color' => '#F0F0F0',
'text_color' => '#2F2F2F',
),
);
}
/**
* Get the default fulfillment statuses.
*
* This method provides the default fulfillment statuses that can be used
* in the WooCommerce Fulfillments system. It can be filtered using the
* `woocommerce_fulfillment_fulfillment_statuses` filter.
*
* @return array An associative array of default fulfillment statuses.
*/
protected static function get_default_fulfillment_statuses(): array {
return array(
'fulfilled' => array(
'label' => __( 'Fulfilled', 'woocommerce' ),
'is_fulfilled' => true,
'background_color' => '#C6E1C6',
'text_color' => '#13550F',
),
'unfulfilled' => array(
'label' => __( 'Unfulfilled', 'woocommerce' ),
'is_fulfilled' => false,
'background_color' => '#FBE5E5',
'text_color' => '#CC1818',
),
);
}
/**
* Calculate the S10 check digit for UPU tracking numbers.
*
* @param string $tracking_number The tracking number without the check digit.
*
* @return bool True if the check digit is valid, false otherwise.
*/
public static function check_s10_upu_format( string $tracking_number ): bool {
if ( preg_match( '/^[A-Z]{2}\d{9}[A-Z]{2}$/', $tracking_number ) ) {
// The tracking number is in the UPU S10 format.
$tracking_number = substr( $tracking_number, 2, -2 );
} elseif ( ! preg_match( '/^\d{9}$/', $tracking_number ) ) {
// Ensure the tracking number is exactly 9 digits.
return false;
}
// Define the weights for the S10 check digit calculation.
$weights = array( 8, 6, 4, 2, 3, 5, 9, 7 );
$sum = 0;
// Calculate the weighted sum of the digits.
for ( $i = 0; $i < 8; $i++ ) {
$sum += $weights[ $i ] * (int) $tracking_number[ $i ];
}
// Calculate the check digit.
$check_digit = 11 - ( $sum % 11 );
if ( 10 === $check_digit ) {
$check_digit = 0;
} elseif ( 11 === $check_digit ) {
$check_digit = 5;
}
// Validate the check digit against the last digit of the tracking number.
return (int) $tracking_number[8] === $check_digit;
}
/**
* Validate UPS 1Z tracking number using Mod 10 check digit.
*
* @param string $tracking_number The UPS 1Z tracking number.
* @return bool True if valid, false otherwise.
*/
public static function validate_ups_1z_check_digit( string $tracking_number ): bool {
if ( ! preg_match( '/^1Z[0-9A-Z]{15,16}$/', $tracking_number ) ) {
return false;
}
// Extract the trackable part (remove 1Z prefix).
$trackable = substr( $tracking_number, 2 );
$check_digit = (int) substr( $trackable, -1 );
$trackable = substr( $trackable, 0, -1 );
$sum = 0;
$odd_position = true;
// Process each character from right to left.
for ( $i = strlen( $trackable ) - 1; $i >= 0; $i-- ) {
$char = $trackable[ $i ];
$value = is_numeric( $char ) ? (int) $char : ord( $char ) - 55; // A=10, B=11, etc.
if ( $odd_position ) {
$value *= 2;
if ( $value > 9 ) {
$value = (int) ( $value / 10 ) + ( $value % 10 );
}
}
$sum += $value;
$odd_position = ! $odd_position;
}
$calculated_check = ( 10 - ( $sum % 10 ) ) % 10;
return $calculated_check === $check_digit;
}
/**
* Validate Mod 7 check digit for numeric tracking numbers.
*
* @param string $tracking_number The numeric tracking number.
* @return bool True if valid, false otherwise.
*/
public static function validate_mod7_check_digit( string $tracking_number ): bool {
if ( ! preg_match( '/^\d+$/', $tracking_number ) || strlen( $tracking_number ) < 2 ) {
return false;
}
$check_digit = (int) substr( $tracking_number, -1 );
$number = substr( $tracking_number, 0, -1 );
$sum = 0;
$weights = array( 3, 1, 3, 1, 3, 1, 3 ); // Mod 7 weights.
$weight_index = 0;
// Process each digit from right to left.
for ( $i = strlen( $number ) - 1; $i >= 0; $i-- ) {
$digit = (int) $number[ $i ];
$sum += $digit * $weights[ $weight_index % count( $weights ) ];
++$weight_index;
}
$calculated_check = $sum % 7;
if ( 0 === $calculated_check ) {
$calculated_check = 7; // If the sum is a multiple of 7, the check digit is 7.
}
return $calculated_check === $check_digit;
}
/**
* Validate Mod 10 check digit for numeric tracking numbers.
*
* @param string $tracking_number The numeric tracking number.
* @return bool True if valid, false otherwise.
*/
public static function validate_mod10_check_digit( string $tracking_number ): bool {
if ( ! preg_match( '/^\d+$/', $tracking_number ) || strlen( $tracking_number ) < 2 ) {
return false;
}
$check_digit = (int) substr( $tracking_number, -1 );
$number = substr( $tracking_number, 0, -1 );
$sum = 0;
$odd_position = true;
// Process each digit from right to left.
for ( $i = strlen( $number ) - 1; $i >= 0; $i-- ) {
$digit = (int) $number[ $i ];
if ( $odd_position ) {
$digit *= 2;
if ( $digit > 9 ) {
$digit = (int) ( $digit / 10 ) + ( $digit % 10 );
}
}
$sum += $digit;
$odd_position = ! $odd_position;
}
$calculated_check = ( 10 - ( $sum % 10 ) ) % 10;
return $calculated_check === $check_digit;
}
/**
* Validate Mod 11 check digit for tracking numbers (used by DHL).
*
* @param string $tracking_number The tracking number.
* @return bool True if valid, false otherwise.
*/
public static function validate_mod11_check_digit( string $tracking_number ): bool {
if ( ! preg_match( '/^\d+$/', $tracking_number ) || strlen( $tracking_number ) < 2 ) {
return false;
}
$check_digit = (int) substr( $tracking_number, -1 );
$number = substr( $tracking_number, 0, -1 );
$weights = array( 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 );
$sum = 0;
$weight_index = 0;
// Process each digit from right to left.
for ( $i = strlen( $number ) - 1; $i >= 0; $i-- ) {
$digit = (int) $number[ $i ];
$sum += $digit * $weights[ $weight_index % count( $weights ) ];
++$weight_index;
}
$calculated_check = 11 - ( $sum % 11 );
if ( 10 === $calculated_check ) {
$calculated_check = 0;
} elseif ( 11 === $calculated_check ) {
$calculated_check = 5;
}
return $calculated_check === $check_digit;
}
/**
* Validate FedEx check digit for 12/14-digit tracking numbers.
*
* @param string $tracking_number The FedEx tracking number.
* @return bool True if valid, false otherwise.
*/
public static function validate_fedex_check_digit( string $tracking_number ): bool {
if ( ! preg_match( '/^\d{12}$/', $tracking_number ) ) {
return false;
}
$digits = str_split( substr( $tracking_number, 0, 11 ) );
$multipliers = array( 3, 1, 7 );
$sum = 0;
$multiplier_index = 0;
for ( $i = 10; $i >= 0; $i-- ) {
$sum += $digits[ $i ] * $multipliers[ $multiplier_index ];
$multiplier_index = ( ++$multiplier_index ) % 3;
}
$check = $sum % 11;
if ( 10 === $check ) {
$check = 0;
}
return intval( $tracking_number[11] ) === $check;
}
}
PK [1]}&p p 0 Fulfillments/OrderFulfillmentsRestController.phpnu Note: This REST controller is only created for `WC_Order` type of entities, that allow
* !> managing fulfillments only for admins. Regular users can only view their fulfillments.
* !>
* !> If you are using another entity type for your fulfillments, you should create a new controller.
*
* @package Automattic\WooCommerce\Internal\Fulfillments
*/
class OrderFulfillmentsRestController extends RestApiControllerBase {
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v3';
/**
* REST API base.
*
* @var string
*/
protected $rest_base = '/orders/(?P[\d]+)/fulfillments';
/**
* Get the WooCommerce REST API namespace for the class.
*
* @return string
*/
protected function get_rest_api_namespace(): string {
return 'order_fulfillments';
}
/**
* Register the routes for fulfillments.
*/
public function register_routes() {
// Register the route for getting and setting order fulfillments.
register_rest_route(
$this->route_namespace,
$this->rest_base,
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_fulfillments' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_get_fulfillments(),
'schema' => $this->get_schema_for_get_fulfillments(),
),
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'create_fulfillment' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_create_fulfillment(),
'schema' => $this->get_schema_for_create_fulfillment(),
),
),
);
// Register the route for getting a specific fulfillment.
register_rest_route(
$this->route_namespace,
$this->rest_base . '/(?P[\d]+)',
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_fulfillment' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_get_fulfillment(),
'schema' => $this->get_schema_for_get_fulfillment(),
),
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'update_fulfillment' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_update_fulfillment(),
'schema' => $this->get_schema_for_update_fulfillment(),
),
array(
'methods' => \WP_REST_Server::DELETABLE,
'callback' => fn( $request ) => $this->run( $request, 'delete_fulfillment' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_delete_fulfillment(),
'schema' => $this->get_schema_for_delete_fulfillment(),
),
),
);
// Register the route for fulfillment metadata.
register_rest_route(
$this->route_namespace,
$this->rest_base . '/(?P[\d]+)/metadata',
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_fulfillment_meta' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_get_fulfillment_meta(),
'schema' => $this->get_schema_for_get_fulfillment_meta(),
),
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'update_fulfillment_meta' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_update_fulfillment_meta(),
'schema' => $this->get_schema_for_update_fulfillment_meta(),
),
array(
'methods' => \WP_REST_Server::DELETABLE,
'callback' => fn( $request ) => $this->run( $request, 'delete_fulfillment_meta' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_delete_fulfillment_meta(),
'schema' => $this->get_schema_for_delete_fulfillment_meta(),
),
),
);
// Register the route for tracking number lookup.
register_rest_route(
$this->route_namespace,
$this->rest_base . '/lookup',
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_tracking_number_details' ),
'permission_callback' => fn( $request ) => $this->check_permission_for_fulfillments( $request ),
'args' => $this->get_args_for_get_tracking_number_details(),
'schema' => $this->get_schema_for_get_tracking_number_details(),
),
),
);
}
/**
* Permission check for REST API endpoints, given the request method.
* For all fulfillments methods that have an order_id, we need to be sure the user has permission to view the order.
* For all other methods, we check if the user is logged in as admin and has the required capability.
*
* @param WP_REST_Request $request The request for which the permission is checked.
* @return bool|\WP_Error True if the current user has the capability, otherwise an "Unauthorized" error or False if no error is available for the request method.
*
* @throws \WP_Error If the URL contains an order, but the order does not exist.
*/
protected function check_permission_for_fulfillments( WP_REST_Request $request ) {
// Fetch the order first if there's an order_id in the request.
$order = null;
if ( $request->has_param( 'order_id' ) ) {
$order_id = (int) $request->get_param( 'order_id' );
$order = wc_get_order( $order_id );
if ( ! $order ) {
return new \WP_Error(
'woocommerce_rest_order_invalid_id',
esc_html__( 'Invalid order ID.', 'woocommerce' ),
array( 'status' => esc_attr( WP_Http::NOT_FOUND ) )
);
}
}
// Check if the user is logged in as admin, and has the required capability.
// Admins who can manage WooCommerce can view all fulfillments.
if ( current_user_can( 'manage_woocommerce' ) ) { // phpcs:ignore WordPress.WP.Capabilities.Unknown
return true;
}
// Check if the order exists, and if the current user is the owner of the order, and the request is a read request.
// We allow this because we need to render the order fulfillments on the customer's order details and order tracking pages.
// But they will be only able to view them, not edit.
if ( get_current_user_id() === $order->get_customer_id() && WP_REST_Server::READABLE === $request->get_method() ) {
return true;
}
// Return an error related to the request method.
$error_information = $this->get_authentication_error_by_method( $request->get_method() );
if ( is_null( $error_information ) ) {
return false;
}
return new \WP_Error(
$error_information['code'],
$error_information['message'],
array( 'status' => rest_authorization_required_code() )
);
}
/**
* Get the fulfillments for the order.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The fulfillments for the order, or an error if the request fails.
*/
public function get_fulfillments( WP_REST_Request $request ): WP_REST_Response {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillments = array();
// Fetch fulfillments for the order.
try {
$datastore = wc_get_container()->get( FulfillmentsDataStore::class );
$fulfillments = $datastore->read_fulfillments( WC_Order::class, "$order_id" );
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
// Return the fulfillments.
return new WP_REST_Response(
array_map(
function ( $fulfillment ) {
return $fulfillment->get_raw_data(); },
$fulfillments
),
WP_Http::OK
);
}
/**
* Create a new fulfillment with the given data for the order.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The created fulfillment, or an error if the request fails.
*/
public function create_fulfillment( WP_REST_Request $request ) {
$order_id = (int) $request->get_param( 'order_id' );
$notify_customer = (bool) $request->get_param( 'notify_customer' );
// Create a new fulfillment.
try {
$fulfillment = new Fulfillment();
$fulfillment->set_props( $request->get_json_params() );
$fulfillment->set_meta_data( $request->get_json_params()['meta_data'] );
$fulfillment->set_entity_type( WC_Order::class );
$fulfillment->set_entity_id( "$order_id" );
$fulfillment->save();
if ( $fulfillment->get_is_fulfilled() && $notify_customer ) {
/**
* Trigger the fulfillment created notification on creating a fulfilled fulfillment.
*
* @since 10.1.0
*/
do_action( 'woocommerce_fulfillment_created_notification', $order_id, $fulfillment, wc_get_order( $order_id ) );
}
} catch ( ApiException $ex ) {
return $this->prepare_error_response(
$ex->getErrorCode(),
$ex->getMessage(),
WP_Http::BAD_REQUEST
);
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
return new WP_REST_Response( $fulfillment->get_raw_data(), WP_Http::CREATED );
}
/**
* Get a specific fulfillment for the order.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The fulfillment for the order, or an error if the request fails.
*
* @throws \Exception If the fulfillment is not found or is deleted.
*/
public function get_fulfillment( WP_REST_Request $request ): WP_REST_Response {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
// Fetch the fulfillment for the order.
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );
if ( $fulfillment->get_date_deleted() ) {
throw new \Exception(
esc_html__( 'Fulfillment not found.', 'woocommerce' ),
WP_Http::NOT_FOUND
);
}
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
return new WP_REST_Response(
$fulfillment->get_raw_data(),
WP_Http::OK
);
}
/**
* Update a specific fulfillment for the order.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The updated fulfillment, or an error if the request fails.
*/
public function update_fulfillment( WP_REST_Request $request ): WP_REST_Response {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
$notify_customer = (bool) $request->get_param( 'notify_customer' );
// Update the fulfillment for the order.
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$previous_state = $fulfillment->get_is_fulfilled();
$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );
$fulfillment->set_props( $request->get_json_params() );
$next_state = $fulfillment->get_is_fulfilled();
if ( isset( $request->get_json_params()['meta_data'] ) && is_array( $request->get_json_params()['meta_data'] ) ) {
// Update the meta data keys that exist in the request.
foreach ( $request->get_json_params()['meta_data'] as $meta ) {
$fulfillment->update_meta_data( $meta['key'], $meta['value'], $meta['id'] ?? 0 );
}
// Remove the meta data keys that don't exist in the request, by matching their keys.
$existing_meta_data = $fulfillment->get_meta_data();
foreach ( $existing_meta_data as $meta ) {
if ( ! in_array( $meta->key, array_column( $request->get_json_params()['meta_data'], 'key' ), true ) ) {
$fulfillment->delete_meta_data( $meta->key );
}
}
}
$fulfillment->save();
$fulfillment->save_meta_data();
if ( $notify_customer ) {
if ( ! $previous_state && $next_state ) {
/**
* Trigger the fulfillment created notification on fulfilling a fulfillment.
*
* @since 10.1.0
*/
do_action( 'woocommerce_fulfillment_created_notification', $order_id, $fulfillment, wc_get_order( $order_id ) );
} elseif ( $next_state ) {
/**
* Trigger the fulfillment updated notification on updating a fulfillment.
*
* @since 10.1.0
*/
do_action( 'woocommerce_fulfillment_updated_notification', $order_id, $fulfillment, wc_get_order( $order_id ) );
}
}
} catch ( ApiException $ex ) {
return $this->prepare_error_response(
$ex->getErrorCode(),
$ex->getMessage(),
WP_Http::BAD_REQUEST
);
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
return new WP_REST_Response(
$fulfillment->get_raw_data(),
WP_Http::OK
);
}
/**
* Delete a specific fulfillment for the order.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The deleted fulfillment, or an error if the request fails.
*/
public function delete_fulfillment( WP_REST_Request $request ) {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
$notify_customer = (bool) $request->get_param( 'notify_customer' );
// Delete the fulfillment for the order.
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );
$fulfillment->delete();
} catch ( ApiException $ex ) {
return $this->prepare_error_response(
$ex->getErrorCode(),
$ex->getMessage(),
WP_Http::BAD_REQUEST
);
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
if ( $fulfillment->get_is_fulfilled() && $notify_customer ) {
/**
* Trigger the fulfillment deleted notification.
*
* @since 10.1.0
*/
do_action( 'woocommerce_fulfillment_deleted_notification', $order_id, $fulfillment, wc_get_order( $order_id ) );
}
return new WP_REST_Response(
array(
'message' => __( 'Fulfillment deleted successfully.', 'woocommerce' ),
),
WP_Http::OK
);
}
/**
* Get the metadata for a specific fulfillment.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The metadata for the fulfillment, or an error if the request fails.
*/
public function get_fulfillment_meta( WP_REST_Request $request ): WP_REST_Response {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
// Fetch the metadata for the fulfillment.
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
return new WP_REST_Response(
$fulfillment->get_raw_meta_data(),
WP_Http::OK
);
}
/**
* Update the metadata for a specific fulfillment.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The updated metadata for the fulfillment, or an error if the request fails.
*/
public function update_fulfillment_meta( WP_REST_Request $request ): WP_REST_Response {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
// Update the metadata for the fulfillment.
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );
// Update the meta data keys that exist in the request.
foreach ( $request->get_json_params()['meta_data'] as $meta ) {
$fulfillment->update_meta_data( $meta['key'], $meta['value'], $meta['id'] ?? 0 );
}
// Remove the meta data keys that don't exist in the request, by matching their keys.
$existing_meta_data = $fulfillment->get_meta_data();
foreach ( $existing_meta_data as $meta ) {
if ( ! in_array( $meta->key, array_column( $request->get_json_params()['meta_data'], 'key' ), true ) ) {
$fulfillment->delete_meta_data( $meta->key );
}
}
$fulfillment->save();
} catch ( ApiException $ex ) {
return $this->prepare_error_response(
$ex->getErrorCode(),
$ex->getMessage(),
WP_Http::BAD_REQUEST
);
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
return new WP_REST_Response(
$fulfillment->get_raw_meta_data(),
WP_Http::OK
);
}
/**
* Delete the metadata for a specific fulfillment.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The deleted metadata for the fulfillment, or an error if the request fails.
*/
public function delete_fulfillment_meta( WP_REST_Request $request ) {
$order_id = (int) $request->get_param( 'order_id' );
$fulfillment_id = (int) $request->get_param( 'fulfillment_id' );
// Delete the metadata for the fulfillment.
try {
$fulfillment = new Fulfillment( $fulfillment_id );
$this->validate_fulfillment( $fulfillment, $fulfillment_id, $order_id );
$meta_key = sanitize_text_field( wp_unslash( (string) $request->get_param( 'meta_key' ) ) );
$fulfillment->delete_meta_data( $meta_key );
$fulfillment->save();
} catch ( ApiException $ex ) {
return $this->prepare_error_response(
$ex->getErrorCode(),
$ex->getMessage(),
WP_Http::BAD_REQUEST
);
} catch ( \Exception $e ) {
return $this->prepare_error_response(
$e->getCode(),
$e->getMessage(),
WP_Http::BAD_REQUEST
);
}
return new WP_REST_Response(
$fulfillment->get_raw_meta_data(),
WP_Http::OK
);
}
/**
* Get the tracking number details for a given tracking number, if possible.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_REST_Response The tracking number details, or an error if the request fails.
*/
public function get_tracking_number_details( WP_REST_Request $request ) {
$order_id = (int) $request->get_param( 'order_id' );
$tracking_number = sanitize_text_field( $request->get_param( 'tracking_number' ) );
if ( empty( $tracking_number ) ) {
return $this->prepare_error_response(
'woocommerce_rest_tracking_number_missing',
__( 'Tracking number is required.', 'woocommerce' ),
array( 'status' => WP_Http::BAD_REQUEST )
);
}
if ( ! $order_id ) {
return $this->prepare_error_response(
'woocommerce_rest_order_id_missing',
__( 'Order ID is required.', 'woocommerce' ),
array( 'status' => WP_Http::BAD_REQUEST )
);
}
$order = wc_get_order( $order_id );
if ( ! $order || ! $order instanceof WC_Order ) {
return $this->prepare_error_response(
'woocommerce_rest_order_invalid_id',
__( 'Invalid order ID.', 'woocommerce' ),
array( 'status' => WP_Http::NOT_FOUND )
);
}
/**
* Parse the tracking number with additional parameters.
*
* @since 10.1.0
*/
$tracking_number_parse_result = apply_filters(
'woocommerce_fulfillment_parse_tracking_number',
$tracking_number,
WC()->countries->get_base_country(),
$order->get_shipping_country(),
);
return new WP_REST_Response( $tracking_number_parse_result, WP_Http::OK );
}
/**
* Get the arguments for the get order fulfillments endpoint.
*
* @return array
*/
private function get_args_for_get_fulfillments(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
);
}
/**
* Get the schema for the get order fulfillments endpoint.
*
* @return array
*/
private function get_schema_for_get_fulfillments(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Get fulfillments response.', 'woocommerce' );
$schema['type'] = 'array';
$schema['items'] = array(
'type' => 'object',
'properties' => $this->get_read_schema_for_fulfillment(),
);
return $schema;
}
/**
* Get the arguments for the create fulfillment endpoint.
*
* @return array
*/
private function get_args_for_create_fulfillment(): array {
return $this->get_write_args_for_fulfillment( true );
}
/**
* Get the schema for the create fulfillment endpoint.
*
* @return array
*/
private function get_schema_for_create_fulfillment(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Create fulfillment response.', 'woocommerce' );
$schema['properties'] = $this->get_read_schema_for_fulfillment();
return $schema;
}
/**
* Get the arguments for the get fulfillment endpoint.
*
* @return array
*/
private function get_args_for_get_fulfillment(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'required' => true,
),
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'required' => true,
),
);
}
/**
* Get the schema for the get fulfillment endpoint.
*
* @return array
*/
private function get_schema_for_get_fulfillment(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Get fulfillment response.', 'woocommerce' );
$schema['properties'] = $this->get_read_schema_for_fulfillment();
return $schema;
}
/**
* Get the arguments for the update fulfillment endpoint.
*
* @return array
*/
private function get_args_for_update_fulfillment(): array {
return $this->get_write_args_for_fulfillment( false );
}
/**
* Get the schema for the update fulfillment endpoint.
*
* @return array
*/
private function get_schema_for_update_fulfillment(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Update fulfillment response.', 'woocommerce' );
$schema['type'] = 'object';
$schema['properties'] = $this->get_read_schema_for_fulfillment();
return $schema;
}
/**
* Get the arguments for the delete fulfillment endpoint.
*
* @return array
*/
private function get_args_for_delete_fulfillment(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'notify_customer' => array(
'description' => __( 'Whether to notify the customer about the fulfillment update.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'required' => false,
'context' => array( 'view', 'edit' ),
),
);
}
/**
* Get the schema for the delete fulfillment endpoint.
*
* @return array
*/
private function get_schema_for_delete_fulfillment(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Delete fulfillment response.', 'woocommerce' );
$schema['properties'] = array(
'message' => array(
'description' => __( 'The response message.', 'woocommerce' ),
'type' => 'string',
'required' => true,
),
);
return $schema;
}
/**
* Get the arguments for the get fulfillment meta endpoint.
*
* @return array
*/
private function get_args_for_get_fulfillment_meta(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
);
}
/**
* Get the schema for the get fulfillment meta endpoint.
*
* @return array
*/
private function get_schema_for_get_fulfillment_meta(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Get fulfillment meta data response.', 'woocommerce' );
$schema['type'] = 'array';
$schema['items'] = array(
'description' => __( 'The meta data object.', 'woocommerce' ),
'type' => 'object',
'properties' => $this->get_schema_for_meta_data(),
);
return $schema;
}
/**
* Get the arguments for the update fulfillment meta endpoint.
*
* @return array
*/
private function get_args_for_update_fulfillment_meta(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'meta_data' => array(
'description' => __( 'The meta data array.', 'woocommerce' ),
'type' => 'array',
'required' => true,
'items' => array(
'description' => __( 'The meta data object.', 'woocommerce' ),
'type' => 'object',
'properties' => $this->get_schema_for_meta_data(),
),
),
);
}
/**
* Get the schema for the update fulfillment meta endpoint.
*
* @return array
*/
private function get_schema_for_update_fulfillment_meta(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Update fulfillment meta data response.', 'woocommerce' );
$schema['type'] = 'array';
$schema['items'] = array(
'description' => __( 'The meta data object.', 'woocommerce' ),
'type' => 'object',
'properties' => $this->get_schema_for_meta_data(),
);
return $schema;
}
/**
* Get the arguments for the delete fulfillment meta endpoint.
*
* @return array
*/
private function get_args_for_delete_fulfillment_meta(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'meta_key' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'description' => __( 'The meta key to delete.', 'woocommerce' ),
'type' => 'string',
'required' => true,
),
);
}
/**
* Get the schema for the delete fulfillment meta endpoint.
*
* @return array
*/
private function get_schema_for_delete_fulfillment_meta(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'Delete fulfillment meta data response.', 'woocommerce' );
$schema['type'] = 'array';
$schema['items'] = array(
'description' => __( 'The meta data object.', 'woocommerce' ),
'type' => 'object',
'properties' => $this->get_schema_for_meta_data(),
);
return $schema;
}
/**
* Get the arguments for the get tracking number details endpoint.
*
* @return array
*/
private function get_args_for_get_tracking_number_details(): array {
return array(
'order_id' => array(
'description' => __( 'Unique identifier for the order.', 'woocommerce' ),
'type' => 'integer',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'tracking_number' => array(
'description' => __( 'The tracking number to look up.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => array( 'view', 'edit' ),
),
);
}
/**
* Get the schema for the get tracking number details endpoint.
*
* @return array
*/
private function get_schema_for_get_tracking_number_details(): array {
$schema = $this->get_base_schema();
$schema['title'] = __( 'The tracking number details response.', 'woocommerce' );
$schema['properties'] = array(
'tracking_number' => array(
'description' => __( 'The tracking number.', 'woocommerce' ),
'type' => 'string',
'required' => true,
),
'shipping_provider' => array(
'description' => __( 'The shipping provider.', 'woocommerce' ),
'type' => 'string',
'required' => true,
),
'tracking_url' => array(
'description' => __( 'The tracking URL.', 'woocommerce' ),
'type' => 'string',
'required' => true,
),
'possibilities' => array(
'description' => __( 'Ambiguous shipping providers list.', 'woocommerce' ),
'type' => 'array',
'required' => false,
'items' => array(
'type' => 'string',
),
),
);
return $schema;
}
/**
* Get the base schema for the fulfillment with a read context.
*
* @return array
*/
private function get_read_schema_for_fulfillment() {
return array(
'id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'entity_type' => array(
'description' => __( 'The type of entity for which the fulfillment is created.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'entity_id' => array(
'description' => __( 'Unique identifier for the entity.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'status' => array(
'description' => __( 'The status of the fulfillment.', 'woocommerce' ),
'type' => 'string',
'default' => 'unfulfilled',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'is_fulfilled' => array(
'description' => __( 'Whether the fulfillment is fulfilled.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'required' => true,
'context' => array( 'view', 'edit' ),
),
'date_updated' => array(
'description' => __( 'The date the fulfillment was last updated.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'required' => true,
),
'date_deleted' => array(
'description' => __( 'The date the fulfillment was deleted.', 'woocommerce' ),
'anyOf' => array(
array(
'type' => 'string',
),
array(
'type' => 'null',
),
),
'default' => null,
'context' => array( 'view', 'edit' ),
'readonly' => true,
'required' => true,
),
'meta_data' => array(
'description' => __( 'Meta data for the fulfillment.', 'woocommerce' ),
'type' => 'array',
'required' => true,
'items' => $this->get_schema_for_meta_data(),
),
);
}
/**
* Get the base args for the fulfillment with a write context.
*
* @param bool $is_create Whether the args list is for a create request.
*
* @return array
*/
private function get_write_args_for_fulfillment( bool $is_create = false ) {
return array_merge(
! $is_create ? array(
'fulfillment_id' => array(
'description' => __( 'Unique identifier for the fulfillment.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
) : array(),
array(
'status' => array(
'description' => __( 'The status of the fulfillment.', 'woocommerce' ),
'type' => 'string',
'default' => 'unfulfilled',
'required' => false,
'context' => array( 'view', 'edit' ),
),
'is_fulfilled' => array(
'description' => __( 'Whether the fulfillment is fulfilled.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'required' => false,
'context' => array( 'view', 'edit' ),
),
'meta_data' => array(
'description' => __( 'Meta data for the fulfillment.', 'woocommerce' ),
'type' => 'array',
'required' => true,
'schema' => $this->get_schema_for_meta_data(),
),
'notify_customer' => array(
'description' => __( 'Whether to notify the customer about the fulfillment update.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'required' => false,
'context' => array( 'view', 'edit' ),
),
)
);
}
/**
* Get the schema for the meta data.
*
* @return array
*/
private function get_schema_for_meta_data(): array {
return array(
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'The unique identifier for the meta data. Set `0` for new records.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'key' => array(
'description' => __( 'The key of the meta data.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => array( 'view', 'edit' ),
),
'value' => array(
'description' => __( 'The value of the meta data.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'context' => array( 'view', 'edit' ),
),
),
'required' => true,
'context' => array( 'view', 'edit' ),
'readonly' => true,
);
}
/**
* Prepare an error response.
*
* @param string $code The error code.
* @param string $message The error message.
* @param int $status The HTTP status code.
*
* @return WP_REST_Response The error response.
*/
private function prepare_error_response( $code, $message, $status ): WP_REST_Response {
return new WP_REST_Response(
array(
'code' => $code,
'message' => $message,
'data' => array( 'status' => $status ),
),
$status
);
}
/**
* Validate the fulfillment.
*
* @param Fulfillment $fulfillment The fulfillment object.
* @param int $fulfillment_id The fulfillment ID.
* @param int $order_id The order ID.
*
* @throws \Exception If the fulfillment ID is invalid.
*/
private function validate_fulfillment( Fulfillment $fulfillment, int $fulfillment_id, int $order_id ) {
if ( $fulfillment->get_id() !== $fulfillment_id || $fulfillment->get_entity_type() !== WC_Order::class || $fulfillment->get_entity_id() !== "$order_id" ) {
throw new \Exception( esc_html__( 'Invalid fulfillment ID.', 'woocommerce' ) );
}
}
}
PK [1]SRE{ 7 Fulfillments/Providers/DeutschePostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/deutsche-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.deutschepost.de/sendung/simpleQuery.html?piececode=' . $tracking_number;
}
}
PK [1]~#e 4 Fulfillments/Providers/StarTrackShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/startrack.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.startrack.com.au/track/' . $tracking_number;
}
}
PK [1]v 8 Fulfillments/Providers/AustraliaPostShippingProvider.phpnu , confidence: int}>
*/
private const TRACKING_PATTERNS = array(
'AU' => array( // Australia.
'patterns' => array(
// International UPU S10 format with validation.
'/^[A-Z]{2}\d{9}AU$/', // XX#########AU.
'/^[A-Z]{2}\d{7}AU$/', // Alternative international format: XX#######AU.
// Domestic numeric tracking formats.
'/^\d{13}$/', // 13-digit domestic tracking.
'/^\d{12}$/', // 12-digit domestic tracking.
'/^\d{11}$/', // 11-digit domestic tracking.
// Standard alphanumeric formats.
'/^[A-Z]{2}\d{8}[A-Z]{2}$/', // Standard format: XX########XX.
'/^[A-Z]{1}\d{10}[A-Z]{1}$/', // Domestic format: X##########X.
// Service-specific patterns.
'/^[A-Z]{4}\d{8}$/', // Express Post format: XXXX########.
'/^EP\d{10}$/', // Express Post specific.
'/^ST\d{10}$/', // StarTrack (freight).
'/^MB\d{10}$/', // MyPost Business.
'/^PO\d{10}$/', // Post Office Box.
// MyPost Digital formats.
'/^MP\d{10,12}$/', // MyPost tracking.
'/^DG\d{10,12}$/', // Digital tracking.
// Parcel numeric formats.
'/^7\d{15}$/', // 16-digit format starting with 7.
'/^3\d{15}$/', // 16-digit format starting with 3.
'/^8\d{15}$/', // 16-digit format starting with 8.
// eParcel formats.
'/^[A-Z]{3}\d{8,12}$/', // Three-letter prefix.
'/^33\d?[A-Z]{2}\d{18,20}$/', // StarTrack eParcel.
'/^AP\d{10,13}$/', // Australia Post eParcel.
// Legacy and alternative formats.
'/^[0-9]{10}[A-Z]{2}$/', // 10 digits + 2 letters.
'/^[A-Z]{1}\d{8}[A-Z]{3}$/', // Alternative format.
),
'confidence' => 90,
),
);
/**
* Get the unique key for this shipping provider.
*
* @return string Unique key.
*/
public function get_key(): string {
return 'australia-post';
}
/**
* Get the name of this shipping provider.
*
* @return string Name of the shipping provider.
*/
public function get_name(): string {
return 'Australia Post';
}
/**
* Get the icon URL for this shipping provider.
*
* @return string URL of the shipping provider icon.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/australia-post.png';
}
/**
* Get the countries this shipping provider can ship from.
*
* @return array List of country codes.
*/
public function get_shipping_from_countries(): array {
return array_keys( self::TRACKING_PATTERNS );
}
/**
* Get the countries this shipping provider can ship to.
*
* Australia Post ships internationally, so we return a comprehensive list.
*
* @return array List of country codes.
*/
public function get_shipping_to_countries(): array {
return array( 'AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AR', 'AS', 'AT', 'AU', 'AW', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BM', 'BN', 'BO', 'BR', 'BS', 'BT', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW' );
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number to generate the URL for.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://auspost.com.au/mypost/track/details/' . rawurlencode( $tracking_number );
}
/**
* Validate tracking number against country-specific patterns.
*
* @param string $tracking_number The tracking number to validate.
* @param string $country_code The country code for the shipment.
* @return bool True if valid, false otherwise.
*/
private function validate_country_pattern( string $tracking_number, string $country_code ): bool {
if ( ! isset( self::TRACKING_PATTERNS[ $country_code ] ) ) {
return false;
}
foreach ( self::TRACKING_PATTERNS[ $country_code ]['patterns'] as $pattern ) {
if ( preg_match( $pattern, $tracking_number ) ) {
return true;
}
}
return false;
}
/**
* Try to parse an Australia Post tracking number.
*
* @param string $tracking_number The tracking number to parse.
* @param string $shipping_from The country code of the shipping origin.
* @param string $shipping_to The country code of the shipping destination.
* @return array|null An array with 'url' and 'ambiguity_score' if valid, null otherwise.
*/
public function try_parse_tracking_number(
string $tracking_number,
string $shipping_from,
string $shipping_to
): ?array {
if ( empty( $tracking_number ) || empty( $shipping_from ) || empty( $shipping_to ) ) {
return null;
}
$normalized = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) );
if ( empty( $normalized ) ) {
return null;
}
$shipping_from = strtoupper( $shipping_from );
$shipping_to = strtoupper( $shipping_to );
// Australia Post ships only from Australia.
if ( 'AU' !== $shipping_from ) {
return null;
}
if ( $this->validate_country_pattern( $normalized, $shipping_from ) ) {
$confidence = self::TRACKING_PATTERNS[ $shipping_from ]['confidence'];
// Check digit validation for numeric formats.
if ( preg_match( '/^\d{11,13}$/', $normalized ) ) {
if ( FulfillmentUtils::validate_mod10_check_digit( $normalized ) ) {
$confidence = min( 98, $confidence + 8 );
}
}
// UPU S10 validation for international formats.
if ( preg_match( '/^[A-Z]{2}\d{7,9}AU$/', $normalized ) ) {
if ( FulfillmentUtils::check_s10_upu_format( $normalized ) ) {
$confidence = min( 98, $confidence + 8 );
}
}
// Service-specific confidence boosts.
if ( preg_match( '/^(EP|ST|MB)\d+/', $normalized ) ) {
$confidence = min( 95, $confidence + 5 );
}
// Boost confidence for domestic shipments.
if ( 'AU' === $shipping_to ) {
$confidence = min( 98, $confidence + 5 );
}
// Boost confidence for Asia-Pacific destinations.
$apac_destinations = array( 'NZ', 'SG', 'HK', 'JP', 'KR', 'TH', 'MY', 'ID', 'PH', 'VN', 'IN' );
if ( in_array( $shipping_to, $apac_destinations, true ) ) {
$confidence = min( 95, $confidence + 3 );
}
// Boost confidence for common destinations.
$common_destinations = array( 'US', 'GB', 'CA', 'DE', 'FR' );
if ( in_array( $shipping_to, $common_destinations, true ) ) {
$confidence = min( 93, $confidence + 2 );
}
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => $confidence,
);
}
return null;
}
}
PK [1] 2 2 Fulfillments/Providers/HayPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/haypost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.haypost.am/en/track/' . $tracking_number;
}
}
PK [1] 9 Fulfillments/Providers/NewZealandPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/new-zealand-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.nzpost.co.nz/tools/tracking?track=' . $tracking_number;
}
}
PK [1]Y`
7 Fulfillments/Providers/YurticiKargoShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/yurtici-kargo.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.yurticikargo.com/Tracking/Detail/' . $tracking_number;
}
}
PK [1]r / Fulfillments/Providers/SeurShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/seur.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.seur.com/seguimiento/' . $tracking_number;
}
}
PK [1]ٿ> 5 Fulfillments/Providers/NovaPoshtaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/nova-poshta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://novaposhta.ua/en/tracking/' . $tracking_number;
}
}
PK [1]} - - ; Fulfillments/Providers/LaPosteColissimoShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/la-poste-colissimo.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.laposte.fr/outils/suivre-vos-envois?code=' . $tracking_number;
}
}
PK [1]&o
8 Fulfillments/Providers/PostaMoldoveiShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/posta-moldovei.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.posta.md/track/' . $tracking_number;
}
}
PK [1]plugin_url() ) . '/assets/images/shipping_providers/sda.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.sda.it/track/' . $tracking_number;
}
}
PK [1]z"d 4 Fulfillments/Providers/MaltaPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/maltapost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.maltapost.com/track/' . $tracking_number;
}
}
PK [1]vn 3 Fulfillments/Providers/HelthjemShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/helthjem.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.helthjem.no/sporing/' . $tracking_number;
}
}
PK [1]] A
: Fulfillments/Providers/MakedonskaPostaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/makedonska-posta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.posta.gov.mk/track/' . $tracking_number;
}
}
PK [1] 4 Fulfillments/Providers/SwissPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/swiss-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.post.ch/en/parcel-tracking?itemId=' . $tracking_number;
}
}
PK [1]Zn 0 Fulfillments/Providers/BpostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/bpost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.bpost.be/en/track-and-trace?itemId=' . $tracking_number;
}
}
PK [1]y+) 3 Fulfillments/Providers/AbstractShippingProvider.phpnu get_shipping_from_countries(), true );
}
/**
* Check if the shipping provider can ship to a specific country.
*
* @param string $country_code The country code to check.
* @return bool True if the provider can ship to the country, false otherwise.
*/
public function can_ship_to( string $country_code ): bool {
return in_array( $country_code, $this->get_shipping_to_countries(), true );
}
/**
* Check if the shipping provider can ship from a specific country to another.
*
* @param string $shipping_from The country code from which the shipment is sent.
* @param string $shipping_to The country code to which the shipment is sent.
* @return bool True if the provider can ship from the source to the destination, false otherwise.
*/
public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
return $this->can_ship_from( $shipping_from ) && $this->can_ship_to( $shipping_to );
}
/**
* Get the tracking URL for a given tracking number with additional parameters.
*
* @param string $tracking_number The tracking number.
* @param string $shipping_from The country code from which the shipment is sent.
* @param string $shipping_to The country code to which the shipment is sent.
*
* @return array|null The tracking URL with ambiguity score, or null if parsing fails.
*
* phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): ?array {
return null; // Default implementation returns null, subclasses should override this method.
}
}
PK [1] 9 Fulfillments/Providers/PostLuxembourgShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/post-luxembourg.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.post.lu/en/track/' . $tracking_number;
}
}
PK [1] j 5 Fulfillments/Providers/CyprusPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/cyprus-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.cypruspost.post/en/track/' . $tracking_number;
}
}
PK [1]tP 5 Fulfillments/Providers/CeskaPostaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/ceska-posta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.postaonline.cz/trackandtrace/' . $tracking_number;
}
}
PK [1]؝ 6 Fulfillments/Providers/ParcelForceShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/parcelforce.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.parcelforce.com/track-trace/' . $tracking_number;
}
}
PK [1]\[ 6 Fulfillments/Providers/RussianPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/russian-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.pochta.ru/tracking/' . $tracking_number;
}
}
PK [1]]m 5 Fulfillments/Providers/ZasilkovnaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/zasilkovna.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.zasilkovna.cz/track/' . $tracking_number;
}
}
PK [1]7 7 Fulfillments/Providers/PocztaPolskaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/poczta-polska.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://emonitoring.poczta-polska.pl/track/' . $tracking_number;
}
}
PK [1]K{+ + A Fulfillments/Providers/LiechtensteinischePostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/liechtensteinische-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.post.li/en/track/' . $tracking_number;
}
}
PK [1]j+ : Fulfillments/Providers/SpeeDeeDeliveryShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/spee-dee-delivery.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.speedeedelivery.com/track/' . $tracking_number;
}
}
PK [1]S 3 Fulfillments/Providers/PostNordShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/postnord.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.postnord.se/track-and-trace/' . $tracking_number;
}
}
PK [1]m+ 5 Fulfillments/Providers/FanCourierShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/fan-courier.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.fancourier.ro/urmarire/' . $tracking_number;
}
}
PK [1]5 : Fulfillments/Providers/AmazonLogisticsShippingProvider.phpnu
*/
private array $operating_countries = array( 'US', 'CA', 'GB', 'DE', 'FR', 'BE', 'NL', 'IT', 'IN', 'MX', 'JP', 'AU', 'ES', 'CN', 'HK', 'SG', 'GG', 'JE', 'IM', 'GI', 'AT', 'CH', 'PL', 'SE', 'DK', 'NO', 'FI', 'IE', 'PT', 'CZ', 'HU', 'RO', 'BG', 'HR', 'SK', 'SI', 'EE', 'LV', 'LT', 'CY', 'MT', 'LU', 'GR', 'BR', 'TR', 'AE', 'SA', 'EG', 'KW', 'IL', 'ZA', 'KR', 'TW', 'TH', 'MY', 'ID', 'PH', 'VN', 'NZ' );
/**
* Gets the unique provider key.
*
* @return string The provider key 'amazon-logistics'.
*/
public function get_key(): string {
return 'amazon-logistics';
}
/**
* Gets the display name of the provider.
*
* @return string The provider name 'Amazon Logistics'.
*/
public function get_name(): string {
return 'Amazon Logistics';
}
/**
* Gets the path to the provider's icon.
*
* @return string URL to the Amazon Logistics logo image.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/amazon-logistics.png';
}
/**
* Gets the list of origin countries supported by Amazon Logistics.
*
* @return array Array of country codes.
*/
public function get_shipping_from_countries(): array {
return $this->operating_countries;
}
/**
* Gets the list of destination countries supported by Amazon Logistics.
*
* @return array Array of country codes.
*/
public function get_shipping_to_countries(): array {
return $this->operating_countries;
}
/**
* Checks if Amazon Logistics can ship between two countries.
*
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return bool True if shipping route is supported.
*/
public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
return in_array( $shipping_from, $this->operating_countries, true ) &&
in_array( $shipping_to, $this->operating_countries, true );
}
/**
* Generates the tracking URL for an Amazon Logistics tracking number.
*
* @param string $tracking_number The tracking number to generate URL for.
* @return string The complete tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.amazon.com/progress-tracker/package/ref=ppx_yo_dt_b_track_package_o0?_=' .
strtoupper( rawurlencode( $tracking_number ) );
}
/**
* Validates and parses an Amazon Logistics tracking number.
*
* @param string $tracking_number The tracking number to validate.
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return array|null Array with tracking URL and score, or null if invalid.
*/
public function try_parse_tracking_number(
string $tracking_number,
string $shipping_from,
string $shipping_to
): ?array {
if ( empty( $tracking_number ) || ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
return null;
}
$tracking_number = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) );
// Amazon Logistics tracking number patterns with region/service differentiation.
$patterns = array(
// North America patterns.
'/^TBA\d{12}$/' => fn() => 'US' === $shipping_from ? 100 : 95, // US standard format.
'/^TBC\d{12}$/' => fn() => 'CA' === $shipping_from ? 100 : 90, // Canada standard format.
'/^TBM\d{12}$/' => fn() => 'MX' === $shipping_from ? 100 : 85, // Mexico standard format.
// European patterns.
'/^CC\d{12}$/' => fn() => in_array( $shipping_from, array( 'FR', 'BE', 'NL', 'DE' ), true ) ? 95 : 80, // Continental Europe.
'/^GBA\d{12}$/' => fn() => 'GB' === $shipping_from ? 100 : 85, // United Kingdom.
'/^UK\d{10}$/' => fn() => 'GB' === $shipping_from ? 100 : 85, // United Kingdom.
'/^W[A-Z]\d{9}GB$/' => fn() => 'GB' === $shipping_from ? 99 : 85, // Amazon UK specific pattern.
'/^[A-Z]{2}\d{9}GB$/' => fn() => 'GB' === $shipping_from ? 92 : 75, // United Kingdom.
'/^AM\d{12}$/' => fn() => in_array( $shipping_from, array( 'DE', 'FR', 'IT', 'ES' ), true ) ? 95 : 80, // Amazon Europe.
'/^D\d{13}$/' => fn() => 'DE' === $shipping_from ? 95 : 75, // Germany specific.
// Asia-Pacific patterns.
'/^RB\d{12}$/' => fn() => in_array( $shipping_from, array( 'CN', 'HK' ), true ) ? 95 : 75, // China/Hong Kong.
'/^ZZ\d{12}$/' => fn() => 'AU' === $shipping_from ? 100 : 80, // Australia.
'/^ZX\d{12}$/' => fn() => 'IN' === $shipping_from ? 100 : 85, // India.
'/^JP\d{12}$/' => fn() => 'JP' === $shipping_from ? 100 : 85, // Japan.
'/^SG\d{12}$/' => fn() => 'SG' === $shipping_from ? 100 : 85, // Singapore.
// Amazon Fresh/Whole Foods.
'/^AF\d{12}$/' => fn() => 'US' === $shipping_from ? 98 : 80, // Amazon Fresh US.
'/^WF\d{12}$/' => fn() => 'US' === $shipping_from ? 98 : 80, // Whole Foods US.
// Amazon Business.
'/^AB\d{12}$/' => fn() => in_array( $shipping_from, array( 'US', 'GB', 'DE', 'FR' ), true ) ? 95 : 80, // Amazon Business.
// Legacy and alternative formats.
'/^TB[A-Z]\d{11}$/' => fn() => in_array( $shipping_from, array( 'US', 'CA', 'MX' ), true ) ? 90 : 70, // Variable third character.
'/^AZ\d{12}$/' => fn() => in_array( $shipping_from, array( 'US', 'GB', 'DE' ), true ) ? 88 : 75, // Alternative format.
// Amazon Pantry/Subscribe & Save.
'/^AP\d{12}$/' => fn() => 'US' === $shipping_from ? 90 : 75, // Pantry US.
'/^SS\d{12}$/' => fn() => 'US' === $shipping_from ? 90 : 75, // Subscribe & Save US.
// Fallback: 15-20 character Amazon codes (future-proof, low confidence).
'/^[A-Z0-9]{15,20}$/' => fn() => 60,
);
foreach ( $patterns as $pattern => $score_callback ) {
if ( preg_match( $pattern, $tracking_number ) ) {
return array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => $score_callback(),
);
}
}
return null;
}
}
PK [1]N= 7 Fulfillments/Providers/UrgentCargusShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/urgent-cargus.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.urgentcargus.ro/urmarire/' . $tracking_number;
}
}
PK [1]j 7 Fulfillments/Providers/MondialRelayShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/mondial-relay.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.mondialrelay.fr/suivi-colis/' . $tracking_number;
}
}
PK [1]GXhZ 5 Fulfillments/Providers/ChronopostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/chronopost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.chronopost.fr/en/track/' . $tracking_number;
}
}
PK [1]9 2 Fulfillments/Providers/CorreosShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/correos.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.correos.es/ss/Satellite/site/pagina-tracking/info?idioma=en_GB&numeroEnvio=' . $tracking_number;
}
}
PK [1]~ 5 Fulfillments/Providers/ACSCourierShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/acs-courier.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.acscourier.com/track?tracking_number=' . $tracking_number;
}
}
PK [1]LH . Fulfillments/Providers/MRWShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/mrw.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.mrw.es/seguimiento/' . $tracking_number;
}
}
PK [1]h% % 9 Fulfillments/Providers/BulgarianPostsShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/bulgarian-posts.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.bulgarianposts.bg/en/track-and-trace?trackingNumber=' . $tracking_number;
}
}
PK [1]ƻ 6 Fulfillments/Providers/PostaRomanaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/posta-romana.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.posta-romana.ro/urmărire-colet/' . $tracking_number;
}
}
PK [1]8Y 3 Fulfillments/Providers/AzerpostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/azerpost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.azerpost.az/track/' . $tracking_number;
}
}
PK [1]:/
1 Fulfillments/Providers/AnPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/an-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.anpost.com/Track/Track?item=' . $tracking_number;
}
}
PK [1]vY 4 Fulfillments/Providers/PurolatorShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/purolator.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.purolator.com/en/shipping/tracking/' . $tracking_number;
}
}
PK [1]V4 0 Fulfillments/Providers/FedExShippingProvider.phpnu
*/
private array $supported_countries = array( 'US', 'CA', 'GB', 'DE', 'FR', 'AU', 'JP', 'MX', 'CN', 'IN', 'IT', 'ES', 'NL', 'BE', 'CH', 'AT', 'BR', 'SG' );
/**
* Gets the unique provider key.
*
* @return string The provider key 'fedex'.
*/
public function get_key(): string {
return 'fedex';
}
/**
* Gets the display name of the provider.
*
* @return string The provider name 'FedEx'.
*/
public function get_name(): string {
return 'FedEx';
}
/**
* Gets the path to the provider's icon.
*
* @return string URL to the FedEx logo image.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/fedex.png';
}
/**
* Generates the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number to generate URL for.
* @return string The complete tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.fedex.com/fedextrack/?tracknumbers=' . rawurlencode( $tracking_number );
}
/**
* Gets the list of origin countries supported by FedEx.
*
* @return array Array of country codes.
*/
public function get_shipping_from_countries(): array {
return $this->supported_countries;
}
/**
* Gets the list of destination countries supported by FedEx.
*
* @return array Array of country codes.
*/
public function get_shipping_to_countries(): array {
return $this->supported_countries;
}
/**
* Checks if FedEx can ship between two countries.
*
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return bool True if shipping route is supported.
*/
public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
return in_array( $shipping_from, $this->supported_countries, true ) &&
in_array( $shipping_to, $this->supported_countries, true );
}
/**
* Validates and parses a FedEx tracking number.
*
* @param string $tracking_number The tracking number to validate.
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return array|null Array with tracking URL and score, or null if invalid.
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): ?array {
if ( empty( $tracking_number ) || ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
return null;
}
$tracking_number = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) ); // Remove spaces and uppercase for consistency.
$is_north_america = in_array( $shipping_from, array( 'US', 'CA' ), true ); // North America flag for scoring.
$is_us_domestic = 'US' === $shipping_from && 'US' === $shipping_to; // US domestic flag for scoring.
// FedEx tracking number patterns with enhanced validation and comments.
$patterns = array(
// FedEx Door Tag: DT + 12 digits (US/CA only).
'/^DT\d{12}$/' => $is_north_america ? 90 : 0,
// FedEx Custom Critical: 0 or 1 followed by 13-23 digits (very rare, highest confidence).
'/^0[01]\d{13,23}$/' => 98,
// FedEx SmartPost: 023 + 17 digits (US only, SmartPost).
'/^023\d{17}$/' => 97,
// FedEx SmartPost: 58 + 17-19 digits (older SmartPost).
'/^58\d{17,19}$/' => 96,
// FedEx Express: 12 digits (most common, with check digit validation).
'/^\d{12}$/' => function () use ( $tracking_number, $is_north_america, $is_us_domestic ) {
if ( FulfillmentUtils::validate_fedex_check_digit( $tracking_number ) ) {
return $is_north_america || $is_us_domestic ? 98 : 85; // High confidence if check digit valid.
}
return $is_north_america ? ( $is_us_domestic ? 98 : 85 ) : 70; // Lower if check digit invalid.
},
// FedEx Express: 15 digits (less common, with check digit validation).
'/^\d{15}$/' => function () use ( $tracking_number, $is_north_america ) {
if ( FulfillmentUtils::validate_fedex_check_digit( $tracking_number ) ) {
return $is_north_america ? 96 : 80; // High confidence if check digit valid.
}
return $is_north_america ? 80 : 65; // Lower if check digit invalid.
},
// FedEx Express: 14 digits (with check digit validation).
'/^\d{14}$/' => function () use ( $tracking_number, $is_north_america ) {
if ( FulfillmentUtils::validate_fedex_check_digit( $tracking_number ) ) {
return $is_north_america ? 95 : 78; // High confidence if check digit valid.
}
return $is_north_america ? 78 : 60; // Lower if check digit invalid.
},
// FedEx Express: 34 digits (rare, international bulk shipments).
'/^\d{34}$/' => 90,
// FedEx Ground: 96 + 18-20 digits (US/CA only).
'/^96\d{18,20}$/' => $is_north_america ? 95 : 60,
// FedEx Ground: 7 + 11-20 digits (US/CA only, legacy).
'/^7\d{11,20}$/' => $is_north_america ? 90 : 75,
// FedEx Freight: 97 + 13-23 digits (Freight/LTL).
'/^97\d{13,23}$/' => 93,
// FedEx Express International: 3 + 10-14 digits (Europe/Asia).
'/^3\d{10,14}$/' => 92,
// FedEx International Priority: 8 + 8-14 digits (Europe/Asia).
'/^8\d{8,14}$/' => function () use ( $shipping_from ) {
return in_array( $shipping_from, array( 'GB', 'DE', 'FR', 'IT', 'ES', 'NL' ), true ) ? 93 : 75;
},
// FedEx Express Next Flight Out: NFO + 10-15 digits.
'/^NFO\d{10,15}$/' => 92,
// FedEx SameDay: SD + 10-15 digits.
'/^SD\d{10,15}$/' => 90,
// Fallback: 20 digit numeric (used by some international and legacy services).
'/^\d{20}$/' => 70,
// Fallback: 22 digit numeric (rare, legacy).
'/^\d{22}$/' => 65,
);
foreach ( $patterns as $pattern => $base_score ) {
if ( preg_match( $pattern, $tracking_number ) ) {
$score = is_callable( $base_score ) ? $base_score() : $base_score;
if ( $score > 0 ) {
return array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => $score,
);
}
}
}
return null; // No matching pattern found.
}
}
PK [1]M 7 Fulfillments/Providers/BartoliniBRTShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/bartolini-brt.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.brt.it/track?trackingNumber=' . $tracking_number;
}
}
PK [1]| / Fulfillments/Providers/CDEKShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/cdek.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.cdek.ru/track.html?trackingNumber=' . $tracking_number;
}
}
PK [1]!4 ; Fulfillments/Providers/PostenNorgeBringShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/posten-norge-bring.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.posten.no/sporing/' . $tracking_number;
}
}
PK [1]5'_ < Fulfillments/Providers/GenikiTaxydromikiShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/geniki-taxydromiki.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.taxydromiki.com.gr/track/' . $tracking_number;
}
}
PK [1]M2PӨ . Fulfillments/Providers/UPSShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/ups.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.ups.com/track?tracknum=' . rawurlencode( $tracking_number );
}
/**
* Get the countries from which this provider can ship.
*
* @return array An array of country codes.
*/
public function get_shipping_from_countries(): array {
return $this->international_shipping_countries;
}
/**
* Get the countries to which this provider can ship.
*
* @return array An array of country codes.
*/
public function get_shipping_to_countries(): array {
return $this->international_shipping_countries;
}
/**
* Check if this provider can ship from a specific country.
*
* @param string $shipping_from The country code from which the shipment is sent.
* @param string $shipping_to The country code to which the shipment is sent.
*
* @return bool True if this provider can ship from the country, false otherwise.
*/
public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
if ( $shipping_from === $shipping_to ) {
return in_array( $shipping_from, $this->domestic_shipping_countries, true ) ||
in_array( $shipping_from, $this->domestic_but_international_tracking, true );
} else {
return in_array( $shipping_from, $this->international_shipping_countries, true ) &&
in_array( $shipping_to, $this->international_shipping_countries, true );
}
}
/**
* Try to parse the tracking number with additional parameters.
*
* @param string $tracking_number The tracking number.
* @param string $shipping_from The country code from which the shipment is sent.
* @param string $shipping_to The country code to which the shipment is sent.
*
* @return array|null The tracking URL with ambiguity score, or null if parsing fails.
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): ?array {
if ( empty( $tracking_number ) || empty( $shipping_from ) || empty( $shipping_to ) || ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
return null;
}
$tracking_number = strtoupper( $tracking_number );
$is_domestic_shipping = $shipping_from === $shipping_to;
// UPS tracking number patterns (ordered by confidence).
$patterns = array(
// 1Z format (standard UPS) - 18 chars, check digit validation.
'/^1Z[0-9A-Z]{16}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::validate_ups_1z_check_digit( $tracking_number ) ? 100 : 95;
},
// Numeric only: 12 digits (common for UPS Air/Ground, with mod10 check digit).
'/^\d{12}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::validate_mod10_check_digit( $tracking_number ) ? 90 : 80;
},
// Numeric only: 9 or 10 digits (legacy/freight).
'/^\d{10}$/' => 75,
'/^\d{9}$/' => 70,
// T, H, or V prefix + 10 digits (special international/freight).
'/^[THV]\d{10}$/' => 85,
// UPS InfoNotice (J + 10 digits).
'/^J\d{10}$/' => 80,
// UPS Mail Innovations Parcel ID (MI + 6 digits + up to 22 alphanum).
'/^MI\d{6}[A-Z0-9]{6,22}$/' => 80,
// USPS Delivery Confirmation (Mail Innovations, 22–34 digits).
'/^9\d{21,33}$/' => function () use ( $shipping_from ) {
return in_array( $shipping_from, array( 'US', 'CA' ), true ) ? 85 : 70;
},
// UPU S10 format (international, e.g. 'AA123456789CC').
'/^[A-Z]{2}\d{9}[A-Z]{2}$/' => function () use ( $shipping_from ) {
return in_array( $shipping_from, $this->domestic_but_international_tracking, true ) ? 80 : 65;
},
// Long mail format (22 digits).
'/^\d{22}$/' => 60,
);
$match = false;
$ambiguity_score = 0;
foreach ( $patterns as $pattern => $score ) {
if ( preg_match( $pattern, $tracking_number ) ) {
$match = true;
$ambiguity_score = is_callable( $score ) ? $score() : $score;
break;
}
}
// Boost score for domestic-but-international-tracking countries.
if ( $match && $is_domestic_shipping && in_array( $shipping_from, $this->domestic_but_international_tracking, true ) ) {
$ambiguity_score += 5;
}
return $match ? array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => $ambiguity_score,
) : null;
}
}
PK [1]- 4 Fulfillments/Providers/BelpochtaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/belpochta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.belpost.by/track/' . $tracking_number;
}
}
PK [1]{C 2 Fulfillments/Providers/EimskipShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/eimskip.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.eimskip.is/track/' . $tracking_number;
}
}
PK [1] 0 Fulfillments/Providers/EcontShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/econt.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.econt.com/en/track/' . $tracking_number;
}
}
PK [1]_ . Fulfillments/Providers/CTTShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/ctt.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.ctt.pt/feapl_2/app/open/objectTrackingSearch.do?objectCode=' . $tracking_number;
}
}
PK [1] ) 1 Fulfillments/Providers/OmnivaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/omniva.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.omniva.ee/track/' . $tracking_number;
}
}
PK [1]JrT" T" 5 Fulfillments/Providers/CanadaPostShippingProvider.phpnu , confidence: int}>
*/
private const TRACKING_PATTERNS = array(
'CA' => array( // Canada.
'patterns' => array(
// UPU S10 international format (outbound).
'/^[A-Z]{2}\d{9}CA$/', // Standard format: XX#########CA.
// UPU S10 international (inbound/other countries, fallback).
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // Any S10/UPU code.
// Domestic numeric formats.
'/^\d{16}$/', // 16-digit domestic tracking.
'/^\d{15}$/', // 15-digit legacy/partner/returns.
'/^\d{14}$/', // 14-digit legacy/partner/returns.
'/^\d{13}$/', // 13-digit domestic (most common).
'/^\d{12}$/', // 12-digit domestic.
'/^\d{10}$/', // 10-digit legacy.
'/^\d{9}$/', // 9-digit legacy.
'/^\d{8}$/', // 8-digit calling card/legacy.
// Service-specific patterns.
'/^XP\d{9}CA$/', // Xpresspost International.
'/^EX\d{9}CA$/', // Express International.
'/^PR\d{9}CA$/', // Priority.
'/^RG\d{9}CA$/', // Regular (deprecated, legacy).
'/^RM\d{9}CA$/', // Registered Mail.
'/^CM\d{9}CA$/', // Certified Mail.
'/^[A-Z]{2}\d{7}[A-Z]{2}$/', // International format: XX#######XX.
'/^[A-Z]{1}\d{9}[A-Z]{1}$/', // Domestic formats: X#########X.
'/^FD\d{10,12}$/', // FlexDelivery.
'/^PO\d{10,12}$/', // Post Office Box service.
'/^CP\d{10,14}$/', // Canada Post business.
'/^SM\d{10,14}$/', // Small packet.
// Legacy and alternative formats.
'/^[0-9]{13}[A-Z]{1}$/', // 13 digits + 1 letter.
),
'confidence' => 92,
),
);
/**
* Get the unique key for this shipping provider.
*
* @return string Unique key.
*/
public function get_key(): string {
return 'canada-post';
}
/**
* Get the name of this shipping provider.
*
* @return string Name of the shipping provider.
*/
public function get_name(): string {
return 'Canada Post';
}
/**
* Get the icon URL for this shipping provider.
*
* @return string URL of the shipping provider icon.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/canada-post.png';
}
/**
* Get the countries this shipping provider can ship from.
*
* @return array List of country codes.
*/
public function get_shipping_from_countries(): array {
return array_keys( self::TRACKING_PATTERNS );
}
/**
* Get the countries this shipping provider can ship to.
*
* Canada Post ships internationally, so we return a comprehensive list.
*
* @return array List of country codes.
*/
public function get_shipping_to_countries(): array {
return array( 'AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW' );
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number to generate the URL for.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.canadapost-postescanada.ca/track-reperage/en#/search?searchFor=' . rawurlencode( $tracking_number );
}
/**
* Validate tracking number against country-specific patterns.
*
* @param string $tracking_number The tracking number to validate.
* @param string $country_code The country code for the shipment.
* @return bool True if valid, false otherwise.
*/
private function validate_country_pattern( string $tracking_number, string $country_code ): bool {
if ( ! isset( self::TRACKING_PATTERNS[ $country_code ] ) ) {
return false;
}
foreach ( self::TRACKING_PATTERNS[ $country_code ]['patterns'] as $pattern ) {
if ( preg_match( $pattern, $tracking_number ) ) {
return true;
}
}
return false;
}
/**
* Try to parse a Canada Post tracking number.
*
* @param string $tracking_number The tracking number to parse.
* @param string $shipping_from The country code of the shipping origin.
* @param string $shipping_to The country code of the shipping destination.
* @return array|null An array with 'url' and 'ambiguity_score' if valid, null otherwise.
*/
public function try_parse_tracking_number(
string $tracking_number,
string $shipping_from,
string $shipping_to
): ?array {
if ( empty( $tracking_number ) || empty( $shipping_from ) || empty( $shipping_to ) ) {
return null;
}
$normalized = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) ); // Normalize input.
if ( empty( $normalized ) ) {
return null;
}
$shipping_from = strtoupper( $shipping_from );
$shipping_to = strtoupper( $shipping_to );
// Check if shipping from Canada.
if ( 'CA' !== $shipping_from ) {
return null;
}
// Check country-specific patterns with enhanced validation.
if ( $this->validate_country_pattern( $normalized, $shipping_from ) ) {
$confidence = self::TRACKING_PATTERNS[ $shipping_from ]['confidence'];
// Apply UPU S10 validation for international formats.
if ( preg_match( '/^[A-Z]{2}\d{9}CA$/', $normalized ) ) {
if ( FulfillmentUtils::check_s10_upu_format( $normalized ) ) {
$confidence = min( 98, $confidence + 6 ); // Strong boost for valid UPU.
}
} elseif ( preg_match( '/^[A-Z]{2}\d{9}[A-Z]{2}$/', $normalized ) ) {
// Apply S10/UPU fallback with lower confidence.
if ( FulfillmentUtils::check_s10_upu_format( $normalized ) ) {
$confidence = min( 94, $confidence + 2 ); // Lower boost for inbound S10.
}
}
// Apply check digit validation for numeric formats.
if ( preg_match( '/^\d{12,16}$/', $normalized ) ) {
if ( FulfillmentUtils::validate_mod10_check_digit( $normalized ) ) {
$confidence = min( 96, $confidence + 4 ); // Boost for valid check digit.
}
}
// Service-specific confidence boosts.
if ( preg_match( '/^(XP|EX|PR)\d+/', $normalized ) ) {
$confidence = min( 96, $confidence + 4 ); // Express/Priority services.
} elseif ( preg_match( '/^(RM|CM)\d+/', $normalized ) ) {
$confidence = min( 95, $confidence + 3 ); // Registered/Certified.
} elseif ( preg_match( '/^(FD|PO|CP|SM)\d+/', $normalized ) ) {
$confidence = min( 94, $confidence + 2 ); // Special services.
}
// Boost confidence for domestic shipments.
if ( 'CA' === $shipping_to ) {
$confidence = min( 98, $confidence + 3 );
}
// Boost for North American destinations.
if ( in_array( $shipping_to, array( 'US', 'MX' ), true ) ) {
$confidence = min( 95, $confidence + 2 );
}
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => $confidence,
);
}
return null;
}
}
PK [1]s"/ 2 Fulfillments/Providers/FastwayShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/fastway.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.fastway.ie/track/' . $tracking_number;
}
}
PK [1]h / Fulfillments/Providers/ELTAShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/elta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://elta.gr/en/track/' . $tracking_number;
}
}
PK [1](~0 0 . Fulfillments/Providers/DPDShippingProvider.phpnu , confidence: int, services?: array}>
*/
private const TRACKING_PATTERNS = array(
'DE' => array( // Germany.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
'/^02\d{12}$/', // DPD Classic.
'/^05\d{12}$/', // DPD Express.
'/^09\d{12}$/', // DPD Predict.
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
'/^\d{24}$/', // 24-digit fallback.
),
'confidence' => 80,
'services' => array(
'classic' => 80,
'express' => 85,
'predict' => 85,
's10' => 90,
),
),
'GB' => array( // United Kingdom.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{9}GB$/',
'/^03\d{12}$/', // DPD Next Day.
'/^06\d{12}$/', // DPD Express.
'/^1[56]\d{12}$/', // Predict/Return.
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
'/^\d{24}$/', // 24-digit fallback.
),
'confidence' => 90,
'services' => array(
'next_day' => 88,
'express' => 88,
's10' => 90,
),
),
'FR' => array( // France.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
'/^02\d{12}$/', // DPD Relais.
'/^04\d{12}$/', // DPD Predict.
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
'/^\d{24}$/', // 24-digit fallback.
),
'confidence' => 78,
'services' => array(
'relais' => 82,
'predict' => 82,
's10' => 90,
),
),
'NL' => array( // Netherlands.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
'/^03\d{12}$/', // DPD Classic.
'/^07\d{12}$/', // DPD Express.
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
'/^\d{24}$/', // 24-digit fallback.
),
'confidence' => 78,
'services' => array(
'classic' => 82,
'express' => 85,
's10' => 90,
),
),
'BE' => array( // Belgium.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
'/^03\d{12}$/', // DPD Classic.
'/^08\d{12}$/', // DPD Express.
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
'/^\d{24}$/', // 24-digit fallback.
),
'confidence' => 78,
'services' => array(
'classic' => 82,
'express' => 85,
's10' => 90,
),
),
'PL' => array( // Poland.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
'/^[A-Z]{2}\d{9}[A-Z]{2}$/', // S10/UPU international.
'/^\d{24}$/', // 24-digit fallback.
),
'confidence' => 90,
),
'IE' => array( // Ireland.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{9}IE$/',
),
'confidence' => 85,
),
'AT' => array( // Austria.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 75, // Reduced: generic patterns.
),
'CH' => array( // Switzerland.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{9}CH$/',
),
'confidence' => 85,
),
'ES' => array( // Spain.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 85,
),
'IT' => array( // Italy.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 85,
),
'LU' => array( // Luxembourg.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 75, // Reduced: generic patterns.
),
'CZ' => array( // Czech Republic.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 90,
),
'SK' => array( // Slovakia.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 90,
),
'HU' => array( // Hungary.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 90,
),
'SI' => array( // Slovenia.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 80,
),
'HR' => array( // Croatia.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 80,
),
'RO' => array( // Romania.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 75,
),
'BG' => array( // Bulgaria.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 70,
),
'LT' => array( // Lithuania.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 70, // Reduced: generic patterns, limited DPD presence.
),
'LV' => array( // Latvia.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 70, // Reduced: generic patterns, limited DPD presence.
),
'EE' => array( // Estonia.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 70, // Reduced: generic patterns, limited DPD presence.
),
'FI' => array( // Finland.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 65, // Reduced: partnership-based, not direct DPD.
),
'DK' => array( // Denmark.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 65, // Reduced: partnership-based, not direct DPD.
),
'SE' => array( // Sweden.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 65, // Reduced: partnership-based, not direct DPD.
),
'NO' => array( // Norway.
'patterns' => array(
'/^\d{14}$/',
'/^\d{12}$/',
),
'confidence' => 60, // Reduced: limited DPD presence.
),
'GR' => array( // Greece.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 85,
),
'PT' => array( // Portugal.
'patterns' => array(
'/^\d{14}$/',
'/^[A-Z]{2}\d{10}$/',
),
'confidence' => 85,
),
);
/**
* International shipment pattern (28 digits)
*/
private const INTERNATIONAL_PATTERN = '/^\d{28}$/';
/**
* S10/UPU international pattern.
*/
private const S10_PATTERN = '/^[A-Z]{2}\d{9}[A-Z]{2}$/';
/**
* Get the unique key for this shipping provider.
*
* @return string Unique key.
*/
public function get_key(): string {
return 'dpd';
}
/**
* Get the name of this shipping provider.
*
* @return string Name of the shipping provider.
*/
public function get_name(): string {
return 'DPD';
}
/**
* Get the icon URL for this shipping provider.
*
* @return string URL of the shipping provider icon.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/dpd.png';
}
/**
* Get the description of this shipping provider.
*
* @return array Description of the shipping provider.
*/
public function get_shipping_from_countries(): array {
return array_keys( self::TRACKING_PATTERNS );
}
/**
* Get the countries this shipping provider can ship to.
*
* DPD typically ships within Europe, so we return the same countries as shipping from.
*
* @return array List of country codes.
*/
public function get_shipping_to_countries(): array {
return $this->get_shipping_from_countries();
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number to generate the URL for.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.dpd.com/tracking/' . rawurlencode( $tracking_number );
}
/**
* Validate tracking number against country-specific patterns and determine service type.
*
* @param string $tracking_number The tracking number to validate.
* @param string $country_code The country code for the shipment.
* @return array|bool Array with service info if valid, false otherwise.
*/
private function validate_country_pattern( string $tracking_number, string $country_code ) {
if ( ! isset( self::TRACKING_PATTERNS[ $country_code ] ) ) {
return false;
}
$country_data = self::TRACKING_PATTERNS[ $country_code ];
$detected_service = null;
$confidence_boost = 0;
// Check service-specific patterns first.
if ( isset( $country_data['services'] ) ) {
if ( preg_match( '/^02\d{12}$/', $tracking_number ) ) {
$detected_service = 'classic';
$confidence_boost = $country_data['services']['classic'] ?? 0;
} elseif ( preg_match( '/^0[34578]\d{12}$/', $tracking_number ) ) {
$detected_service = 'express';
$confidence_boost = $country_data['services']['express'] ?? 0;
} elseif ( preg_match( '/^0[49]\d{12}$/', $tracking_number ) ) {
$detected_service = 'predict';
$confidence_boost = $country_data['services']['predict'] ?? 0;
} elseif ( preg_match( '/^03\d{12}$/', $tracking_number ) && 'GB' === $country_code ) {
$detected_service = 'next_day';
$confidence_boost = $country_data['services']['next_day'] ?? 0;
} elseif ( preg_match( '/^02\d{12}$/', $tracking_number ) && 'FR' === $country_code ) {
$detected_service = 'relais';
$confidence_boost = $country_data['services']['relais'] ?? 0;
} elseif ( preg_match( self::S10_PATTERN, $tracking_number ) ) {
$detected_service = 's10';
$confidence_boost = $country_data['services']['s10'] ?? 90;
}
}
// Check all patterns.
foreach ( $country_data['patterns'] as $pattern ) {
if ( preg_match( $pattern, $tracking_number ) ) {
return array(
'valid' => true,
'service' => $detected_service,
'confidence_boost' => $confidence_boost,
);
}
}
return false;
}
/**
* Try to parse a DPD tracking number.
*
* @param string $tracking_number The tracking number to parse.
* @param string $shipping_from The country code of the shipping origin.
* @param string $shipping_to The country code of the shipping destination.
* @return array|null An array with 'url' and 'ambiguity_score' if valid, null otherwise.
*/
public function try_parse_tracking_number(
string $tracking_number,
string $shipping_from,
string $shipping_to
): ?array {
if ( empty( $tracking_number ) || empty( $shipping_from ) || empty( $shipping_to ) ) {
return null;
}
$normalized = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) );
if ( empty( $normalized ) ) {
return null;
}
$shipping_from = strtoupper( $shipping_from );
$shipping_to = strtoupper( $shipping_to );
// 1. Check international 28-digit format first.
if ( preg_match( self::INTERNATIONAL_PATTERN, $normalized ) ) {
if ( in_array( $shipping_from, $this->get_shipping_from_countries(), true ) &&
in_array( $shipping_to, $this->get_shipping_to_countries(), true ) ) {
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => 95,
);
}
return null;
}
// 2. Check S10/UPU format (international DPD).
if ( preg_match( self::S10_PATTERN, $normalized ) ) {
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => 90,
);
}
// 3. Check country-specific patterns.
$validation_result = $this->validate_country_pattern( $normalized, $shipping_from );
if ( $validation_result && is_array( $validation_result ) ) {
$confidence = self::TRACKING_PATTERNS[ $shipping_from ]['confidence'];
// Apply service-specific confidence boost.
if ( $validation_result['confidence_boost'] > 0 ) {
$confidence = min( 95, $validation_result['confidence_boost'] );
}
// Boost confidence for intra-DPD shipments.
if ( in_array( $shipping_to, $this->get_shipping_to_countries(), true ) ) {
$confidence = min( 98, $confidence + 3 );
}
// Additional boost for express services.
if ( 'express' === $validation_result['service'] ) {
$confidence = min( 98, $confidence + 2 );
}
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => $confidence,
);
}
// 4. Fallback: 12–24 digit numeric.
if ( preg_match( '/^\d{12,24}$/', $normalized ) ) {
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => 60,
);
}
return null;
}
}
PK [1]&I- 9 Fulfillments/Providers/PosteSanMarinoShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/poste-san-marino.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.poste.sm/it/servizi/ricerca-spedizioni/' . $tracking_number;
}
}
PK [1]\[ [ 5 Fulfillments/Providers/EvriHermesShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/evri-hermes.png';
}
/**
* Get the countries this shipping provider can ship from.
*
* @return array List of country codes.
*/
public function get_shipping_from_countries(): array {
// Evri (formerly Hermes UK) primarily operates from the UK only.
return array( 'GB' );
}
/**
* Get the countries this shipping provider can ship to.
*
* @return array List of country codes.
*/
public function get_shipping_to_countries(): array {
// Evri ships from UK to these exact destinations as listed on their website dropdown.
// This list is based on the actual options in their destination choice select.
return array( 'GB', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'PT', 'BS', 'BH', 'ES', 'BD', 'BB', 'BE', 'BZ', 'BJ', 'BM', 'BT', 'BO', 'BQ', 'BA', 'BA', 'BW', 'BR', 'VG', 'BN', 'BG', 'BF', 'BI', 'KH', 'CM', 'CA', 'ES', 'CV', 'KY', 'CF', 'TD', 'JE', 'CL', 'CN', 'CO', 'KM', 'CG', 'CK', 'CR', 'GR', 'HR', 'CW', 'CY', 'CZ', 'CD', 'DK', 'DJ', 'DM', 'DO', 'TL', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'SZ', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'GA', 'GM', 'GE', 'DE', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT', 'HN', 'HK', 'HU', 'ES', 'IS', 'IN', 'ID', 'IQ', 'IE', 'IL', 'IT', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KW', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MG', 'ES', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'ES', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'MK', 'GB', 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PL', 'PT', 'PR', 'QA', 'RE', 'RO', 'RW', 'MP', 'WS', 'SM', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SK', 'SI', 'SB', 'KR', 'ES', 'LK', 'BL', 'BQ', 'KN', 'LC', 'SX', 'VC', 'SR', 'SE', 'CH', 'TW', 'TJ', 'TZ', 'TH', 'TG', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'GB', 'UA', 'AE', 'UY', 'US', 'UZ', 'VU', 'VA', 'VN', 'VI', 'WF', 'YE', 'ZM', 'ZW' );
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number to generate the URL for.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.evri.com/track/' . rawurlencode( $tracking_number );
}
/**
* Try to parse an Evri tracking number.
*
* @param string $tracking_number The tracking number to parse.
* @param string $shipping_from The country code of the shipping origin.
* @param string $shipping_to The country code of the shipping destination.
* @return array|null An array with 'url' and 'ambiguity_score' if valid, null otherwise.
*/
public function try_parse_tracking_number(
string $tracking_number,
string $shipping_from,
string $shipping_to
): ?array {
if ( empty( $tracking_number ) || empty( $shipping_from ) || empty( $shipping_to ) ) {
return null;
}
// Check if this provider can handle this shipping route.
if ( ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
return null;
}
$normalized = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) );
if ( empty( $normalized ) ) {
return null;
}
// 1. Check for main 16-digit and legacy Evri/Hermes formats.
foreach ( self::MAIN_PATTERNS as $pattern ) {
if ( preg_match( $pattern, $normalized ) ) {
$confidence = 90;
// Boost for UK shipments.
if ( 'GB' === $shipping_from ) {
$confidence = min( 98, $confidence + 2 );
}
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => $confidence,
);
}
}
// 2. Check for 8-digit calling card number.
if ( preg_match( self::CALLING_CARD_PATTERN, $normalized ) ) {
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => 80,
);
}
// 3. Check for legacy/fallback patterns (lower confidence).
foreach ( self::LEGACY_PATTERNS as $pattern ) {
if ( preg_match( $pattern, $normalized ) ) {
$confidence = 75;
// Boost for UK shipments.
if ( 'GB' === $shipping_from ) {
$confidence = min( 95, $confidence + 15 );
}
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => $confidence,
);
}
}
return null;
}
}
PK [1]e_J 8 Fulfillments/Providers/PosteItalianeShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/poste-italiane.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.poste.it/track/' . $tracking_number;
}
}
PK [1]g( 9 Fulfillments/Providers/SlovenskaPostaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/slovenska-posta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.posta.sk/track/' . $tracking_number;
}
}
PK [1]S 2 Fulfillments/Providers/KazpostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/kazpost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.kazpost.kz/track/' . $tracking_number;
}
}
PK [1] ̌ > Fulfillments/Providers/OsterreichischePostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/osterreichische-post.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.post.at/en/track/' . $tracking_number;
}
}
PK [1]Sه . Fulfillments/Providers/MPLShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/mpl.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.mpl.com.mt/track/' . $tracking_number;
}
}
PK [1]J݈ / Fulfillments/Providers/USPSShippingProvider.phpnu
*/
private array $domestic_countries = array( 'US', 'PR', 'GU', 'AS', 'VI', 'MP', 'FM', 'MH', 'PW' );
/**
* Gets the unique provider key.
*
* @return string The provider key 'usps'.
*/
public function get_key(): string {
return 'usps';
}
/**
* Gets the display name of the provider.
*
* @return string The provider name 'USPS'.
*/
public function get_name(): string {
return 'USPS';
}
/**
* Gets the path to the provider's icon.
*
* @return string URL to the USPS logo image.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/usps.png';
}
/**
* Generates the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number to generate URL for.
* @return string The complete tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://tools.usps.com/go/TrackConfirmAction?tLabels=' . rawurlencode( $tracking_number );
}
/**
* Gets the list of origin countries supported by USPS.
*
* @return array Array of country codes (only 'US').
*/
public function get_shipping_from_countries(): array {
return array( 'US' ); // USPS only ships from the United States.
}
/**
* Gets the list of destination countries supported by USPS.
*
* @return array Array of country codes including domestic and international.
*/
public function get_shipping_to_countries(): array {
return array_merge(
$this->domestic_countries,
explode( ' ', 'AD AE AF AG AI AL AM AO AR AT AU AW AZ BA BB BD BE BF BG BH BI BJ BM BN BO BR BS BT BW BY BZ CA CD CF CG CH CI CL CM CN CO CR CU CV CY CZ DE DJ DK DM DO DZ EC EE EG ER ES ET FI FJ FR GA GB GD GE GH GI GM GN GQ GR GT GW GY HK HN HR HT HU ID IE IL IN IQ IR IS IT JM JO JP KE KG KH KI KM KN KP KR KW KZ LA LB LC LK LR LS LT LU LV LY MA MC MD ME MG MK ML MM MN MO MR MT MU MV MW MX MY MZ NA NE NG NI NL NO NP NZ OM PA PE PG PH PK PL PT PY QA RO RS RU RW SA SB SC SD SE SG SI SK SL SM SN SO SR ST SV SY SZ TD TG TH TJ TL TM TN TO TR TT TV TW TZ UA UG UK UY UZ VC VE VN VU WS YE ZA ZM ZW' )
);
}
/**
* Checks if USPS can ship from and to the specified countries.
*
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return bool
*/
public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
return in_array( $shipping_from, $this->get_shipping_from_countries(), true )
&& in_array( $shipping_to, $this->get_shipping_to_countries(), true );
}
/**
* Attempts to parse and validate a USPS tracking number.
*
* @param string $tracking_number The tracking number to validate.
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return array|null Array with tracking URL and score, or null if invalid.
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): ?array {
if ( empty( $tracking_number ) || ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
return null;
}
// Remove spaces and uppercase for consistency.
$tracking_number = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) );
$is_domestic = in_array( $shipping_to, $this->domestic_countries, true );
// USPS tracking number patterns (ordered by confidence).
$patterns = array(
// 22-digit, 20-digit, and 26-34 digit numeric (domestic and third-party)
'/^(94|93|92|95|96|94|94|94|94)\d{18,22}$/' => function () use ( $tracking_number ) {
// Most common domestic, check digit validation.
return FulfillmentUtils::validate_mod10_check_digit( $tracking_number ) ? 100 : 95;
},
// S10/UPU international (2 letters, 9 digits, 2 letters, e.g., EC123456789US).
'/^[A-Z]{2}\d{9}[A-Z]{2}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::check_s10_upu_format( $tracking_number ) ? 98 : 90;
},
// Global Express Guaranteed (10 or 11 digits, starts with 82).
'/^82\d{8,9}$/' => 95,
// 26-34 digit numeric (Parcel Pool, third-party, starts with 420)
'/^420\d{23,31}$/' => 90,
// 20-22 digit numeric (fallback, domestic)
'/^\d{20,22}$/' => 80,
// 9x... (fallback, 22-34 digits, numeric)
'/^9\d{21,33}$/' => 75,
// Legacy/Express/other.
'/^91\d{18,20}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::validate_mod10_check_digit( $tracking_number ) ? 90 : 80;
},
'/^030[67]\d{16,20}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::validate_mod10_check_digit( $tracking_number ) ? 88 : 80;
},
);
foreach ( $patterns as $pattern => $score ) {
if ( preg_match( $pattern, $tracking_number ) ) {
$ambiguity_score = is_callable( $score ) ? $score() : $score;
return array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => $ambiguity_score,
);
}
}
// Fallback: Accept any 13-char S10/UPU format ending with "US".
if ( preg_match( '/^[A-Z]{2}\d{9}US$/', $tracking_number ) ) {
return array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => 80,
);
}
// Fallback: Accept any 20-34 digit numeric string (very low confidence).
if ( preg_match( '/^\d{20,34}$/', $tracking_number ) ) {
return array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => 60,
);
}
return null; // No matching pattern found.
}
}
PK [1] 6 Fulfillments/Providers/MatkahuoltoShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/matkahuolto.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.matkahuolto.fi/fi/asiakaspalvelu/rahtien-seuranta?trackingNumber=' . $tracking_number;
}
}
PK [1]SD' / Fulfillments/Providers/TollShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/toll.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.tollgroup.com/track/' . $tracking_number;
}
}
PK [1]# 4 Fulfillments/Providers/UkrposhtaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/ukrposhta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.ukrposhta.ua/track/' . $tracking_number;
}
}
PK [1]ϥ 8 Fulfillments/Providers/HrvatskaPostaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/hrvatska-posta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.posta.hr/track/' . $tracking_number;
}
}
PK [1]{(h 1 Fulfillments/Providers/InPostShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/inpost.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://inpost.pl/sledzenie-przesylek/' . $tracking_number;
}
}
PK [1] u . Fulfillments/Providers/GLSShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/gls.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://gls-group.eu/EU/en/parcel-tracking/' . $tracking_number;
}
}
PK [1]V&p$ $ 4 Fulfillments/Providers/RoyalMailShippingProvider.phpnu , confidence: int}>
*/
private const TRACKING_PATTERNS = array(
'GB' => array( // United Kingdom.
'patterns' => array(
// UPU S10 international formats.
'/^[A-Z]{2}\d{9}GB$/', // International format: XX#########GB.
'/^[A-Z]{2}\d{7}GB$/', // Alternative international format: XX#######GB.
// Domestic tracking formats.
'/^[A-Z]{1}\d{9}[A-Z]{1}$/', // Domestic format: X#########X.
'/^[A-Z]{2}\d{8}[A-Z]{2}$/', // Standard format: XX########XX.
'/^[A-Z]{2}\d{6}[A-Z]{2}$/', // Compact format: XX######XX.
// Service-specific patterns.
'/^[A-Z]{4}\d{10}$/', // Special delivery format: XXXX##########.
'/^SD\d{8,12}$/', // Signed For service.
'/^SF\d{8,12}$/', // Special Delivery.
'/^RM\d{8,12}$/', // Royal Mail standard.
// Digital tracking formats.
'/^\d{16}$/', // 16-digit returns label or digital.
'/^\d{14}$/', // 14-digit returns label.
'/^\d{13}$/', // 13-digit domestic/international tracking.
'/^\d{12}$/', // 12-digit domestic tracking.
'/^\d{11}$/', // 11-digit domestic tracking.
'/^\d{10}$/', // 10-digit legacy Parcelforce/RM.
'/^\d{9}$/', // 9-digit legacy Parcelforce/RM.
// Parcelforce (Royal Mail Group).
'/^PF\d{8,12}$/', // Parcelforce Express.
'/^[A-Z]{2}\d{8}PF$/', // Parcelforce International.
'/^\d{13}$/', // Parcelforce Worldwide numeric.
// International tracked services.
'/^IT\d{9}GB$/', // International Tracked.
'/^IE\d{9}GB$/', // International Economy.
'/^IS\d{9}GB$/', // International Standard.
// Business services.
'/^BF\d{8,12}$/', // Business services.
'/^[A-Z]{3}\d{8,12}$/', // Three-letter business codes.
// Legacy formats.
'/^[A-Z]{1}\d{8}[A-Z]{2}$/', // Legacy format: X########XX.
'/^[0-9]{9}[A-Z]{3}$/', // 9 digits + 3 letters.
),
'confidence' => 80,
),
);
/**
* Get the key of the shipping provider.
*
* @return string
*/
public function get_key(): string {
return 'royal-mail';
}
/**
* Get the name of the shipping provider.
*
* @return string
*/
public function get_name(): string {
return 'Royal Mail';
}
/**
* Get the icon of the shipping provider.
*
* @return string
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/royal-mail.png';
}
/**
* Get the countries this shipping provider can ship from.
*
* @return array List of country codes.
*/
public function get_shipping_from_countries(): array {
return array_keys( self::TRACKING_PATTERNS );
}
/**
* Get the countries this shipping provider can ship to.
*
* Royal Mail ships internationally, so we return a comprehensive list.
*
* @return array List of country codes.
*/
public function get_shipping_to_countries(): array {
return array( 'AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB', 'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY', 'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX', 'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK', 'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS', 'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR', 'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA', 'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK', 'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE', 'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM', 'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG', 'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF', 'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY', 'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW' );
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.royalmail.com/track-your-item#/tracking-results/' . rawurlencode( $tracking_number );
}
/**
* Validate tracking number against country-specific patterns.
*
* @param string $tracking_number The tracking number to validate.
* @param string $country_code The country code for the shipment.
* @return bool True if valid, false otherwise.
*/
private function validate_country_pattern( string $tracking_number, string $country_code ): bool {
if ( ! isset( self::TRACKING_PATTERNS[ $country_code ] ) ) {
return false;
}
foreach ( self::TRACKING_PATTERNS[ $country_code ]['patterns'] as $pattern ) {
if ( preg_match( $pattern, $tracking_number ) ) {
return true;
}
}
return false;
}
/**
* Try to parse a Royal Mail tracking number.
*
* @param string $tracking_number The tracking number to parse.
* @param string $shipping_from The country code of the shipping origin.
* @param string $shipping_to The country code of the shipping destination.
* @return array|null An array with 'url' and 'ambiguity_score' if valid, null otherwise.
*/
public function try_parse_tracking_number(
string $tracking_number,
string $shipping_from,
string $shipping_to
): ?array {
if ( empty( $tracking_number ) || empty( $shipping_from ) || empty( $shipping_to ) ) {
return null;
}
$normalized = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) ); // Normalize input.
if ( empty( $normalized ) ) {
return null;
}
$shipping_from = strtoupper( $shipping_from );
$shipping_to = strtoupper( $shipping_to );
// Check if shipping from UK.
if ( 'GB' !== $shipping_from ) {
return null;
}
// Check country-specific patterns with enhanced validation.
if ( $this->validate_country_pattern( $normalized, $shipping_from ) ) {
$confidence = self::TRACKING_PATTERNS[ $shipping_from ]['confidence'];
// Apply UPU S10 validation for international formats.
if ( preg_match( '/^[A-Z]{2}\d{7,9}GB$/', $normalized ) ) {
if ( FulfillmentUtils::check_s10_upu_format( $normalized ) ) {
$confidence = min( 98, $confidence + 8 ); // Strong boost for valid UPU.
}
}
// Apply check digit validation for numeric formats.
if ( preg_match( '/^\d{11,16}$/', $normalized ) ) {
if ( FulfillmentUtils::validate_mod10_check_digit( $normalized ) ) {
$confidence = min( 95, $confidence + 5 ); // Boost for valid check digit.
}
}
// Service-specific confidence boosts.
if ( preg_match( '/^(SD|SF)\d+/', $normalized ) ) {
$confidence = min( 96, $confidence + 6 ); // Special Delivery/Signed For.
} elseif ( preg_match( '/^PF\d+/', $normalized ) ) {
$confidence = min( 94, $confidence + 4 ); // Parcelforce.
} elseif ( preg_match( '/^(IT|IE|IS)\d+GB$/', $normalized ) ) {
$confidence = min( 95, $confidence + 5 ); // International tracked services.
} elseif ( preg_match( '/^(RM|BF)\d+/', $normalized ) ) {
$confidence = min( 92, $confidence + 3 ); // Standard Royal Mail/Business.
}
// Boost confidence for domestic shipments.
if ( 'GB' === $shipping_to ) {
$confidence = min( 95, $confidence + 8 );
}
// Boost confidence for common destinations (Europe).
$european_destinations = array( 'FR', 'DE', 'ES', 'IT', 'NL', 'BE', 'IE', 'AT', 'CH', 'PT', 'DK', 'SE', 'NO' );
if ( in_array( $shipping_to, $european_destinations, true ) ) {
$confidence = min( 95, $confidence + 3 );
}
// Boost for other common destinations.
$common_destinations = array( 'US', 'CA', 'AU', 'NZ', 'JP', 'SG', 'HK' );
if ( in_array( $shipping_to, $common_destinations, true ) ) {
$confidence = min( 93, $confidence + 2 );
}
return array(
'url' => $this->get_tracking_url( $normalized ),
'ambiguity_score' => $confidence,
);
}
return null;
}
}
PK [1] y 1 Fulfillments/Providers/PostNLShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/postnl.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.postnl.nl/track-en-trace/' . $tracking_number;
}
}
PK [1]?XG 6 Fulfillments/Providers/MagyarPostaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/magyar-posta.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://posta.hu/track/' . $tracking_number;
}
}
PK [1]!c: : 8 Fulfillments/Providers/IslandsposturShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/islandspostur.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.islandspostur.is/umsoknir-og-umsoknir/umsoknir/umsoknir-um-sendingar/sendingar/' . $tracking_number;
}
}
PK [1]s@ @ . Fulfillments/Providers/DHLShippingProvider.phpnu
*/
private array $major_operation_countries = array( 'DE', 'US', 'CA', 'GB', 'SG', 'JP', 'HK', 'NL', 'FR', 'IT', 'AU', 'CN', 'IN', 'ES', 'BE', 'CH', 'AT', 'SE', 'DK', 'NO', 'PL', 'CZ', 'FI', 'IE', 'PT', 'GR', 'HU', 'RO', 'BG', 'HR', 'SK', 'SI', 'LT', 'LV', 'EE', 'CY', 'MT', 'LU' );
/**
* Gets the unique provider key.
*
* @return string The provider key 'dhl'.
*/
public function get_key(): string {
return 'dhl';
}
/**
* Gets the display name of the provider.
*
* @return string The provider name 'DHL'.
*/
public function get_name(): string {
return 'DHL';
}
/**
* Gets the path to the provider's icon.
*
* @return string URL to the DHL logo image.
*/
public function get_icon(): string {
return esc_url( WC()->plugin_url() ) . '/assets/images/shipping_providers/dhl.png';
}
/**
* Generates the appropriate tracking URL based on DHL service type.
*
* @param string $tracking_number The tracking number to generate URL for.
* @return string The complete tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
$tracking_number = strtoupper( $tracking_number ); // Uppercase for consistency.
// DHL Global Mail and eCommerce prefixes.
if ( preg_match( '/^(GM|LX|RX|CN|SG|MY|HK|AU|TH|420)/', $tracking_number ) ) {
return 'https://webtrack.dhlglobalmail.com/?trackingnumber=' . rawurlencode( $tracking_number );
}
// DHL Paket Germany (3S...).
if ( preg_match( '/^3S[A-Z0-9]{8,12}$/', $tracking_number ) ) {
return 'https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html?piececode=' . rawurlencode( $tracking_number );
}
// Standard DHL Express tracking.
return 'https://www.dhl.com/en/express/tracking.html?AWB=' . rawurlencode( $tracking_number );
}
/**
* Gets the list of origin countries supported by DHL.
*
* @return array Array of country codes.
*/
public function get_shipping_from_countries(): array {
return $this->major_operation_countries;
}
/**
* Gets the list of destination countries supported by DHL.
*
* @return array Array of country codes.
*/
public function get_shipping_to_countries(): array {
return array_keys( wc()->countries->get_countries() );
}
/**
* Checks if DHL can ship between two countries.
*
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return bool True if shipping route is supported.
*/
public function can_ship_from_to( string $shipping_from, string $shipping_to ): bool {
return in_array( $shipping_from, $this->get_shipping_from_countries(), true ) &&
in_array( $shipping_to, $this->get_shipping_to_countries(), true );
}
/**
* Validates and parses a DHL tracking number.
*
* @param string $tracking_number The tracking number to validate.
* @param string $shipping_from Origin country code.
* @param string $shipping_to Destination country code.
* @return array|null Array with tracking URL and score, or null if invalid.
*/
public function try_parse_tracking_number( string $tracking_number, string $shipping_from, string $shipping_to ): ?array {
if ( empty( $tracking_number ) || ! $this->can_ship_from_to( $shipping_from, $shipping_to ) ) {
return null;
}
$tracking_number = strtoupper( preg_replace( '/\s+/', '', $tracking_number ) ); // Remove spaces and uppercase for consistency.
$is_major_country = in_array( $shipping_from, $this->major_operation_countries, true ); // Major operation region flag.
// DHL tracking number patterns with enhanced validation and comments.
$patterns = array(
// DHL Express Air Waybill: 10 or 11 digits, with check digit validation.
'/^\d{10}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::validate_mod11_check_digit( $tracking_number ) ? 98 : 90;
},
'/^\d{11}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::validate_mod11_check_digit( $tracking_number ) ? 98 : 90;
},
// DHL Express JJD and JVGL formats.
'/^JJD\d{10}$/' => 98,
'/^JVGL\d{10}$/' => 98,
// DHL Paket Germany: 12, 14, or 20 digits.
// Only match 12/14-digit numeric for DHL if both from and to are DE (Germany).
'/^\d{12}$/' => function () use ( $shipping_from, $shipping_to ) {
return ( 'DE' === $shipping_from && 'DE' === $shipping_to ) ? 92 : 60;
},
'/^\d{14}$/' => function () use ( $shipping_from, $shipping_to ) {
return ( 'DE' === $shipping_from && 'DE' === $shipping_to ) ? 92 : 60;
},
'/^\d{20}$/' => 90,
// DHL Paket Germany: 3S + 8–12 alphanumeric.
'/^3S[A-Z0-9]{8,12}$/' => 95,
// DHL eCommerce North America: GM + 16–20 digits.
'/^GM\d{16,20}$/' => function () use ( $shipping_from ) {
return in_array( $shipping_from, array( 'US', 'CA' ), true ) ? 95 : 80;
},
// DHL eCommerce Asia-Pacific: LX, RX, CN, SG, MY, HK, AU, TH + 9 digits + 2 letters.
'/^(LX|RX|CN|SG|MY|HK|AU|TH)\d{9}[A-Z]{2}$/' => 92,
// DHL eCommerce US consolidator: 420 + 27–31 digits.
'/^420\d{23,31}$/' => 90,
// DHL Global Forwarding: 7, 8, or 9 digits (numeric only).
'/^\d{7,9}$/' => 88,
// DHL Global Forwarding: 1 digit + 2 letters + 4–6 digits.
'/^\d[A-Z]{2}\d{4,6}$/' => 90,
// DHL Global Forwarding: 3–4 letters + 4–8 digits.
'/^[A-Z]{3,4}\d{4,8}$/' => 88,
// DHL Same Day: DSD + 8–12 digits.
'/^DSD\d{8,12}$/' => 92,
// DHL Piece Numbers: JD + 11 digits.
'/^JD\d{11}$/' => 90,
// DHL Supply Chain: DSC + 10–15 digits.
'/^DSC\d{10,15}$/' => 85,
// S10/UPU format: 2 letters + 9 digits + 2 letters (used for DHL eCommerce and Packet International).
'/^[A-Z]{2}\d{9}[A-Z]{2}$/' => function () use ( $tracking_number ) {
return FulfillmentUtils::check_s10_upu_format( $tracking_number ) ? 88 : 75;
},
// Fallback: 22 digit numeric (legacy/rare).
'/^\d{22}$/' => 70,
);
foreach ( $patterns as $pattern => $base_score ) {
if ( preg_match( $pattern, $tracking_number ) ) {
$score = is_callable( $base_score ) ? $base_score() : $base_score;
if ( $score > 0 ) {
return array(
'url' => $this->get_tracking_url( $tracking_number ),
'ambiguity_score' => $score,
);
}
}
}
return null;
}
}
PK [1]-3 4 Fulfillments/Providers/ArasKargoShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/aras-kargo.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.araskargo.com.tr/Tracking/Detail?trackingNumber=' . $tracking_number;
}
}
PK [1] 5 8 Fulfillments/Providers/LatvijasPastsShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/latvijas-pasts.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.pasts.lv/en/track/' . $tracking_number;
}
}
PK [1]i_ : Fulfillments/Providers/LasershipOntracShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/lasership-ontrac.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.lasership.com/track/' . $tracking_number;
}
}
PK [1]Va 1 Fulfillments/Providers/ItellaShippingProvider.phpnu plugin_url() ) . '/assets/images/shipping_providers/itella.png';
}
/**
* Get the tracking URL for a given tracking number.
*
* @param string $tracking_number The tracking number.
* @return string The tracking URL.
*/
public function get_tracking_url( string $tracking_number ): string {
return 'https://www.smartposti.fi/track/' . $tracking_number;
}
}
PK [1];A A % Fulfillments/FulfillmentException.phpnu $column_info ) {
$new_columns[ $column_name ] = $column_info;
if ( 'order_status' === $column_name ) {
$new_columns[ $column_name ] = 'Order Status';
$new_columns['fulfillment_status'] = __( 'Fulfillment Status', 'woocommerce' );
$new_columns['shipment_tracking'] = __( 'Shipment Tracking', 'woocommerce' );
$new_columns['shipment_provider'] = __( 'Shipment Provider', 'woocommerce' );
}
}
return $new_columns;
}
/**
* Render the fulfillment column row data for legacy order list support.
*
* @param string $column_name The name of the column.
*/
public function render_fulfillment_column_row_data_legacy( string $column_name ) {
global $the_order;
// This method is kept for legacy support, but the main rendering logic is now in render_fulfillment_column_row_data.
return $this->render_fulfillment_column_row_data( $column_name, $the_order );
}
/**
* Render the fulfillment status column.
*
* @param string $column_name The name of the column.
* @param WC_Order $order The order object.
*/
public function render_fulfillment_column_row_data( string $column_name, WC_Order $order ) {
$fulfillments = $this->maybe_read_fulfillments( $order );
// Render the column data based on the column name.
switch ( $column_name ) {
case 'fulfillment_status':
$this->render_order_fulfillment_status_column_row_data( $order );
break;
case 'shipment_tracking':
$this->render_shipment_tracking_column_row_data( $order, $fulfillments );
break;
case 'shipment_provider':
$this->render_shipment_provider_column_row_data( $order, $fulfillments );
break;
}
}
/**
* Render the fulfillment status column row data.
*
* @param WC_Order $order The order object.
*/
private function render_order_fulfillment_status_column_row_data( WC_Order $order ) {
$order_fulfillment_status = FulfillmentUtils::get_order_fulfillment_status( $order );
echo "
Shipment %1$s was shipped on %2$s', 'woocommerce' ), 'b' ),
intval( $index ) + 1,
esc_html(
gmdate(
'F j, Y',
strtotime(
$fulfillment->get_date_fulfilled() // Get the fulfilled date.
?? $fulfillment->get_date_updated() // Fallback to the updated date if fulfilled date is not set.
)
)
)
);
?>
';
// Get the fulfillment status for the order.
$fulfillments = $this->maybe_read_fulfillments( $order );
$order_fulfillment_status = FulfillmentUtils::calculate_order_fulfillment_status( $order, $fulfillments );
// Render order status badge.
$order_status = $order->get_status();
echo '' . esc_html( wc_get_order_status_name( $order_status ) ) . '';
// Render fulfillment status badge.
$this->render_order_fulfillment_status_badge( $order, $order_fulfillment_status );
echo '';
}
/**
* Loads the fulfillments scripts and styles.
*/
public function load_components() {
if ( ! $this->should_render_fulfillment_drawer() ) {
return;
}
$this->register_fulfillments_assets();
$this->load_fulfillments_js_settings();
}
/**
* Register the fulfillment assets.
*/
protected function register_fulfillments_assets() {
WCAdminAssets::register_style( 'fulfillments', 'style', array( 'wp-components' ) );
WCAdminAssets::register_script( 'wp-admin-scripts', 'fulfillments', true );
}
/**
* Load the fulfillments JS settings.
*
* @return void
*/
protected function load_fulfillments_js_settings() {
$fulfillment_settings = array(
'providers' => FulfillmentUtils::get_shipping_providers_object(),
'currency_symbols' => get_woocommerce_currency_symbols(),
'fulfillment_statuses' => FulfillmentUtils::get_fulfillment_statuses(),
'order_fulfillment_statuses' => FulfillmentUtils::get_order_fulfillment_statuses(),
);
wp_localize_script( 'wc-admin-fulfillments', 'wcFulfillmentSettings', $fulfillment_settings );
}
/**
* Render the fulfillment filters in the orders table.
*/
public function render_fulfillment_filters() {
if ( ! self::should_render_fulfillment_drawer() ) {
return;
}
?>
render_fulfillment_filters();
}
/**
* Apply the fulfillment status filter to the orders list.
*
* @param array $args The query arguments for the orders list.
* @return array The modified query arguments.
*/
public function filter_orders_list_table_query( $args ) {
// This is a read-only filter on the admin orders table, so nonce verification is not required.
// phpcs:ignore WordPress.Security.NonceVerification
if ( isset( $_GET['fulfillment_status'] ) && ! empty( $_GET['fulfillment_status'] ) ) {
// phpcs:ignore WordPress.Security.NonceVerification
$fulfillment_status = sanitize_text_field( wp_unslash( $_GET['fulfillment_status'] ) );
// Ensure the fulfillment status is one of the allowed values.
if ( FulfillmentUtils::is_valid_order_fulfillment_status( $fulfillment_status ) ) {
$meta_query = FulfillmentUtils::get_order_fulfillment_status_meta_query( $fulfillment_status );
if ( ! empty( $meta_query ) ) {
if ( ! isset( $args['meta_query'] ) ) {
$args['meta_query'] = array(); // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
}
$args['meta_query'][] = $meta_query;
}
}
}
return $args;
}
/**
* Filter the legacy orders list query to include fulfillment status.
*
* @param \WP_Query $query The WP_Query object.
*/
public function filter_legacy_orders_list_query( $query ) {
if (
is_admin()
&& $query->is_main_query()
&& $query->get( 'post_type' ) === 'shop_order'
&& isset( $_GET['fulfillment_status'] ) && ! empty( $_GET['fulfillment_status'] ) // phpcs:ignore WordPress.Security.NonceVerification
) {
$status = sanitize_text_field( wp_unslash( $_GET['fulfillment_status'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
// Ensure the fulfillment status is one of the allowed values.
if ( FulfillmentUtils::is_valid_order_fulfillment_status( $status ) ) {
$query->set(
'meta_query',
'no_fulfillments' === $status ?
array(
'relation' => 'OR',
array(
'key' => '_fulfillment_status',
'compare' => 'NOT EXISTS',
),
) :
array(
array(
'key' => '_fulfillment_status',
'value' => $status,
'compare' => '=',
),
)
);
}
}
}
/**
* Check if the fulfillment drawer should be rendered (admin only).
*
* @return bool True if the fulfillment drawer should be rendered, false otherwise.
*/
protected function should_render_fulfillment_drawer(): bool {
if ( ! is_admin() ) {
return false;
}
if ( ! function_exists( 'get_current_screen' ) ) {
return false;
}
$current_screen = get_current_screen();
if ( ! $current_screen || ! $current_screen->id ) {
return false;
}
return 'woocommerce_page_wc-orders' === $current_screen->id // HPOS screen.
|| 'edit-shop_order' === $current_screen->id // Legacy screen.
|| 'shop_order' === $current_screen->id; // Order details screen (legacy).
}
/**
* Fetches the fulfillments for the given order, caching them to avoid multiple fetches.
*
* @param WC_Order $order The order object.
*
* @return array The fulfillments for the order.
*/
private function maybe_read_fulfillments( WC_Order $order ): array {
// Check if we've already fetched the fulfillments for this order.
if ( isset( $this->fulfillments_cache[ $order->get_id() ] ) ) {
return $this->fulfillments_cache[ $order->get_id() ];
}
// If not, fetch them and cache them.
$data_store = wc_get_container()->get( FulfillmentsDataStore::class );
$fulfillments = $data_store->read_fulfillments( WC_Order::class, '' . $order->get_id() );
$this->fulfillments_cache[ $order->get_id() ] = $fulfillments;
return $fulfillments;
}
}
PK [1]uW W " Fulfillments/ShippingProviders.phpnu ShippingProviders\ACSCourierShippingProvider::class,
'amazon-logistics' => ShippingProviders\AmazonLogisticsShippingProvider::class,
'an-post' => ShippingProviders\AnPostShippingProvider::class,
'aras-kargo' => ShippingProviders\ArasKargoShippingProvider::class,
'australia-post' => ShippingProviders\AustraliaPostShippingProvider::class,
'azerpost' => ShippingProviders\AzerpostShippingProvider::class,
'bartolini-brt' => ShippingProviders\BartoliniBRTShippingProvider::class,
'belpochta' => ShippingProviders\BelpochtaShippingProvider::class,
'bpost' => ShippingProviders\BpostShippingProvider::class,
'bulgarian-posts' => ShippingProviders\BulgarianPostsShippingProvider::class,
'canada-post' => ShippingProviders\CanadaPostShippingProvider::class,
'cdek' => ShippingProviders\CDEKShippingProvider::class,
'ceska-posta' => ShippingProviders\CeskaPostaShippingProvider::class,
'chronopost' => ShippingProviders\ChronopostShippingProvider::class,
'correos' => ShippingProviders\CorreosShippingProvider::class,
'ctt' => ShippingProviders\CTTShippingProvider::class,
'cyprus-post' => ShippingProviders\CyprusPostShippingProvider::class,
'deutsche-post' => ShippingProviders\DeutschePostShippingProvider::class,
'dhl' => ShippingProviders\DHLShippingProvider::class,
'dpd' => ShippingProviders\DPDShippingProvider::class,
'econt' => ShippingProviders\EcontShippingProvider::class,
'eimskip' => ShippingProviders\EimskipShippingProvider::class,
'elta' => ShippingProviders\ELTAShippingProvider::class,
'evri-hermes' => ShippingProviders\EvriHermesShippingProvider::class,
'fan-courier' => ShippingProviders\FanCourierShippingProvider::class,
'fastway' => ShippingProviders\FastwayShippingProvider::class,
'fedex' => ShippingProviders\FedExShippingProvider::class,
'geniki-taxydromiki' => ShippingProviders\GenikiTaxydromikiShippingProvider::class,
'gls' => ShippingProviders\GLSShippingProvider::class,
'haypost' => ShippingProviders\HayPostShippingProvider::class,
'helthjem' => ShippingProviders\HelthjemShippingProvider::class,
'hrvatska-posta' => ShippingProviders\HrvatskaPostaShippingProvider::class,
'inpost' => ShippingProviders\InPostShippingProvider::class,
'islandspostur' => ShippingProviders\IslandsposturShippingProvider::class,
'itella' => ShippingProviders\ItellaShippingProvider::class,
'kazpost' => ShippingProviders\KazpostShippingProvider::class,
'la-poste-colissimo' => ShippingProviders\LaPosteColissimoShippingProvider::class,
'lasership-ontrac' => ShippingProviders\LasershipOntracShippingProvider::class,
'latvijas-pasts' => ShippingProviders\LatvijasPastsShippingProvider::class,
'liechtensteinische-post' => ShippingProviders\LiechtensteinischePostShippingProvider::class,
'magyar-posta' => ShippingProviders\MagyarPostaShippingProvider::class,
'makedonska-posta' => ShippingProviders\MakedonskaPostaShippingProvider::class,
'maltapost' => ShippingProviders\MaltaPostShippingProvider::class,
'matkahuolto' => ShippingProviders\MatkahuoltoShippingProvider::class,
'mondial-relay' => ShippingProviders\MondialRelayShippingProvider::class,
'mpl' => ShippingProviders\MPLShippingProvider::class,
'mrw' => ShippingProviders\MRWShippingProvider::class,
'new-zealand-post' => ShippingProviders\NewZealandPostShippingProvider::class,
'nova-poshta' => ShippingProviders\NovaPoshtaShippingProvider::class,
'omniva' => ShippingProviders\OmnivaShippingProvider::class,
'osterreichische-post' => ShippingProviders\OsterreichischePostShippingProvider::class,
'parcelforce' => ShippingProviders\ParcelForceShippingProvider::class,
'poczta-polska' => ShippingProviders\PocztaPolskaShippingProvider::class,
'post-luxembourg' => ShippingProviders\PostLuxembourgShippingProvider::class,
'posta-moldovei' => ShippingProviders\PostaMoldoveiShippingProvider::class,
'posta-romana' => ShippingProviders\PostaRomanaShippingProvider::class,
'poste-italiane' => ShippingProviders\PosteItalianeShippingProvider::class,
'poste-san-marino' => ShippingProviders\PosteSanMarinoShippingProvider::class,
'posten-norge-bring' => ShippingProviders\PostenNorgeBringShippingProvider::class,
'postnl' => ShippingProviders\PostNLShippingProvider::class,
'postnord' => ShippingProviders\PostNordShippingProvider::class,
'purolator' => ShippingProviders\PurolatorShippingProvider::class,
'royal-mail' => ShippingProviders\RoyalMailShippingProvider::class,
'russian-post' => ShippingProviders\RussianPostShippingProvider::class,
'sda' => ShippingProviders\SDAShippingProvider::class,
'seur' => ShippingProviders\SeurShippingProvider::class,
'slovenska-posta' => ShippingProviders\SlovenskaPostaShippingProvider::class,
'spee-dee-delivery' => ShippingProviders\SpeeDeeDeliveryShippingProvider::class,
'startrack' => ShippingProviders\StarTrackShippingProvider::class,
'swiss-post' => ShippingProviders\SwissPostShippingProvider::class,
'toll' => ShippingProviders\TollShippingProvider::class,
'ukrposhta' => ShippingProviders\UkrposhtaShippingProvider::class,
'ups' => ShippingProviders\UPSShippingProvider::class,
'usps' => ShippingProviders\USPSShippingProvider::class,
'urgent-cargus' => ShippingProviders\UrgentCargusShippingProvider::class,
'yurtici-kargo' => ShippingProviders\YurticiKargoShippingProvider::class,
'zasilkovna' => ShippingProviders\ZasilkovnaShippingProvider::class,
);
PK [1]Z$Id d * MCP/Transport/WooCommerceRestTransport.phpnu validate_request( $request );
}
/**
* Validate the MCP request using standalone authentication.
*
* @param \WP_REST_Request $request The REST request object.
* @return bool|\WP_Error True if allowed, WP_Error if not.
*/
public function validate_request( \WP_REST_Request $request ) {
// Require TLS by default; allow explicit opt-in for non-SSL (e.g., local dev).
/**
* Filter to allow insecure transport for MCP requests.
*
* @since 10.3.0
* @param bool $allowed Whether to allow insecure transport.
* @param \WP_REST_Request $request The REST request object.
*/
if ( ! is_ssl() && ! apply_filters( 'woocommerce_mcp_allow_insecure_transport', false, $request ) ) {
return new \WP_Error(
'insecure_transport',
__( 'HTTPS is required for MCP requests.', 'woocommerce' ),
array( 'status' => 403 )
);
}
// Get X-MCP-API-Key header.
$api_key = $request->get_header( 'X-MCP-API-Key' );
if ( empty( $api_key ) ) {
return new \WP_Error(
'missing_api_key',
__( 'X-MCP-API-Key header required. Format: consumer_key:consumer_secret', 'woocommerce' ),
array( 'status' => 401 )
);
}
if ( strpos( $api_key, ':' ) === false ) {
return new \WP_Error(
'invalid_api_key',
__( 'X-MCP-API-Key must be in format consumer_key:consumer_secret', 'woocommerce' ),
array( 'status' => 401 )
);
}
list( $consumer_key, $consumer_secret ) = explode( ':', $api_key, 2 );
// Use our standalone authentication method.
$result = $this->authenticate( $consumer_key, $consumer_secret );
if ( is_wp_error( $result ) ) {
return $result;
}
return true;
}
/**
* Authenticate user using consumer key and secret.
*
* @param string $consumer_key Consumer key.
* @param string $consumer_secret Consumer secret.
* @return int|\WP_Error User ID on success, WP_Error on failure.
*/
private function authenticate( $consumer_key, $consumer_secret ) {
global $wpdb;
// Hash the consumer key as WooCommerce does.
$hashed_consumer_key = wc_api_hash( trim( (string) $consumer_key ) );
// Query the WooCommerce API keys table directly.
$user_data = $wpdb->get_row(
$wpdb->prepare(
"SELECT key_id, user_id, permissions, consumer_key, consumer_secret, nonces
FROM {$wpdb->prefix}woocommerce_api_keys
WHERE consumer_key = %s",
$hashed_consumer_key
)
);
// Check if user data was found.
if ( empty( $user_data ) ) {
return new \WP_Error(
'authentication_failed',
__( 'Authentication failed.', 'woocommerce' ),
array( 'status' => 401 )
);
}
// Validate consumer secret using hash_equals for timing attack protection.
if ( ! hash_equals( $user_data->consumer_secret, trim( (string) $consumer_secret ) ) ) {
return new \WP_Error(
'authentication_failed',
__( 'Authentication failed.', 'woocommerce' ),
array( 'status' => 401 )
);
}
// Store permissions for tool-level checking.
self::$current_mcp_permissions = $user_data->permissions;
// Ensure the user exists before switching context.
$user = get_user_by( 'id', (int) $user_data->user_id );
if ( ! $user ) {
return new \WP_Error(
'mcp_user_not_found',
__( 'The user associated with this API key no longer exists.', 'woocommerce' ),
array( 'status' => 401 )
);
}
wp_set_current_user( $user->ID );
return $user->ID;
}
/**
* Get the current MCP user's API key permissions.
*
* @return string|null The permissions (read, write, read_write) or null if no MCP context.
*/
public static function get_current_user_permissions(): ?string {
return self::$current_mcp_permissions;
}
/**
* Check REST ability permissions for HTTP method.
*
* @param bool $allowed Whether the operation is allowed. Default false.
* @param string $method HTTP method (GET, POST, PUT, DELETE).
* @param object $controller REST controller instance.
* @return bool Whether permission is granted.
*/
public function check_ability_permission( $allowed, $method, $controller ) {
// Only check permissions if we have MCP context.
$permissions = self::get_current_user_permissions();
if ( null === $permissions ) {
return $allowed;
}
// Check permissions based on method.
switch ( $method ) {
case 'HEAD':
case 'GET':
return ( 'read' === $permissions || 'read_write' === $permissions );
case 'POST':
case 'PUT':
case 'PATCH':
case 'DELETE':
return ( 'write' === $permissions || 'read_write' === $permissions );
case 'OPTIONS':
return true;
default:
return false;
}
}
}
PK [1]SO MCP/MCPAdapterProvider.phpnu initialized ) {
return;
}
$this->initialize_mcp_adapter();
$this->register_hooks();
$this->initialized = true;
}
/**
* Initialize the MCP adapter.
*/
private function initialize_mcp_adapter(): void {
// Check if MCP adapter class exists (should be autoloaded by WooCommerce's composer).
if ( ! class_exists( 'WP\MCP\Core\McpAdapter' ) ) {
if ( function_exists( 'wc_get_logger' ) ) {
wc_get_logger()->warning(
'MCP adapter class not found. Skipping MCP initialization.',
array( 'source' => 'woocommerce-mcp' )
);
}
return;
}
// Initialize the MCP adapter instance - this triggers the rest_api_init hook registration.
\WP\MCP\Core\McpAdapter::instance();
}
/**
* Register WordPress hooks for MCP adapter.
*/
private function register_hooks(): void {
// Initialize MCP server when MCP adapter is ready.
add_action( 'mcp_adapter_init', array( $this, 'initialize_mcp_server' ) );
}
/**
* Initialize MCP server.
*
* @param object $adapter MCP adapter instance.
*/
public function initialize_mcp_server( $adapter ): void {
// Get filtered abilities for MCP server.
$abilities_ids = $this->get_woocommerce_mcp_abilities();
// Bail if no abilities are available.
if ( empty( $abilities_ids ) ) {
return;
}
/*
* Temporarily disable MCP validation during server creation.
* Workaround for validator bug with union types (e.g., ["integer", "null"]).
* This will be removed once the mcp-adapter validator bug is fixed.
*
* @see https://github.com/WordPress/mcp-adapter/issues/47
*/
add_filter( 'mcp_validation_enabled', array( __CLASS__, 'disable_mcp_validation' ), 999 );
try {
// Create MCP server.
$adapter->create_server(
'woocommerce-mcp',
self::MCP_NAMESPACE,
self::MCP_ROUTE,
__( 'WooCommerce MCP Server', 'woocommerce' ),
__( 'AI-accessible WooCommerce operations via MCP', 'woocommerce' ),
'1.0.0',
array( WooCommerceRestTransport::class ),
\WP\MCP\Infrastructure\ErrorHandling\ErrorLogMcpErrorHandler::class,
\WP\MCP\Infrastructure\Observability\NullMcpObservabilityHandler::class,
$abilities_ids,
);
} catch ( \Throwable $e ) {
if ( function_exists( 'wc_get_logger' ) ) {
wc_get_logger()->error(
'MCP server initialization failed: ' . $e->getMessage(),
array( 'source' => 'woocommerce-mcp' )
);
}
} finally {
// Re-enable MCP validation immediately after server creation.
remove_filter( 'mcp_validation_enabled', array( __CLASS__, 'disable_mcp_validation' ), 999 );
}
}
/**
* Get WooCommerce abilities for MCP server.
*
* Filters abilities to include only those with 'woocommerce/' namespace by default,
* with a filter to allow inclusion of abilities from other namespaces.
*
* @return array Array of ability IDs for MCP server.
*/
private function get_woocommerce_mcp_abilities(): array {
// Get all abilities from the registry.
$abilities_registry = wc_get_container()->get( AbilitiesRegistry::class );
$all_abilities_ids = $abilities_registry->get_abilities_ids();
// Filter abilities based on namespace and custom filter.
$mcp_abilities = array_filter(
$all_abilities_ids,
function ( $ability_id ) {
// Include WooCommerce abilities by default.
$include = str_starts_with( $ability_id, 'woocommerce/' );
// Allow filter to override inclusion decision.
/**
* Filter to override MCP ability inclusion decision.
*
* @since 10.3.0
* @param bool $include Whether to include the ability.
* @param string $ability_id The ability ID.
*/
return apply_filters( 'woocommerce_mcp_include_ability', $include, $ability_id );
}
);
// Re-index array.
return array_values( $mcp_abilities );
}
/**
* Temporarily disable MCP validation.
*
* Used as a callback for the mcp_validation_enabled filter to work around
* validator bugs with union types.
*
* @return bool Always returns false to disable validation.
*/
public static function disable_mcp_validation(): bool {
return false;
}
/**
* Check if MCP adapter is initialized.
*
* @return bool Whether MCP adapter is initialized.
*/
public function is_initialized(): bool {
return $this->initialized;
}
/**
* Check if the current request is for the MCP endpoint.
*
* @return bool True if this is an MCP endpoint request.
*/
public static function is_mcp_request(): bool {
// Check if this is a REST request.
if ( ! defined( 'REST_REQUEST' ) || ! REST_REQUEST ) {
return false;
}
// Get the request URI.
$request_uri = isset( $_SERVER['REQUEST_URI'] ) ? sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : '';
// Build the MCP endpoint path dynamically from constants.
$mcp_endpoint = '/' . self::MCP_NAMESPACE . '/' . self::MCP_ROUTE;
// Check if the request is for the MCP endpoint.
return false !== strpos( $request_uri, $mcp_endpoint );
}
}
PK [1]&e$O $O ProductFilters/QueryClauses.phpnu params = $params;
}
/**
* Add conditional query clauses based on the filter params in query vars.
*
* There isn't a clause for rating filter because we use tax_query for it
* (product_visibility).
*
* @param array $args Query args.
* @param \WP_Query $wp_query WP_Query object.
* @return array
*/
public function add_query_clauses( array $args, \WP_Query $wp_query ): array {
if ( $wp_query->get( 'filter_stock_status' ) ) {
$stock_statuses = trim( $wp_query->get( 'filter_stock_status' ) );
$stock_statuses = explode( ',', $stock_statuses );
$args = $this->add_stock_clauses( $args, $stock_statuses );
}
if ( $wp_query->get( 'min_price' ) || $wp_query->get( 'max_price' ) ) {
$price_range = array(
'min_price' => $wp_query->get( 'min_price' ),
'max_price' => $wp_query->get( 'max_price' ),
);
$price_range = array_filter( $price_range );
$args = $this->add_price_clauses( $args, $price_range );
}
$args = $this->add_attribute_clauses(
$args,
$this->get_chosen_attributes( $wp_query->query_vars )
);
$args = $this->add_taxonomy_clauses(
$args,
$this->get_chosen_taxonomies( $wp_query->query_vars )
);
return $args;
}
/**
* Add query clauses for main query.
* WooCommerce handles attribute, price, and rating filters in the main query.
* This method is used to add stock status and taxonomy filters to the main query.
*
* @param array $args Query args.
* @param \WP_Query $wp_query WP_Query object.
* @return array
*/
public function add_query_clauses_for_main_query( array $args, \WP_Query $wp_query ): array {
if (
! $wp_query->is_main_query() ||
'product_query' !== $wp_query->get( 'wc_query' )
) {
return $args;
}
if ( $wp_query->get( 'filter_stock_status' ) ) {
$stock_statuses = trim( $wp_query->get( 'filter_stock_status' ) );
$stock_statuses = explode( ',', $stock_statuses );
$stock_statuses = array_filter( $stock_statuses );
$args = $this->add_stock_clauses( $args, $stock_statuses );
}
$args = $this->add_taxonomy_clauses(
$args,
$this->get_chosen_taxonomies( $wp_query->query_vars )
);
return $args;
}
/**
* Add query clauses for stock filter.
*
* @param array $args Query args.
* @param array $stock_statuses Stock statuses to be queried.
* @return array
*/
public function add_stock_clauses( array $args, array $stock_statuses ): array {
$stock_statuses = array_filter( $stock_statuses );
if ( empty( $stock_statuses ) ) {
return $args;
}
$filtered_stock_statuses = array_intersect(
array_map( 'esc_sql', $stock_statuses ),
array_keys( wc_get_product_stock_status_options() )
);
if ( ! empty( $filtered_stock_statuses ) ) {
$args['join'] = $this->append_product_sorting_table_join( $args['join'] );
$args['where'] .= ' AND wc_product_meta_lookup.stock_status IN ("' . implode( '","', $filtered_stock_statuses ) . '")';
}
if ( ! empty( $stock_statuses ) && empty( $filtered_stock_statuses ) ) {
$args['where'] .= ' AND 1=0';
}
return $args;
}
/**
* Add query clauses for price filter.
*
* @param array $args Query args.
* @param array $price_range {
* Price range array.
*
* @type int|string $min_price Optional. Min price.
* @type int|string $max_price Optional. Max Price.
* }
* @return array
*/
public function add_price_clauses( array $args, array $price_range ): array {
if ( ! isset( $price_range['min_price'] ) && ! isset( $price_range['max_price'] ) ) {
return $args;
}
global $wpdb;
$adjust_for_taxes = $this->should_adjust_price_filters_for_displayed_taxes();
$args['join'] = $this->append_product_sorting_table_join( $args['join'] );
if ( isset( $price_range['min_price'] ) ) {
$min_price_filter = intval( $price_range['min_price'] );
if ( $adjust_for_taxes ) {
$args['where'] .= $this->get_price_filter_query_for_displayed_taxes( $min_price_filter, 'max_price', '>=' );
} else {
$args['where'] .= $wpdb->prepare( ' AND wc_product_meta_lookup.max_price >= %f ', $min_price_filter );
}
}
if ( isset( $price_range['max_price'] ) ) {
$max_price_filter = intval( $price_range['max_price'] );
if ( $adjust_for_taxes ) {
$args['where'] .= $this->get_price_filter_query_for_displayed_taxes( $max_price_filter, 'min_price', '<=' );
} else {
$args['where'] .= $wpdb->prepare( ' AND wc_product_meta_lookup.min_price <= %f ', $max_price_filter );
}
}
return $args;
}
/**
* Add query clauses for filtering products by attributes.
*
* @param array $args Query args.
* @param array $chosen_attributes {
* Chosen attributes array.
*
* @type array {$taxonomy: Attribute taxonomy name} {
* @type string[] $terms Chosen terms' slug.
* @type string $query_type Query type. Accepts 'and' or 'or'.
* }
* }
*
* @return array
*/
public function add_attribute_clauses( array $args, array $chosen_attributes ): array {
if ( empty( $chosen_attributes ) ) {
return $args;
}
global $wpdb;
// The extra derived table ("SELECT product_or_parent_id FROM") is needed for performance
// (causes the filtering subquery to be executed only once).
$clause_root = " {$wpdb->posts}.ID IN ( SELECT product_or_parent_id FROM (";
if ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) ) {
$in_stock_clause = ' AND in_stock = 1';
} else {
$in_stock_clause = '';
}
$attribute_ids_for_and_filtering = array();
$clauses = array();
// Get all terms for all attribute taxonomies in one query for better performance.
$all_terms_slugs = array();
foreach ( $chosen_attributes as $data ) {
if ( ! empty( $data['terms'] ) && is_array( $data['terms'] ) ) {
$all_terms_slugs = array_merge( $all_terms_slugs, $data['terms'] );
}
}
$all_terms = get_terms(
array(
'taxonomy' => array_keys( $chosen_attributes ),
'slug' => $all_terms_slugs,
'hide_empty' => false,
)
);
if ( is_wp_error( $all_terms ) ) {
return $args;
}
// Group terms by taxonomy for easier processing.
$terms_by_taxonomy = array();
foreach ( $all_terms as $term ) {
$terms_by_taxonomy[ $term->taxonomy ][] = $term;
}
foreach ( $chosen_attributes as $taxonomy => $data ) {
$current_attribute_terms = $terms_by_taxonomy[ $taxonomy ] ?? array();
$term_ids_by_slug = wp_list_pluck( $current_attribute_terms, 'term_id', 'slug' );
$term_ids_to_filter_by = array_values( array_intersect_key( $term_ids_by_slug, array_flip( $data['terms'] ) ) );
$term_ids_to_filter_by = array_map( 'absint', $term_ids_to_filter_by );
$term_ids_to_filter_by_list = '(' . join( ',', $term_ids_to_filter_by ) . ')';
$is_and_query = 'and' === strtolower( $data['query_type'] );
$count = count( $term_ids_to_filter_by );
if ( 0 !== $count ) {
if ( $is_and_query && $count > 1 ) {
$attribute_ids_for_and_filtering = array_merge( $attribute_ids_for_and_filtering, $term_ids_to_filter_by );
} else {
$clauses[] = "
{$clause_root}
SELECT product_or_parent_id
FROM {$this->get_lookup_table_name()} lt
WHERE term_id in {$term_ids_to_filter_by_list}
{$in_stock_clause}
)";
}
}
}
if ( ! empty( $attribute_ids_for_and_filtering ) ) {
$count = count( $attribute_ids_for_and_filtering );
$term_ids_to_filter_by_list = '(' . join( ',', $attribute_ids_for_and_filtering ) . ')';
$clauses[] = "
{$clause_root}
SELECT product_or_parent_id
FROM {$this->get_lookup_table_name()} lt
WHERE is_variation_attribute=0
{$in_stock_clause}
AND term_id in {$term_ids_to_filter_by_list}
GROUP BY product_id
HAVING COUNT(product_id)={$count}
UNION
SELECT product_or_parent_id
FROM {$this->get_lookup_table_name()} lt
WHERE is_variation_attribute=1
{$in_stock_clause}
AND term_id in {$term_ids_to_filter_by_list}
)";
}
if ( ! empty( $clauses ) ) {
// "temp" is needed because the extra derived tables require an alias.
$args['where'] .= ' AND (' . join( ' temp ) AND ', $clauses ) . ' temp ))';
} elseif ( ! empty( $chosen_attributes ) ) {
$args['where'] .= ' AND 1=0';
}
return $args;
}
/**
* Add query clauses for taxonomy filter (e.g., product_cat, product_tag).
*
* @param array $args Query args.
* @param array $chosen_taxonomies {
* Chosen taxonomies array.
*
* @type array {$taxonomy: Taxonomy name} {
* @type string[] $terms Chosen terms' slug.
* }
* }
* @return array
*/
public function add_taxonomy_clauses( array $args, array $chosen_taxonomies ): array {
if ( empty( $chosen_taxonomies ) ) {
return $args;
}
global $wpdb;
$tax_queries = array();
$all_terms = get_terms(
array(
'taxonomy' => array_keys( $chosen_taxonomies ),
'slug' => array_merge( ...array_values( $chosen_taxonomies ) ),
'hide_empty' => false,
)
);
if ( is_wp_error( $all_terms ) ) {
/**
* No error logging needed here because:
* 1. Taxonomy existence is already validated in the initial get_terms() call above
* 2. get_terms() only returns WP_Error for invalid taxonomy or rare DB connection issues
* 3. If the taxonomy was invalid, we would have failed earlier and never reached this code
* 4. Database errors would likely affect the entire request, not just this call
*/
return $args;
}
$term_ids_by_taxonomy = array();
foreach ( $all_terms as $term ) {
$term_ids_by_taxonomy[ $term->taxonomy ][] = $term->term_id;
}
foreach ( $term_ids_by_taxonomy as $taxonomy => $term_ids ) {
if ( empty( $term_ids ) ) {
continue;
}
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
$expanded_term_ids = $term_ids;
foreach ( $term_ids as $term_id ) {
$cache_key = WC_Cache_Helper::get_cache_prefix( CacheController::CACHE_GROUP ) . 'child_terms_' . $taxonomy . '_' . $term_id;
$children = wp_cache_get( $cache_key );
if ( false === $children ) {
$children = get_terms(
array(
'taxonomy' => $taxonomy,
'child_of' => $term_id,
'fields' => 'ids',
'hide_empty' => false,
)
);
if ( ! is_wp_error( $children ) ) {
wp_cache_set( $cache_key, $children, '', HOUR_IN_SECONDS );
} else {
$children = array();
}
}
$expanded_term_ids = array_merge( $expanded_term_ids, $children );
}
$term_ids = array_unique( $expanded_term_ids );
}
$term_ids_list = '(' . implode( ',', array_map( 'absint', $term_ids ) ) . ')';
/*
* Use EXISTS subquery for taxonomy filtering for several key benefits:
*
* 1. Performance: EXISTS stops execution as soon as the first matching row is found,
* making it faster than JOIN approaches that need to process all matches.
*
* 2. No duplicate rows: Unlike JOINs, EXISTS doesn't create duplicate rows when
* a product has multiple matching terms, eliminating the need for DISTINCT.
*
* 3. Clean boolean logic: We only care IF a product has the terms, not HOW MANY
* or which specific ones, making EXISTS semantically correct.
*
* 4. Efficient combination: Multiple taxonomy filters can be combined with AND
* without complex GROUP BY logic or performance degradation.
*/
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared
$tax_queries[] = $wpdb->prepare(
"EXISTS (
SELECT 1 FROM {$wpdb->term_relationships} tr
INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id = tt.term_taxonomy_id
WHERE tr.object_id = {$wpdb->posts}.ID
AND tt.taxonomy = %s
AND tt.term_id IN {$term_ids_list}
)",
$taxonomy
);
}
if ( ! empty( $tax_queries ) ) {
$args['where'] .= ' AND (' . implode( ' AND ', $tax_queries ) . ')';
} else {
$args['where'] .= ' AND 1=0';
}
return $args;
}
/**
* Join wc_product_meta_lookup to posts if not already joined.
*
* @param string $sql SQL join.
* @return string
*/
private function append_product_sorting_table_join( string $sql ): string {
global $wpdb;
if ( ! strstr( $sql, 'wc_product_meta_lookup' ) ) {
$sql .= " LEFT JOIN {$wpdb->wc_product_meta_lookup} wc_product_meta_lookup ON $wpdb->posts.ID = wc_product_meta_lookup.product_id ";
}
return $sql;
}
/**
* If price filters need adjustment to work with displayed taxes, this returns true.
*
* This logic is used when prices are stored in the database differently to how they are being displayed, with regards
* to taxes.
*
* @return boolean
*/
private function should_adjust_price_filters_for_displayed_taxes(): bool {
$display = get_option( 'woocommerce_tax_display_shop' );
$database = wc_prices_include_tax() ? 'incl' : 'excl';
return $display !== $database;
}
/**
* Get query for price filters when dealing with displayed taxes.
*
* @param float $price_filter Price filter to apply.
* @param string $column Price being filtered (min or max).
* @param string $operator Comparison operator for column. Accepts '>=' or '<='.
* @return string Constructed query.
*/
private function get_price_filter_query_for_displayed_taxes( float $price_filter, string $column = 'min_price', string $operator = '>=' ): string {
global $wpdb;
if ( ! in_array( $operator, array( '>=', '<=' ), true ) ) {
return '';
}
// Select only used tax classes to avoid unwanted calculations.
$cache_key = WC_Cache_Helper::get_cache_prefix( 'filter_clauses' ) . 'tax_classes';
$product_tax_classes = wp_cache_get( $cache_key );
if ( ! $product_tax_classes ) {
$product_tax_classes = $wpdb->get_col( "SELECT DISTINCT tax_class FROM {$wpdb->wc_product_meta_lookup};" );
wp_cache_set( $cache_key, $product_tax_classes );
}
if ( empty( $product_tax_classes ) ) {
return '';
}
$or_queries = array();
// We need to adjust the filter for each possible tax class and combine the queries into one.
foreach ( $product_tax_classes as $tax_class ) {
$adjusted_price_filter = $this->adjust_price_filter_for_tax_class( $price_filter, $tax_class );
$or_queries[] = $wpdb->prepare(
'( wc_product_meta_lookup.tax_class = %s AND wc_product_meta_lookup.`' . esc_sql( $column ) . '` ' . esc_sql( $operator ) . ' %f )',
$tax_class,
$adjusted_price_filter
);
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared
return $wpdb->prepare(
' AND (
wc_product_meta_lookup.tax_status = "taxable" AND ( 0=1 OR ' . implode( ' OR ', $or_queries ) . ')
OR ( wc_product_meta_lookup.tax_status != "taxable" AND wc_product_meta_lookup.`' . esc_sql( $column ) . '` ' . esc_sql( $operator ) . ' %f )
) ',
$price_filter
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Adjusts a price filter based on a tax class and whether or not the amount includes or excludes taxes.
*
* This calculation logic is based on `wc_get_price_excluding_tax` and `wc_get_price_including_tax` in core.
*
* @param float $price_filter Price filter amount as entered.
* @param string $tax_class Tax class for adjustment.
* @return float
*/
private function adjust_price_filter_for_tax_class( float $price_filter, string $tax_class ): float {
$tax_display = get_option( 'woocommerce_tax_display_shop' );
$tax_rates = WC_Tax::get_rates( $tax_class );
$base_tax_rates = WC_Tax::get_base_tax_rates( $tax_class );
// If prices are shown incl. tax, we want to remove the taxes from the filter amount to match prices stored excl. tax.
if ( 'incl' === $tax_display ) {
/**
* Filters if taxes should be removed from locations outside the store base location.
*
* The woocommerce_adjust_non_base_location_prices filter can stop base taxes being taken off when dealing
* with out of base locations. e.g. If a product costs 10 including tax, all users will pay 10
* regardless of location and taxes.
*
* @since 2.6.0
*
* @internal Matches filter name in WooCommerce core.
*
* @param boolean $adjust_non_base_location_prices True by default.
* @return boolean
*/
$taxes = apply_filters( 'woocommerce_adjust_non_base_location_prices', true ) ? WC_Tax::calc_tax( $price_filter, $base_tax_rates, true ) : WC_Tax::calc_tax( $price_filter, $tax_rates, true );
return $price_filter - array_sum( $taxes );
}
// If prices are shown excl. tax, add taxes to match the prices stored in the DB.
$taxes = WC_Tax::calc_tax( $price_filter, $tax_rates, false );
return $price_filter + array_sum( $taxes );
}
/**
* Get an array of attributes and terms selected from query arguments.
*
* @param array $query_vars The WP_Query arguments.
* @return array
*/
private function get_chosen_attributes( array $query_vars ): array {
$chosen_attributes = array();
if ( empty( $query_vars ) ) {
return $chosen_attributes;
}
foreach ( $query_vars as $key => $value ) {
if ( 0 === strpos( $key, 'filter_' ) ) {
$attribute = wc_sanitize_taxonomy_name( str_replace( 'filter_', '', $key ) );
$taxonomy = wc_attribute_taxonomy_name( $attribute );
$filter_terms = ! empty( $value ) ? explode( ',', wc_clean( wp_unslash( $value ) ) ) : array();
if ( empty( $filter_terms ) || ! taxonomy_exists( $taxonomy ) || ! wc_attribute_taxonomy_id_by_name( $attribute ) ) {
continue;
}
$query_type = ! empty( $query_vars[ 'query_type_' . $attribute ] ) && in_array( $query_vars[ 'query_type_' . $attribute ], array( 'and', 'or' ), true ) ? wc_clean( wp_unslash( $query_vars[ 'query_type_' . $attribute ] ) ) : '';
$chosen_attributes[ $taxonomy ]['terms'] = array_map( 'sanitize_title', $filter_terms ); // Ensures correct encoding.
$chosen_attributes[ $taxonomy ]['query_type'] = $query_type ? $query_type : 'and';
}
}
return $chosen_attributes;
}
/**
* Get an array of taxonomies and terms selected from query arguments.
*
* @param array $query_vars The WP_Query arguments.
* @return array
*/
private function get_chosen_taxonomies( array $query_vars ): array {
$chosen_taxonomies = array();
if ( empty( $query_vars ) ) {
return $chosen_taxonomies;
}
foreach ( $this->params->get_param( 'taxonomy' ) as $taxonomy => $param ) {
if ( isset( $query_vars[ $param ] ) && ! empty( trim( $query_vars[ $param ] ) ) ) {
$chosen_taxonomies[ $taxonomy ] = array_filter( array_map( 'sanitize_title', explode( ',', $query_vars[ $param ] ) ) );
}
}
return $chosen_taxonomies;
}
/**
* Get attribute lookup table name.
*
* @return string
*/
private function get_lookup_table_name(): string {
return wc_get_container()->get( LookupDataStore::class )->get_lookup_table_name();
}
}
PK [1]26uh h % ProductFilters/FilterDataProvider.phpnu taxonomy_hierarchy_data = $taxonomy_hierarchy_data;
}
/**
* Get the data provider with desired query clauses generator.
*
* @param QueryClausesGenerator $query_clauses_generator The query clauses generator instance.
*/
public function with( QueryClausesGenerator $query_clauses_generator ) {
$class_name = get_class( $query_clauses_generator );
if ( ! isset( $this->providers[ $class_name ] ) ) {
$this->providers[ $class_name ] = new FilterData( $query_clauses_generator, $this->taxonomy_hierarchy_data );
}
return $this->providers[ $class_name ];
}
}
PK [1] kt
ProductFilters/Params.phpnu init_params();
}
$keys = array();
foreach ( self::$params as $taxonomy => $params ) {
$keys = array_merge( $keys, array_values( $params ) );
if ( 'attribute' === $taxonomy ) {
$query_type_params = array_map(
function ( $param ) {
return 'query_type_' . $param;
},
array_keys( $params )
);
$keys = array_merge( $keys, $query_type_params );
}
}
return $keys;
}
/**
* Get the param.
*
* @param string $type The type of param to get.
* @return array
*/
public function get_param( string $type ): array {
if ( empty( self::$params ) ) {
$this->init_params();
}
return self::$params[ $type ] ?? array();
}
/**
* Initialize the params.
*
* @return void
*/
private function init_params(): void {
self::$params = array(
'price' => array(
'min_price',
'max_price',
),
'rating' => array(
'rating_filter',
),
'status' => array(
'filter_stock_status',
),
'attribute' => $this->get_attribute_params(),
'taxonomy' => $this->get_taxonomy_params(),
);
}
/**
* Get the attribute params.
*
* @return array
*/
private function get_attribute_params(): array {
$params = array();
foreach ( wc_get_attribute_taxonomies() as $attribute ) {
$params[ $attribute->attribute_name ] = "filter_$attribute->attribute_name";
}
return $params;
}
/**
* Get the taxonomy params.
*
* @return array
*/
private function get_taxonomy_params(): array {
$public_product_taxonomies = get_taxonomies(
array(
'public' => true,
'show_ui' => true,
),
'objects'
);
// We have control over built-in taxonomies, so we can use prettier names.
$map = array(
'product_cat' => 'categories',
'product_tag' => 'tags',
'product_brand' => 'brands',
);
$params = array();
foreach ( $public_product_taxonomies as $taxonomy ) {
if ( is_array( $taxonomy->object_type ) && in_array( 'product', $taxonomy->object_type, true ) ) {
$params[ $taxonomy->name ] = $map[ $taxonomy->name ] ?? "filter_$taxonomy->name";
}
}
return $params;
}
}
PK [1]LmK K ProductFilters/FilterData.phpnu query_clauses = $query_clauses;
$this->taxonomy_hierarchy_data = $taxonomy_hierarchy_data;
}
/**
* Get price data for current products.
*
* @param array $query_vars The WP_Query arguments.
* @return object
*/
public function get_filtered_price( array $query_vars ) {
/**
* Allows offloading the filter data to external services like Elasticsearch.
*
* @hook woocommerce_pre_product_filter_data
*
* @since 9.9.0
*
* @param array $results The results for current query.
* @param string $filter_type The type of filter. Accepts price|stock|rating|attribute.
* @param array $query_vars The query arguments to calculate the filter data.
* @param array $extra Some filter types require extra arguments for calculation, like attribute.
* @return array The filtered results or null to continue with default processing.
*/
$pre_filter_counts = apply_filters( 'woocommerce_pre_product_filter_data', null, 'price', $query_vars, array() );
if ( is_array( $pre_filter_counts ) ) {
return $pre_filter_counts;
}
$transient_key = $this->get_transient_key( $query_vars, 'price' );
$cached_data = $this->get_cache( $transient_key );
if ( ! empty( $cached_data ) ) {
return $cached_data;
}
$results = array();
$product_ids = $this->get_cached_product_ids( $query_vars );
if ( $product_ids ) {
global $wpdb;
$price_filter_sql = "
SELECT min( min_price ) as min_price, MAX( max_price ) as max_price
FROM {$wpdb->wc_product_meta_lookup}
WHERE product_id IN ( {$product_ids} )
";
/**
* We can't use $wpdb->prepare() here because using %s with
* $wpdb->prepare() for a subquery won't work as it will escape the SQL
* query.
* We're using the query as is, same as Core does.
*/
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$results = (array) $wpdb->get_row( $price_filter_sql );
}
/**
* Filters the product filter data before it is returned.
*
* @hook woocommerce_product_filter_data
* @since 9.9.0
*
* @param array $results The results for current query.
* @param string $filter_type The type of filter. Accepts price|stock|rating|attribute.
* @param array $query_vars The query arguments to calculate the filter data.
* @param array $extra Some filter types require extra arguments for calculation, like attribute.
* @return array The filtered results
*/
$results = apply_filters( 'woocommerce_product_filter_data', $results, 'price', $query_vars, array() );
$this->set_cache( $transient_key, $results );
return $results;
}
/**
* Get stock status counts for the current products.
*
* @param array $query_vars The WP_Query arguments.
* @param array $statuses Array of stock status values to count.
* @return array status=>count pairs.
*/
public function get_stock_status_counts( array $query_vars, array $statuses ) {
/**
* Filter the data. @see get_filtered_price() for full documentation.
*/
$pre_filter_counts = apply_filters( 'woocommerce_pre_product_filter_data', null, 'stock', $query_vars, array() ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
if ( is_array( $pre_filter_counts ) ) {
return $pre_filter_counts;
}
$transient_key = $this->get_transient_key( $query_vars, 'stock' );
$cached_data = $this->get_cache( $transient_key );
if ( ! empty( $cached_data ) ) {
return $cached_data;
}
$results = array();
$product_ids = $this->get_cached_product_ids( $query_vars );
if ( $product_ids ) {
global $wpdb;
foreach ( $statuses as $status ) {
$stock_status_count_sql = "
SELECT COUNT( DISTINCT posts.ID ) as status_count
FROM {$wpdb->posts} as posts
INNER JOIN {$wpdb->postmeta} as postmeta ON posts.ID = postmeta.post_id
AND postmeta.meta_key = '_stock_status'
AND postmeta.meta_value = '" . esc_sql( $status ) . "'
WHERE posts.ID IN ( {$product_ids} )
";
/**
* We can't use $wpdb->prepare() here because using %s with
* $wpdb->prepare() for a subquery won't work as it will escape the
* SQL query.
* We're using the query as is, same as Core does.
*/
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$result = $wpdb->get_row( $stock_status_count_sql );
$results[ $status ] = $result->status_count;
}
}
/**
* Filter the results. @see get_filtered_price() for full documentation.
*/
$results = apply_filters( 'woocommerce_product_filter_data', $results, 'stock', $query_vars, array() ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
$this->set_cache( $transient_key, $results );
return $results;
}
/**
* Get rating counts for the current products.
*
* @param array $query_vars The WP_Query arguments.
* @return array rating=>count pairs.
*/
public function get_rating_counts( array $query_vars ) {
/**
* Filter the data. @see get_filtered_price() for full documentation.
*/
$pre_filter_counts = apply_filters( 'woocommerce_pre_product_filter_data', null, 'rating', $query_vars, array() ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
if ( is_array( $pre_filter_counts ) ) {
return $pre_filter_counts;
}
$transient_key = $this->get_transient_key( $query_vars, 'rating' );
$cached_data = $this->get_cache( $transient_key );
if ( ! empty( $cached_data ) ) {
return $cached_data;
}
$results = array();
$product_ids = $this->get_cached_product_ids( $query_vars );
if ( $product_ids ) {
global $wpdb;
$rating_count_sql = "
SELECT COUNT( DISTINCT product_id ) as product_count, ROUND( average_rating, 0 ) as rounded_average_rating
FROM {$wpdb->wc_product_meta_lookup}
WHERE product_id IN ( {$product_ids} )
AND average_rating > 0
GROUP BY rounded_average_rating
ORDER BY rounded_average_rating DESC
";
/**
* We can't use $wpdb->prepare() here because using %s with
* $wpdb->prepare() for a subquery won't work as it will escape the
* SQL query.
* We're using the query as is, same as Core does.
*/
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$results = $wpdb->get_results( $rating_count_sql );
$results = array_map( 'absint', wp_list_pluck( $results, 'product_count', 'rounded_average_rating' ) );
}
/**
* Filter the results. @see get_filtered_price() for full documentation.
*/
$results = apply_filters( 'woocommerce_product_filter_data', $results, 'rating', $query_vars, array() ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
$this->set_cache( $transient_key, $results );
return $results;
}
/**
* Get attribute counts for the current products.
*
* @param array $query_vars The WP_Query arguments.
* @param string $attribute_to_count Attribute taxonomy name.
* @return array termId=>count pairs.
*/
public function get_attribute_counts( array $query_vars, string $attribute_to_count ) {
/**
* Filter the data. @see get_filtered_price() for full documentation.
*/
$pre_filter_counts = apply_filters( 'woocommerce_pre_product_filter_data', null, 'attribute', $query_vars, array( 'taxonomy' => $attribute_to_count ) ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
if ( is_array( $pre_filter_counts ) ) {
return $pre_filter_counts;
}
$transient_key = $this->get_transient_key( $query_vars, 'attribute', array( 'taxonomy' => $attribute_to_count ) );
$cached_data = $this->get_cache( $transient_key );
if ( ! empty( $cached_data ) ) {
return $cached_data;
}
$results = array();
$product_ids = $this->get_cached_product_ids( $query_vars );
if ( $product_ids ) {
global $wpdb;
$taxonomy_escaped = esc_sql( wc_sanitize_taxonomy_name( $attribute_to_count ) );
$attribute_count_sql = "
SELECT COUNT( DISTINCT posts.ID ) as term_count, terms.term_id as term_count_id
FROM {$wpdb->posts} AS posts
INNER JOIN {$wpdb->term_relationships} AS term_relationships ON posts.ID = term_relationships.object_id
INNER JOIN {$wpdb->term_taxonomy} AS term_taxonomy USING( term_taxonomy_id )
INNER JOIN {$wpdb->terms} AS terms USING( term_id )
WHERE posts.ID IN ( {$product_ids} )
AND term_taxonomy.taxonomy = '{$taxonomy_escaped}'
GROUP BY terms.term_id
";
/**
* We can't use $wpdb->prepare() here because using %s with
* $wpdb->prepare() for a subquery won't work as it will escape the
* SQL query.
* We're using the query as is, same as Core does.
*/
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$results = $wpdb->get_results( $attribute_count_sql );
$results = array_map( 'absint', wp_list_pluck( $results, 'term_count', 'term_count_id' ) );
}
/**
* Filter the results. @see get_filtered_price() for full documentation.
*
* @since 9.9.0
*/
$results = apply_filters( 'woocommerce_product_filter_data', $results, 'attribute', $query_vars, array( 'taxonomy' => $attribute_to_count ) );
$this->set_cache( $transient_key, $results );
return $results;
}
/**
* Get taxonomy counts for the current products.
*
* @param array $query_vars The WP_Query arguments.
* @param string $taxonomy_to_count Taxonomy name.
* @return array termId=>count pairs.
*/
public function get_taxonomy_counts( array $query_vars, string $taxonomy_to_count ) {
/**
* Filter the data. @see get_filtered_price() for full documentation.
*
* @since 9.9.0
*/
$pre_filter_counts = apply_filters( 'woocommerce_pre_product_filter_data', null, 'taxonomy', $query_vars, array( 'taxonomy' => $taxonomy_to_count ) );
if ( is_array( $pre_filter_counts ) ) {
return $pre_filter_counts;
}
$transient_key = $this->get_transient_key( $query_vars, 'taxonomy', array( 'taxonomy' => $taxonomy_to_count ) );
$cached_data = $this->get_cache( $transient_key );
if ( ! empty( $cached_data ) ) {
return $cached_data;
}
$results = array();
$product_ids = $this->get_cached_product_ids( $query_vars );
if ( $product_ids ) {
global $wpdb;
$taxonomy_escaped = esc_sql( wc_sanitize_taxonomy_name( $taxonomy_to_count ) );
if ( is_taxonomy_hierarchical( $taxonomy_to_count ) ) {
$results = $this->get_hierarchical_taxonomy_counts( $product_ids, $taxonomy_to_count );
} else {
$taxonomy_count_sql = "
SELECT COUNT( DISTINCT term_relationships.object_id ) as term_count, term_taxonomy.term_taxonomy_id as term_count_id
FROM {$wpdb->term_relationships} AS term_relationships
INNER JOIN {$wpdb->term_taxonomy} AS term_taxonomy USING( term_taxonomy_id )
WHERE term_relationships.object_id IN ( {$product_ids} )
AND term_taxonomy.taxonomy = '{$taxonomy_escaped}'
GROUP BY term_taxonomy.term_taxonomy_id
";
/**
* We can't use $wpdb->prepare() here because using %s with
* $wpdb->prepare() for a subquery won't work as it will escape the
* SQL query.
* We're using the query as is, same as Core does.
*/
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$base_results = $wpdb->get_results( $taxonomy_count_sql );
$results = array_map( 'absint', wp_list_pluck( $base_results, 'term_count', 'term_count_id' ) );
}
}
/**
* Filter the results. @see get_filtered_price() for full documentation.
*
* @since 9.9.0
*/
$results = apply_filters( 'woocommerce_product_filter_data', $results, 'taxonomy', $query_vars, array( 'taxonomy' => $taxonomy_to_count ) );
$this->set_cache( $transient_key, $results );
return $results;
}
/**
* Get hierarchical taxonomy counts using optimized hierarchy data.
*
* @param string $product_ids Comma-separated list of product IDs.
* @param string $taxonomy_name Original taxonomy name for hierarchy methods.
* @return array Array of term_id => count pairs.
*/
private function get_hierarchical_taxonomy_counts( string $product_ids, string $taxonomy_name ) {
global $wpdb;
// Step 1: Get all terms that have products in the filtered set (1 query).
$taxonomy_escaped = esc_sql( wc_sanitize_taxonomy_name( $taxonomy_name ) );
$base_terms_sql = "
SELECT DISTINCT tt.term_id, tt.term_taxonomy_id
FROM {$wpdb->term_relationships} tr
INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id = tt.term_taxonomy_id
WHERE tr.object_id IN ( {$product_ids} )
AND tt.taxonomy = '{$taxonomy_escaped}'
";
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$base_terms = $wpdb->get_results( $base_terms_sql );
if ( empty( $base_terms ) ) {
return array();
}
// Step 2: Build hierarchy relationships using TaxonomyHierarchyData.
$hierarchy_counts = array();
$processed_terms = array();
// Process each base term and its ancestors.
foreach ( $base_terms as $term ) {
$term_id = (int) $term->term_id;
// Count for the term itself and all its descendants.
if ( ! isset( $hierarchy_counts[ $term_id ] ) ) {
$descendants = $this->taxonomy_hierarchy_data->get_descendants( $term_id, $taxonomy_name );
$descendants[] = $term_id; // Include the term itself.
$hierarchy_counts[ $term_id ] = $descendants;
}
// Get ancestors using hierarchy data.
$ancestors = $this->taxonomy_hierarchy_data->get_ancestors( $term_id, $taxonomy_name );
foreach ( $ancestors as $ancestor_id ) {
if ( in_array( $ancestor_id, $processed_terms, true ) ) {
continue;
}
$descendants = $this->taxonomy_hierarchy_data->get_descendants( $ancestor_id, $taxonomy_name );
$descendants[] = $ancestor_id; // Include the ancestor term itself.
$hierarchy_counts[ $ancestor_id ] = $descendants;
$processed_terms[] = $ancestor_id;
}
}
if ( empty( $hierarchy_counts ) ) {
return array();
}
// Step 3: Execute batch counting using a single query with CASE statements.
$count_cases = array();
foreach ( $hierarchy_counts as $term_id => $term_ids ) {
$term_ids_str = implode( ',', array_map( 'absint', $term_ids ) );
$count_cases[] = "COUNT(DISTINCT CASE WHEN tt.term_id IN ({$term_ids_str}) THEN tr.object_id END) as count_{$term_id}";
}
$batch_count_sql = '
SELECT ' . implode( ', ', $count_cases ) . "
FROM {$wpdb->term_relationships} tr
INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id = tt.term_taxonomy_id
WHERE tr.object_id IN ( {$product_ids} )
AND tt.taxonomy = '{$taxonomy_escaped}'
";
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$count_result = $wpdb->get_row( $batch_count_sql, ARRAY_A );
if ( empty( $count_result ) ) {
return array();
}
// Parse results back to term_id => count format.
$final_counts = array();
foreach ( $hierarchy_counts as $term_id => $term_ids ) {
$count_key = "count_{$term_id}";
if ( isset( $count_result[ $count_key ] ) && $count_result[ $count_key ] > 0 ) {
$final_counts[ $term_id ] = absint( $count_result[ $count_key ] );
}
}
return $final_counts;
}
/**
* Get filter data transient key.
*
* @param array $query_vars The query arguments to calculate the filter data.
* @param string $filter_type The type of filter. Accepts price|stock|rating|attribute.
* @param array $extra Some filter types require extra arguments for calculation, like attribute.
*/
private function get_transient_key( $query_vars, $filter_type, $extra = array() ) {
return sprintf(
'wc_%s_%s',
CacheController::CACHE_GROUP,
md5(
wp_json_encode(
array(
'query_vars' => $query_vars,
'extra' => $extra,
'filter_type' => $filter_type,
)
)
)
);
}
/**
* Get cached filter data.
*
* @param string $key Transient key.
*/
private function get_cache( $key ) {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
return null;
}
$cache = get_transient( $key );
$transient_version = WC_Cache_Helper::get_transient_version( CacheController::CACHE_GROUP );
if ( empty( $cache['version'] ) ||
! is_array( $cache['value'] ) ||
empty( $cache['value'] ) ||
$transient_version !== $cache['version']
) {
return null;
}
return $cache['value'];
}
/**
* Set the cache with transient version to invalidate all at once when needed.
*
* @param string $key Transient key.
* @param mix $value Value to set.
*
* @return bool True if the cache was set, false otherwise.
*/
private function set_cache( $key, $value ) {
if ( ! is_array( $value ) ) {
return false;
}
$transient_version = WC_Cache_Helper::get_transient_version( CacheController::CACHE_GROUP );
$transient_value = array(
'version' => $transient_version,
'value' => $value,
);
$result = set_transient( $key, $transient_value, DAY_IN_SECONDS );
return $result;
}
/**
* Get cached product IDs from query vars.
*
* Executes a WP_Query with the given query vars and returns a comma-separated string of product IDs.
* Results are cached to avoid repeated database queries.
*
* @param array $query_vars The WP_Query arguments.
* @return string Comma-separated list of product IDs.
*/
private function get_cached_product_ids( array $query_vars ) {
$cache_key = WC_Cache_Helper::get_cache_prefix( CacheController::CACHE_GROUP ) . md5( wp_json_encode( $query_vars ) );
$cache = wp_cache_get( $cache_key );
if ( $cache ) {
return $cache;
}
add_filter( 'posts_clauses', array( $this->query_clauses, 'add_query_clauses' ), 10, 2 );
add_filter( 'posts_pre_query', '__return_empty_array' );
$query_vars['no_found_rows'] = true;
$query_vars['posts_per_page'] = -1;
$query_vars['fields'] = 'ids';
$query = new \WP_Query();
$query->query( $query_vars );
remove_filter( 'posts_clauses', array( $this->query_clauses, 'add_query_clauses' ), 10 );
remove_filter( 'posts_pre_query', '__return_empty_array' );
global $wpdb;
// The query is already prepared by WP_Query.
$results = $wpdb->get_results( $query->request, ARRAY_A ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
if ( ! $results ) {
$results = array();
}
$results = implode( ',', array_column( $results, 'ID' ) );
wp_cache_set( $cache_key, $results );
return $results;
}
}
PK [1]0M@ @ ( ProductFilters/TaxonomyHierarchyData.phpnu hierarchy_data[ $taxonomy ] ) ) {
return $this->hierarchy_data[ $taxonomy ];
}
// Check option cache.
$cache_key = self::CACHE_GROUP . '_' . $taxonomy;
$cached_map = null;
if ( ! ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {
$cached_map = get_option( $cache_key );
}
if ( ! empty( $cached_map ) && $this->validate_cache( $cached_map ) ) {
// Cache in memory and return.
$this->hierarchy_data[ $taxonomy ] = $cached_map;
return $cached_map;
}
// Build the complete hierarchy map with all descendants pre-computed.
$map = $this->build_full_hierarchy_map( $taxonomy );
// Cache the map in options and memory.
if ( ! ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ) {
update_option( $cache_key, $map, false );
}
$this->hierarchy_data[ $taxonomy ] = $map;
return $map;
}
/**
* Get all descendants for a term.
*
* @param int $term_id The term ID.
* @param string $taxonomy The taxonomy name.
* @return array Array of all descendant term IDs.
*/
public function get_descendants( int $term_id, string $taxonomy ): array {
$map = $this->get_hierarchy_map( $taxonomy );
return $map['descendants'][ $term_id ] ?? array();
}
/**
* Get ancestor chain for batch processing.
*
* @param int $term_id The term ID.
* @param string $taxonomy The taxonomy name.
* @return array Array of ancestor term IDs (bottom-up).
*/
public function get_ancestors( int $term_id, string $taxonomy ): array {
$map = $this->get_hierarchy_map( $taxonomy );
return $map['ancestors'][ $term_id ] ?? array();
}
/**
* Clear hierarchy cache for a taxonomy.
*
* @param string $taxonomy The taxonomy name.
*/
public function clear_cache( string $taxonomy ): void {
// Clear in-memory cache for this taxonomy.
unset( $this->hierarchy_data[ $taxonomy ] );
// Clear only the specific taxonomy's option cache.
$cache_key = self::CACHE_GROUP . '_' . $taxonomy;
delete_option( $cache_key );
}
/**
* Check if the cache is valid.
*
* @param array $data Cache data.
*
* @return boolean
*/
private function validate_cache( $data ) {
return is_array( $data ) &&
array_key_exists( 'descendants', $data ) &&
array_key_exists( 'ancestors', $data ) &&
array_key_exists( 'tree', $data );
}
/**
* Build hierarchy map for FilterData and ProductFilterTaxonomy.
*
* Pre-computes descendants and ancestor chains for maximum query speed.
*
* @param string $taxonomy The taxonomy name.
* @return array Complete hierarchy map with descendants and ancestor chains.
*/
private function build_full_hierarchy_map( string $taxonomy ): array {
$terms = get_terms(
array(
'taxonomy' => $taxonomy,
'hide_empty' => false,
'orderby' => 'name',
'order' => 'ASC',
)
);
if ( is_wp_error( $terms ) || empty( $terms ) ) {
return array();
}
$map = array(
'descendants' => array(), // term_id => [descendant_ids].
'ancestors' => array(), // term_id => [ancestor_ids].
'tree' => array(),
);
// Build core lookups and temporary structures.
$temp_children = array();
$temp_parents = array();
$temp_terms = array();
foreach ( $terms as $term ) {
$term_id = $term->term_id;
$parent_id = $term->parent;
$temp_parents[ $term_id ] = $parent_id;
if ( ! isset( $temp_children[ $parent_id ] ) ) {
$temp_children[ $parent_id ] = array();
}
$temp_children[ $parent_id ][] = $term_id;
$temp_terms[ $term_id ] = array(
'slug' => $term->slug,
'name' => $term->name,
'parent' => $parent_id,
'term_id' => $term->term_id,
);
}
// Pre-compute descendants and ancestors.
foreach ( array_keys( $temp_parents ) as $term_id ) {
$map['descendants'][ $term_id ] = $this->compute_descendants( $term_id, $temp_children );
$map['ancestors'][ $term_id ] = $this->compute_ancestors( $term_id, $temp_parents );
}
foreach ( $temp_children[0] as $term_id ) {
$this->build_term_tree( $map['tree'], $term_id, $temp_children, $temp_terms );
}
return $map;
}
/**
* Recursively build hierarchical term tree with depth and parent.
*
* @param array $tree Reference to tree array being built.
* @param int $term_id Current term ID.
* @param array $children Children relationships map (parent_id => [child_ids]).
* @param array $temp_terms Term data indexed by term_id.
* @param int $depth Current depth level in hierarchy.
*/
private function build_term_tree( &$tree, $term_id, $children, $temp_terms, $depth = 0 ) {
$tree[ $term_id ] = $temp_terms[ $term_id ];
$tree[ $term_id ]['depth'] = $depth;
if ( ! empty( $children[ $term_id ] ) ) {
foreach ( $children[ $term_id ] as $child_id ) {
$this->build_term_tree( $tree[ $term_id ]['children'], $child_id, $children, $temp_terms, $depth + 1 );
}
}
}
/**
* Compute all descendants of a term.
*
* @param int $term_id The term ID.
* @param array $children Children relationships map.
* @return array Array of descendant term IDs.
*/
private function compute_descendants( int $term_id, array $children ): array {
$descendants = array();
if ( ! isset( $children[ $term_id ] ) ) {
return $descendants;
}
foreach ( $children[ $term_id ] as $child_id ) {
$descendants[] = $child_id;
$descendants = array_merge( $descendants, $this->compute_descendants( $child_id, $children ) );
}
return array_unique( $descendants );
}
/**
* Compute ancestor chain for a term.
*
* @param int $term_id The term ID.
* @param array $parent_lookup Parent relationships.
* @return array Array of ancestor term IDs (bottom-up).
*/
private function compute_ancestors( int $term_id, array $parent_lookup ): array {
$ancestors = array();
$current_id = $term_id;
while ( isset( $parent_lookup[ $current_id ] ) && $parent_lookup[ $current_id ] > 0 ) {
$parent_id = $parent_lookup[ $current_id ];
$ancestors[] = $parent_id;
$current_id = $parent_id;
}
return $ancestors;
}
}
PK [1]) " ProductFilters/CacheController.phpnu taxonomy_hierarchy_data = $taxonomy_hierarchy_data;
}
/**
* Hook into actions and filters.
*/
public function register() {
if ( ! $this->need_cleanup() ) {
return;
}
add_action( 'woocommerce_after_product_object_save', array( $this, 'invalidate_filter_data_cache' ) );
add_action( 'woocommerce_delete_product_transients', array( $this, 'invalidate_filter_data_cache' ) );
// Clear taxonomy hierarchy cache when terms change.
add_action( 'created_term', array( $this, 'clear_taxonomy_hierarchy_cache' ), 10, 3 );
add_action( 'edited_term', array( $this, 'clear_taxonomy_hierarchy_cache' ), 10, 3 );
add_action( 'delete_term', array( $this, 'clear_taxonomy_hierarchy_cache' ), 10, 3 );
}
/**
* Invalidate all cache under filter data group.
*/
public function invalidate_filter_data_cache(): void {
WC_Cache_Helper::get_transient_version( self::CACHE_GROUP, true );
WC_Cache_Helper::invalidate_cache_group( self::CACHE_GROUP );
}
/**
* Clear taxonomy hierarchy cache when terms are created, updated, or deleted.
*
* @param int $term_id Term ID.
* @param int $term_taxonomy_id Term taxonomy ID.
* @param string $taxonomy Taxonomy slug.
*/
public function clear_taxonomy_hierarchy_cache( $term_id, $term_taxonomy_id, $taxonomy ) {
// Only clear cache for hierarchical taxonomies.
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
$this->taxonomy_hierarchy_data->clear_cache( $taxonomy );
}
}
/**
* Delete all filter data transients.
*/
public function delete_filter_data_transients(): void {
if ( ! $this->need_cleanup() ) {
return;
}
global $wpdb;
$wpdb->query(
$wpdb->prepare(
"DELETE FROM {$wpdb->options} WHERE option_name LIKE %s OR option_name LIKE %s",
$wpdb->esc_like( '_transient_wc_filter_data_' ) . '%',
$wpdb->esc_like( '_transient_timeout_wc_filter_data_' ) . '%'
)
);
}
/**
* Check if the filter data cache should be cleaned up.
* If the cache group is not set, it means that the store is not using
* the product filters and we don't need to register the hooks.
*
* @return bool
*/
public function need_cleanup() {
return ! empty( get_transient( self::CACHE_GROUP . '-transient-version' ) );
}
}
PK [1]Q , ProductFilters/Interfaces/FilterUrlParam.phpnu query_clauses = $query_clauses;
$this->params = $params;
}
/**
* Hook into actions and filters.
*
* @return void
*/
public function register(): void {
add_filter( 'posts_clauses', array( $this->query_clauses, 'add_query_clauses_for_main_query' ), 10, 2 );
add_filter( 'query_vars', array( $this, 'add_query_vars' ) );
}
/**
* Register custom query vars for our filters. Price, stock status, and attribute query vars are
* already registered at WC_Query.
*
* @param array $query_vars Query vars.
* @return array
*/
public function add_query_vars( array $query_vars ): array {
return array_merge( $query_vars, $this->params->get_param_keys() );
}
}
PK [1]=ke e McStats.phpnu get_current_stats();
if ( isset( $stats[ $group_name ] ) && ! empty( $stats[ $group_name ] ) ) {
return array( "x_woocommerce-{$group_name}" => implode( ',', $stats[ $group_name ] ) );
}
return array();
}
/**
* Outputs the tracking pixels for the current stats and empty the stored stats from the object
*
* @return void
*/
public function do_stats() {
if ( ! \WC_Site_Tracking::is_tracking_enabled() ) {
return;
}
parent::do_stats();
}
/**
* Runs stats code for a one-off, server-side.
*
* @param string $url string The URL to be pinged. Should include `x_woocommerce-{$group}={$stats}` or whatever we want to store.
*
* @return bool If it worked.
*/
public function do_server_side_stat( $url ) {
if ( ! \WC_Site_Tracking::is_tracking_enabled() ) {
return false;
}
return parent::do_server_side_stat( $url );
}
/**
* Pings the stats server for the current stats and empty the stored stats from the object
*
* @return void
*/
public function do_server_side_stats() {
if ( ! \WC_Site_Tracking::is_tracking_enabled() ) {
return;
}
parent::do_server_side_stats();
}
}
PK [1] + + / CostOfGoodsSold/CogsAwareUnitTestSuiteTrait.phpnu register_legacy_proxy_function_mocks(
array(
'wc_doing_it_wrong' => function ( $function_name, $message ) {
// phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
throw new \Exception( "Doing it wrong, function: '$function_name', message: '$message'" );
},
)
);
$this->expectExceptionMessage( "Doing it wrong, function: '{$method_name}', message: 'The Cost of Goods sold feature is disabled, thus the method called will do nothing and will return dummy data.'" );
}
}
PK [1]m< < " CostOfGoodsSold/CogsAwareTrait.phpnu get( CostOfGoodsSoldController::class )->feature_is_enabled() ) {
return true;
}
if ( $doing_it_wrong_function_name ) {
wc_get_container()->get( LegacyProxy::class )->call_function(
'wc_doing_it_wrong',
$doing_it_wrong_function_name,
'The Cost of Goods sold feature is disabled, thus the method called will do nothing and will return dummy data.',
'9.5.0'
);
}
return false;
}
}
PK [1]zgp p - CostOfGoodsSold/CostOfGoodsSoldController.phpnu features_controller = $features_controller;
}
/**
* Is the Cost of Goods Sold engine enabled?
*
* @return bool True if the engine is enabled, false otherwise.
*/
public function feature_is_enabled(): bool {
return $this->features_controller->feature_is_enabled( 'cost_of_goods_sold' );
}
/**
* Add the feature information for the features settings page.
*
* @param FeaturesController $features_controller The instance of FeaturesController to use.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function add_feature_definition( $features_controller ) {
$definition = array(
'description' => __( 'Allows entering cost of goods sold information for products.', 'woocommerce' ),
'is_experimental' => false,
'enabled_by_default' => false,
'default_plugin_compatibility' => FeaturePluginCompatibility::COMPATIBLE,
);
$features_controller->add_feature_definition(
'cost_of_goods_sold',
__( 'Cost of Goods Sold', 'woocommerce' ),
$definition
);
}
/**
* Add the entry for "add/remove COGS value column to/from the product meta lookup table" to the WooCommerce admin tools.
*
* @internal Hook handler, not to be explicitly used from outside the class.
*
* @param array $tools_array Array to add the tool to.
* @return array Updated tools array.
*/
public function add_debug_tools_entry( array $tools_array ): array {
// If the feature is disabled we show the tool for removing the column, but not for adding it.
$column_exists = $this->product_meta_lookup_table_cogs_value_columns_exist();
if ( ! $this->feature_is_enabled() && ! $column_exists ) {
return $tools_array;
}
$tools_array['generate_cogs_value_meta_column'] = array(
'name' => $column_exists ?
__( 'Remove COGS columns from the product meta lookup table', 'woocommerce' ) :
__( 'Create COGS columns in the product meta lookup table', 'woocommerce' ),
'button' => $column_exists ?
__( 'Remove columns', 'woocommerce' ) :
__( 'Create columns', 'woocommerce' ),
'desc' =>
$column_exists ?
__( 'This tool will remove the Cost of Goods Sold (COGS) related columns from the product meta lookup table. COGS will continue working (if the feature is enabled) but some functionality will not be available.', 'woocommerce' ) :
__( 'This tool will generate the necessary Cost of Goods Sold (COGS) related columns in the product meta lookup table, and populate them from existing product data.', 'woocommerce' ),
'callback' =>
$column_exists ? array( $this, 'remove_lookup_cogs_columns' ) : array( $this, 'generate_lookup_cogs_columns' ),
);
return $tools_array;
}
/**
* Handler for the "add COGS value column to the product meta lookup table" admin tool.
*
* @internal Tool callback, not to be explicitly used from outside the class.
*/
public function generate_lookup_cogs_columns() {
global $wpdb;
if ( $this->feature_is_enabled() && ! $this->product_meta_lookup_table_cogs_value_columns_exist() ) {
$wpdb->query( "ALTER TABLE {$wpdb->prefix}wc_product_meta_lookup ADD COLUMN cogs_total_value DECIMAL(19,4)" );
$wpdb->query(
"UPDATE {$wpdb->prefix}wc_product_meta_lookup AS lookup
JOIN {$wpdb->prefix}postmeta AS pm ON lookup.product_id = pm.post_id
SET lookup.cogs_total_value = CAST(pm.meta_value AS DECIMAL(19, 4))
WHERE pm.meta_key = '_cogs_total_value';"
);
}
}
/**
* Handler for the "remove COGS value column to the product meta lookup table" admin tool.
*
* @internal Tool callback, not to be explicitly used from outside the class.
*/
public function remove_lookup_cogs_columns() {
global $wpdb;
if ( $this->product_meta_lookup_table_cogs_value_columns_exist() ) {
$wpdb->query( "ALTER TABLE {$wpdb->prefix}wc_product_meta_lookup DROP COLUMN cogs_total_value" );
}
}
/**
* Tells if the COGS value column exists in the product meta lookup table.
*
* @return bool True if the column exists, false otherwise.
*/
public function product_meta_lookup_table_cogs_value_columns_exist(): bool {
global $wpdb;
return (bool) $wpdb->get_var(
$wpdb->prepare(
"SHOW COLUMNS FROM {$wpdb->prefix}wc_product_meta_lookup LIKE %s",
'cogs_total_value'
)
);
}
/**
* Get the tooltip text for the COGS value field in the product editor.
*
* @param bool $for_variable_products True to get the value for variable products, false for other types of products.
* @return string The string to use as tooltip (translated but not escaped).
*/
public function get_general_cost_edit_field_tooltip( bool $for_variable_products ) {
return $for_variable_products ?
__( 'Add the amount it costs you to buy or make this product. This will be applied as the default value for variations.', 'woocommerce' ) :
__( 'Add the amount it costs you to buy or make this product.', 'woocommerce' );
}
}
PK [1]sN? ? 0 CostOfGoodsSold/CogsAwareRestControllerTrait.phpnu cogs_is_enabled() ) {
return;
}
$data['cost_of_goods_sold'] = array(
'values' => array(
array(
'defined_value' => $product->get_cogs_value(),
'effective_value' => $product->get_cogs_effective_value(),
),
),
'total_value' => $product->get_cogs_total_value(),
);
if ( $product instanceof \WC_Product_Variation ) {
$data['cost_of_goods_sold']['defined_value_is_additive'] = $product->get_cogs_value_is_additive();
}
}
/**
* Apply Cost of Goods Sold related information received in the request body to a product object.
*
* @param WP_Rest_Request $request Request data.
* @param WC_Product $product The product to apply the data to.
*/
private function set_cogs_info_in_product_object( $request, $product ): void {
$values = $request['cost_of_goods_sold']['values'] ?? null;
if ( ! is_null( $values ) ) {
$value = 0;
foreach ( $values as $value_info ) {
$value += (float) ( $value_info['defined_value'] ?? 0 );
}
$product->set_cogs_value( $value );
}
if ( $product instanceof \WC_Product_Variation ) {
$is_additive = $request['cost_of_goods_sold']['defined_value_is_additive'] ?? null;
if ( ! is_null( $is_additive ) ) {
$product->set_cogs_value_is_additive( $is_additive );
}
}
}
/**
* Add Cost of Goods Sold related schema information to a given REST endpoint schema.
*
* @param array $schema The schema data set to add the information to.
* @param bool $for_variations_controller True if the information is for an endpoint in the variations controller.
* @return array Updated schema information.
*/
private function add_cogs_related_product_schema( array $schema, bool $for_variations_controller ): array {
$schema['properties']['cost_of_goods_sold'] = array(
'description' => __( 'Cost of Goods Sold data.', 'woocommerce' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'properties' => array(
'values' => array(
'description' => __( 'Cost of Goods Sold values for the product.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'items' => array(
'type' => 'object',
'properties' => array(
'defined_value' => array(
'description' => __( 'Defined cost value.', 'woocommerce' ),
'type' => 'number',
'context' => array( 'view', 'edit' ),
),
'effective_value' => array(
'description' => __( 'Effective monetary cost value.', 'woocommerce' ),
'type' => 'number',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'defined_value_is_additive' => array(
'description' => __( 'Applies to variations only. If true, the effective value is the base value from the parent product plus the defined value; if false, the defined value is the final effective value.', 'woocommerce' ),
'type' => 'boolean',
'default' => false,
'context' => array( 'view', 'edit' ),
),
'total_value' => array(
'description' => __( 'Total monetary value of the Cost of Goods Sold for the product (sum of all the effective values).', 'woocommerce' ),
'type' => 'number',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
);
if ( $for_variations_controller ) {
$schema['properties']['cost_of_goods_sold']['properties']['defined_value_is_additive']['description'] =
__( 'If true, the effective value is the base value from the parent product plus the defined value; if false, the defined value is the final effective value.', 'woocommerce' );
}
return $schema;
}
}
PK [1]:7 + BatchProcessing/BatchProcessorInterface.phpnu handle_watchdog_action();
}
);
add_action(
self::PROCESS_SINGLE_BATCH_ACTION_NAME,
function ( $batch_process ) {
$this->process_next_batch_for_single_processor( $batch_process );
},
10,
2
);
add_action(
'shutdown',
function () {
$this->remove_or_retry_failed_processors();
}
);
$this->logger = wc_get_logger();
}
/**
* Enqueue a processor so that it will get batch processing requests from within scheduled actions.
*
* @param string $processor_class_name Fully qualified class name of the processor, must implement `BatchProcessorInterface`.
*/
public function enqueue_processor( string $processor_class_name ): void {
$pending_updates = $this->get_enqueued_processors();
if ( ! in_array( $processor_class_name, array_keys( $pending_updates ), true ) ) {
$pending_updates[] = $processor_class_name;
$this->set_enqueued_processors( $pending_updates );
}
$this->schedule_watchdog_action( false, true );
}
/**
* Schedule the watchdog action.
*
* @param bool $with_delay Whether to delay the action execution. Should be true when rescheduling, false when enqueueing.
* @param bool $unique Whether to make the action unique.
*/
private function schedule_watchdog_action( bool $with_delay = false, bool $unique = false ): void {
$time = time();
if ( $with_delay ) {
/**
* Modify the delay interval for the batch processor's watchdog events.
*
* @since 8.2.0
*
* @param int $delay Time, in seconds, before the watchdog process will run. Defaults to 3600 (1 hour).
*/
$time += apply_filters( 'woocommerce_batch_processor_watchdog_delay_seconds', HOUR_IN_SECONDS );
}
if ( ! as_has_scheduled_action( self::WATCHDOG_ACTION_NAME ) ) {
as_schedule_single_action(
$time,
self::WATCHDOG_ACTION_NAME,
array(),
self::ACTION_GROUP,
$unique
);
}
}
/**
* Schedule a processing action for all the processors that are enqueued but not scheduled
* (because they have just been enqueued, or because the processing for a batch failed).
*/
private function handle_watchdog_action(): void {
$pending_processes = $this->get_enqueued_processors();
if ( empty( $pending_processes ) ) {
return;
}
foreach ( $pending_processes as $process_name ) {
if ( ! $this->is_scheduled( $process_name ) ) {
$this->schedule_batch_processing( $process_name );
}
}
$this->schedule_watchdog_action( true );
}
/**
* Process a batch for a single processor, and handle any required rescheduling or state cleanup.
*
* @param string $processor_class_name Fully qualified class name of the processor.
*
* @throws \Exception If error occurred during batch processing.
*/
private function process_next_batch_for_single_processor( string $processor_class_name ): void {
if ( ! $this->is_enqueued( $processor_class_name ) ) {
return;
}
$batch_processor = $this->get_processor_instance( $processor_class_name );
$error = $this->process_next_batch_for_single_processor_core( $batch_processor );
$still_pending = count( $batch_processor->get_next_batch_to_process( 1 ) ) > 0;
if ( ( $error instanceof \Exception ) ) {
// The batch processing failed and no items were processed:
// reschedule the processing with a delay, unless this is a repeatead failure.
if ( $this->is_consistently_failing( $batch_processor ) ) {
$this->log_consistent_failure( $batch_processor, $this->get_process_details( $batch_processor ) );
$this->remove_processor( $processor_class_name );
} else {
$this->schedule_batch_processing( $processor_class_name, true );
}
throw $error;
}
if ( $still_pending ) {
$this->schedule_batch_processing( $processor_class_name );
} else {
$this->dequeue_processor( $processor_class_name );
}
}
/**
* Process a batch for a single processor, updating state and logging any error.
*
* @param BatchProcessorInterface $batch_processor Batch processor instance.
*
* @return null|\Exception Exception if error occurred, null otherwise.
*/
private function process_next_batch_for_single_processor_core( BatchProcessorInterface $batch_processor ): ?\Exception {
$details = $this->get_process_details( $batch_processor );
$time_start = microtime( true );
$batch = $batch_processor->get_next_batch_to_process( $details['current_batch_size'] );
if ( empty( $batch ) ) {
return null;
}
try {
$batch_processor->process_batch( $batch );
$time_taken = microtime( true ) - $time_start;
$this->update_processor_state( $batch_processor, $time_taken );
} catch ( \Exception $exception ) {
$time_taken = microtime( true ) - $time_start;
$this->log_error( $exception, $batch_processor, $batch );
$this->update_processor_state( $batch_processor, $time_taken, $exception );
return $exception;
}
return null;
}
/**
* Get the current state for a given enqueued processor.
*
* @param BatchProcessorInterface $batch_processor Batch processor instance.
*
* @return array Current state for the processor, or a "blank" state if none exists yet.
*/
private function get_process_details( BatchProcessorInterface $batch_processor ): array {
$defaults = array(
'total_time_spent' => 0,
'current_batch_size' => $batch_processor->get_default_batch_size(),
'last_error' => null,
'recent_failures' => 0,
'batch_first_failure' => null,
'batch_last_failure' => null,
);
$process_details = get_option( $this->get_processor_state_option_name( $batch_processor ) );
$process_details = wp_parse_args( is_array( $process_details ) ? $process_details : array(), $defaults );
return $process_details;
}
/**
* Get the name of the option where we will be saving state for a given processor.
*
* @param BatchProcessorInterface|string $batch_processor Batch processor instance or class name.
*
* @return string Option name.
*/
private function get_processor_state_option_name( $batch_processor ): string {
$class_name = is_a( $batch_processor, BatchProcessorInterface::class ) ? get_class( $batch_processor ) : $batch_processor;
$class_md5 = md5( $class_name );
// truncate the class name so we know that it will fit in the option name column along with md5 hash and prefix.
$class_name = substr( $class_name, 0, 140 );
return 'wc_batch_' . $class_name . '_' . $class_md5;
}
/**
* Update the state for a processor after a batch has completed processing.
*
* @param BatchProcessorInterface $batch_processor Batch processor instance.
* @param float $time_taken Time take by the batch to complete processing.
* @param \Exception|null $last_error Exception object in processing the batch, if there was one.
*/
private function update_processor_state( BatchProcessorInterface $batch_processor, float $time_taken, ?\Exception $last_error = null ): void {
$current_status = $this->get_process_details( $batch_processor );
$current_status['total_time_spent'] += $time_taken;
$current_status['last_error'] = null !== $last_error ? $last_error->getMessage() : null;
if ( null !== $last_error ) {
$current_status['recent_failures'] = ( $current_status['recent_failures'] ?? 0 ) + 1;
$current_status['batch_last_failure'] = current_time( 'mysql' );
if ( is_null( $current_status['batch_first_failure'] ) ) {
$current_status['batch_first_failure'] = $current_status['batch_last_failure'];
}
} else {
$current_status['recent_failures'] = 0;
$current_status['batch_first_failure'] = null;
$current_status['batch_last_failure'] = null;
}
update_option( $this->get_processor_state_option_name( $batch_processor ), $current_status, false );
}
/**
* Removes the option where we store state for a given processor.
*
* @since 9.1.0
*
* @param string $processor_class_name Fully qualified class name of the processor.
*/
private function clear_processor_state( string $processor_class_name ): void {
delete_option( $this->get_processor_state_option_name( $processor_class_name ) );
}
/**
* Schedule a processing action for a single processor.
*
* @param string $processor_class_name Fully qualified class name of the processor.
* @param bool $with_delay Whether to schedule the action for immediate execution or for later.
*/
private function schedule_batch_processing( string $processor_class_name, bool $with_delay = false ): void {
$time = $with_delay ? time() + MINUTE_IN_SECONDS : time();
as_schedule_single_action( $time, self::PROCESS_SINGLE_BATCH_ACTION_NAME, array( $processor_class_name ) );
}
/**
* Check if a batch processing action is already scheduled for a given processor.
* Differs from `as_has_scheduled_action` in that this excludes actions in progress.
*
* @param string $processor_class_name Fully qualified class name of the batch processor.
*
* @return bool True if a batch processing action is already scheduled for the processor.
*/
public function is_scheduled( string $processor_class_name ): bool {
return as_has_scheduled_action( self::PROCESS_SINGLE_BATCH_ACTION_NAME, array( $processor_class_name ) );
}
/**
* Get an instance of a processor given its class name.
*
* @param string $processor_class_name Full class name of the batch processor.
*
* @return BatchProcessorInterface Instance of batch processor for the given class.
* @throws \Exception If it's not possible to get an instance of the class.
*/
private function get_processor_instance( string $processor_class_name ): BatchProcessorInterface {
$container = wc_get_container();
$processor = $container->has( $processor_class_name ) ? $container->get( $processor_class_name ) : null;
/**
* Filters the instance of a processor for a given class name.
*
* @param object|null $processor The processor instance given by the dependency injection container, or null if none was obtained.
* @param string $processor_class_name The full class name of the processor.
* @return BatchProcessorInterface|null The actual processor instance to use, or null if none could be retrieved.
*
* @since 6.8.0.
*/
$processor = apply_filters( 'woocommerce_get_batch_processor', $processor, $processor_class_name );
if ( ! isset( $processor ) && class_exists( $processor_class_name ) ) {
// This is a fallback for when the batch processor is not registered in the container.
$processor = new $processor_class_name();
}
if ( ! is_a( $processor, BatchProcessorInterface::class ) ) {
throw new \Exception( "Unable to initialize batch processor instance for $processor_class_name" );
}
return $processor;
}
/**
* Helper method to get list of all the enqueued processors.
*
* @return array List (of string) of the class names of the enqueued processors.
*/
public function get_enqueued_processors(): array {
$enqueued_processors = get_option( self::ENQUEUED_PROCESSORS_OPTION_NAME, array() );
if ( ! is_array( $enqueued_processors ) ) {
$this->logger->error( 'Could not fetch list of processors. Clearing up queue.', array( 'source' => 'batch-processing' ) );
delete_option( self::ENQUEUED_PROCESSORS_OPTION_NAME );
$enqueued_processors = array();
}
return $enqueued_processors;
}
/**
* Dequeue a processor once it has no more items pending processing.
*
* @param string $processor_class_name Full processor class name.
*/
private function dequeue_processor( string $processor_class_name ): void {
$pending_processes = $this->get_enqueued_processors();
if ( in_array( $processor_class_name, $pending_processes, true ) ) {
$this->clear_processor_state( $processor_class_name );
$pending_processes = array_diff( $pending_processes, array( $processor_class_name ) );
$this->set_enqueued_processors( $pending_processes );
}
}
/**
* Helper method to set the enqueued processor class names.
*
* @param array $processors List of full processor class names.
*/
private function set_enqueued_processors( array $processors ): void {
update_option( self::ENQUEUED_PROCESSORS_OPTION_NAME, $processors, false );
}
/**
* Check if a particular processor is enqueued.
*
* @param string $processor_class_name Fully qualified class name of the processor.
*
* @return bool True if the processor is enqueued.
*/
public function is_enqueued( string $processor_class_name ): bool {
return in_array( $processor_class_name, $this->get_enqueued_processors(), true );
}
/**
* Dequeue and de-schedule a processor instance so that it won't be processed anymore.
*
* @param string $processor_class_name Fully qualified class name of the processor.
* @return bool True if the processor has been dequeued, false if the processor wasn't enqueued (so nothing has been done).
*/
public function remove_processor( string $processor_class_name ): bool {
$enqueued_processors = $this->get_enqueued_processors();
if ( ! in_array( $processor_class_name, $enqueued_processors, true ) ) {
return false;
}
$enqueued_processors = array_diff( $enqueued_processors, array( $processor_class_name ) );
if ( empty( $enqueued_processors ) ) {
$this->force_clear_all_processes();
} else {
update_option( self::ENQUEUED_PROCESSORS_OPTION_NAME, $enqueued_processors, false );
as_unschedule_all_actions( self::PROCESS_SINGLE_BATCH_ACTION_NAME, array( $processor_class_name ) );
$this->clear_processor_state( $processor_class_name );
}
return true;
}
/**
* Dequeues and de-schedules all the processors.
*/
public function force_clear_all_processes(): void {
as_unschedule_all_actions( self::PROCESS_SINGLE_BATCH_ACTION_NAME );
as_unschedule_all_actions( self::WATCHDOG_ACTION_NAME );
foreach ( $this->get_enqueued_processors() as $processor ) {
$this->clear_processor_state( $processor );
}
update_option( self::ENQUEUED_PROCESSORS_OPTION_NAME, array(), false );
}
/**
* Log an error that happened while processing a batch.
*
* @param \Exception $error Exception object to log.
* @param BatchProcessorInterface $batch_processor Batch processor instance.
* @param array $batch Batch that was being processed.
*/
protected function log_error( \Exception $error, BatchProcessorInterface $batch_processor, array $batch ): void {
$error_message = "Error processing batch for {$batch_processor->get_name()}: {$error->getMessage()}";
$error_context = array(
'exception' => $error,
'source' => 'batch-processing',
);
// Log only first and last, as the entire batch may be too big.
if ( count( $batch ) > 0 ) {
$error_context = array_merge(
$error_context,
array(
'batch_start' => $batch[0],
'batch_end' => end( $batch ),
)
);
}
/**
* Filters the error message for a batch processing.
*
* @param string $error_message The error message that will be logged.
* @param \Exception $error The exception that was thrown by the processor.
* @param BatchProcessorInterface $batch_processor The processor that threw the exception.
* @param array $batch The batch that was being processed.
* @param array $error_context Context to be passed to the logging function.
* @return string The actual error message that will be logged.
*
* @since 6.8.0
*/
$error_message = apply_filters( 'wc_batch_processing_log_message', $error_message, $error, $batch_processor, $batch, $error_context );
$this->logger->error( $error_message, $error_context );
}
/**
* Determines whether a given processor is consistently failing based on how many recent consecutive failures it has had.
*
* @since 9.1.0
*
* @param BatchProcessorInterface $batch_processor The processor that we want to check.
* @return boolean TRUE if processor is consistently failing. FALSE otherwise.
*/
private function is_consistently_failing( BatchProcessorInterface $batch_processor ): bool {
$process_details = $this->get_process_details( $batch_processor );
$max_attempts = absint(
/**
* Controls the failure threshold for batch processors. That is, the number of times we'll attempt to
* process a batch that has resulted in a failure. Once above this threshold, the processor won't be
* re-scheduled and will be removed from the queue.
*
* @since 9.1.0
*
* @param int $failure_threshold Maximum number of times for the processor to try processing a given batch.
* @param BatchProcessorInterface $batch_processor The processor instance.
* @param array $process_details Array with batch processor state.
*/
apply_filters(
'wc_batch_processing_max_attempts',
self::FAILING_PROCESS_MAX_ATTEMPTS_DEFAULT,
$batch_processor,
$process_details
)
);
return absint( $process_details['recent_failures'] ?? 0 ) >= max( $max_attempts, 1 );
}
/**
* Creates log entry with details about a batch processor that is consistently failing.
*
* @since 9.1.0
*
* @param BatchProcessorInterface $batch_processor The batch processor instance.
* @param array $process_details Failing process details.
*/
private function log_consistent_failure( BatchProcessorInterface $batch_processor, array $process_details ): void {
$this->logger->error(
"Batch processor {$batch_processor->get_name()} appears to be failing consistently: {$process_details['recent_failures']} unsuccessful attempt(s). No further attempts will be made.",
array(
'source' => 'batch-processing',
'failures' => $process_details['recent_failures'],
'first_failure' => $process_details['batch_first_failure'],
'last_failure' => $process_details['batch_last_failure'],
)
);
}
/**
* Hooked onto 'shutdown'. This cleanup routine checks enqueued processors and whether they are scheduled or not to
* either re-eschedule them or remove them from the queue.
* This prevents stale states where Action Scheduler won't schedule any more attempts but we still report the
* processor as enqueued.
*
* @since 9.1.0
*/
private function remove_or_retry_failed_processors(): void {
if ( ! did_action( 'wp_loaded' ) ) {
return;
}
$last_error = error_get_last();
if ( ! is_null( $last_error ) && in_array( $last_error['type'], array( E_ERROR, E_PARSE, E_CORE_ERROR, E_COMPILE_ERROR, E_USER_ERROR, E_RECOVERABLE_ERROR ), true ) ) {
return;
}
// The most efficient way to check for an existing action is to use `as_has_scheduled_action`, but in unusual
// cases where another plugin has loaded a very old version of Action Scheduler, it may not be available to us.
$has_scheduled_action = function_exists( 'as_has_scheduled_action') ? 'as_has_scheduled_action' : 'as_next_scheduled_action';
if ( call_user_func( $has_scheduled_action, self::WATCHDOG_ACTION_NAME ) ) {
return;
}
$enqueued_processors = $this->get_enqueued_processors();
$unscheduled_processors = array_diff( $enqueued_processors, array_filter( $enqueued_processors, array( $this, 'is_scheduled' ) ) );
foreach ( $unscheduled_processors as $processor ) {
try {
$instance = $this->get_processor_instance( $processor );
} catch ( \Exception $e ) {
continue;
}
$exception = new \Exception( 'Processor is enqueued but not scheduled. Background job was probably killed or marked as failed. Reattempting execution.' );
$this->update_processor_state( $instance, 0, $exception );
$this->log_error( $exception, $instance, array() );
if ( $this->is_consistently_failing( $instance ) ) {
$this->log_consistent_failure( $instance, $this->get_process_details( $instance ) );
$this->remove_processor( $processor );
} else {
$this->schedule_batch_processing( $processor, true );
}
}
}
}
PK [1]Բa RegisterHooksInterface.phpnu get( ::class )->register();
*
* @since 8.5.0
*/
interface RegisterHooksInterface {
/**
* Register this class instance to the appropriate hooks.
*
* @return void
*/
public function register();
}
PK [1][ $ Admin/ProductForm/ComponentTrait.phpnu id;
}
/**
* Return plugin id.
*
* @return string
*/
public function get_plugin_id() {
return $this->plugin_id;
}
}
PK [1]rH> > ! Admin/ProductForm/FormFactory.phpnu (string) Field type. Required.
* 'section' => (string) Field location. Required.
* 'order' => (int) Field order.
* 'properties' => (array) Field properties.
* 'name' => (string) Field name.
* ).
* @return Field|WP_Error New field or WP_Error.
*/
public static function add_field( $id, $plugin_id, $args ) {
$new_field = self::create_item( 'field', 'Field', $id, $plugin_id, $args );
if ( is_wp_error( $new_field ) ) {
return $new_field;
}
self::$form_fields[ $id ] = $new_field;
return $new_field;
}
/**
* Adds a Subsection to the product form.
*
* @param string $id Subsection id.
* @param string $plugin_id Plugin id.
* @param array $args Array containing the necessary arguments.
* @return Subsection|WP_Error New subsection or WP_Error.
*/
public static function add_subsection( $id, $plugin_id, $args = array() ) {
$new_subsection = self::create_item( 'subsection', 'Subsection', $id, $plugin_id, $args );
if ( is_wp_error( $new_subsection ) ) {
return $new_subsection;
}
self::$form_subsections[ $id ] = $new_subsection;
return $new_subsection;
}
/**
* Adds a section to the product form.
*
* @param string $id Card id.
* @param string $plugin_id Plugin id.
* @param array $args Array containing the necessary arguments.
* @return Section|WP_Error New section or WP_Error.
*/
public static function add_section( $id, $plugin_id, $args ) {
$new_section = self::create_item( 'section', 'Section', $id, $plugin_id, $args );
if ( is_wp_error( $new_section ) ) {
return $new_section;
}
self::$form_sections[ $id ] = $new_section;
return $new_section;
}
/**
* Adds a tab to the product form.
*
* @param string $id Card id.
* @param string $plugin_id Plugin id.
* @param array $args Array containing the necessary arguments.
* @return Tab|WP_Error New section or WP_Error.
*/
public static function add_tab( $id, $plugin_id, $args ) {
$new_tab = self::create_item( 'tab', 'Tab', $id, $plugin_id, $args );
if ( is_wp_error( $new_tab ) ) {
return $new_tab;
}
self::$form_tabs[ $id ] = $new_tab;
return $new_tab;
}
/**
* Returns list of registered fields.
*
* @param array $sort_by key and order to sort by.
* @return array list of registered fields.
*/
public static function get_fields( $sort_by = array(
'key' => 'order',
'order' => 'asc',
) ) {
return self::get_items( 'field', 'Field', $sort_by );
}
/**
* Returns list of registered cards.
*
* @param array $sort_by key and order to sort by.
* @return array list of registered cards.
*/
public static function get_subsections( $sort_by = array(
'key' => 'order',
'order' => 'asc',
) ) {
return self::get_items( 'subsection', 'Subsection', $sort_by );
}
/**
* Returns list of registered sections.
*
* @param array $sort_by key and order to sort by.
* @return array list of registered sections.
*/
public static function get_sections( $sort_by = array(
'key' => 'order',
'order' => 'asc',
) ) {
return self::get_items( 'section', 'Section', $sort_by );
}
/**
* Returns list of registered tabs.
*
* @param array $sort_by key and order to sort by.
* @return array list of registered tabs.
*/
public static function get_tabs( $sort_by = array(
'key' => 'order',
'order' => 'asc',
) ) {
return self::get_items( 'tab', 'Tab', $sort_by );
}
/**
* Returns list of registered items.
*
* @param string $type Form component type.
* @return array List of registered items.
*/
private static function get_item_list( $type ) {
$mapping = array(
'field' => self::$form_fields,
'subsection' => self::$form_subsections,
'section' => self::$form_sections,
'tab' => self::$form_tabs,
);
if ( array_key_exists( $type, $mapping ) ) {
return $mapping[ $type ];
}
return array();
}
/**
* Returns list of registered items.
*
* @param string $type Form component type.
* @param class-string $class_name Class of component type.
* @param array $sort_by key and order to sort by.
* @return array list of registered items.
*/
private static function get_items( $type, $class_name, $sort_by = array(
'key' => 'order',
'order' => 'asc',
) ) {
$item_list = self::get_item_list( $type );
$class = 'Automattic\\WooCommerce\\Internal\\Admin\\ProductForm\\' . $class_name;
$items = array_values( $item_list );
if ( class_exists( $class ) && method_exists( $class, 'sort' ) ) {
usort(
$items,
function ( $a, $b ) use ( $sort_by, $class ) {
return $class::sort( $a, $b, $sort_by );
}
);
}
return $items;
}
/**
* Creates a new item.
*
* @param string $type Form component type.
* @param class-string $class_name Class of component type.
* @param string $id Item id.
* @param string $plugin_id Plugin id.
* @param array $args additional arguments for item.
* @return Field|Card|Section|Tab|WP_Error New product form item or WP_Error.
*/
private static function create_item( $type, $class_name, $id, $plugin_id, $args ) {
$item_list = self::get_item_list( $type );
$class = 'Automattic\\WooCommerce\\Internal\\Admin\\ProductForm\\' . $class_name;
if ( ! class_exists( $class ) ) {
return new WP_Error(
'wc_product_form_' . $type . '_missing_form_class',
sprintf(
/* translators: 1: missing class name. */
esc_html__( '%1$s class does not exist.', 'woocommerce' ),
$class
)
);
}
if ( isset( $item_list[ $id ] ) ) {
return new WP_Error(
'wc_product_form_' . $type . '_duplicate_field_id',
sprintf(
/* translators: 1: Item type 2: Duplicate registered item id. */
esc_html__( 'You have attempted to register a duplicate form %1$s with WooCommerce Form: %2$s', 'woocommerce' ),
$type,
'`' . $id . '`'
)
);
}
$defaults = array(
'order' => 20,
);
$item_arguments = wp_parse_args( $args, $defaults );
try {
return new $class( $id, $plugin_id, $item_arguments );
} catch ( \Exception $e ) {
return new WP_Error(
'wc_product_form_' . $type . '_class_creation',
$e->getMessage()
);
}
}
}
PK [1]^V Admin/ProductForm/Tab.phpnu (string) Tab name. Required.
* 'title' => (string) Tab title. Required.
* 'order' => (int) Tab order.
* 'properties' => (array) Tab properties.
* ).
* @throws \Exception If there are missing arguments.
*/
public function __construct( $id, $plugin_id, $additional_args ) {
parent::__construct( $id, $plugin_id, $additional_args );
$this->required_arguments = array(
'name',
'title',
);
$missing_arguments = self::get_missing_arguments( $additional_args );
if ( count( $missing_arguments ) > 0 ) {
throw new \Exception(
sprintf(
/* translators: 1: Missing arguments list. */
esc_html__( 'You are missing required arguments of WooCommerce ProductForm Tab: %1$s', 'woocommerce' ),
join( ', ', $missing_arguments )
)
);
}
}
}
PK [1]KMa Admin/ProductForm/Component.phpnu id = $id;
$this->plugin_id = $plugin_id;
$this->additional_args = $additional_args;
}
/**
* Component arguments.
*
* @return array
*/
public function get_additional_args() {
return $this->additional_args;
}
/**
* Component arguments.
*
* @param string $key key of argument.
* @return mixed
*/
public function get_additional_argument( $key ) {
return self::get_argument_from_path( $this->additional_args, $key );
}
/**
* Get the component as JSON.
*
* @return array
*/
public function get_json() {
return array_merge(
array(
'id' => $this->get_id(),
'plugin_id' => $this->get_plugin_id(),
),
$this->get_additional_args()
);
}
/**
* Sorting function for product form component.
*
* @param Component $a Component a.
* @param Component $b Component b.
* @param array $sort_by key and order to sort by.
* @return int
*/
public static function sort( $a, $b, $sort_by = array() ) {
$key = $sort_by['key'];
$a_val = $a->get_additional_argument( $key );
$b_val = $b->get_additional_argument( $key );
if ( 'asc' === $sort_by['order'] ) {
return $a_val <=> $b_val;
} else {
return $b_val <=> $a_val;
}
}
/**
* Gets argument by dot notation path.
*
* @param array $arguments Arguments array.
* @param string $path Path for argument key.
* @param string $delimiter Path delimiter, default: '.'.
* @return mixed|null
*/
public static function get_argument_from_path( $arguments, $path, $delimiter = '.' ) {
$path_keys = explode( $delimiter, $path );
$num_keys = false !== $path_keys ? count( $path_keys ) : 0;
$val = $arguments;
for ( $i = 0; $i < $num_keys; $i++ ) {
$key = $path_keys[ $i ];
if ( array_key_exists( $key, $val ) ) {
$val = $val[ $key ];
} else {
$val = null;
break;
}
}
return $val;
}
/**
* Array of required arguments.
*
* @var array
*/
protected $required_arguments = array();
/**
* Get missing arguments of args array.
*
* @param array $args field arguments.
* @return array
*/
public function get_missing_arguments( $args ) {
return array_values(
array_filter(
$this->required_arguments,
function( $arg_key ) use ( $args ) {
return null === self::get_argument_from_path( $args, $arg_key );
}
)
);
}
}
PK [1]ua Admin/ProductForm/Section.phpnu (int) Section order.
* 'title' => (string) Section description.
* 'description' => (string) Section description.
* ).
* @throws \Exception If there are missing arguments.
*/
public function __construct( $id, $plugin_id, $additional_args ) {
parent::__construct( $id, $plugin_id, $additional_args );
$this->required_arguments = array(
'title',
);
$missing_arguments = self::get_missing_arguments( $additional_args );
if ( count( $missing_arguments ) > 0 ) {
throw new \Exception(
sprintf(
/* translators: 1: Missing arguments list. */
esc_html__( 'You are missing required arguments of WooCommerce ProductForm Section: %1$s', 'woocommerce' ),
join( ', ', $missing_arguments )
)
);
}
}
}
PK [1]:i Admin/ProductForm/Subsection.phpnu (string) Field type. Required.
* 'section' => (string) Field location. Required.
* 'order' => (int) Field order.
* 'properties' => (array) Field properties.
* ).
* @throws \Exception If there are missing arguments.
*/
public function __construct( $id, $plugin_id, $additional_args ) {
parent::__construct( $id, $plugin_id, $additional_args );
$this->required_arguments = array(
'type',
'section',
'properties.name',
'properties.label',
);
$missing_arguments = self::get_missing_arguments( $additional_args );
if ( count( $missing_arguments ) > 0 ) {
throw new \Exception(
sprintf(
/* translators: 1: Missing arguments list. */
esc_html__( 'You are missing required arguments of WooCommerce ProductForm Field: %1$s', 'woocommerce' ),
join( ', ', $missing_arguments )
)
);
}
}
}
PK [1]/^rPF PF Admin/WCAdminAssets.phpnu handle, $allowlist, true )
) ||
( ! empty( $this->preloaded_dependencies[ $type ] ) &&
in_array( $dependency->handle, $this->preloaded_dependencies[ $type ], true ) )
) {
return;
}
$this->preloaded_dependencies[ $type ][] = $dependency->handle;
$source = $dependency->ver ? add_query_arg( 'ver', $dependency->ver, $dependency->src ) : $dependency->src;
echo '', "\n";
}
/**
* Output a preload link tag for dependencies (and their sub dependencies)
* with an optional allowlist.
*
* See: https://macarthur.me/posts/preloading-javascript-in-wordpress
*
* @param string $type Dependency type - 'script' or 'style'.
* @param array $allowlist Optional. List of allowed dependency handles.
*/
private function output_header_preload_tags_for_type( $type, $allowlist = array() ) {
if ( $type === 'script' ) {
$dependencies_of_type = wp_scripts();
} elseif ( $type === 'style' ) {
$dependencies_of_type = wp_styles();
} else {
return;
}
foreach ( $dependencies_of_type->queue as $dependency_handle ) {
$dependency = $dependencies_of_type->query( $dependency_handle, 'registered' );
if ( $dependency === false ) {
continue;
}
// Preload the subdependencies first.
foreach ( $dependency->deps as $sub_dependency_handle ) {
$sub_dependency = $dependencies_of_type->query( $sub_dependency_handle, 'registered' );
if ( $sub_dependency ) {
$this->maybe_output_preload_link_tag( $sub_dependency, $type, $allowlist );
}
}
$this->maybe_output_preload_link_tag( $dependency, $type, $allowlist );
}
}
/**
* Output preload link tags for all enqueued stylesheets and scripts.
*
* See: https://macarthur.me/posts/preloading-javascript-in-wordpress
*/
private function output_header_preload_tags() {
$wc_admin_scripts = array(
WC_ADMIN_APP,
'wc-components',
);
$wc_admin_styles = array(
WC_ADMIN_APP,
'wc-components',
'wc-material-icons',
);
// Preload styles.
$this->output_header_preload_tags_for_type( 'style', $wc_admin_styles );
// Preload scripts.
$this->output_header_preload_tags_for_type( 'script', $wc_admin_scripts );
}
/**
* Loads the required scripts on the correct pages.
*/
public function enqueue_assets() {
if ( ! PageController::is_admin_or_embed_page() ) {
return;
}
if ( ! PageController::is_modern_settings_page() ) {
wp_enqueue_script( WC_ADMIN_APP );
wp_enqueue_style( WC_ADMIN_APP );
}
wp_enqueue_style( 'wc-material-icons' );
wp_enqueue_style( 'wc-onboarding' );
if ( PageController::is_settings_page() ) {
$this->register_script( 'wp-admin-scripts', 'settings-embed', true );
$this->register_style( 'settings-embed', 'style', array( 'wp-components' ) );
}
// Preload our assets.
$this->output_header_preload_tags();
}
/**
* Modify script dependencies based on various conditions to only load the necessary scripts.
*
* @param array $dependencies Array of script dependencies.
* @param string $script Script name.
* @return array Modified dependencies.
*/
private function modify_script_dependencies( $dependencies, $script ) {
switch ( $script ) {
case WC_ADMIN_APP:
// Remove wp-editor dependency if we're not on a customize store page since we don't use wp-editor in other pages.
$is_customize_store_page = (
PageController::is_admin_page() &&
isset( $_GET['path'] ) && // phpcs:ignore WordPress.Security.NonceVerification.Recommended
str_starts_with( wc_clean( wp_unslash( $_GET['path'] ) ), '/customize-store' ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended
);
if ( ! $is_customize_store_page ) {
$dependencies = array_diff( $dependencies, array( 'wp-editor' ) );
}
// Remove product editor dependency from WC_ADMIN_APP when feature is disabled.
if ( ! FeaturesUtil::feature_is_enabled( 'product_block_editor' ) ) {
$dependencies = array_diff( $dependencies, array( 'wc-product-editor' ) );
}
break;
case 'wc-product-editor':
// Remove wp-editor dependency if the product editor feature is disabled as we don't need it.
$is_product_data_view_page = \Automattic\WooCommerce\Admin\Features\ProductDataViews\Init::is_product_data_view_page();
if ( ! ( FeaturesUtil::feature_is_enabled( 'product_block_editor' ) || $is_product_data_view_page ) ) {
$dependencies = array_diff( $dependencies, array( 'wp-editor' ) );
}
break;
}
return $dependencies;
}
/**
* Registers all the necessary scripts and styles to show the admin experience.
*/
public function register_scripts() {
if ( ! function_exists( 'wp_set_script_translations' ) ) {
return;
}
// Register the JS scripts.
$scripts = array(
'wc-admin-layout',
'wc-explat',
'wc-experimental',
'wc-customer-effort-score',
// NOTE: This should be removed when Gutenberg is updated and the notices package is removed from WooCommerce Admin.
'wc-notices',
'wc-number',
'wc-tracks',
'wc-date',
'wc-components',
WC_ADMIN_APP,
'wc-csv',
'wc-store-data',
'wc-currency',
'wc-navigation',
'wc-block-templates',
'wc-product-editor',
'wc-settings-editor',
'wc-remote-logging',
'wc-sanitize',
);
$scripts_map = array(
WC_ADMIN_APP => PageController::is_embed_page() ? 'embed' : 'app',
'wc-csv' => 'csv-export',
'wc-store-data' => 'data',
);
$translated_scripts = array(
'wc-currency',
'wc-date',
'wc-components',
'wc-customer-effort-score',
'wc-experimental',
'wc-navigation',
'wc-product-editor',
WC_ADMIN_APP,
);
foreach ( $scripts as $script ) {
$script_path_name = isset( $scripts_map[ $script ] ) ? $scripts_map[ $script ] : str_replace( 'wc-', '', $script );
try {
$script_assets_filename = self::get_script_asset_filename( $script_path_name, 'index' );
$script_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $script_path_name . '/' . $script_assets_filename;
$script_version = self::get_file_version( 'js', $script_assets['version'] );
$script_dependencies = $this->modify_script_dependencies( $script_assets['dependencies'], $script, $script_path_name );
wp_register_script(
$script,
self::get_url( $script_path_name . '/index', 'js' ),
$script_dependencies,
$script_version,
true
);
if ( in_array( $script, $translated_scripts, true ) ) {
wp_set_script_translations( $script, 'woocommerce' );
}
if ( WC_ADMIN_APP === $script ) {
wp_localize_script(
WC_ADMIN_APP,
'wcAdminAssets',
array(
'path' => plugins_url( self::get_path( 'js' ), WC_ADMIN_PLUGIN_FILE ),
'version' => $script_version,
)
);
}
} catch ( \Exception $e ) {
// Avoid crashing WordPress if an asset file could not be loaded.
wc_caught_exception( $e, __CLASS__ . '::' . __FUNCTION__, $script_path_name );
}
}
// Register the CSS styles.
$styles = array(
array(
'handle' => 'wc-admin-layout',
),
array(
'handle' => 'wc-components',
),
array(
'handle' => 'wc-block-templates',
),
array(
'handle' => 'wc-product-editor',
),
array(
'handle' => 'wc-settings-editor',
),
array(
'handle' => 'wc-customer-effort-score',
),
array(
'handle' => 'wc-experimental',
),
array(
'handle' => WC_ADMIN_APP,
'dependencies' => array( 'wc-components', 'wc-admin-layout', 'wc-customer-effort-score', 'wp-components', 'wc-experimental' ),
),
array(
'handle' => 'wc-onboarding',
),
);
$css_file_version = self::get_file_version( 'css' );
foreach ( $styles as $style ) {
$handle = $style['handle'];
$style_path_name = isset( $scripts_map[ $handle ] ) ? $scripts_map[ $handle ] : str_replace( 'wc-', '', $handle );
try {
$style_assets_filename = self::get_script_asset_filename( $style_path_name, 'style' );
$style_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $style_path_name . '/' . $style_assets_filename;
$version = $style_assets['version'];
} catch ( \Throwable $e ) {
// Use the default version if the asset file could not be loaded.
$version = $css_file_version;
}
$dependencies = isset( $style['dependencies'] ) ? $style['dependencies'] : array();
wp_register_style(
$handle,
self::get_url( $style_path_name . '/style', 'css' ),
$dependencies,
self::get_file_version( 'css', $version ),
);
wp_style_add_data( $handle, 'rtl', 'replace' );
}
}
/**
* Injects wp-shared-settings as a dependency if it's present.
*/
public function inject_wc_settings_dependencies() {
$wp_scripts = wp_scripts();
if ( wp_script_is( 'wc-settings', 'registered' ) ) {
$handles_for_injection = array(
'wc-admin-layout',
'wc-csv',
'wc-currency',
'wc-customer-effort-score',
'wc-navigation',
// NOTE: This should be removed when Gutenberg is updated and
// the notices package is removed from WooCommerce Admin.
'wc-notices',
'wc-number',
'wc-date',
'wc-components',
'wc-tracks',
'wc-block-templates',
'wc-product-editor',
);
foreach ( $handles_for_injection as $handle ) {
$script = $wp_scripts->query( $handle, 'registered' );
if ( $script instanceof _WP_Dependency ) {
$script->deps[] = 'wc-settings';
$wp_scripts->add_data( $handle, 'group', 1 );
}
}
foreach ( $wp_scripts->registered as $handle => $script ) {
// scripts that are loaded in the footer has extra->group = 1.
if ( array_intersect( $handles_for_injection, $script->deps ) && ! isset( $script->extra['group'] ) ) {
// Append the script to footer.
$wp_scripts->add_data( $handle, 'group', 1 );
// Show a warning.
$error_handle = 'wc-settings-dep-in-header';
$used_deps = implode( ', ', array_intersect( $handles_for_injection, $script->deps ) );
$error_message = "Scripts that have a dependency on [$used_deps] must be loaded in the footer, {$handle} was registered to load in the header, but has been switched to load in the footer instead. See https://github.com/woocommerce/woocommerce-gutenberg-products-block/pull/5059";
// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter,WordPress.WP.EnqueuedResourceParameters.MissingVersion
wp_register_script( $error_handle, '' );
wp_enqueue_script( $error_handle );
wp_add_inline_script(
$error_handle,
sprintf( 'console.warn( "%s" );', $error_message )
);
}
}
}
}
/**
* Loads a script
*
* @param string $script_path_name The script path name.
* @param string $script_name Filename of the script to load.
* @param bool $need_translation Whether the script need translations.
* @param array $dependencies Array of any extra dependencies. Note wc-admin and any application JS dependencies are automatically added by Dependency Extraction Webpack Plugin. Use this parameter to designate any extra dependencies.
*/
public static function register_script( $script_path_name, $script_name, $need_translation = false, $dependencies = array() ) {
$script_assets_filename = self::get_script_asset_filename( $script_path_name, $script_name );
$script_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $script_path_name . '/' . $script_assets_filename;
wp_enqueue_script(
'wc-admin-' . $script_name,
self::get_url( $script_path_name . '/' . $script_name, 'js' ),
array_merge( array( WC_ADMIN_APP ), $script_assets ['dependencies'], $dependencies ),
self::get_file_version( 'js', $script_assets['version'] ),
true
);
if ( $need_translation ) {
wp_set_script_translations( 'wc-admin-' . $script_name, 'woocommerce' );
}
}
/**
* Loads a style
*
* @param string $style_path_name The style path name.
* @param string $style_name Filename of the style to load.
* @param array $dependencies Array of any extra dependencies.
*/
public static function register_style( $style_path_name, $style_name, $dependencies = array() ) {
$style_assets_filename = self::get_script_asset_filename( $style_path_name, $style_name );
$style_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_CSS_FOLDER . $style_path_name . '/' . $style_assets_filename;
$handle = 'wc-admin-' . $style_name;
wp_enqueue_style(
$handle,
self::get_url( $style_path_name . '/' . $style_name, 'css' ),
$dependencies,
self::get_file_version( 'css', $style_assets['version'] ),
);
wp_style_add_data( $handle, 'rtl', 'replace' );
}
}
PK [1]! # Admin/Agentic/AgenticController.phpnu get( AgenticWebhookManager::class )->register();
// Register Agentic Commerce integration.
add_filter( 'woocommerce_integrations', array( $this, 'add_agentic_commerce_integration' ) );
}
/**
* Add Agentic Commerce integration to WooCommerce integrations.
*
* @param array $integrations Existing integrations.
* @return array Modified integrations.
*/
public function add_agentic_commerce_integration( $integrations ): array {
if ( ! is_array( $integrations ) ) {
$integrations = array();
}
$integrations[] = AgenticCommerceIntegration::class;
return $integrations;
}
}
PK [1]^A"q q , Admin/Agentic/AgenticCommerceIntegration.phpnu id = 'agentic_commerce';
$this->method_title = __( 'Agentic Commerce', 'woocommerce' );
$this->method_description = __( 'Configure settings to allow AI agents to purchase from your store.', 'woocommerce' );
// Initialize settings page helper.
$this->settings_page = new AgenticSettingsPage();
// Bind to the save action for the settings.
add_action( 'woocommerce_update_options_integration_' . $this->id, array( $this, 'process_admin_options' ) );
}
/**
* Admin options output.
*/
public function admin_options() {
$settings = $this->settings_page->get_settings( array(), $this->id );
\WC_Admin_Settings::output_fields( $settings );
}
/**
* Process and save options.
*/
public function process_admin_options() {
// Let AgenticSettingsPage handle saving.
$this->settings_page->save_settings();
}
}
PK [1] .A . Admin/Agentic/AgenticWebhookPayloadBuilder.phpnu money_formatter = new MoneyFormatter();
}
/**
* Build the webhook payload for an order event.
*
* @param string $event Event type ('order_create' or 'order_update').
* @param WC_Order $order Order object.
* @return array Webhook payload.
*/
public function build_payload( string $event, WC_Order $order ): array {
return array(
'type' => $event,
'data' => $this->build_order_data( $order ),
);
}
/**
* Build the order data for the webhook payload.
*
* @param WC_Order $order Order object.
* @return array Order data.
*/
private function build_order_data( WC_Order $order ): array {
return array(
'type' => 'order',
'checkout_session_id' => $order->get_meta( OrderMetaKey::AGENTIC_CHECKOUT_SESSION_ID ),
'permalink_url' => $order->get_checkout_order_received_url(),
'status' => $this->map_order_status( $order->get_status() ),
'refunds' => $this->build_refunds_data( $order ),
);
}
/**
* Map WooCommerce order status to ACP status.
*
* ACP statuses: created, manual_review, confirmed, canceled, shipped, fulfilled
*
* @param string $wc_status WooCommerce order status.
* @return string ACP status.
*/
private function map_order_status( string $wc_status ): string {
$status_map = array(
// WooCommerce status => ACP status.
OrderStatus::PENDING => ACPOrderStatus::CREATED,
OrderStatus::PROCESSING => ACPOrderStatus::CONFIRMED,
OrderStatus::ON_HOLD => ACPOrderStatus::MANUAL_REVIEW,
OrderStatus::COMPLETED => ACPOrderStatus::FULFILLED,
OrderStatus::CANCELLED => ACPOrderStatus::CANCELED,
OrderStatus::REFUNDED => ACPOrderStatus::FULFILLED, // Refunded orders are still fulfilled.
OrderStatus::FAILED => ACPOrderStatus::CANCELED,
);
/**
* Filter the WooCommerce to ACP order status mapping.
*
* Allows extensions to map custom WooCommerce order statuses to ACP order statuses.
* The mapped status must be one of: created, manual_review, confirmed, canceled, shipped, fulfilled.
*
* @see Automattic\WooCommerce\Internal\Agentic\Enums\Specs\OrderStatus
*
* @since 10.3.0
*
* @param array $status_map Associative array of WooCommerce status => ACP status.
* @param string $wc_status The WooCommerce order status being mapped.
*/
$status_map = apply_filters( 'woocommerce_agentic_webhook_order_status_map', $status_map, $wc_status );
// Get mapped status or default to 'created'.
$mapped_status = isset( $status_map[ $wc_status ] ) ? $status_map[ $wc_status ] : ACPOrderStatus::CREATED;
// Validate the mapped status is a valid ACP status.
if ( ! ACPOrderStatus::is_valid( $mapped_status ) ) {
// Log a warning for invalid status but continue with fallback.
wc_get_logger()->warning(
sprintf(
'Invalid ACP order status "%s" returned by woocommerce_agentic_webhook_order_status_map filter for WooCommerce status "%s". Using "created" as fallback.',
$mapped_status,
$wc_status
),
array( 'source' => 'agentic-webhooks' )
);
return ACPOrderStatus::CREATED;
}
return $mapped_status;
}
/**
* Build refunds data for the order.
*
* @param WC_Order $order Order object.
* @return array Array of refunds.
*/
private function build_refunds_data( WC_Order $order ): array {
return array_map(
array( $this, 'build_single_refund_data' ),
$order->get_refunds()
);
}
/**
* Build data for a single refund.
*
* @param WC_Order_Refund $refund Refund object.
* @return array Refund data.
*/
private function build_single_refund_data( WC_Order_Refund $refund ): array {
$refund_type = $this->determine_refund_type( $refund );
$amount = abs( (float) $refund->get_total() ); // Get absolute value as refunds are negative.
// Convert amount to minor units using MoneyFormatter (respects store currency decimals).
$amount_in_minor_units = (int) $this->money_formatter->format( $amount );
return array(
'type' => $refund_type,
'amount' => $amount_in_minor_units,
);
}
/**
* Determine the refund type.
*
* @param WC_Order_Refund $refund Refund object.
* @return string Refund type ('store_credit' or 'original_payment').
*/
private function determine_refund_type( WC_Order_Refund $refund ): string {
// Default to original payment method.
$refund_type = RefundType::ORIGINAL_PAYMENT;
/**
* Filter the refund type for Agentic webhooks.
*
* This allows extensions to specify when a refund is store credit.
* By default, all refunds are assumed to be original payment method.
*
* @since 10.4.0
* @param string $refund_type The refund type ('store_credit' or 'original_payment').
* @param WC_Order_Refund $refund The refund object.
*/
return apply_filters( 'woocommerce_agentic_webhook_refund_type', $refund_type, $refund );
}
}
PK [1]VOx% x% % Admin/Agentic/AgenticSettingsPage.phpnu Settings > Integration.
* Uses a provider-based system to allow multiple AI agent integrations.
*
* @since 10.4.0
*/
class AgenticSettingsPage {
/**
* Registry option name.
*/
const REGISTRY_OPTION = 'woocommerce_agentic_agent_registry';
/**
* Constructor.
*/
public function __construct() {
// No hooks needed - used by AgenticCommerceIntegration class.
}
/**
* Get the agent registry with default values.
*
* @return array Agent registry.
*/
private function get_registry() {
return get_option( self::REGISTRY_OPTION, array() );
}
/**
* Get registered providers.
*
* Each provider should return an array with:
* - id: string (unique identifier, e.g., 'openai')
* - name: string (display name, e.g., 'OpenAI')
* - description: string (optional description)
* - fields: array (settings fields configuration)
*
* @return array Array of registered providers.
*/
private function get_providers() {
$registry = $this->get_registry();
// Register built-in OpenAI provider.
$providers = array(
array(
'id' => 'openai',
'name' => __( 'ChatGPT', 'woocommerce' ),
'description' => sprintf(
/* translators: %s: URL to ChatGPT merchants application page */
__( 'To get started, apply to ChatGPT. Once approved, ChatGPT will provide the credentials below.', 'woocommerce' ),
'https://chatgpt.com/merchants'
),
'fields' => $this->get_openai_fields(),
),
);
/**
* Filter to register additional AI agent providers.
*
* Allows extensions to add their own AI agent provider settings.
* Each provider should return an array with id, name, description, and fields.
*
* @since 10.4.0
*
* @internal This filter is experimental and behind a non-visible feature flag. Backwards compatibility not guaranted.
*
* @param array $providers Array of provider configurations.
* @param array $registry Current registry data.
*/
$providers = apply_filters( 'woocommerce_agentic_commerce_providers', $providers, $registry );
// Validate provider structure.
$validated = array();
foreach ( $providers as $provider ) {
if (
! is_array( $provider )
|| empty( $provider['id'] )
|| empty( $provider['name'] )
|| ! is_array( $provider['fields'] ?? null )
) {
continue;
}
// Sanitize text fields.
$provider['id'] = sanitize_key( $provider['id'] );
$provider['name'] = sanitize_text_field( $provider['name'] );
if ( ! empty( $provider['description'] ) ) {
$provider['description'] = wp_kses_post( $provider['description'] );
}
$validated[] = $provider;
}
return $validated;
}
/**
* Get general Agentic Commerce settings.
*
* @param array $config Current general configuration.
* @return array Settings fields.
*/
private function get_general_settings( $config ) {
return array(
array(
'title' => __( 'Agentic commerce', 'woocommerce' ),
'type' => 'title',
'desc' => '',
'id' => 'agentic_commerce_general_settings',
),
array(
'title' => __( 'Enable product visibility', 'woocommerce' ),
'desc' => __( 'Allow products to be visible by default to the AI agents you integrate with. Can be overridden per product.', 'woocommerce' ),
'id' => 'woocommerce_agentic_enable_products_default',
'type' => 'checkbox',
'default' => ( ! empty( $config['enable_products_default'] ) && 'yes' === $config['enable_products_default'] ) ? 'yes' : 'no',
),
array(
'type' => 'sectionend',
'id' => 'agentic_commerce_general_settings',
),
);
}
/**
* Get store policies settings.
*
* @return array Settings fields.
*/
private function get_store_policies_settings() {
// Get URLs from WooCommerce/WordPress settings.
$terms_page_id = wc_terms_and_conditions_page_id();
$privacy_page_id = get_option( 'wp_page_for_privacy_policy' );
$terms_url = $terms_page_id ? get_permalink( $terms_page_id ) : '';
$privacy_url = $privacy_page_id ? get_permalink( $privacy_page_id ) : '';
// Build admin URLs for configuration links.
$advanced_settings_url = admin_url( 'admin.php?page=wc-settings&tab=advanced' );
$privacy_settings_url = admin_url( 'options-privacy.php' );
return array(
array(
'title' => __( 'Store policies', 'woocommerce' ),
'type' => 'title',
'desc' => '',
'id' => 'agentic_commerce_store_policies',
),
array(
'title' => __( 'Privacy Policy URL', 'woocommerce' ),
'desc' => sprintf(
/* translators: %s: URL to WordPress privacy settings */
__( 'Configure your Privacy Policy page in Settings > Privacy.', 'woocommerce' ),
esc_url( $privacy_settings_url )
),
'id' => 'woocommerce_agentic_privacy_url_display',
'type' => 'text',
'default' => esc_url( $privacy_url ),
'custom_attributes' => array(
'disabled' => 'disabled',
'readonly' => 'readonly',
),
),
array(
'title' => __( 'Terms and Conditions URL', 'woocommerce' ),
'desc' => sprintf(
/* translators: %s: URL to WooCommerce advanced settings */
__( 'Configure your Terms and Conditions page in WooCommerce > Settings > Advanced > Page setup.', 'woocommerce' ),
esc_url( $advanced_settings_url )
),
'id' => 'woocommerce_agentic_terms_url_display',
'type' => 'text',
'default' => esc_url( $terms_url ),
'custom_attributes' => array(
'disabled' => 'disabled',
'readonly' => 'readonly',
),
),
array(
'type' => 'sectionend',
'id' => 'agentic_commerce_store_policies',
),
);
}
/**
* Get OpenAI provider fields.
*
* @return array Fields configuration.
*/
private function get_openai_fields() {
return array(
array(
'title' => __( 'Authorization Token', 'woocommerce' ),
'desc' => __( 'The bearer token that ChatGPT uses to authenticate checkout requests.', 'woocommerce' ),
'id' => 'woocommerce_agentic_openai_bearer_token',
'type' => 'password',
'default' => '',
),
);
}
/**
* Get settings for Agentic Commerce integration.
*
* @param array $settings Current settings.
* @param string $current_section Current section ID.
* @return array Settings array.
*/
public function get_settings( $settings, $current_section ) {
if ( 'agentic_commerce' !== $current_section ) {
return $settings;
}
$agentic_settings = array();
$registry = $this->get_registry();
// Add general Agentic Commerce settings section.
$agentic_settings = array_merge( $agentic_settings, $this->get_general_settings( $registry['general'] ?? array() ) );
// Build settings for each provider.
$providers = $this->get_providers();
foreach ( $providers as $provider ) {
// Provider section header.
$agentic_settings[] = array(
'title' => $provider['name'],
'type' => 'title',
'desc' => $provider['description'] ?? '',
'id' => 'agentic_commerce_' . $provider['id'] . '_settings',
);
// Add provider fields.
foreach ( $provider['fields'] as $field ) {
$agentic_settings[] = $field;
}
// Provider section end.
$agentic_settings[] = array(
'type' => 'sectionend',
'id' => 'agentic_commerce_' . $provider['id'] . '_settings',
);
}
// Add store policies section.
$agentic_settings = array_merge( $agentic_settings, $this->get_store_policies_settings() );
return $agentic_settings;
}
/**
* Save settings to registry structure.
*/
public function save_settings() {
check_admin_referer( 'woocommerce-settings' );
$registry = $this->get_registry();
// Update general settings.
$registry['general'] = array(
'enable_products_default' => isset( $_POST['woocommerce_agentic_enable_products_default'] ) && '1' === $_POST['woocommerce_agentic_enable_products_default']
? 'yes'
: 'no',
);
// Update OpenAI settings.
$new_token = isset( $_POST['woocommerce_agentic_openai_bearer_token'] )
? sanitize_text_field( wp_unslash( $_POST['woocommerce_agentic_openai_bearer_token'] ) )
: '';
// Only update if a new token was provided; otherwise keep existing.
if ( ! empty( $new_token ) ) {
$registry['openai']['bearer_token'] = wp_hash_password( $new_token );
} elseif ( ! isset( $registry['openai']['bearer_token'] ) ) {
$registry['openai']['bearer_token'] = '';
}
/**
* Filter registry before saving.
*
* Allows extensions to save their own agent provider settings.
* Extensions can access $_POST directly for their settings but MUST sanitize all input
* using appropriate WordPress sanitization functions (sanitize_text_field, esc_url_raw, etc.)
* and call wp_unslash() on POST data.
*
* @since 10.4.0
*
* @internal This filter is experimental and behind a non-visible feature flag. Backwards compatibility not guaranted.
*
* @param array $registry Registry data to save. Extensions should add their provider settings to this array.
*/
$registry = apply_filters( 'woocommerce_agentic_commerce_save_settings', $registry );
// Save registry (don't autoload to prevent performance issues).
update_option( self::REGISTRY_OPTION, $registry, false );
}
}
PK [1]ƯKb ' Admin/Agentic/AgenticWebhookManager.phpnu payload_builder = $payload_builder;
}
/**
* Initialize hooks for webhook integration.
*
* @internal
*/
public function register() {
add_filter( 'woocommerce_webhook_topics', array( $this, 'register_webhook_topic_names' ) );
// Hook into order lifecycle events to fire our custom actions.
add_action( 'woocommerce_new_order', array( $this, 'handle_order_created' ), 999, 2 ); // Hook late to give a chance for other plugins to modify.
add_action( 'woocommerce_order_status_changed', array( $this, 'handle_order_status_changed' ), 10, 4 );
add_action( 'woocommerce_order_refunded', array( $this, 'handle_order_refunded' ), 10, 1 );
// Customize webhook payload for our topics.
add_filter( 'woocommerce_webhook_payload', array( $this, 'customize_webhook_payload' ), 10, 4 );
// Customize webhook HTTP arguments for our topics.
add_filter( 'woocommerce_webhook_http_args', array( $this, 'customize_webhook_http_args' ), 10, 3 );
// When the webhook is delivered (or not), mark the first event as delivered.
add_action( 'woocommerce_webhook_delivery', array( $this, 'mark_first_event_delivered' ), 10, 5 );
}
/**
* Register webhook topic names for display in the UI.
*
* @param array $topics Existing topics.
* @return array Modified topics.
*/
public function register_webhook_topic_names( $topics ): array {
$topics[ self::WEBHOOK_TOPIC ] = __( 'Agentic Commerce Protocol: Order created or updated', 'woocommerce' );
return $topics;
}
/**
* Handle order creation.
*
* @param int $order_id Order ID.
* @param WC_Order $order Order object.
*/
public function handle_order_created( $order_id, $order ) {
if ( ! $this->should_trigger_webhook( $order ) ) {
return;
}
/**
* Fires when an Agentic order is updated or created.
*
* @since 10.3.0
*
* @param int $order_id Order ID.
* @param WC_Order $order Order object.
*/
do_action( self::WEBHOOK_ACTION, $order_id, $order );
}
/**
* Handle order status changes.
*
* @param int $order_id Order ID.
* @param string $old_status Old status.
* @param string $new_status New status.
* @param WC_Order $order Order object.
*/
public function handle_order_status_changed( $order_id, $old_status, $new_status, $order ) {
if ( ! $this->should_trigger_webhook( $order ) ) {
return;
}
/**
* Fires when an Agentic order status changes.
*
* @since 10.3.0
*
* @param int $order_id Order ID.
* @param WC_Order $order Order object.
*/
do_action( self::WEBHOOK_ACTION, $order_id, $order );
}
/**
* Handle order refunds.
*
* @param int $order_id Order ID.
*/
public function handle_order_refunded( $order_id ) {
$order = wc_get_order( $order_id );
if ( ! $order || ! $this->should_trigger_webhook( $order ) ) {
return;
}
/**
* Fires when an Agentic order is refunded.
*
* @since 10.3.0
*
* @param int $order_id Order ID.
* @param WC_Order $order Order object.
*/
do_action( self::WEBHOOK_ACTION, $order_id, $order );
}
/**
* Check if webhook should be triggered for this order.
*
* @param WC_Order $order Order object.
* @return bool True if webhook should be triggered.
*/
private function should_trigger_webhook( $order ) {
// Only trigger for orders with an Agentic checkout session ID.
$checkout_session_id = $order->get_meta( OrderMetaKey::AGENTIC_CHECKOUT_SESSION_ID );
if ( empty( $checkout_session_id ) ) {
return false;
}
// Don't trigger for draft orders.
if (
in_array(
$order->get_status(),
array(
OrderStatus::CHECKOUT_DRAFT,
OrderStatus::DRAFT,
OrderStatus::AUTO_DRAFT,
),
true
)
) {
return false;
}
return true;
}
/**
* Customize webhook payload for Agentic topics.
*
* @param array $payload Original payload.
* @param string $resource_type Resource type.
* @param int $resource_id Resource ID.
* @param int $webhook_id Webhook ID.
* @return array Modified payload.
*/
public function customize_webhook_payload( $payload, $resource_type, $resource_id, $webhook_id ) {
$webhook = wc_get_webhook( $webhook_id );
if ( ! $webhook ) {
return $payload;
}
$topic = $webhook->get_topic();
// Check if this is one of our Agentic topics.
if ( self::WEBHOOK_TOPIC !== $topic ) {
return $payload;
}
// Get the order.
$order = wc_get_order( $resource_id );
if ( ! $order ) {
return $payload;
}
$is_first_event = 'sent' !== $order->get_meta( self::FIRST_EVENT_DELIVERED_META_KEY );
$event = $is_first_event ? 'order_create' : 'order_update';
// Build ACP-compliant payload.
return $this->payload_builder->build_payload( $event, $order );
}
/**
* Customize webhook HTTP arguments for Agentic topics.
*
* @param array $http_args HTTP arguments.
* @param mixed $arg First hook argument.
* @param int $webhook_id Webhook ID.
* @return array Modified HTTP arguments.
*/
public function customize_webhook_http_args( $http_args, $arg, $webhook_id ) {
$webhook = wc_get_webhook( $webhook_id );
if ( ! $webhook ) {
return $http_args;
}
$topic = $webhook->get_topic();
// Check if this is one of our Agentic topics.
if ( self::WEBHOOK_TOPIC !== $topic ) {
return $http_args;
}
// Compute HMAC signature per ACP webhook spec using WooCommerce's built-in method.
// The signature must be computed over the raw request body.
if ( isset( $http_args['body'] ) && ! empty( $webhook->get_secret() ) ) {
// Use WooCommerce's signature generation to ensure consistency.
$signature = $webhook->generate_signature( $http_args['body'] );
// Add Merchant-Signature header per ACP webhook specification.
$http_args['headers']['Merchant-Signature'] = $signature;
}
return $http_args;
}
/**
* Mark first event as delivered on successful webhook delivery.
*
* @param array $http_args HTTP request args.
* @param mixed $response HTTP response.
* @param float $duration Request duration.
* @param int $arg First argument to the action (order_id).
* @param int $webhook_id Webhook ID.
*/
public function mark_first_event_delivered( $http_args, $response, $duration, $arg, $webhook_id ) {
// Only proceed for successful responses.
if ( is_wp_error( $response ) ) {
return;
}
$code = wp_remote_retrieve_response_code( $response );
if ( $code < 200 || $code >= 300 ) {
return;
}
// Verify this is our webhook topic.
$webhook = wc_get_webhook( $webhook_id );
if ( ! $webhook || self::WEBHOOK_TOPIC !== $webhook->get_topic() ) {
return;
}
// $arg contains the order_id from do_action( self::WEBHOOK_ACTION, $order_id, $order ).
$order = wc_get_order( $arg );
if ( ! $order ) {
return;
}
if ( 'sent' !== $order->get_meta( self::FIRST_EVENT_DELIVERED_META_KEY ) ) {
$order->update_meta_data( self::FIRST_EVENT_DELIVERED_META_KEY, 'sent' );
$order->save();
}
}
}
PK [1]e ) Admin/ShippingLabelBannerDisplayRules.phpnu dotcom_connected = $dotcom_connected;
$this->wcs_version = $wcs_version;
$this->no_incompatible_plugins_installed = ! $incompatible_plugins_installed;
}
/**
* Determines whether banner is eligible for display (does not include a/b logic).
*/
public function should_display_banner() {
return $this->banner_not_dismissed() &&
$this->dotcom_connected &&
$this->no_incompatible_plugins_installed &&
$this->order_has_shippable_products() &&
$this->store_in_us_and_usd() &&
$this->wcs_not_installed();
}
/**
* Checks if the banner was not dismissed by the user.
*
* @return bool
*/
private function banner_not_dismissed() {
$dismissed_timestamp_ms = get_option( 'woocommerce_shipping_dismissed_timestamp' );
if ( ! is_numeric( $dismissed_timestamp_ms ) ) {
return true;
}
$dismissed_timestamp_ms = intval( $dismissed_timestamp_ms );
$dismissed_timestamp = intval( round( $dismissed_timestamp_ms / 1000 ) );
$expired_timestamp = $dismissed_timestamp + 24 * 60 * 60; // 24 hours from click time
$dismissed_for_good = -1 === $dismissed_timestamp_ms;
$dismissed_24h = time() < $expired_timestamp;
return ! $dismissed_for_good && ! $dismissed_24h;
}
/**
* Checks if there's a shippable product in the current order.
*
* @return bool
*/
private function order_has_shippable_products() {
$order = wc_get_order();
if ( ! $order ) {
return false;
}
// At this point (no packaging data), only show if there's at least one existing and shippable product.
foreach ( $order->get_items() as $item ) {
if ( $item instanceof \WC_Order_Item_Product ) {
$product = $item->get_product();
if ( $product && $product->needs_shipping() ) {
return true;
}
}
}
return false;
}
/**
* Checks if the store is in the US and has its default currency set to USD.
*
* @return bool
*/
private function store_in_us_and_usd() {
$base_currency = get_woocommerce_currency();
$base_location = wc_get_base_location();
return in_array( $base_currency, $this->supported_currencies, true ) && in_array( $base_location['country'], $this->supported_countries, true );
}
/**
* Checks if WooCommerce Shipping & Tax is not installed.
*
* @return bool
*/
private function wcs_not_installed() {
return ! $this->wcs_version;
}
}
PK [1])}ξ + Admin/Emails/EmailListingRestController.phpnu email_template_generator = new WCTransactionalEmailPostsGenerator();
}
/**
* Perform the initialization.
*/
public function initialize_template_generator() {
$this->email_template_generator->init_default_transactional_emails();
}
/**
* Register the REST API endpoints handled by this controller.
*/
public function register_routes() {
$this->initialize_template_generator();
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/recreate-email-post',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->recreate_email_post( $request ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => $this->get_args_for_recreate_email_post(),
'schema' => $this->get_schema_with_message(),
),
)
);
}
/**
* Get the accepted arguments for the POST recreate-email-post request.
*
* @return array[]
*/
private function get_args_for_recreate_email_post() {
return array(
'email_id' => array(
'description' => __( 'The email ID to recreate the post for.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'validate_callback' => fn( $email_id ) => $this->validate_email_id( $email_id ),
'sanitize_callback' => 'sanitize_text_field',
),
);
}
/**
* Get the schema for the POST recreate-email-post and save-transient requests.
*
* @return array[]
*/
private function get_schema_with_message() {
return array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'email-listing-with-message',
'type' => 'object',
'properties' => array(
'message' => array(
'description' => __( 'A message indicating that the action completed successfully.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'post_id' => array(
'description' => __( 'The post ID of the generated email post.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
);
}
/**
* Validate the email ID.
*
* @param string $email_id The email ID to validate.
* @return bool|WP_Error True if the email ID is valid, otherwise a WP_Error object.
*/
private function validate_email_id( string $email_id ) {
if ( ! in_array( $email_id, WCTransactionalEmails::get_transactional_emails(), true ) ) {
return new \WP_Error(
'woocommerce_rest_not_allowed_email_id',
sprintf( 'The provided email ID "%s" is not allowed.', $email_id ),
array( 'status' => 400 ),
);
}
return true;
}
/**
* Permission check for REST API endpoint.
*
* @param WP_REST_Request $request The request for which the permission is checked.
* @return bool|WP_Error True if the current user has the capability, otherwise a WP_Error object.
*/
private function check_permissions( WP_REST_Request $request ) {
$nonce = $request->get_param( 'nonce' );
if ( ! wp_verify_nonce( $nonce, self::NONCE_KEY ) ) {
return new WP_Error(
'invalid_nonce',
__( 'Invalid nonce.', 'woocommerce' ),
array( 'status' => 403 ),
);
}
return $this->check_permission( $request, 'manage_woocommerce' );
}
/**
* Handle the POST /settings/email/listing/recreate-email-post.
*
* @param WP_REST_Request $request The received request.
* @return array|WP_Error Request response or an error.
*/
public function recreate_email_post( WP_REST_Request $request ) {
$email_id = $request->get_param( 'email_id' );
$generated_post_id = '';
try {
$generated_post_id = $this->email_template_generator->generate_email_template_if_not_exists( $email_id );
} catch ( \Exception $e ) {
return new WP_Error(
'woocommerce_rest_email_post_generation_failed',
// translators: %s: Error message.
sprintf( __( 'Error generating email post. Error: %s.', 'woocommerce' ), $e->getMessage() ),
array( 'status' => 500 )
);
}
if ( $generated_post_id ) {
return array(
// translators: %s: WooCommerce transactional email ID.
'message' => sprintf( __( 'Email post generated for %s.', 'woocommerce' ), $email_id ),
'post_id' => (string) $generated_post_id,
);
}
return new WP_Error(
'woocommerce_rest_email_post_generation_error',
__( 'Error unable to generate email post.', 'woocommerce' ),
array( 'status' => 500 )
);
}
}
PK [1]Mш" " Admin/Homescreen.phpnu =' ) ) {
// priority is 20 to run after admin_menu hook for woocommerce runs, so that submenu is populated.
add_action( 'admin_menu', array( $this, 'possibly_remove_woocommerce_menu' ) );
add_action( 'admin_menu', array( $this, 'update_link_structure' ), 20 );
} else {
// priority is 20 to run after https://github.com/woocommerce/woocommerce/blob/a55ae325306fc2179149ba9b97e66f32f84fdd9c/includes/admin/class-wc-admin-menus.php#L165.
add_action( 'admin_head', array( $this, 'update_link_structure' ), 20 );
}
add_filter( 'woocommerce_admin_preload_options', array( $this, 'preload_options' ) );
if ( Features::is_enabled( 'shipping-smart-defaults' ) ) {
add_filter(
'woocommerce_admin_shared_settings',
array( $this, 'maybe_set_default_shipping_options_on_home' ),
9999
);
}
}
/**
* Set free shipping in the same country as the store default
* Flag rate in all other countries when any of the following conditions are true
*
* - The store sells physical products, has JP and WCS installed and connected, and is located in the US.
* - The store sells physical products, and is not located in US/Canada/Australia/UK (irrelevant if JP is installed or not).
* - The store sells physical products and is located in US, but JP and WCS are not installed.
*
* @param array $settings shared admin settings.
* @return array
*/
public function maybe_set_default_shipping_options_on_home( $settings ) {
if ( ! function_exists( 'get_current_screen' ) ) {
return $settings;
}
$current_screen = get_current_screen();
// Abort if it's not the homescreen.
if ( ! isset( $current_screen->id ) || 'woocommerce_page_wc-admin' !== $current_screen->id ) {
return $settings;
}
// Abort if we already created the shipping options.
$already_created = get_option( 'woocommerce_admin_created_default_shipping_zones' );
if ( $already_created === 'yes' ) {
return $settings;
}
$zone_count = count( \WC_Data_Store::load( 'shipping-zone' )->get_zones() );
if ( $zone_count ) {
update_option( 'woocommerce_admin_created_default_shipping_zones', 'yes' );
update_option( 'woocommerce_admin_reviewed_default_shipping_zones', 'yes' );
return $settings;
}
$user_skipped_obw = $settings['onboarding']['profile']['skipped'] ?? false;
$store_address = $settings['preloadSettings']['general']['woocommerce_store_address'] ?? '';
$product_types = $settings['onboarding']['profile']['product_types'] ?? array();
$user_has_set_store_country = $settings['onboarding']['profile']['is_store_country_set'] ?? false;
// Do not proceed if user has not filled out their country in the onboarding profiler.
if ( ! $user_has_set_store_country ) {
return $settings;
}
// If user skipped the obw or has not completed the store_details
// then we assume the user is going to sell physical products.
if ( $user_skipped_obw || '' === $store_address ) {
$product_types[] = 'physical';
}
if ( false === in_array( 'physical', $product_types, true ) ) {
return $settings;
}
$country_code = wc_format_country_state_string( $settings['preloadSettings']['general']['woocommerce_default_country'] )['country'];
$country_name = WC()->countries->get_countries()[ $country_code ] ?? null;
$is_jetpack_installed = in_array( 'jetpack', $settings['plugins']['installedPlugins'] ?? array(), true );
$is_wcs_installed = in_array( 'woocommerce-services', $settings['plugins']['installedPlugins'] ?? array(), true );
if (
( 'US' === $country_code && $is_jetpack_installed )
||
( ! in_array( $country_code, array( 'CA', 'AU', 'NZ', 'SG', 'HK', 'GB', 'ES', 'IT', 'DE', 'FR', 'CL', 'AR', 'PE', 'BR', 'UY', 'GT', 'NL', 'AT', 'BE' ), true ) )
||
( 'US' === $country_code && false === $is_jetpack_installed && false === $is_wcs_installed )
) {
$zone = new \WC_Shipping_Zone();
$zone->set_zone_name( $country_name );
$zone->add_location( $country_code, 'country' );
// Method creation has no default title, use the REST API to add a title.
$instance_id = $zone->add_shipping_method( 'free_shipping' );
$request = new \WP_REST_Request( 'POST', '/wc/v2/shipping/zones/' . $zone->get_id() . '/methods/' . $instance_id );
$request->set_body_params(
array(
'settings' => array(
'title' => 'Free shipping',
),
)
);
rest_do_request( $request );
update_option( 'woocommerce_admin_created_default_shipping_zones', 'yes' );
Shipping::delete_zone_count_transient();
}
return $settings;
}
/**
* Adds fields so that we can store performance indicators, row settings, and chart type settings for users.
*
* @param array $user_data_fields User data fields.
* @return array
*/
public function add_user_data_fields( $user_data_fields ) {
return array_merge(
$user_data_fields,
array(
'homepage_layout',
'homepage_stats',
'task_list_tracked_started_tasks',
)
);
}
/**
* Registers home page.
*/
public function register_page() {
// Register a top-level item for users who cannot view the core WooCommerce menu.
if ( ! self::is_admin_user() ) {
wc_admin_register_page(
array(
'id' => 'woocommerce-home',
'title' => __( 'WooCommerce', 'woocommerce' ),
'path' => self::MENU_SLUG,
'capability' => 'read',
)
);
return;
}
wc_admin_register_page(
array(
'id' => 'woocommerce-home',
'title' => __( 'Home', 'woocommerce' ),
'parent' => 'woocommerce',
'path' => self::MENU_SLUG,
'order' => 0,
'capability' => 'read',
)
);
}
/**
* Check if the user can access the top-level WooCommerce item.
*
* @return bool
*/
public static function is_admin_user() {
if ( ! class_exists( 'WC_Admin_Menus', false ) ) {
include_once WC_ABSPATH . 'includes/admin/class-wc-admin-menus.php';
}
if ( method_exists( 'WC_Admin_Menus', 'can_view_woocommerce_menu_item' ) ) {
return \WC_Admin_Menus::can_view_woocommerce_menu_item() || current_user_can( 'manage_woocommerce' );
} else {
// We leave this line for WC versions <= 6.2.
return current_user_can( 'edit_others_shop_orders' ) || current_user_can( 'manage_woocommerce' );
}
}
/**
* Possibly remove the WooCommerce menu item if it was purely used to access wc-admin pages.
*/
public function possibly_remove_woocommerce_menu() {
global $menu;
if ( self::is_admin_user() ) {
return;
}
foreach ( $menu as $key => $menu_item ) {
if ( self::MENU_SLUG !== $menu_item[2] || 'read' !== $menu_item[1] ) {
continue;
}
unset( $menu[ $key ] );
}
}
/**
* Update the WooCommerce menu structure to make our main dashboard/handler
* the top level link for 'WooCommerce'.
*/
public function update_link_structure() {
global $submenu;
// User does not have capabilities to see the submenu.
if ( ! current_user_can( 'manage_woocommerce' ) || empty( $submenu['woocommerce'] ) ) {
return;
}
$wc_admin_key = null;
foreach ( $submenu['woocommerce'] as $submenu_key => $submenu_item ) {
if ( self::MENU_SLUG === $submenu_item[2] ) {
$wc_admin_key = $submenu_key;
break;
}
}
if ( ! $wc_admin_key ) {
return;
}
$menu = $submenu['woocommerce'][ $wc_admin_key ];
// Move menu item to top of array.
unset( $submenu['woocommerce'][ $wc_admin_key ] );
array_unshift( $submenu['woocommerce'], $menu );
}
/**
* Preload options to prime state of the application.
*
* @param array $options Array of options to preload.
* @return array
*/
public function preload_options( $options ) {
$options[] = 'woocommerce_default_homepage_layout';
$options[] = 'woocommerce_admin_install_timestamp';
return $options;
}
}
PK [1] & Admin/Onboarding/OnboardingProfile.phpnu 'skipped',
'industry' => array(),
'product_types' => array(),
'product_count' => '0',
'selling_venues' => 'no',
'number_employees' => '1',
'revenue' => 'none',
'other_platform' => 'none',
'business_extensions' => array(),
'theme' => get_stylesheet(),
'setup_client' => false,
'store_location' => $base_location['country'],
'default_currency' => get_woocommerce_currency(),
);
// Prepare industries as an array of slugs if they are in array format.
if ( isset( $profile['industry'] ) && is_array( $profile['industry'] ) ) {
$industry_slugs = array();
foreach ( $profile['industry'] as $industry ) {
$industry_slugs[] = is_array( $industry ) ? $industry['slug'] : $industry;
}
$profile['industry'] = $industry_slugs;
}
$body = wp_parse_args( $profile, $defaults );
\WC_Helper_API::put(
'profile',
array(
'authenticated' => true,
'body' => wp_json_encode( $body ),
'headers' => array(
'Content-Type' => 'application/json',
),
)
);
}
/**
* Send profiler data on profiler change to completion.
*
* @param array $old_value Previous value.
* @param array $value Current value.
*/
public function send_profile_data_on_update( $old_value, $value ) {
if ( ! isset( $value['completed'] ) || ! $value['completed'] ) {
return;
}
$this->send_profile_data();
}
/**
* Send profiler data after a site is connected.
*/
public function send_profile_data_on_connect() {
$profile = get_option( OnboardingProfile::DATA_OPTION, array() );
if ( ! isset( $profile['completed'] ) || ! $profile['completed'] ) {
return;
}
$this->send_profile_data();
}
/**
* Redirects the user to the task list if the task list is enabled and finishing a wccom checkout.
*
* @todo Once URL params are added to the redirect, we can check those instead of the referer.
*/
public function redirect_wccom_install() {
$task_list = TaskLists::get_list( 'setup' );
if (
! $task_list ||
$task_list->is_hidden() ||
! isset( $_SERVER['HTTP_REFERER'] ) ||
0 !== strpos( wp_unslash( $_SERVER['HTTP_REFERER'] ), 'https://woocommerce.com/checkout?utm_medium=product' ) // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
) {
return;
}
wp_safe_redirect( wc_admin_url() );
}
}
PK [1] \ \ ' Admin/Onboarding/OnboardingProducts.phpnu array(
'label' => __( 'Physical products', 'woocommerce' ),
'default' => true,
),
'downloads' => array(
'label' => __( 'Downloads', 'woocommerce' ),
),
'subscriptions' => array(
'label' => __( 'Subscriptions', 'woocommerce' ),
),
'memberships' => array(
'label' => __( 'Memberships', 'woocommerce' ),
'product' => 958589,
),
'bookings' => array(
'label' => __( 'Bookings', 'woocommerce' ),
'product' => 390890,
),
'product-bundles' => array(
'label' => __( 'Bundles', 'woocommerce' ),
'product' => 18716,
),
'product-add-ons' => array(
'label' => __( 'Customizable products', 'woocommerce' ),
'product' => 18618,
),
);
$base_location = wc_get_base_location();
$has_cbd_industry = false;
if ( 'US' === $base_location['country'] ) {
$profile = get_option( OnboardingProfile::DATA_OPTION, array() );
if ( ! empty( $profile['industry'] ) ) {
$has_cbd_industry = in_array( 'cbd-other-hemp-derived-products', array_column( $profile['industry'], 'slug' ), true );
}
}
if ( ! Features::is_enabled( 'subscriptions' ) || 'US' !== $base_location['country'] || $has_cbd_industry ) {
$products['subscriptions']['product'] = 27147;
}
return apply_filters( 'woocommerce_admin_onboarding_product_types', $products );
}
/**
* Get dynamic product data from API.
*
* @param array $product_types Array of product types.
* @return array
*/
public static function get_product_data( $product_types ) {
$locale = get_user_locale();
// Transient value is an array of product data keyed by locale.
$transient_value = get_transient( self::PRODUCT_DATA_TRANSIENT );
$transient_value = is_array( $transient_value ) ? $transient_value : array();
$woocommerce_products = $transient_value[ $locale ] ?? false;
if ( false === $woocommerce_products ) {
$woocommerce_products = wp_remote_get(
add_query_arg(
array(
'locale' => $locale,
),
'https://woocommerce.com/wp-json/wccom-extensions/1.0/search'
),
array(
'user-agent' => 'WooCommerce/' . WC()->version . '; ' . get_bloginfo( 'url' ),
)
);
if ( is_wp_error( $woocommerce_products ) ) {
return $product_types;
}
$transient_value[ $locale ] = $woocommerce_products;
set_transient( self::PRODUCT_DATA_TRANSIENT, $transient_value, DAY_IN_SECONDS );
}
$data = json_decode( $woocommerce_products['body'] );
$products = array();
$product_data = array();
// Map product data by ID.
if ( isset( $data ) && isset( $data->products ) ) {
foreach ( $data->products as $product_datum ) {
if ( isset( $product_datum->id ) ) {
$products[ $product_datum->id ] = $product_datum;
}
}
}
// Loop over product types and append data.
foreach ( $product_types as $key => $product_type ) {
$product_data[ $key ] = $product_types[ $key ];
if ( isset( $product_type['product'] ) && isset( $products[ $product_type['product'] ] ) ) {
$price = html_entity_decode( $products[ $product_type['product'] ]->price );
$yearly_price = (float) str_replace( '$', '', $price );
$product_data[ $key ]['yearly_price'] = $yearly_price;
$product_data[ $key ]['description'] = $products[ $product_type['product'] ]->excerpt;
$product_data[ $key ]['more_url'] = $products[ $product_type['product'] ]->link;
$product_data[ $key ]['slug'] = strtolower( preg_replace( '~[^\pL\d]+~u', '-', $products[ $product_type['product'] ]->slug ) );
}
}
return $product_data;
}
/**
* Get the allowed product types with the polled data.
*
* @return array
*/
public static function get_product_types_with_data() {
return self::get_product_data( self::get_allowed_product_types() );
}
/**
* Get relevant purchaseable products for the site.
*
* @return array
*/
public static function get_relevant_products() {
$profiler_data = get_option( OnboardingProfile::DATA_OPTION, array() );
$installed = PluginsHelper::get_installed_plugin_slugs();
$product_types = isset( $profiler_data['product_types'] ) ? $profiler_data['product_types'] : array();
$product_data = self::get_product_types_with_data();
$purchaseable = array();
$remaining = array();
foreach ( $product_types as $type ) {
if ( ! isset( $product_data[ $type ]['slug'] ) ) {
continue;
}
$purchaseable[] = $product_data[ $type ];
if ( ! in_array( $product_data[ $type ]['slug'], $installed, true ) ) {
$remaining[] = $product_data[ $type ]['label'];
}
}
return array(
'purchaseable' => $purchaseable,
'remaining' => $remaining,
);
}
}
PK [1]hȣ* * * Admin/Onboarding/OnboardingSetupWizard.phpnu install_options_for_core_profiler_plugin_install( $slug, $source );
},
10,
2
);
if ( ! is_admin() ) {
return;
}
// Old settings injection.
// Run after Automattic\WooCommerce\Internal\Admin\Loader.
add_filter( 'woocommerce_components_settings', array( $this, 'component_settings' ), 20 );
// New settings injection.
add_filter( 'woocommerce_admin_shared_settings', array( $this, 'component_settings' ), 20 );
add_filter( 'woocommerce_admin_preload_settings', array( $this, 'preload_settings' ) );
add_filter( 'admin_body_class', array( $this, 'add_loading_classes' ) );
add_action( 'admin_init', array( $this, 'do_admin_redirects' ) );
add_action( 'current_screen', array( $this, 'redirect_to_profiler' ) );
add_filter( 'woocommerce_show_admin_notice', array( $this, 'remove_old_install_notice' ), 10, 2 );
add_filter( 'admin_viewport_meta', array( $this, 'set_viewport_meta_tag' ) );
}
/**
* Test whether the context of execution comes from async action scheduler.
* Note: this is a polyfill for wc_is_running_from_async_action_scheduler()
* which was introduced in WC 4.0.
*
* @return bool
*/
private function is_running_from_async_action_scheduler() {
if ( function_exists( '\wc_is_running_from_async_action_scheduler' ) ) {
return \wc_is_running_from_async_action_scheduler();
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
return isset( $_REQUEST['action'] ) && 'as_async_request_queue_runner' === $_REQUEST['action'];
}
/**
* Handle redirects to setup/welcome page after install and updates.
*
* For setup wizard, transient must be present, the user must have access rights, and we must ignore the network/bulk plugin updaters.
*/
public function do_admin_redirects() {
// Don't run this fn from Action Scheduler requests, as it would clear _wc_activation_redirect transient.
// That means OBW would never be shown.
if ( $this->is_running_from_async_action_scheduler() ) {
return;
}
// Setup wizard redirect.
// phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment
if ( get_transient( '_wc_activation_redirect' ) && apply_filters( 'woocommerce_enable_setup_wizard', true ) ) {
$do_redirect = true;
$current_page = isset( $_GET['page'] ) ? wc_clean( wp_unslash( $_GET['page'] ) ) : false; // phpcs:ignore WordPress.Security.NonceVerification
$is_onboarding_path = ! isset( $_GET['path'] ) || '/setup-wizard' === wc_clean( wp_unslash( $_GET['page'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
// On these pages, or during these events, postpone the redirect.
// phpcs:ignore WordPress.WP.Capabilities.Unknown
if ( wp_doing_ajax() || is_network_admin() || ! current_user_can( 'manage_woocommerce' ) ) {
$do_redirect = false;
}
// On these pages, or during these events, disable the redirect.
if (
( 'wc-admin' === $current_page && $is_onboarding_path ) ||
// phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment
apply_filters( 'woocommerce_prevent_automatic_wizard_redirect', false ) ||
isset( $_GET['activate-multi'] ) // phpcs:ignore WordPress.Security.NonceVerification
) {
delete_transient( '_wc_activation_redirect' );
$do_redirect = false;
}
if ( $do_redirect ) {
delete_transient( '_wc_activation_redirect' );
wp_safe_redirect( wc_admin_url() );
exit;
}
}
}
/**
* Trigger the woocommerce_onboarding_profile_completed action
*
* @param array $old_value Previous value.
* @param array $value Current value.
*/
public function trigger_profile_completed_action( $old_value, $value ) {
if ( isset( $old_value['completed'] ) && $old_value['completed'] ) {
return;
}
if ( ! isset( $value['completed'] ) || ! $value['completed'] ) {
return;
}
/**
* Action hook fired when the onboarding profile (or onboarding wizard,
* or profiler) is completed.
*
* @since 1.5.0
*/
do_action( 'woocommerce_onboarding_profile_completed' );
}
/**
* Returns true if the profiler should be displayed (not completed and not skipped).
*
* @return bool
*/
private function should_show() {
if ( $this->is_setup_wizard() ) {
return true;
}
return OnboardingProfile::needs_completion();
}
/**
* Redirect to the profiler on homepage if completion is needed.
*/
public function redirect_to_profiler() {
if ( ! $this->is_homepage() || ! OnboardingProfile::needs_completion() ) {
return;
}
wp_safe_redirect( wc_admin_url( '&path=/setup-wizard' ) );
exit;
}
/**
* Check if the current page is the profile wizard.
*
* @return bool
*/
private function is_setup_wizard() {
/* phpcs:disable WordPress.Security.NonceVerification */
return isset( $_GET['page'] ) &&
'wc-admin' === $_GET['page'] &&
isset( $_GET['path'] ) &&
'/setup-wizard' === $_GET['path'];
/* phpcs: enable */
}
/**
* Check if the current page is the homepage.
*
* @return bool
*/
private function is_homepage() {
/* phpcs:disable WordPress.Security.NonceVerification */
return isset( $_GET['page'] ) &&
'wc-admin' === $_GET['page'] &&
! isset( $_GET['path'] );
/* phpcs: enable */
}
/**
* Determine if the current page is one of the WC Admin pages.
*
* @return bool
*/
private function is_woocommerce_page() {
$current_page = PageController::get_instance()->get_current_page();
if ( ! $current_page || ! isset( $current_page['path'] ) ) {
return false;
}
return 0 === strpos( $current_page['path'], 'wc-admin' );
}
/**
* Add profiler items to component settings.
*
* @param array $settings Component settings.
*
* @return array
*/
public function component_settings( $settings ) {
$profile = (array) get_option( OnboardingProfile::DATA_OPTION, array() );
$settings['onboarding'] = array(
'profile' => $profile,
);
// Only fetch if the onboarding wizard OR the task list is incomplete or currently shown
// or the current page is one of the WooCommerce Admin pages.
if (
( ! $this->should_show() && ! count( TaskLists::get_visible() )
// phpcs:ignore Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence.MissingParentheses
||
! $this->is_woocommerce_page()
)
) {
return $settings;
}
include_once WC_ABSPATH . 'includes/admin/helper/class-wc-helper-options.php';
$wccom_auth = \WC_Helper_Options::get( 'auth' );
$profile['wccom_connected'] = empty( $wccom_auth['access_token'] ) ? false : true;
$settings['onboarding']['currencySymbols'] = get_woocommerce_currency_symbols();
$settings['onboarding']['euCountries'] = WC()->countries->get_european_union_countries();
$settings['onboarding']['localeInfo'] = include WC()->plugin_path() . '/i18n/locale-info.php';
$settings['onboarding']['profile'] = $profile;
if ( $this->is_setup_wizard() ) {
$settings['onboarding']['pageCount'] = (int) ( wp_count_posts( 'page' ) )->publish;
$settings['onboarding']['postCount'] = (int) ( wp_count_posts( 'post' ) )->publish;
$settings['onboarding']['isBlockTheme'] = wp_is_block_theme();
}
// phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment
return apply_filters( 'woocommerce_admin_onboarding_preloaded_data', $settings );
}
/**
* Preload WC setting options to prime state of the application.
*
* @param array $options Array of options to preload.
* @return array
*/
public function preload_settings( $options ) {
$options[] = 'general';
return $options;
}
/**
* Set the admin full screen class when loading to prevent flashes of unstyled content.
*
* @param bool $classes Body classes.
* @return array
*/
public function add_loading_classes( $classes ) {
/* phpcs:disable WordPress.Security.NonceVerification */
if ( $this->is_setup_wizard() ) {
$classes .= ' woocommerce-admin-full-screen';
}
/* phpcs: enable */
return $classes;
}
/**
* Remove the install notice that prompts the user to visit the old onboarding setup wizard.
*
* @param bool $show Show or hide the notice.
* @param string $notice The slug of the notice.
* @return bool
*/
public function remove_old_install_notice( $show, $notice ) {
if ( 'install' === $notice ) {
return false;
}
return $show;
}
/**
* Set the viewport meta tag for the setup wizard.
*
* @param string $viewport_meta Viewport meta content value.
* @return string Viewport meta content value.
*
* @since 9.0.0
*/
public function set_viewport_meta_tag( $viewport_meta ) {
if ( ! $this->is_setup_wizard() ) {
return $viewport_meta;
}
return 'width=device-width, initial-scale=1.0, maximum-scale=1.0';
}
/**
* Install options for core profiler plugin install.
*
* When a plugin is installed from the core profiler, this method is called to process the install options.
*
* Install options are a list of options that are set for the plugin being installed.
*
* @param string $slug Plugin slug.
* @param string $source Source of the plugin install.
*
* @return void|null
*/
public function install_options_for_core_profiler_plugin_install( $slug, $source ) {
// Only proceed if the plugin install was initiated from the core profiler.
if ( 'core-profiler' !== $source ) {
return;
}
// Retrieve the core profiler spec.
$specs = array_filter( Init::get_specs(), fn( $spec ) => 'obw/core-profiler' === $spec->key );
if ( ! $specs ) {
return null;
}
$install_options = new ProcessCoreProfilerPluginInstallOptions( current( $specs )->plugins, $slug, wc_get_logger() );
$install_options->process_install_options();
}
}
PK [1]O ) Admin/Onboarding/OnboardingIndustries.phpnu array(
'label' => __( 'Fashion, apparel, and accessories', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'health-beauty' => array(
'label' => __( 'Health and beauty', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'electronics-computers' => array(
'label' => __( 'Electronics and computers', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'food-drink' => array(
'label' => __( 'Food and drink', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'home-furniture-garden' => array(
'label' => __( 'Home, furniture, and garden', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'cbd-other-hemp-derived-products' => array(
'label' => __( 'CBD and other hemp-derived products', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'education-and-learning' => array(
'label' => __( 'Education and learning', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'sports-and-recreation' => array(
'label' => __( 'Sports and recreation', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'arts-and-crafts' => array(
'label' => __( 'Arts and crafts', 'woocommerce' ),
'use_description' => false,
'description_label' => '',
),
'other' => array(
'label' => __( 'Other', 'woocommerce' ),
'use_description' => true,
'description_label' => __( 'Description', 'woocommerce' ),
),
)
);
}
/**
* Add preloaded data to onboarding.
*
* @param array $settings Component settings.
* @return array
*/
public static function preload_data( $settings ) {
$settings['onboarding']['industries'] = self::get_allowed_industries();
return $settings;
}
}
PK [1] t t % Admin/Onboarding/OnboardingHelper.phpnu id, wc_get_screen_ids(), true ) ) {
return;
}
// Remove the old help tab if it exists.
$help_tabs = $screen->get_help_tabs();
foreach ( $help_tabs as $help_tab ) {
if ( 'woocommerce_onboard_tab' !== $help_tab['id'] ) {
continue;
}
$screen->remove_help_tab( 'woocommerce_onboard_tab' );
}
// Add the new help tab.
$help_tab = array(
'title' => __( 'Setup wizard', 'woocommerce' ),
'id' => 'woocommerce_onboard_tab',
);
$setup_list = TaskLists::get_list( 'setup' );
$extended_list = TaskLists::get_list( 'extended' );
if ( $setup_list ) {
$help_tab['content'] = '
function( $user ) {
if ( ! isset( $user['id'] ) || 0 === $user['id'] ) {
return false;
}
return is_super_admin( $user['id'] );
},
'schema' => null,
)
);
register_rest_field(
'user',
'woocommerce_meta',
array(
'get_callback' => array( $this, 'get_user_data_values' ),
'update_callback' => array( $this, 'update_user_data_values' ),
'schema' => null,
)
);
}
/**
* For all the registered user data fields ( Loader::get_user_data_fields ), fetch the data
* for returning via the REST API.
*
* @param WP_User $user Current user.
*/
public function get_user_data_values( $user ) {
$values = array();
foreach ( $this->get_user_data_fields() as $field ) {
$values[ $field ] = self::get_user_data_field( $user['id'], $field );
}
return $values;
}
/**
* For all the registered user data fields ( Loader::get_user_data_fields ), update the data
* for the REST API.
*
* @param array $values The new values for the meta.
* @param WP_User $user The current user.
* @param string $field_id The field id for the user meta.
*/
public function update_user_data_values( $values, $user, $field_id ) {
if ( empty( $values ) || ! is_array( $values ) || 'woocommerce_meta' !== $field_id ) {
return;
}
$fields = $this->get_user_data_fields();
$updates = array();
foreach ( $values as $field => $value ) {
if ( in_array( $field, $fields, true ) ) {
$updates[ $field ] = $value;
self::update_user_data_field( $user->ID, $field, $value );
}
}
return $updates;
}
/**
* We store some WooCommerce specific user meta attached to users endpoint,
* so that we can track certain preferences or values such as the inbox activity panel last open time.
* Additional fields can be added in the function below, and then used via wc-admin's currentUser data.
*
* @return array Fields to expose over the WP user endpoint.
*/
public function get_user_data_fields() {
/**
* Filter user data fields exposed over the WordPress user endpoint.
*
* @since 4.0.0
* @param array $fields Array of fields to expose over the WP user endpoint.
*/
return apply_filters( 'woocommerce_admin_get_user_data_fields', array( 'variable_product_tour_shown' ) );
}
/**
* Helper to update user data fields.
*
* @param int $user_id User ID.
* @param string $field Field name.
* @param mixed $value Field value.
*/
public static function update_user_data_field( $user_id, $field, $value ) {
update_user_meta( $user_id, 'woocommerce_admin_' . $field, $value );
}
/**
* Helper to retrieve user data fields.
*
* Migrates old key prefixes as well.
*
* @param int $user_id User ID.
* @param string $field Field name.
* @return mixed The user field value.
*/
public static function get_user_data_field( $user_id, $field ) {
$meta_value = get_user_meta( $user_id, 'woocommerce_admin_' . $field, true );
// Migrate old meta values (prefix changed from `wc_admin_` to `woocommerce_admin_`).
if ( '' === $meta_value ) {
$old_meta_value = get_user_meta( $user_id, 'wc_admin_' . $field, true );
if ( '' !== $old_meta_value ) {
self::update_user_data_field( $user_id, $field, $old_meta_value );
delete_user_meta( $user_id, 'wc_admin_' . $field );
$meta_value = $old_meta_value;
}
}
return $meta_value;
}
/**
* Get the current user data.
*
* @return array User data.
*/
public static function get_user_data() {
$user_controller = new \WP_REST_Users_Controller();
$request = new \WP_REST_Request();
$request->set_query_params( array( 'context' => 'edit' ) );
$user_response = $user_controller->get_current_item( $request );
$current_user_data = is_wp_error( $user_response ) ? (object) array() : $user_response->get_data();
$current_user_data = self::filter_user_capabilities( $current_user_data );
return $current_user_data;
}
/**
* Filter user capabilities to respect file modification restrictions.
*
* @param array $user_data User data.
* @return array Filtered user data.
*/
private static function filter_user_capabilities( $user_data ) {
if ( ! is_array( $user_data ) || ! isset( $user_data['capabilities'] ) ) {
return $user_data;
}
// If the user has install_plugins capability, check if file modifications are allowed.
if ( isset( $user_data['capabilities']->install_plugins ) && $user_data['capabilities']->install_plugins ) {
$user_data['capabilities']->install_plugins = wp_is_file_mod_allowed( 'woocommerce' );
}
return $user_data;
}
}
PK [1]/DQ Q Admin/WcPayWelcomePage.phpnu suggestion_incentives = wc_get_container()->get( PaymentsExtensionSuggestionIncentives::class );
}
/**
* Check if we have an incentive available to show.
*
* @param bool $skip_wcpay_active Whether to skip the check for the WooPayments plugin being active.
*
* @return bool Whether we have an incentive available to show.
*/
public function has_incentive( bool $skip_wcpay_active = false ): bool {
// The WooPayments plugin must not be active.
if ( ! $skip_wcpay_active && $this->is_wcpay_active() ) {
return false;
}
// Suggestions not disabled via a setting.
if ( get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) === 'no' ) {
return false;
}
/**
* Filter allow marketplace suggestions.
*
* User can disable all suggestions via filter.
*
* @since 3.6.0
*/
if ( ! apply_filters( 'woocommerce_allow_marketplace_suggestions', true ) ) {
return false;
}
$incentive = $this->get_incentive();
if ( empty( $incentive ) ) {
return false;
}
if ( $this->is_incentive_dismissed( $incentive ) ) {
return false;
}
return $this->suggestion_incentives->is_incentive_visible(
$incentive['id'],
PaymentsExtensionSuggestions::WOOPAYMENTS,
WC()->countries->get_base_country(),
$skip_wcpay_active
);
}
/**
* Get the WooPayments incentive details, if available.
*
* @return array|null The incentive details. Null if there is no incentive available.
*/
private function get_incentive(): ?array {
return $this->suggestion_incentives->get_incentive(
PaymentsExtensionSuggestions::WOOPAYMENTS,
WC()->countries->get_base_country(),
self::INCENTIVE_TYPE,
true
);
}
/**
* Check if the WooPayments plugin is active.
*
* @return boolean
*/
private function is_wcpay_active(): bool {
return class_exists( '\WC_Payments' );
}
/**
* Check if the current incentive has been manually dismissed.
*
* @param array $incentive The incentive details.
*
* @return boolean
*/
private function is_incentive_dismissed( array $incentive ): bool {
/*
* First, check the legacy option.
*/
$dismissed_incentives = get_option( 'wcpay_welcome_page_incentives_dismissed', array() );
if ( ! empty( $dismissed_incentives ) ) {
// Search the incentive ID in the dismissed incentives list.
if ( in_array( $incentive['id'], $dismissed_incentives, true ) ) {
return true;
}
}
/*
* Second, use the new logic.
*/
return $this->suggestion_incentives->is_incentive_dismissed(
$incentive['id'],
PaymentsExtensionSuggestions::WOOPAYMENTS,
'wc_payments_task'
);
}
/**
* Get the slug of the active payments task.
*
* It can be either 'woocommerce-payments' or 'payments'.
*
* @return string Either 'woocommerce-payments' or 'payments'. Empty string if no task is found.
*/
private function get_active_payments_task_slug(): string {
$setup_task_list = TaskLists::get_list( 'setup' );
$extended_task_list = TaskLists::get_list( 'extended' );
// The task pages are not available if the task lists don't exist or are not visible.
// Bail early if we have no task to work with.
if (
( empty( $setup_task_list ) || ! $setup_task_list->is_visible() ) &&
( empty( $extended_task_list ) || ! $extended_task_list->is_visible() )
) {
return '';
}
// The Payments task in the setup task list.
if ( ! empty( $setup_task_list ) && $setup_task_list->is_visible() ) {
$payments_task = $setup_task_list->get_task( 'payments' );
if ( ! empty( $payments_task ) && $payments_task->can_view() ) {
return 'payments';
}
}
// The Additional Payments task in the extended task list.
if ( ! empty( $extended_task_list ) && $extended_task_list->is_visible() ) {
$payments_task = $extended_task_list->get_task( 'payments' );
if ( ! empty( $payments_task ) && $payments_task->can_view() ) {
return 'payments';
}
}
// The WooPayments task in the setup task list.
if ( ! empty( $setup_task_list ) && $setup_task_list->is_visible() ) {
$payments_task = $setup_task_list->get_task( 'woocommerce-payments' );
if ( ! empty( $payments_task ) && $payments_task->can_view() ) {
return 'woocommerce-payments';
}
}
return '';
}
/**
* Get the WooCommerce setup task list Payments task instance.
*
* @return Task|null The Payments task instance. null if the task is not found.
*/
private function get_payments_task(): ?Task {
$task_list = TaskLists::get_list( 'setup' );
if ( empty( $task_list ) ) {
return null;
}
$payments_task = $task_list->get_task( 'payments' );
if ( empty( $payments_task ) ) {
return null;
}
return $payments_task;
}
/**
* Determine if the WooCommerce setup task list Payments task is complete.
*
* @return bool True if the Payments task is complete, false otherwise.
*/
private function is_payments_task_complete(): bool {
$payments_task = $this->get_payments_task();
return ! empty( $payments_task ) && $payments_task->is_complete();
}
}
PK [1]ZOP P Admin/WCAdminSharedSettings.phpnu on_woocommerce_blocks_loaded();
} else {
add_action( 'woocommerce_blocks_loaded', array( $this, 'on_woocommerce_blocks_loaded' ), 10 );
}
}
/**
* Get class instance.
*
* @return object Instance.
*/
public static function get_instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Adds settings to the Blocks AssetDataRegistry when woocommerce_blocks is loaded.
*
* @return void
*/
public function on_woocommerce_blocks_loaded() {
// Ensure we only add admin settings on the admin.
if ( ! is_admin() ) {
return;
}
if ( class_exists( '\Automattic\WooCommerce\Blocks\Assets\AssetDataRegistry' ) ) {
\Automattic\WooCommerce\Blocks\Package::container()->get( \Automattic\WooCommerce\Blocks\Assets\AssetDataRegistry::class )->add(
$this->settings_prefix,
function () {
/**
* Filters the shared settings that are passed to the client.
*
* @since 6.4.0
*/
return apply_filters( 'woocommerce_admin_shared_settings', array() );
}
);
add_action(
'admin_enqueue_scripts',
function () {
if ( ! PageController::is_admin_or_embed_page() ) {
return;
}
// Enqueue deprecation scripts (client/wp-admin-scripts/wcsettings-deprecation/index.js).
WCAdminAssets::register_script( 'wp-admin-scripts', 'wcsettings-deprecation', true );
}
);
}
}
}
PK [1]kh]L L Admin/Loader.phpnu array(),
'style' => array(),
);
/**
* Get class instance.
*/
public static function get_instance() {
if ( ! self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Constructor.
* Hooks added here should be removed in `wc_admin_initialize` via the feature plugin.
*/
public function __construct() {
Features::get_instance();
WCAdminSharedSettings::get_instance();
Translations::get_instance();
WCAdminUser::get_instance();
Settings::get_instance();
SiteHealth::get_instance();
SystemStatusReport::get_instance();
wc_get_container()->get( Reviews::class );
wc_get_container()->get( ReviewsCommentsOverrides::class );
add_filter( 'admin_body_class', array( __CLASS__, 'add_admin_body_classes' ) );
add_filter( 'admin_title', array( __CLASS__, 'update_admin_title' ) );
add_action( 'in_admin_header', array( __CLASS__, 'embed_page_header' ) );
add_action( 'admin_head', array( __CLASS__, 'remove_notices' ) );
add_action( 'admin_head', array( __CLASS__, 'smart_app_banner' ) );
add_action( 'admin_notices', array( __CLASS__, 'inject_before_notices' ), -9999 );
add_action( 'admin_notices', array( __CLASS__, 'inject_after_notices' ), PHP_INT_MAX );
// Added this hook to delete the field woocommerce_onboarding_homepage_post_id when deleting the homepage.
add_action( 'trashed_post', array( __CLASS__, 'delete_homepage' ) );
/*
* Remove the emoji script as it always defaults to replacing emojis with Twemoji images.
* Gutenberg has also disabled emojis. More on that here -> https://github.com/WordPress/gutenberg/pull/6151
*/
remove_action( 'admin_print_scripts', 'print_emoji_detection_script' );
add_action( 'load-themes.php', array( __CLASS__, 'add_appearance_theme_view_tracks_event' ) );
}
/**
* Returns breadcrumbs for the current page.
*/
private static function get_embed_breadcrumbs() {
return wc_admin_get_breadcrumbs();
}
/**
* Outputs breadcrumbs via PHP for the initial load of an embedded page.
*
* @param array $section Section to create breadcrumb from.
*/
private static function output_heading( $section ) {
echo esc_html( $section );
}
/**
* Set up a div for the header embed to render into.
* The initial contents here are meant as a place loader for when the PHP page initially loads.
*/
public static function embed_page_header() {
if ( ! PageController::is_admin_page() && ! PageController::is_embed_page() ) {
return;
}
if ( ! PageController::is_embed_page() ) {
return;
}
if ( PageController::is_modern_settings_page() ) {
return;
}
$sections = self::get_embed_breadcrumbs();
$sections = is_array( $sections ) ? $sections : array( $sections );
$page_title = '';
$pages_with_tabs = array(
'admin.php?page=wc-settings',
'admin.php?page=wc-reports',
'admin.php?page=wc-status',
);
if (
count( $sections ) > 2 &&
is_array( $sections[1] ) &&
in_array( $sections[1][0], $pages_with_tabs, true )
) {
$page_title = $sections[1][1];
} else {
$page_title = end( $sections );
}
?>
get_current_screen_id();
if ( $page_id ) {
$classes[] = $page_id;
}
/**
* Some routes or features like onboarding hide the wp-admin navigation and masterbar.
* Setting `woocommerce_admin_is_loading` to true allows us to premeptively hide these
* elements while the JS app loads.
* This class needs to be removed by those feature components (like ).
*
* @param bool $is_loading If WooCommerce Admin is loading a fullscreen view.
* @since 6.5.0
*/
$is_loading = apply_filters( 'woocommerce_admin_is_loading', false );
if ( PageController::is_admin_page() && $is_loading ) {
$classes[] = 'woocommerce-admin-is-loading';
}
$admin_body_class = implode( ' ', array_unique( $classes ) );
return " $admin_body_class ";
}
/**
* Adds an iOS "Smart App Banner" for display on iOS Safari.
* See https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/PromotingAppswithAppBanners/PromotingAppswithAppBanners.html
*/
public static function smart_app_banner() {
$exclude_paths = array(
'/customize-store',
'/setup-wizard',
'/launch-your-store',
);
/* phpcs:ignore */
$path = $_GET['path'] ?? '';
if ( PageController::is_admin_or_embed_page() && ! in_array( $path, $exclude_paths, true ) ) {
echo "
";
}
}
/**
* Removes notices that should not be displayed on WC Admin pages.
*/
public static function remove_notices() {
if ( ! PageController::is_admin_or_embed_page() ) {
return;
}
// Hello Dolly.
if ( function_exists( 'hello_dolly' ) ) {
remove_action( 'admin_notices', 'hello_dolly' );
}
}
/**
* Runs before admin notices action and hides them.
*/
public static function inject_before_notices() {
if ( ! PageController::is_admin_or_embed_page() ) {
return;
}
// The JITMs won't be shown in the Onboarding Wizard.
$is_onboarding = isset( $_GET['path'] ) && '/setup-wizard' === wc_clean( wp_unslash( $_GET['path'] ) ); // phpcs:ignore WordPress.Security.NonceVerification
$maybe_hide_jitm = $is_onboarding ? '-hide' : '';
echo '';
// Wrap the notices in a hidden div to prevent flickering before
// they are moved elsewhere in the page by WordPress Core.
echo '
';
if ( PageController::is_admin_page() ) {
// Capture all notices and hide them. WordPress Core looks for
// `.wp-header-end` and appends notices after it if found.
// https://github.com/WordPress/WordPress/blob/f6a37e7d39e2534d05b9e542045174498edfe536/wp-admin/js/common.js#L737 .
echo '';
}
}
/**
* Runs after admin notices and closes div.
*/
public static function inject_after_notices() {
if ( ! PageController::is_admin_or_embed_page() ) {
return;
}
// Close the hidden div used to prevent notices from flickering before
// they are inserted elsewhere in the page.
echo '
';
}
/**
* Edits Admin title based on section of wc-admin.
*
* @param string $admin_title Modifies admin title.
* @todo Can we do some URL rewriting so we can figure out which page they are on server side?
*/
public static function update_admin_title( $admin_title ) {
if (
! did_action( 'current_screen' ) ||
! PageController::is_admin_page()
) {
return $admin_title;
}
$sections = self::get_embed_breadcrumbs();
$pieces = array();
foreach ( $sections as $section ) {
$pieces[] = is_array( $section ) ? $section[1] : $section;
}
$pieces = array_reverse( $pieces );
$title = implode( ' ‹ ', $pieces );
/* translators: %1$s: updated title, %2$s: blog info name */
return sprintf( __( '%1$s ‹ %2$s', 'woocommerce' ), $title, get_bloginfo( 'name' ) );
}
/**
* Set up a div for the app to render into.
*/
public static function page_wrapper() {
?>
isset( $settings['siteLocale'] )
? $settings['siteLocale']
: get_locale(),
'userLocale' => isset( $settings['l10n']['userLocale'] )
? $settings['l10n']['userLocale']
: get_user_locale(),
'weekdaysShort' => isset( $settings['l10n']['weekdaysShort'] )
? $settings['l10n']['weekdaysShort']
: array_values( $wp_locale->weekday_abbrev ),
);
}
/**
* The woocommerce_component_settings_preload_endpoints filter
*
* @since 6.5.0
*/
$preload_data_endpoints = apply_filters( 'woocommerce_component_settings_preload_endpoints', array() );
$preload_data_endpoints['jetpackStatus'] = '/jetpack/v4/connection';
if ( ! empty( $preload_data_endpoints ) ) {
$preload_data = array_reduce(
array_values( $preload_data_endpoints ),
'rest_preload_api_request'
);
}
/**
* The woocommerce_admin_preload_options filter
*
* @since 6.5.0
*/
$preload_options = apply_filters( 'woocommerce_admin_preload_options', array() );
if ( ! empty( $preload_options ) ) {
foreach ( $preload_options as $option ) {
$settings['preloadOptions'][ $option ] = get_option( $option );
}
}
/**
* The woocommerce_admin_preload_settings filter
*
* @since 6.5.0
*/
$preload_settings = apply_filters( 'woocommerce_admin_preload_settings', array() );
if ( ! empty( $preload_settings ) ) {
$setting_options = new \WC_REST_Setting_Options_V2_Controller();
foreach ( $preload_settings as $group ) {
$group_settings = $setting_options->get_group_settings( $group );
$preload_settings = array();
foreach ( $group_settings as $option ) {
if ( array_key_exists( 'id', $option ) && array_key_exists( 'value', $option ) ) {
$preload_settings[ $option['id'] ] = $option['value'];
}
}
$settings['preloadSettings'][ $group ] = $preload_settings;
}
}
$user_controller = new \WP_REST_Users_Controller();
$request = new \WP_REST_Request();
$request->set_query_params( array( 'context' => 'edit' ) );
$user_response = $user_controller->get_current_item( $request );
$current_user_data = is_wp_error( $user_response ) ? (object) array() : $user_response->get_data();
$settings['currentUserData'] = $current_user_data;
$settings['reviewsEnabled'] = get_option( 'woocommerce_enable_reviews' );
$settings['manageStock'] = get_option( 'woocommerce_manage_stock' );
$settings['commentModeration'] = get_option( 'comment_moderation' );
$settings['notifyLowStockAmount'] = get_option( 'woocommerce_notify_low_stock_amount' );
// @todo On merge, once plugin images are added to core WooCommerce, `wcAdminAssetUrl` can be retired,
// and `wcAssetUrl` can be used in its place throughout the codebase.
$settings['wcAdminAssetUrl'] = WC_ADMIN_IMAGES_FOLDER_URL;
$settings['wcVersion'] = WC_VERSION;
$settings['siteUrl'] = site_url();
$settings['shopUrl'] = get_permalink( wc_get_page_id( 'shop' ) );
$settings['homeUrl'] = home_url();
$settings['dateFormat'] = get_option( 'date_format' );
$settings['timeZone'] = wc_timezone_string();
$settings['plugins'] = array(
'installedPlugins' => PluginsHelper::get_installed_plugin_slugs(),
'activePlugins' => Plugins::get_active_plugins(),
);
// Plugins that depend on changing the translation work on the server but not the client -
// WooCommerce Branding is an example of this - so pass through the translation of
// 'WooCommerce' to wcSettings.
$settings['woocommerceTranslation'] = __( 'WooCommerce', 'woocommerce' );
// We may have synced orders with a now-unregistered status.
// E.g An extension that added statuses is now inactive or removed.
$settings['unregisteredOrderStatuses'] = self::get_unregistered_order_statuses();
// The separator used for attributes found in Variation titles.
/* phpcs:ignore */
$settings['variationTitleAttributesSeparator'] = apply_filters( 'woocommerce_product_variation_title_attributes_separator', ' - ', new \WC_Product() );
if ( ! empty( $preload_data_endpoints ) ) {
$settings['dataEndpoints'] = isset( $settings['dataEndpoints'] )
? $settings['dataEndpoints']
: array();
foreach ( $preload_data_endpoints as $key => $endpoint ) {
// Handle error case: rest_do_request() doesn't guarantee success.
if ( empty( $preload_data[ $endpoint ] ) ) {
$settings['dataEndpoints'][ $key ] = array();
} else {
$settings['dataEndpoints'][ $key ] = $preload_data[ $endpoint ]['body'];
}
}
}
$settings = self::get_custom_settings( $settings );
if ( PageController::is_embed_page() ) {
$settings['embedBreadcrumbs'] = self::get_embed_breadcrumbs();
}
$settings['allowMarketplaceSuggestions'] = WC_Marketplace_Suggestions::allow_suggestions();
$settings['connectNonce'] = wp_create_nonce( 'connect' );
$settings['wcpay_welcome_page_connect_nonce'] = wp_create_nonce( 'wcpay-connect' );
return $settings;
}
/**
* Format order statuses by removing a leading 'wc-' if present.
*
* @param array $statuses Order statuses.
* @return array formatted statuses.
*
* @deprecated migrate to \Automattic\WooCommerce\Internal\Admin\Settings instead.
*/
public static function get_order_statuses( $statuses ) {
wc_deprecated_function( __CLASS__ . '::' . __FUNCTION__, '9.9.0', '\Automattic\WooCommerce\Internal\Admin\Settings::get_order_statuses' );
return Settings::get_order_statuses( $statuses );
}
/**
* Get all order statuses present in analytics tables that aren't registered.
*
* @return array Unregistered order statuses.
*
* @deprecated migrate to \Automattic\WooCommerce\Internal\Admin\Settings instead.
*/
public static function get_unregistered_order_statuses() {
wc_deprecated_function( __CLASS__ . '::' . __FUNCTION__, '9.9.0' );
$registered_statuses = wc_get_order_statuses();
$all_synced_statuses = OrdersDataStore::get_all_statuses();
$unregistered_statuses = array_diff( $all_synced_statuses, array_keys( $registered_statuses ) );
$formatted_status_keys = Settings::get_order_statuses( array_fill_keys( $unregistered_statuses, '' ) );
$formatted_statuses = array_keys( $formatted_status_keys );
return array_combine( $formatted_statuses, $formatted_statuses );
}
/**
* Register the admin settings for use in the WC REST API
*
* @param array $groups Array of setting groups.
* @return array
*
* @deprecated migrate to \Automattic\WooCommerce\Internal\Admin\Settings instead.
*/
public static function add_settings_group( $groups ) {
wc_deprecated_function( __CLASS__ . '::' . __FUNCTION__, '9.9.0', '\Automattic\WooCommerce\Internal\Admin\Settings::add_settings_group' );
return Settings::get_instance()->add_settings_group( $groups );
}
/**
* Add WC Admin specific settings
*
* @param array $settings Array of settings in wc admin group.
* @return array
*
* @deprecated migrate to \Automattic\WooCommerce\Internal\Admin\Settings instead.
*/
public static function add_settings( $settings ) {
wc_deprecated_function( __CLASS__ . '::' . __FUNCTION__, '9.9.0', '\Automattic\WooCommerce\Internal\Admin\Settings::add_settings' );
return Settings::get_instance()->add_settings( $settings );
}
/**
* Gets custom settings used for WC Admin.
*
* @param array $settings Array of settings to merge into.
* @return array
*
* @deprecated migrate to \Automattic\WooCommerce\Internal\Admin\Settings instead.
*/
public static function get_custom_settings( $settings ) {
wc_deprecated_function( __CLASS__ . '::' . __FUNCTION__, '9.9.0' );
$wc_rest_settings_options_controller = new \WC_REST_Setting_Options_Controller();
$wc_admin_group_settings = $wc_rest_settings_options_controller->get_group_settings( 'wc_admin' );
$settings['wcAdminSettings'] = array();
foreach ( $wc_admin_group_settings as $setting ) {
if ( ! empty( $setting['id'] ) ) {
$settings['wcAdminSettings'][ $setting['id'] ] = $setting['value'];
}
}
return $settings;
}
/**
* Return an object defining the currency options for the site's current currency
*
* @return array Settings for the current currency {
* Array of settings.
*
* @type string $code Currency code.
* @type string $precision Number of decimals.
* @type string $symbol Symbol for currency.
* }
*
* @deprecated migrate to \Automattic\WooCommerce\Internal\Admin\Settings instead.
*/
public static function get_currency_settings() {
wc_deprecated_function( __CLASS__ . '::' . __FUNCTION__, '9.9.0', '\Automattic\WooCommerce\Internal\Admin\Settings::get_currency_settings' );
return Settings::get_currency_settings();
}
/**
* Delete woocommerce_onboarding_homepage_post_id field when the homepage is deleted
*
* @param int $post_id The deleted post id.
*/
public static function delete_homepage( $post_id ) {
if ( 'page' !== get_post_type( $post_id ) ) {
return;
}
$homepage_id = intval( get_option( 'woocommerce_onboarding_homepage_post_id', false ) );
if ( $homepage_id === $post_id ) {
delete_option( 'woocommerce_onboarding_homepage_post_id' );
}
}
/**
* Adds the appearance_theme_view Tracks event.
*/
public static function add_appearance_theme_view_tracks_event() {
wc_admin_record_tracks_event( 'appearance_theme_view', array() );
}
}
PK [1] $ Admin/Schedulers/ImportInterface.phpnu OrdersScheduler::get_action( 'delete_batch_init' ),
);
}
/**
* Get the customer IDs and total count that need to be synced.
*
* @internal
* @param int $limit Number of records to retrieve.
* @param int $page Page number.
* @param int|bool $days Number of days prior to current date to limit search results.
* @param bool $skip_existing Skip already imported customers.
*/
public static function get_items( $limit = 10, $page = 1, $days = false, $skip_existing = false ) {
$customer_roles = apply_filters( 'woocommerce_analytics_import_customer_roles', array( 'customer' ) );
$query_args = array(
'fields' => 'ID',
'orderby' => 'ID',
'order' => 'ASC',
'number' => $limit,
'paged' => $page,
'role__in' => $customer_roles,
);
if ( is_int( $days ) ) {
$query_args['date_query'] = array(
'after' => gmdate( 'Y-m-d 00:00:00', time() - ( DAY_IN_SECONDS * $days ) ),
);
}
if ( $skip_existing ) {
add_action( 'pre_user_query', array( __CLASS__, 'exclude_existing_customers_from_query' ) );
}
$customer_query = new \WP_User_Query( $query_args );
remove_action( 'pre_user_query', array( __CLASS__, 'exclude_existing_customers_from_query' ) );
return (object) array(
'total' => $customer_query->get_total(),
'ids' => $customer_query->get_results(),
);
}
/**
* Exclude users that already exist in our customer lookup table.
*
* Meant to be hooked into 'pre_user_query' action.
*
* @internal
* @param WP_User_Query $wp_user_query WP_User_Query to modify.
*/
public static function exclude_existing_customers_from_query( $wp_user_query ) {
global $wpdb;
$wp_user_query->query_where .= " AND NOT EXISTS (
SELECT ID FROM {$wpdb->prefix}wc_customer_lookup
WHERE {$wpdb->prefix}wc_customer_lookup.user_id = {$wpdb->users}.ID
)";
}
/**
* Get total number of rows imported.
*
* @internal
* @return int
*/
public static function get_total_imported() {
global $wpdb;
return $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}wc_customer_lookup" );
}
/**
* Imports a single customer.
*
* @internal
* @param int $user_id User ID.
* @return void
*/
public static function import( $user_id ) {
CustomersDataStore::update_registered_customer( $user_id );
}
/**
* Delete a batch of customers.
*
* @internal
* @param int $batch_size Number of items to delete.
* @return void
*/
public static function delete( $batch_size ) {
global $wpdb;
$customer_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT customer_id FROM {$wpdb->prefix}wc_customer_lookup ORDER BY customer_id ASC LIMIT %d",
$batch_size
)
);
foreach ( $customer_ids as $customer_id ) {
CustomersDataStore::delete_customer( $customer_id );
}
}
}
PK [1]Iav v ' Admin/Schedulers/MailchimpScheduler.phpnu logger = $logger;
}
/**
* Attempt to subscribe store_email to MailChimp.
*
* @internal
*/
public function run() {
// Abort if we've already subscribed to MailChimp.
if ( 'yes' === get_option( self::SUBSCRIBED_OPTION_NAME ) ) {
return false;
}
$profile_data = get_option( 'woocommerce_onboarding_profile' );
if ( ! isset( $profile_data['is_agree_marketing'] ) || false === $profile_data['is_agree_marketing'] ) {
return false;
}
// Abort if store_email doesn't exist.
if ( ! isset( $profile_data['store_email'] ) ) {
return false;
}
// Abort if failed requests reaches the threshold.
if ( intval( get_option( self::SUBSCRIBED_ERROR_COUNT_OPTION_NAME, 0 ) ) >= self::MAX_ERROR_THRESHOLD ) {
return false;
}
$country_code = WC()->countries->get_base_country();
$state = WC()->countries->get_base_state();
$address = array(
// Setting N/A for addr1, city, state, zipcode and country as they are
// required fields. Setting '' doesn't work.
'addr1' => 'N/A',
'addr2' => '',
'city' => 'N/A',
'state' => $state ?? 'N/A',
'zip' => 'N/A',
'country' => $country_code ?? 'N/A',
);
$response = $this->make_request( $profile_data['store_email'], $address );
if ( is_wp_error( $response ) || ! isset( $response['body'] ) ) {
$this->handle_request_error();
return false;
}
$body = json_decode( $response['body'] );
if ( isset( $body->success ) && true === $body->success ) {
update_option( self::SUBSCRIBED_OPTION_NAME, 'yes' );
return true;
}
$this->handle_request_error( $body );
return false;
}
/**
* Make an HTTP request to the API.
*
* @internal
* @param string $store_email Email address to subscribe.
* @param array $address Store address.
*
* @return mixed
*/
public function make_request( $store_email, $address ) {
if ( true === defined( 'WP_ENVIRONMENT_TYPE' ) && 'development' === constant( 'WP_ENVIRONMENT_TYPE' ) ) {
$subscribe_endpoint = self::SUBSCRIBE_ENDPOINT_DEV;
} else {
$subscribe_endpoint = self::SUBSCRIBE_ENDPOINT;
}
return wp_remote_post(
$subscribe_endpoint,
array(
'user-agent' => 'WooCommerce/' . WC()->version . '; ' . get_bloginfo( 'url' ),
'method' => 'POST',
'body' => array(
'email' => $store_email,
'address' => $address,
),
)
);
}
/**
* Reset options.
*
* @internal
*/
public static function reset() {
delete_option( self::SUBSCRIBED_OPTION_NAME );
delete_option( self::SUBSCRIBED_ERROR_COUNT_OPTION_NAME );
}
/**
* Handle subscribe API error.
*
* @internal
* @param string $extra_msg Extra message to log.
*/
private function handle_request_error( $extra_msg = null ) {
// phpcs:ignore
$msg = isset( $extra_msg ) ? 'Incorrect response from Mailchimp API with: ' . print_r( $extra_msg, true ) : 'Error getting a response from Mailchimp API.';
$this->logger->error( $msg, array( 'source' => self::LOGGER_CONTEXT ) );
$accumulated_error_count = intval( get_option( self::SUBSCRIBED_ERROR_COUNT_OPTION_NAME, 0 ) ) + 1;
update_option( self::SUBSCRIBED_ERROR_COUNT_OPTION_NAME, $accumulated_error_count );
}
}
PK [1]h. . $ Admin/Schedulers/ImportScheduler.phpnu search(
array(
'status' => 'pending',
'per_page' => 1,
'claimed' => false,
'search' => 'import',
'group' => self::$group,
)
);
if ( empty( $pending_jobs ) ) {
$in_progress = self::queue()->search(
array(
'status' => 'in-progress',
'per_page' => 1,
'search' => 'import',
'group' => self::$group,
)
);
}
return ! empty( $pending_jobs ) || ! empty( $in_progress );
}
/**
* Get batch sizes.
*
* @internal
* @return array
*/
public static function get_batch_sizes() {
return array_merge(
self::get_scheduler_batch_sizes(),
array(
'delete' => 10,
'import' => 25,
'queue' => 100,
)
);
}
/**
* Get all available scheduling actions.
* Used to determine action hook names and clear events.
*
* @internal
* @return array
*/
public static function get_scheduler_actions() {
return array(
'import_batch_init' => 'wc-admin_import_batch_init_' . static::$name,
'import_batch' => 'wc-admin_import_batch_' . static::$name,
'delete_batch_init' => 'wc-admin_delete_batch_init_' . static::$name,
'delete_batch' => 'wc-admin_delete_batch_' . static::$name,
'import' => 'wc-admin_import_' . static::$name,
);
}
/**
* Queue the imports into multiple batches.
*
* @internal
* @param integer|boolean $days Number of days to import.
* @param boolean $skip_existing Skip existing records.
*/
public static function import_batch_init( $days, $skip_existing ) {
$batch_size = static::get_batch_size( 'import' );
$items = static::get_items( 1, 1, $days, $skip_existing );
if ( 0 === $items->total ) {
return;
}
$num_batches = ceil( $items->total / $batch_size );
self::queue_batches( 1, $num_batches, 'import_batch', array( $days, $skip_existing ) );
}
/**
* Imports a batch of items to update.
*
* @internal
* @param int $batch_number Batch number to import (essentially a query page number).
* @param int|bool $days Number of days to import.
* @param bool $skip_existing Skip existing records.
* @return void
*/
public static function import_batch( $batch_number, $days, $skip_existing ) {
$batch_size = static::get_batch_size( 'import' );
$properties = array(
'batch_number' => $batch_number,
'batch_size' => $batch_size,
'type' => static::$name,
);
wc_admin_record_tracks_event( 'import_job_start', $properties );
// When we are skipping already imported items, the table of items to import gets smaller in
// every batch, so we want to always import the first page.
$page = $skip_existing ? 1 : $batch_number;
$items = static::get_items( $batch_size, $page, $days, $skip_existing );
foreach ( $items->ids as $id ) {
static::import( $id );
}
$import_stats = get_option( self::IMPORT_STATS_OPTION, array() );
$imported_count = absint( $import_stats[ static::$name ]['imported'] ) + count( $items->ids );
$import_stats[ static::$name ]['imported'] = $imported_count;
update_option( self::IMPORT_STATS_OPTION, $import_stats );
$properties['imported_count'] = $imported_count;
wc_admin_record_tracks_event( 'import_job_complete', $properties );
}
/**
* Queue item deletion in batches.
*
* @internal
*/
public static function delete_batch_init() {
global $wpdb;
$batch_size = static::get_batch_size( 'delete' );
$count = static::get_total_imported();
if ( 0 === $count ) {
return;
}
$num_batches = ceil( $count / $batch_size );
self::queue_batches( 1, $num_batches, 'delete_batch' );
}
/**
* Delete a batch by passing the count to be deleted to the child delete method.
*
* @internal
* @return void
*/
public static function delete_batch() {
wc_admin_record_tracks_event( 'delete_import_data_job_start', array( 'type' => static::$name ) );
$batch_size = static::get_batch_size( 'delete' );
static::delete( $batch_size );
ReportsCache::invalidate();
wc_admin_record_tracks_event( 'delete_import_data_job_complete', array( 'type' => static::$name ) );
}
}
PK [1]Sz] ] $ Admin/Schedulers/OrdersScheduler.phpnu last_date) OR (date = last_date AND id > last_id)
*
* @var string
*/
const LAST_PROCESSED_ORDER_ID_OPTION = 'woocommerce_admin_scheduler_last_processed_order_id';
/**
* Option name for storing whether to enable scheduled order import.
*
* @var string
*/
const SCHEDULED_IMPORT_OPTION = 'woocommerce_analytics_scheduled_import';
/**
* Default value for the scheduled import option.
*
* @var string
*/
const SCHEDULED_IMPORT_OPTION_DEFAULT_VALUE = 'no';
/**
* Action name for the order batch import.
*
* @var string
*/
const PROCESS_PENDING_ORDERS_BATCH_ACTION = 'process_pending_batch';
/**
* Attach order lookup update hooks.
*
* @internal
*/
public static function init() {
// Activate WC_Order extension.
\Automattic\WooCommerce\Admin\Overrides\Order::add_filters();
\Automattic\WooCommerce\Admin\Overrides\OrderRefund::add_filters();
if ( self::is_scheduled_import_enabled() ) {
// Schedule recurring batch processor.
add_action( 'action_scheduler_ensure_recurring_actions', array( __CLASS__, 'schedule_recurring_batch_processor' ) );
} else {
// Schedule import immediately on order create/update/delete.
add_action( 'woocommerce_update_order', array( __CLASS__, 'possibly_schedule_import' ) );
add_filter( 'woocommerce_create_order', array( __CLASS__, 'possibly_schedule_import' ) );
add_action( 'woocommerce_refund_created', array( __CLASS__, 'possibly_schedule_import' ) );
add_action( 'woocommerce_schedule_import', array( __CLASS__, 'possibly_schedule_import' ) );
}
if ( Features::is_enabled( 'analytics-scheduled-import' ) ) {
// Watch for changes to the scheduled import option.
add_action( 'add_option_' . self::SCHEDULED_IMPORT_OPTION, array( __CLASS__, 'handle_scheduled_import_option_added' ), 10, 2 );
add_action( 'update_option_' . self::SCHEDULED_IMPORT_OPTION, array( __CLASS__, 'handle_scheduled_import_option_change' ), 10, 2 );
add_action( 'delete_option', array( __CLASS__, 'handle_scheduled_import_option_before_delete' ), 10, 1 );
}
OrdersStatsDataStore::init();
CouponsDataStore::init();
ProductsDataStore::init();
TaxesDataStore::init();
OrderDataStore::init();
parent::init();
}
/**
* Add customer dependencies.
*
* @internal
* @return array
*/
public static function get_dependencies() {
return array(
'import_batch_init' => \Automattic\WooCommerce\Internal\Admin\Schedulers\CustomersScheduler::get_action( 'import_batch_init' ),
);
}
/**
* Get all available scheduling actions.
* Extends parent to add the new batch processor action.
*
* @internal
* @return array
*/
public static function get_scheduler_actions() {
return array_merge(
parent::get_scheduler_actions(),
array(
self::PROCESS_PENDING_ORDERS_BATCH_ACTION => 'wc-admin_process_pending_orders_batch',
)
);
}
/**
* Get batch sizes for OrdersScheduler actions.
*
* @internal
* @return array
*/
public static function get_batch_sizes() {
return array_merge(
parent::get_batch_sizes(),
array(
self::PROCESS_PENDING_ORDERS_BATCH_ACTION => 100,
)
);
}
/**
* Get the order/refund IDs and total count that need to be synced.
*
* @internal
* @param int $limit Number of records to retrieve.
* @param int $page Page number.
* @param int|bool $days Number of days prior to current date to limit search results.
* @param bool $skip_existing Skip already imported orders.
*/
public static function get_items( $limit = 10, $page = 1, $days = false, $skip_existing = false ) {
if ( OrderUtil::custom_orders_table_usage_is_enabled() ) {
return self::get_items_from_orders_table( $limit, $page, $days, $skip_existing );
} else {
return self::get_items_from_posts_table( $limit, $page, $days, $skip_existing );
}
}
/**
* Helper method to ger order/refund IDS and total count that needs to be synced.
*
* @internal
* @param int $limit Number of records to retrieve.
* @param int $page Page number.
* @param int|bool $days Number of days prior to current date to limit search results.
* @param bool $skip_existing Skip already imported orders.
*
* @return object Total counts.
*/
private static function get_items_from_posts_table( $limit, $page, $days, $skip_existing ) {
global $wpdb;
$where_clause = '';
$offset = $page > 1 ? ( $page - 1 ) * $limit : 0;
if ( is_int( $days ) ) {
$days_ago = gmdate( 'Y-m-d 00:00:00', time() - ( DAY_IN_SECONDS * $days ) );
$where_clause .= " AND post_date_gmt >= '{$days_ago}'";
}
if ( $skip_existing ) {
$where_clause .= " AND NOT EXISTS (
SELECT 1 FROM {$wpdb->prefix}wc_order_stats
WHERE {$wpdb->prefix}wc_order_stats.order_id = {$wpdb->posts}.ID
)";
}
$count = $wpdb->get_var(
"SELECT COUNT(*) FROM {$wpdb->posts}
WHERE post_type IN ( 'shop_order', 'shop_order_refund' )
AND post_status NOT IN ( 'wc-auto-draft', 'auto-draft', 'trash' )
{$where_clause}" // phpcs:ignore unprepared,WordPress.DB.PreparedSQL.InterpolatedNotPrepared,WordPress.DB.PreparedSQL.InterpolatedNotPrepared SQL ok.
);
$order_ids = absint( $count ) > 0 ? $wpdb->get_col(
$wpdb->prepare(
"SELECT ID FROM {$wpdb->posts}
WHERE post_type IN ( 'shop_order', 'shop_order_refund' )
AND post_status NOT IN ( 'wc-auto-draft', 'auto-draft', 'trash' )
{$where_clause}
ORDER BY post_date_gmt ASC
LIMIT %d
OFFSET %d",
$limit,
$offset
)
) : array(); // phpcs:ignore unprepared SQL ok.
return (object) array(
'total' => absint( $count ),
'ids' => $order_ids,
);
}
/**
* Helper method to ger order/refund IDS and total count that needs to be synced from HPOS.
*
* @internal
* @param int $limit Number of records to retrieve.
* @param int $page Page number.
* @param int|bool $days Number of days prior to current date to limit search results.
* @param bool $skip_existing Skip already imported orders.
*
* @return object Total counts.
*/
private static function get_items_from_orders_table( $limit, $page, $days, $skip_existing ) {
global $wpdb;
$where_clause = '';
$offset = $page > 1 ? ( $page - 1 ) * $limit : 0;
$order_table = OrdersTableDataStore::get_orders_table_name();
if ( is_int( $days ) ) {
$days_ago = gmdate( 'Y-m-d 00:00:00', time() - ( DAY_IN_SECONDS * $days ) );
$where_clause .= " AND orders.date_created_gmt >= '{$days_ago}'";
}
if ( $skip_existing ) {
$where_clause .= "AND NOT EXiSTS (
SELECT 1 FROM {$wpdb->prefix}wc_order_stats
WHERE {$wpdb->prefix}wc_order_stats.order_id = orders.id
)
";
}
$count = $wpdb->get_var(
"
SELECT COUNT(*) FROM {$order_table} AS orders
WHERE type in ( 'shop_order', 'shop_order_refund' )
AND status NOT IN ( 'wc-auto-draft', 'trash', 'auto-draft' )
{$where_clause}
"
); // phpcs:ignore unprepared SQL ok.
$order_ids = absint( $count ) > 0 ? $wpdb->get_col(
$wpdb->prepare(
"SELECT id FROM {$order_table} AS orders
WHERE type IN ( 'shop_order', 'shop_order_refund' )
AND status NOT IN ( 'wc-auto-draft', 'auto-draft', 'trash' )
{$where_clause}
ORDER BY date_created_gmt ASC
LIMIT %d
OFFSET %d",
$limit,
$offset
)
) : array(); // phpcs:ignore unprepared SQL ok.
return (object) array(
'total' => absint( $count ),
'ids' => $order_ids,
);
}
/**
* Get total number of rows imported.
*
* @internal
*/
public static function get_total_imported() {
global $wpdb;
return $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}wc_order_stats" );
}
/**
* Schedule this import if the post is an order or refund.
* Note: This method is only called when scheduled import is disabled
* (immediate mode). Otherwise, orders are processed in batches periodically.
*
* @param int $order_id Post ID.
*
* @internal
* @returns int The order id
*/
public static function possibly_schedule_import( $order_id ) {
if ( self::is_scheduled_import_enabled() ) {
return $order_id;
}
if ( ! OrderUtil::is_order( $order_id, array( 'shop_order' ) ) && 'woocommerce_refund_created' !== current_filter() && 'woocommerce_schedule_import' !== current_filter() ) {
return $order_id;
}
self::schedule_action( 'import', array( $order_id ) );
return $order_id;
}
/**
* Imports a single order or refund to update lookup tables for.
* If an error is encountered in one of the updates, a retry action is scheduled.
*
* @internal
* @param int $order_id Order or refund ID.
* @return void
*/
public static function import( $order_id ) {
$order = wc_get_order( $order_id );
// If the order isn't found for some reason, skip the sync.
if ( ! $order ) {
return;
}
$type = $order->get_type();
// If the order isn't the right type, skip sync.
if ( 'shop_order' !== $type && 'shop_order_refund' !== $type ) {
return;
}
// If the order has no id or date created, skip sync.
if ( ! $order->get_id() || ! $order->get_date_created() ) {
return;
}
$results = array(
OrdersStatsDataStore::sync_order( $order_id ),
ProductsDataStore::sync_order_products( $order_id ),
CouponsDataStore::sync_order_coupons( $order_id ),
TaxesDataStore::sync_order_taxes( $order_id ),
CustomersDataStore::sync_order_customer( $order_id ),
);
if ( 'shop_order' === $type ) {
$order_refunds = $order->get_refunds();
foreach ( $order_refunds as $refund ) {
OrdersStatsDataStore::sync_order( $refund->get_id() );
}
}
ReportsCache::invalidate();
/**
* Fires after an order or refund has been imported into Analytics lookup tables
* and the reports cache has been invalidated.
*
* @since 10.3.0
* @param int $order_id Order or refund ID.
*/
do_action( 'woocommerce_order_scheduler_after_import_order', $order_id );
}
/**
* Schedule recurring batch processor for order imports.
*
* @internal
*/
public static function schedule_recurring_batch_processor() {
$action_hook = self::get_action( self::PROCESS_PENDING_ORDERS_BATCH_ACTION );
// The most efficient way to check for an existing action is to use `as_has_scheduled_action`, but in unusual
// cases where another plugin has loaded a very old version of Action Scheduler, it may not be available to us.
$has_scheduled_action = function_exists( 'as_has_scheduled_action' ) ? 'as_has_scheduled_action' : 'as_next_scheduled_action';
if ( call_user_func( $has_scheduled_action, $action_hook ) ) {
return;
}
$interval = self::get_import_interval();
as_schedule_recurring_action( time(), $interval, $action_hook, array(), static::$group, true );
}
/**
* Handle changes to the scheduled import option.
*
* When switching from scheduled to immediate import,
* we need to run a final catchup batch to ensure no orders are missed.
*
* When switching from immediate to scheduled import,
* we need to reschedule the recurring batch processor.
*
* @internal
* @param mixed $old_value The old value of the option.
* @param mixed $new_value The new value of the option.
* @return void
*/
public static function handle_scheduled_import_option_change( $old_value, $new_value ) {
// If switching from scheduled to immediate import.
if ( 'yes' === $old_value && 'no' === $new_value ) {
// Unschedule the recurring batch processor.
$action_hook = self::get_action( self::PROCESS_PENDING_ORDERS_BATCH_ACTION );
as_unschedule_all_actions( $action_hook, array(), static::$group );
// Schedule an immediate catchup batch to process all orders up to now.
// This ensures no orders are missed during the transition.
self::schedule_action( self::PROCESS_PENDING_ORDERS_BATCH_ACTION, array( null, null ) );
} elseif ( 'no' === $old_value && 'yes' === $new_value ) {
// Switching from immediate to scheduled import.
// Set the last processed order date to now with 1 minute buffer to ensure no orders are missed.
update_option( self::LAST_PROCESSED_ORDER_DATE_OPTION, gmdate( 'Y-m-d H:i:s', time() - MINUTE_IN_SECONDS ) );
update_option( self::LAST_PROCESSED_ORDER_ID_OPTION, 0 );
// Schedule the recurring batch processor.
self::schedule_recurring_batch_processor();
}
}
/**
* Handle addition of the scheduled import option.
*
* @internal
* @param string $option_name The name of the option that was added.
* @param string $value The value of the option that was added.
*
* @return void
*/
public static function handle_scheduled_import_option_added( $option_name, $value ) {
if ( self::SCHEDULED_IMPORT_OPTION !== $option_name ) {
return;
}
self::handle_scheduled_import_option_change( self::SCHEDULED_IMPORT_OPTION_DEFAULT_VALUE, $value );
}
/**
* Handle deletion of the scheduled import option.
*
* @internal
* @param string $option_name The name of the option that was deleted.
*
* @return void
*/
public static function handle_scheduled_import_option_before_delete( $option_name ) {
if ( self::SCHEDULED_IMPORT_OPTION !== $option_name ) {
return;
}
self::handle_scheduled_import_option_change(
get_option( self::SCHEDULED_IMPORT_OPTION, self::SCHEDULED_IMPORT_OPTION_DEFAULT_VALUE ),
self::SCHEDULED_IMPORT_OPTION_DEFAULT_VALUE,
);
}
/**
* Process pending orders in batch.
*
* This method queries for orders updated since the last cursor position
* (compound cursor: date + ID) and imports them into the analytics tables.
*
* @internal
* @param string|null $cursor_date Cursor date in 'Y-m-d H:i:s' format. Orders after this date will be processed.
* @param int|null $cursor_id Cursor order ID. Combined with $cursor_date to form compound cursor.
* @return void
*/
public static function process_pending_batch( $cursor_date = null, $cursor_id = null ) {
$logger = wc_get_logger();
$context = array( 'source' => 'wc-analytics-order-import' );
if ( self::is_importing() ) {
// No need to process if an import is already in progress.
$logger->info( 'Import is already in progress, skipping batch import.', $context );
return;
}
// Load cursor position from options if not provided.
// If the cursor date is not provided, use the last 24 hours as the default since `action_scheduler_ensure_recurring_actions` runs daily so 24 hours is enough.
$default_cursor_date = gmdate( 'Y-m-d H:i:s', strtotime( '-24 hours' ) );
$cursor_date = $cursor_date ?? get_option( self::LAST_PROCESSED_ORDER_DATE_OPTION, $default_cursor_date );
$cursor_id = $cursor_id ?? (int) get_option( self::LAST_PROCESSED_ORDER_ID_OPTION, 0 );
// Validate cursor date.
if ( ! $cursor_date || ! strtotime( $cursor_date ) ) {
$logger->error( 'Invalid cursor date: ' . $cursor_date, $context );
$cursor_date = $default_cursor_date;
}
$batch_size = self::get_batch_size( self::PROCESS_PENDING_ORDERS_BATCH_ACTION );
$logger->info(
sprintf( 'Starting batch import. Cursor: %s (ID: %d), batch size: %d', $cursor_date, $cursor_id, $batch_size ),
$context
);
$start_time = microtime( true );
// Get orders updated since the cursor position.
$orders = self::get_orders_since( $cursor_date, $cursor_id, $batch_size );
if ( empty( $orders ) ) {
$logger->info( 'No orders to process', $context );
// Update the cursor position to the start time of the batch so that the next batch will start from that point.
update_option( self::LAST_PROCESSED_ORDER_DATE_OPTION, gmdate( 'Y-m-d H:i:s', (int) $start_time ), false );
update_option( self::LAST_PROCESSED_ORDER_ID_OPTION, 0, false );
return;
}
$processed_count = 0;
foreach ( $orders as $order ) {
try {
self::import( $order->id );
++$processed_count;
// Advance cursor after each successful import. Since orders are sorted by
// date ASC, id ASC, we can simply overwrite with the current order's values.
// If an error occurs, we break and save the last successful position.
$cursor_date = $order->date_updated_gmt;
$cursor_id = $order->id;
} catch ( \Exception $e ) {
$logger->error(
sprintf( 'Failed to import order %d: %s', $order->id, $e->getMessage() ),
$context
);
break;
}
}
// Save the updated cursor position.
update_option( self::LAST_PROCESSED_ORDER_DATE_OPTION, $cursor_date, false );
update_option( self::LAST_PROCESSED_ORDER_ID_OPTION, $cursor_id, false );
$elapsed_time = microtime( true ) - $start_time;
$logger->info(
sprintf(
'Batch import completed. Processed: %d orders in %.2f seconds. Cursor: %s (ID: %d)',
$processed_count,
$elapsed_time,
$cursor_date,
$cursor_id
),
$context
);
// If we got a full batch, there might be more orders to process.
// Schedule immediate next batch.
if ( $processed_count === $batch_size ) {
$logger->info( 'Full batch processed, scheduling next batch', $context );
self::schedule_action(
'process_pending_batch',
array( $cursor_date, $cursor_id )
);
}
}
/**
* Get the import interval.
*
* @internal
* @return int The import interval in seconds.
*/
public static function get_import_interval() {
/**
* Filter the analytics import interval.
*
* @since 10.4.0
* @param int $interval The import interval in seconds. Default is 12 hours.
*/
return apply_filters( 'woocommerce_analytics_import_interval', 12 * HOUR_IN_SECONDS );
}
/**
* Get orders updated since the specified cursor position.
*
* Uses a compound cursor (date + ID) to handle cases where multiple orders
* have the same timestamp. This ensures we can paginate through orders reliably
* even when batch_size < number of orders at the same timestamp.
*
* @internal
* @param string $cursor_date Cursor date in 'Y-m-d H:i:s' format.
* @param int $cursor_id Cursor order ID.
* @param int $limit Number of orders to retrieve.
* @return array Array of objects with 'id' and 'date_updated_gmt' properties.
*/
private static function get_orders_since( $cursor_date, $cursor_id, $limit ) {
if ( OrderUtil::custom_orders_table_usage_is_enabled() ) {
return self::get_orders_since_from_orders_table( $cursor_date, $cursor_id, $limit );
} else {
return self::get_orders_since_from_posts_table( $cursor_date, $cursor_id, $limit );
}
}
/**
* Get orders from HPOS orders table updated since the specified cursor position.
*
* Query logic uses a compound cursor (date, ID) to handle pagination when multiple
* orders share the same timestamp:
* - WHERE date > cursor_date: Get orders with newer timestamps
* - OR (date = cursor_date AND id > cursor_id): Continue processing same timestamp
*
* Example: With batch_size=100 and 1000 orders at '2024-01-01 10:00:00',
* this processes them across 10 batches without infinite loops or duplicates.
*
* @internal
* @param string $cursor_date Cursor date in 'Y-m-d H:i:s' format.
* @param int $cursor_id Cursor order ID.
* @param int $limit Number of orders to retrieve.
* @return array Array of objects with 'id' and 'date_updated_gmt' properties.
*/
private static function get_orders_since_from_orders_table( $cursor_date, $cursor_id, $limit ) {
global $wpdb;
$orders_table = OrdersTableDataStore::get_orders_table_name();
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->get_results(
$wpdb->prepare(
"SELECT id, date_updated_gmt
FROM {$orders_table}
WHERE type IN ('shop_order', 'shop_order_refund')
AND status NOT IN ('wc-auto-draft', 'auto-draft', 'trash')
AND (
date_updated_gmt > %s
OR (date_updated_gmt = %s AND id > %d)
)
ORDER BY date_updated_gmt ASC, id ASC
LIMIT %d",
$cursor_date,
$cursor_date,
$cursor_id,
$limit
)
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Get orders from posts table updated since the specified cursor position.
*
* Uses the same compound cursor logic as get_orders_since_from_orders_table()
* but queries the posts table instead of the HPOS orders table.
*
* @internal
* @param string $cursor_date Cursor date in 'Y-m-d H:i:s' format.
* @param int $cursor_id Cursor order ID.
* @param int $limit Number of orders to retrieve.
* @return array Array of objects with 'id' and 'date_updated_gmt' properties.
*/
private static function get_orders_since_from_posts_table( $cursor_date, $cursor_id, $limit ) {
global $wpdb;
return $wpdb->get_results(
$wpdb->prepare(
"SELECT ID as id, post_modified_gmt as date_updated_gmt
FROM {$wpdb->posts}
WHERE post_type IN ('shop_order', 'shop_order_refund')
AND post_status NOT IN ('wc-auto-draft', 'auto-draft', 'trash')
AND (
post_modified_gmt > %s
OR (post_modified_gmt = %s AND ID > %d)
)
ORDER BY post_modified_gmt ASC, ID ASC
LIMIT %d",
$cursor_date,
$cursor_date,
$cursor_id,
$limit
)
);
}
/**
* Delete a batch of orders.
*
* @internal
* @param int $batch_size Number of items to delete.
* @return void
*/
public static function delete( $batch_size ) {
global $wpdb;
$order_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT order_id FROM {$wpdb->prefix}wc_order_stats ORDER BY order_id ASC LIMIT %d",
$batch_size
)
);
foreach ( $order_ids as $order_id ) {
OrdersStatsDataStore::delete_order( $order_id );
}
}
/**
* Check whether scheduled import is enabled.
*
* When the "analytics-scheduled-import" feature is disabled, only immediate
* import is supported (returns false). When enabled, checks the option value.
*
* @internal
* @return bool
*/
private static function is_scheduled_import_enabled(): bool {
if ( ! Features::is_enabled( 'analytics-scheduled-import' ) ) {
// If the feature is disabled, only immediate import is supported.
return false;
}
return 'yes' === get_option( self::SCHEDULED_IMPORT_OPTION, self::SCHEDULED_IMPORT_OPTION_DEFAULT_VALUE );
}
}
PK [1]"h h " Admin/Logging/LogHandlerFileV2.phpnu file_controller = wc_get_container()->get( FileController::class );
$this->settings = wc_get_container()->get( Settings::class );
}
/**
* Handle a log entry.
*
* @param int $timestamp Log timestamp.
* @param string $level emergency|alert|critical|error|warning|notice|info|debug.
* @param string $message Log message.
* @param array $context {
* Optional. Additional information for log handlers. Any data can be added here, but there are some array
* keys that have special behavior.
*
* @type string $source Determines which log file to write to. Must be at least 3 characters in length.
* @type bool $backtrace True to include a backtrace that shows where the logging function got called.
* }
*
* @return bool False if value was not handled and true if value was handled.
*/
public function handle( $timestamp, $level, $message, $context ) {
$context = (array) $context;
if ( isset( $context['source'] ) && is_string( $context['source'] ) && strlen( $context['source'] ) >= 3 ) {
$source = sanitize_title( trim( $context['source'] ) );
} else {
$source = $this->determine_source();
}
$entry = static::format_entry( $timestamp, $level, $message, $context );
$written = $this->file_controller->write_to_file( $source, $entry, $timestamp );
if ( $written ) {
$this->file_controller->invalidate_cache();
}
return $written;
}
/**
* Builds a log entry text from level, timestamp, and message.
*
* @param int $timestamp Log timestamp.
* @param string $level emergency|alert|critical|error|warning|notice|info|debug.
* @param string $message Log message.
* @param array $context Additional information for log handlers.
*
* @return string Formatted log entry.
*/
protected static function format_entry( $timestamp, $level, $message, $context ) {
$time_string = static::format_time( $timestamp );
$level_string = strtoupper( $level );
if ( isset( $context['backtrace'] ) && true === filter_var( $context['backtrace'], FILTER_VALIDATE_BOOLEAN ) ) {
$context['backtrace'] = static::get_backtrace();
}
$context_for_entry = $context;
unset( $context_for_entry['source'] );
if ( ! empty( $context_for_entry ) ) {
$formatted_context = wp_json_encode( $context_for_entry, JSON_UNESCAPED_UNICODE );
$message .= stripslashes( " CONTEXT: $formatted_context" );
}
$entry = "$time_string $level_string $message";
// phpcs:disable WooCommerce.Commenting.CommentHooks.MissingSinceComment
/** This filter is documented in includes/abstracts/abstract-wc-log-handler.php */
return apply_filters(
'woocommerce_format_log_entry',
$entry,
array(
'timestamp' => $timestamp,
'level' => $level,
'message' => $message,
'context' => $context,
)
);
// phpcs:enable WooCommerce.Commenting.CommentHooks.MissingSinceComment
}
/**
* Figures out a source string to use for a log entry based on where the log method was called from.
*
* @return string
*/
protected function determine_source(): string {
$source_roots = array(
'mu-plugin' => trailingslashit( Constants::get_constant( 'WPMU_PLUGIN_DIR' ) ),
'plugin' => trailingslashit( Constants::get_constant( 'WP_PLUGIN_DIR' ) ),
'theme' => trailingslashit( get_theme_root() ),
);
$source = '';
$backtrace = static::get_backtrace();
foreach ( $backtrace as $frame ) {
if ( ! isset( $frame['file'] ) ) {
continue;
}
foreach ( $source_roots as $type => $path ) {
if ( 0 === strpos( $frame['file'], $path ) ) {
$relative_path = trim( substr( $frame['file'], strlen( $path ) ), DIRECTORY_SEPARATOR );
if ( 'mu-plugin' === $type ) {
$info = pathinfo( $relative_path );
if ( '.' === $info['dirname'] ) {
$source = "$type-" . $info['filename'];
} else {
$source = "$type-" . $info['dirname'];
}
break 2;
}
$segments = explode( DIRECTORY_SEPARATOR, $relative_path );
if ( is_array( $segments ) ) {
$source = "$type-" . reset( $segments );
}
break 2;
}
}
}
if ( ! $source ) {
$source = 'log';
}
return sanitize_title( $source );
}
/**
* Delete all logs from a specific source.
*
* @param string $source The source of the log entries.
* @param bool $quiet Whether to suppress the deletion message.
*
* @return int The number of files that were deleted.
*/
public function clear( string $source, bool $quiet = false ): int {
$source = File::sanitize_source( $source );
$files = $this->file_controller->get_files(
array(
'source' => $source,
)
);
if ( is_wp_error( $files ) || count( $files ) < 1 ) {
return 0;
}
$file_ids = array_map(
fn( $file ) => $file->get_file_id(),
$files
);
$deleted = $this->file_controller->delete_files( $file_ids );
if ( $deleted > 0 && ! $quiet ) {
$this->handle(
time(),
'info',
sprintf(
esc_html(
// translators: %1$s is a number of log files, %2$s is a slug-style name for a file.
_n(
'%1$s log file from source %2$s was deleted.',
'%1$s log files from source %2$s were deleted.',
$deleted,
'woocommerce'
)
),
number_format_i18n( $deleted ),
sprintf(
'%s',
esc_html( $source )
)
),
array(
'source' => 'wc_logger',
'backtrace' => true,
)
);
}
return $deleted;
}
/**
* Delete all logs older than a specified timestamp.
*
* @param int $timestamp All files created before this timestamp will be deleted.
*
* @return int The number of files that were deleted.
*/
public function delete_logs_before_timestamp( int $timestamp = 0 ): int {
if ( ! $timestamp ) {
return 0;
}
$files = $this->file_controller->get_files(
array(
'date_filter' => 'created',
'date_start' => 1,
'date_end' => $timestamp,
)
);
if ( is_wp_error( $files ) ) {
return 0;
}
$files = array_filter(
$files,
function ( $file ) use ( $timestamp ) {
/**
* Allows preventing an expired log file from being deleted.
*
* @param bool $delete True to delete the file.
* @param File $file The log file object.
* @param int $timestamp The expiration threshold.
*
* @since 8.7.0
*/
$delete = apply_filters( 'woocommerce_logger_delete_expired_file', true, $file, $timestamp );
return boolval( $delete );
}
);
if ( count( $files ) < 1 ) {
return 0;
}
$file_ids = array_map(
fn( $file ) => $file->get_file_id(),
$files
);
$deleted = $this->file_controller->delete_files( $file_ids );
$retention_days = $this->settings->get_retention_period();
if ( $deleted > 0 ) {
$this->handle(
time(),
'info',
sprintf(
esc_html(
// translators: %s is a number of log files.
_n(
'%s expired log file was deleted.',
'%s expired log files were deleted.',
$deleted,
'woocommerce'
)
),
number_format_i18n( $deleted )
),
array(
'source' => 'wc_logger',
)
);
}
return $deleted;
}
}
PK [1]8 ~{ { ( Admin/Logging/FileV2/SearchListTable.phpnu file_controller = $file_controller;
$this->page_controller = $page_controller;
parent::__construct(
array(
'singular' => 'wc-logs-search-result',
'plural' => 'wc-logs-search-results',
'ajax' => false,
)
);
}
/**
* Render message when there are no items.
*
* @return void
*/
public function no_items(): void {
esc_html_e( 'No search results.', 'woocommerce' );
}
/**
* Set up the column header info.
*
* @return void
*/
public function prepare_column_headers(): void {
$this->_column_headers = array(
$this->get_columns(),
array(),
array(),
$this->get_primary_column(),
);
}
/**
* Prepares the list of items for displaying.
*
* @return void
*/
public function prepare_items(): void {
$per_page = $this->get_items_per_page(
self::PER_PAGE_USER_OPTION_KEY,
$this->get_per_page_default()
);
$args = array(
'per_page' => $per_page,
'offset' => ( $this->get_pagenum() - 1 ) * $per_page,
);
$file_args = $this->page_controller->get_query_params(
array( 'date_end', 'date_filter', 'date_start', 'order', 'orderby', 'search', 'source' )
);
$search = $file_args['search'];
unset( $file_args['search'] );
$total_items = $this->file_controller->search_within_files( $search, $args, $file_args, true );
if ( is_wp_error( $total_items ) ) {
printf(
'
format_line( $line, $line_number );
++$line_number;
}
?>
get_query_params( array( 'view' ) );
$list_table = $this->get_list_table( $params['view'] );
$list_table->prepare_items();
?>
render_search_field(); ?>
display(); ?>
'',
'order' => $this->file_controller::DEFAULTS_GET_FILES['order'],
'orderby' => $this->file_controller::DEFAULTS_GET_FILES['orderby'],
'search' => '',
'source' => $this->file_controller::DEFAULTS_GET_FILES['source'],
'view' => 'list_files',
);
}
/**
* Get and validate URL query params for FileV2 views.
*
* @param array $param_keys Optional. The names of the params you want to get.
*
* @return array
*/
public function get_query_params( array $param_keys = array() ): array {
$defaults = $this->get_query_param_defaults();
$params = filter_input_array(
INPUT_GET,
array(
'file_id' => array(
'filter' => FILTER_CALLBACK,
'options' => function ( $file_id ) {
return sanitize_file_name( wp_unslash( $file_id ) );
},
),
'order' => array(
'filter' => FILTER_VALIDATE_REGEXP,
'options' => array(
'regexp' => '/^(asc|desc)$/i',
'default' => $defaults['order'],
),
),
'orderby' => array(
'filter' => FILTER_VALIDATE_REGEXP,
'options' => array(
'regexp' => '/^(created|modified|source|size)$/',
'default' => $defaults['orderby'],
),
),
'search' => array(
'filter' => FILTER_CALLBACK,
'options' => function ( $search ) {
return esc_html( wp_unslash( $search ) );
},
),
'source' => array(
'filter' => FILTER_CALLBACK,
'options' => function ( $source ) {
return File::sanitize_source( wp_unslash( $source ) );
},
),
'view' => array(
'filter' => FILTER_VALIDATE_REGEXP,
'options' => array(
'regexp' => '/^(list_files|single_file|search_results|settings)$/',
'default' => $defaults['view'],
),
),
),
false
);
$params = wp_parse_args( $params, $defaults );
if ( count( $param_keys ) > 0 ) {
$params = array_intersect_key( $params, array_flip( $param_keys ) );
}
return $params;
}
/**
* Get and cache an instance of the list table.
*
* @param string $view The current view, which determines which list table class to get.
*
* @return FileListTable|SearchListTable
*/
private function get_list_table( string $view ) {
if ( $this->list_table instanceof WP_List_Table ) {
return $this->list_table;
}
switch ( $view ) {
case 'list_files':
$this->list_table = new FileListTable( $this->file_controller, $this );
break;
case 'search_results':
$this->list_table = new SearchListTable( $this->file_controller, $this );
break;
}
return $this->list_table;
}
/**
* Register screen options for the logging views.
*
* @param string $view The current view within the Logs tab.
*
* @return void
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function setup_screen_options( string $view ): void {
$handler = $this->settings->get_default_handler();
$list_table = null;
switch ( $handler ) {
case LogHandlerFileV2::class:
if ( in_array( $view, array( 'list_files', 'search_results' ), true ) ) {
$list_table = $this->get_list_table( $view );
}
break;
case 'WC_Log_Handler_DB':
$list_table = WC_Admin_Status::get_db_log_list_table();
break;
}
if ( $list_table instanceof WP_List_Table ) {
// Ensure list table columns are initialized early enough to enable column hiding, if available.
$list_table->prepare_column_headers();
add_screen_option(
'per_page',
array(
'default' => $list_table->get_per_page_default(),
'option' => $list_table::PER_PAGE_USER_OPTION_KEY,
)
);
}
}
/**
* Process bulk actions initiated from the log file list table.
*
* @param string $view The current view within the Logs tab.
*
* @return void
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function handle_list_table_bulk_actions( string $view ): void {
// Bail if we're not using the file handler.
if ( LogHandlerFileV2::class !== $this->settings->get_default_handler() ) {
return;
}
$params = $this->get_query_params( array( 'file_id' ) );
// Bail if this is not the list table view.
if ( 'list_files' !== $view ) {
return;
}
$action = $this->get_list_table( $view )->current_action();
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$request_uri = isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : $this->get_logs_tab_url();
if ( $action ) {
check_admin_referer( 'bulk-log-files' );
if ( ! current_user_can( 'manage_woocommerce' ) ) {
wp_die( esc_html__( 'You do not have permission to manage log files.', 'woocommerce' ) );
}
$sendback = remove_query_arg( array( 'deleted' ), wp_get_referer() );
// Multiple file_id[] params will be filtered separately, but assigned to $files as an array.
$file_ids = $params['file_id'];
if ( ! is_array( $file_ids ) || count( $file_ids ) < 1 ) {
wp_safe_redirect( $sendback );
exit;
}
switch ( $action ) {
case 'export':
if ( 1 === count( $file_ids ) ) {
$export_error = $this->file_controller->export_single_file( reset( $file_ids ) );
} else {
$export_error = $this->file_controller->export_multiple_files( $file_ids );
}
if ( is_wp_error( $export_error ) ) {
wp_die( wp_kses_post( $export_error->get_error_message() ) );
}
break;
case 'delete':
$deleted = $this->file_controller->delete_files( $file_ids );
$sendback = add_query_arg( 'deleted', $deleted, $sendback );
/**
* If the delete action was triggered on the single file view, don't redirect back there
* since the file doesn't exist anymore.
*/
$sendback = remove_query_arg( array( 'view', 'file_id' ), $sendback );
break;
}
$sendback = remove_query_arg( array( 'action', 'action2' ), $sendback );
wp_safe_redirect( $sendback );
exit;
} elseif ( ! empty( $_REQUEST['_wp_http_referer'] ) ) {
$removable_args = array( '_wp_http_referer', '_wpnonce', 'action', 'action2', 'filter_action' );
wp_safe_redirect( remove_query_arg( $removable_args, $request_uri ) );
exit;
}
$deleted = filter_input( INPUT_GET, 'deleted', FILTER_VALIDATE_INT );
if ( is_numeric( $deleted ) ) {
add_action(
'admin_notices',
function () use ( $deleted ) {
?>
%s',
$segments[0]
);
$has_timestamp = true;
}
if ( isset( $segments[1] ) && WC_Log_Levels::is_valid_level( strtolower( $segments[1] ) ) ) {
$segments[1] = sprintf(
'%2$s',
esc_attr( 'log-level log-level--' . strtolower( $segments[1] ) ),
esc_html( WC_Log_Levels::get_level_label( strtolower( $segments[1] ) ) )
);
$has_level = true;
}
if ( isset( $segments[2] ) && $has_timestamp && $has_level ) {
$message_chunks = explode( 'CONTEXT:', $segments[2], 2 );
if ( isset( $message_chunks[1] ) ) {
try {
$maybe_json = html_entity_decode( addslashes( trim( $message_chunks[1] ) ) );
// Decode for validation.
$context = json_decode( $maybe_json, false, 512, JSON_THROW_ON_ERROR );
// Re-encode to make it pretty.
$context = wp_json_encode( $context, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE );
$message_chunks[1] = sprintf(
'%1$s%2$s',
esc_html__( 'Additional context', 'woocommerce' ),
stripslashes( $context )
);
$segments[2] = implode( ' ', $message_chunks );
$classes[] = 'has-context';
} catch ( \JsonException $exception ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// It's not valid JSON so don't do anything with it.
}
}
}
if ( count( $segments ) > 1 ) {
$line = implode( ' ', $segments );
}
$classes = implode( ' ', $classes );
return sprintf(
'%3$s%4$s',
absint( $line_number ),
esc_attr( $classes ),
sprintf(
'',
absint( $line_number )
),
sprintf(
'%s',
wp_kses_post( $line )
)
);
}
/**
* Render a form for searching within log files.
*
* @return void
*/
private function render_search_field(): void {
$params = $this->get_query_params( array( 'date_end', 'date_filter', 'date_start', 'search', 'source' ) );
$defaults = $this->get_query_param_defaults();
$file_count = $this->file_controller->get_files( $params, true );
if ( $file_count > 0 ) {
?>
true,
'default_handler' => LogHandlerFileV2::class,
'retention_period_days' => 30,
'level_threshold' => 'none',
);
/**
* The prefix for settings keys used in the options table.
*
* @const string
*/
private const PREFIX = 'woocommerce_logs_';
/**
* Class Settings.
*/
public function __construct() {
add_action( 'wc_logs_load_tab', array( $this, 'save_settings' ) );
}
/**
* Get the directory for storing log files.
*
* The `wp_upload_dir` function takes into account the possibility of multisite, and handles changing
* the directory if the context is switched to a different site in the network mid-request.
*
* @param bool $create_dir Optional. True to attempt to create the log directory if it doesn't exist. Default true.
*
* @return string The full directory path, with trailing slash.
*/
public static function get_log_directory( bool $create_dir = true ): string {
if ( true === Constants::get_constant( 'WC_LOG_DIR_CUSTOM' ) ) {
$dir = Constants::get_constant( 'WC_LOG_DIR' );
} else {
$upload_dir = wc_get_container()->get( LegacyProxy::class )->call_function( 'wp_upload_dir', null, $create_dir );
/**
* Filter to change the directory for storing WooCommerce's log files.
*
* @param string $dir The full directory path, with trailing slash.
*
* @since 8.8.0
*/
$dir = apply_filters( 'woocommerce_log_directory', $upload_dir['basedir'] . '/wc-logs/' );
}
$dir = trailingslashit( $dir );
if ( true === $create_dir ) {
$realpath = realpath( $dir );
if ( false === $realpath ) {
$result = wp_mkdir_p( $dir );
if ( true === $result ) {
// Create infrastructure to prevent listing contents of the logs directory.
try {
$filesystem = FilesystemUtil::get_wp_filesystem();
$filesystem->put_contents( $dir . '.htaccess', 'deny from all' );
$filesystem->put_contents( $dir . 'index.html', '' );
} catch ( Exception $exception ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// Creation failed.
}
}
}
}
return $dir;
}
/**
* The definitions used by WC_Admin_Settings to render and save settings controls.
*
* @return array
*/
private function get_settings_definitions(): array {
$settings = array(
'start' => array(
'title' => __( 'Logs settings', 'woocommerce' ),
'id' => self::PREFIX . 'settings',
'type' => 'title',
),
'logging_enabled' => array(
'title' => __( 'Logger', 'woocommerce' ),
'desc' => __( 'Enable logging', 'woocommerce' ),
'id' => self::PREFIX . 'logging_enabled',
'type' => 'checkbox',
'value' => $this->logging_is_enabled() ? 'yes' : 'no',
'default' => self::DEFAULTS['logging_enabled'] ? 'yes' : 'no',
'autoload' => false,
),
'default_handler' => array(),
'retention_period_days' => array(),
'level_threshold' => array(),
'end' => array(
'id' => self::PREFIX . 'settings',
'type' => 'sectionend',
),
);
if ( true === $this->logging_is_enabled() ) {
$settings['default_handler'] = $this->get_default_handler_setting_definition();
$settings['retention_period_days'] = $this->get_retention_period_days_setting_definition();
$settings['level_threshold'] = $this->get_level_threshold_setting_definition();
$default_handler = $this->get_default_handler();
if ( in_array( $default_handler, array( LogHandlerFileV2::class, WC_Log_Handler_File::class ), true ) ) {
$settings += $this->get_filesystem_settings_definitions();
} elseif ( WC_Log_Handler_DB::class === $default_handler ) {
$settings += $this->get_database_settings_definitions();
}
}
return $settings;
}
/**
* The definition for the default_handler setting.
*
* @return array
*/
private function get_default_handler_setting_definition(): array {
$handler_options = array(
LogHandlerFileV2::class => __( 'File system (default)', 'woocommerce' ),
WC_Log_Handler_DB::class => __( 'Database (not recommended on live sites)', 'woocommerce' ),
);
/**
* Filter the list of logging handlers that can be set as the default handler.
*
* @param array $handler_options An associative array of class_name => description.
*
* @since 8.6.0
*/
$handler_options = apply_filters( 'woocommerce_logger_handler_options', $handler_options );
$current_value = $this->get_default_handler();
if ( ! array_key_exists( $current_value, $handler_options ) ) {
$handler_options[ $current_value ] = $current_value;
}
$desc = array();
$desc[] = __( 'Note that if this setting is changed, any log entries that have already been recorded will remain stored in their current location, but will not migrate.', 'woocommerce' );
$hardcoded = ! is_null( Constants::get_constant( 'WC_LOG_HANDLER' ) );
if ( $hardcoded ) {
$desc[] = sprintf(
// translators: %s is the name of a code variable.
__( 'This setting cannot be changed here because it is defined in the %s constant.', 'woocommerce' ),
'WC_LOG_HANDLER'
);
}
return array(
'title' => __( 'Log storage', 'woocommerce' ),
'desc_tip' => __( 'This determines where log entries are saved.', 'woocommerce' ),
'id' => self::PREFIX . 'default_handler',
'type' => 'radio',
'value' => $current_value,
'default' => self::DEFAULTS['default_handler'],
'autoload' => false,
'options' => $handler_options,
'disabled' => $hardcoded ? array_keys( $handler_options ) : array(),
'desc' => implode( '
', $desc ),
'desc_at_end' => true,
);
}
/**
* The definition for the retention_period_days setting.
*
* @return array
*/
private function get_retention_period_days_setting_definition(): array {
$custom_attributes = array(
'min' => 1,
'step' => 1,
);
$desc = array();
$hardcoded = has_filter( 'woocommerce_logger_days_to_retain_logs' );
if ( $hardcoded ) {
$custom_attributes['disabled'] = 'true';
$desc[] = sprintf(
// translators: %s is the name of a filter hook.
__( 'This setting cannot be changed here because it is being set by a filter on the %s hook.', 'woocommerce' ),
'woocommerce_logger_days_to_retain_logs'
);
}
$file_delete_has_filter = LogHandlerFileV2::class === $this->get_default_handler() && has_filter( 'woocommerce_logger_delete_expired_file' );
if ( $file_delete_has_filter ) {
$desc[] = sprintf(
// translators: %s is the name of a filter hook.
__( 'The %s hook has a filter set, so some log files may have different retention settings.', 'woocommerce' ),
'woocommerce_logger_delete_expired_file'
);
}
return array(
'title' => __( 'Retention period', 'woocommerce' ),
'desc_tip' => __( 'This sets how many days log entries will be kept before being auto-deleted.', 'woocommerce' ),
'id' => self::PREFIX . 'retention_period_days',
'type' => 'number',
'value' => $this->get_retention_period(),
'default' => self::DEFAULTS['retention_period_days'],
'autoload' => false,
'custom_attributes' => $custom_attributes,
'css' => 'width:70px;',
'row_class' => 'logs-retention-period-days',
'suffix' => sprintf(
' %s',
__( 'days', 'woocommerce' ),
),
'desc' => implode( '
', $desc ),
);
}
/**
* The definition for the level_threshold setting.
*
* @return array
*/
private function get_level_threshold_setting_definition(): array {
$hardcoded = ! is_null( Constants::get_constant( 'WC_LOG_THRESHOLD' ) );
$desc = '';
if ( $hardcoded ) {
$desc = sprintf(
// translators: %1$s is the name of a code variable. %2$s is the name of a file.
__( 'This setting cannot be changed here because it is defined in the %1$s constant, probably in your %2$s file.', 'woocommerce' ),
'WC_LOG_THRESHOLD',
'wp-config.php'
);
}
$labels = WC_Log_Levels::get_all_level_labels();
$labels['none'] = __( 'None', 'woocommerce' );
$custom_attributes = array();
if ( $hardcoded ) {
$custom_attributes['disabled'] = 'true';
}
return array(
'title' => __( 'Level threshold', 'woocommerce' ),
'desc_tip' => __( 'This sets the minimum severity level of logs that will be stored. Lower severity levels will be ignored. "None" means all logs will be stored.', 'woocommerce' ),
'id' => self::PREFIX . 'level_threshold',
'type' => 'select',
'value' => $this->get_level_threshold(),
'default' => self::DEFAULTS['level_threshold'],
'autoload' => false,
'options' => $labels,
'custom_attributes' => $custom_attributes,
'css' => 'width:auto;',
'desc' => $desc,
);
}
/**
* The definitions used by WC_Admin_Settings to render settings related to filesystem log handlers.
*
* @return array
*/
private function get_filesystem_settings_definitions(): array {
$location_info = array();
$directory = self::get_log_directory();
$status_info = array();
try {
$filesystem = FilesystemUtil::get_wp_filesystem();
if ( $filesystem instanceof WP_Filesystem_Direct ) {
$status_info[] = __( '✅ Ready', 'woocommerce' );
} else {
$status_info[] = __( '⚠️ The file system is not configured for direct writes. This could cause problems for the logger.', 'woocommerce' );
$status_info[] = __( 'You may want to switch to the database for log storage.', 'woocommerce' );
}
} catch ( Exception $exception ) {
$status_info[] = __( '⚠️ The file system connection could not be initialized.', 'woocommerce' );
$status_info[] = __( 'You may want to switch to the database for log storage.', 'woocommerce' );
}
$location_info[] = sprintf(
// translators: %s is a location in the filesystem.
__( 'Log files are stored in this directory: %s', 'woocommerce' ),
sprintf(
'%s',
esc_html( $directory )
)
);
if ( ! wp_is_writable( $directory ) ) {
$location_info[] = __( '⚠️ This directory does not appear to be writable.', 'woocommerce' );
}
$location_info[] = sprintf(
// translators: %s is an amount of computer disk space, e.g. 5 KB.
__( 'Directory size: %s', 'woocommerce' ),
size_format( wc_get_container()->get( FileController::class )->get_log_directory_size() )
);
return array(
'file_start' => array(
'title' => __( 'File system settings', 'woocommerce' ),
'id' => self::PREFIX . 'settings',
'type' => 'title',
),
'file_status' => array(
'title' => __( 'Status', 'woocommerce' ),
'type' => 'info',
'text' => implode( "\n\n", $status_info ),
),
'log_directory' => array(
'title' => __( 'Location', 'woocommerce' ),
'type' => 'info',
'text' => implode( "\n\n", $location_info ),
),
'entry_format' => array(),
'file_end' => array(
'id' => self::PREFIX . 'settings',
'type' => 'sectionend',
),
);
}
/**
* The definitions used by WC_Admin_Settings to render settings related to database log handlers.
*
* @return array
*/
private function get_database_settings_definitions(): array {
global $wpdb;
$table = "{$wpdb->prefix}woocommerce_log";
$location_info = sprintf(
// translators: %s is the name of a table in the database.
__( 'Log entries are stored in this database table: %s', 'woocommerce' ),
"$table"
);
return array(
'file_start' => array(
'title' => __( 'Database settings', 'woocommerce' ),
'id' => self::PREFIX . 'settings',
'type' => 'title',
),
'database_table' => array(
'title' => __( 'Location', 'woocommerce' ),
'type' => 'info',
'text' => $location_info,
),
'file_end' => array(
'id' => self::PREFIX . 'settings',
'type' => 'sectionend',
),
);
}
/**
* Handle the submission of the settings form and update the settings values.
*
* @param string $view The current view within the Logs tab.
*
* @return void
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function save_settings( string $view ): void {
$is_saving = 'settings' === $view && isset( $_POST['save_settings'] );
if ( $is_saving ) {
check_admin_referer( self::PREFIX . 'settings' );
if ( ! current_user_can( 'manage_woocommerce' ) ) {
wp_die( esc_html__( 'You do not have permission to manage logging settings.', 'woocommerce' ) );
}
$settings = $this->get_settings_definitions();
WC_Admin_Settings::save_fields( $settings );
}
}
/**
* Render the settings page.
*
* @return void
*/
public function render_form(): void {
$settings = $this->get_settings_definitions();
?>
query( "TRUNCATE TABLE $wpdb->wc_category_lookup" );
$terms = get_terms(
'product_cat',
array(
'hide_empty' => false,
'fields' => 'id=>parent',
)
);
$hierarchy = array();
$inserts = array();
$this->unflatten_terms( $hierarchy, $terms, 0 );
$this->get_term_insert_values( $inserts, $hierarchy );
if ( ! $inserts ) {
return;
}
$insert_string = implode(
'),(',
array_map(
function( $item ) {
return implode( ',', $item );
},
$inserts
)
);
$wpdb->query( "INSERT IGNORE INTO $wpdb->wc_category_lookup (category_tree_id,category_id) VALUES ({$insert_string})" ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Store edits so we know when the parent ID changes.
*
* @param int $category_id Term ID being edited.
*/
public function before_edit( $category_id ) {
$category = get_term( $category_id, 'product_cat' );
$this->edited_product_cats[ $category_id ] = $category->parent;
}
/**
* When a product category gets edited, see if we need to sync the table.
*
* @param int $category_id Term ID being edited.
*/
public function on_edit( $category_id ) {
global $wpdb;
if ( ! isset( $this->edited_product_cats[ $category_id ] ) ) {
return;
}
$category_object = get_term( $category_id, 'product_cat' );
$prev_parent = $this->edited_product_cats[ $category_id ];
$new_parent = $category_object->parent;
// No edits - no need to modify relationships.
if ( $prev_parent === $new_parent ) {
return;
}
$this->delete( $category_id, $prev_parent );
$this->update( $category_id );
}
/**
* When a product category gets created, add a new lookup row.
*
* @param int $category_id Term ID being created.
*/
public function on_create( $category_id ) {
// If WooCommerce is being installed on a multisite, lookup tables haven't been created yet.
if ( 'yes' === get_transient( 'wc_installing' ) ) {
return;
}
$this->update( $category_id );
}
/**
* Delete lookup table data from a tree.
*
* @param int $category_id Category ID to delete.
* @param int $category_tree_id Tree to delete from.
* @return void
*/
protected function delete( $category_id, $category_tree_id ) {
global $wpdb;
if ( ! $category_tree_id ) {
return;
}
$ancestors = get_ancestors( $category_tree_id, 'product_cat', 'taxonomy' );
$ancestors[] = $category_tree_id;
$children = get_term_children( $category_id, 'product_cat' );
$children[] = $category_id;
$id_list = implode( ',', array_map( 'intval', array_unique( array_filter( $children ) ) ) );
foreach ( $ancestors as $ancestor ) {
$wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->wc_category_lookup WHERE category_tree_id = %d AND category_id IN ({$id_list})", $ancestor ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
}
/**
* Updates lookup table data for a category by ID.
*
* @param int $category_id Category ID to update.
*/
protected function update( $category_id ) {
global $wpdb;
$ancestors = get_ancestors( $category_id, 'product_cat', 'taxonomy' );
$children = get_term_children( $category_id, 'product_cat' );
$inserts = array();
$inserts[] = $this->get_insert_sql( $category_id, $category_id );
$children_ids = array_map( 'intval', array_unique( array_filter( $children ) ) );
foreach ( $ancestors as $ancestor ) {
$inserts[] = $this->get_insert_sql( $category_id, $ancestor );
foreach ( $children_ids as $child_category_id ) {
$inserts[] = $this->get_insert_sql( $child_category_id, $ancestor );
}
}
$insert_string = implode( ',', $inserts );
$wpdb->query( "INSERT IGNORE INTO $wpdb->wc_category_lookup (category_id, category_tree_id) VALUES {$insert_string}" ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Get category lookup table values to insert.
*
* @param int $category_id Category ID to insert.
* @param int $category_tree_id Tree to insert into.
* @return string
*/
protected function get_insert_sql( $category_id, $category_tree_id ) {
global $wpdb;
return $wpdb->prepare( '(%d,%d)', $category_id, $category_tree_id );
}
/**
* Used to construct insert query recursively.
*
* @param array $inserts Array of data to insert.
* @param array $terms Terms to insert.
* @param array $parents Parent IDs the terms belong to.
*/
protected function get_term_insert_values( &$inserts, $terms, $parents = array() ) {
foreach ( $terms as $term ) {
$insert_parents = array_merge( array( $term['term_id'] ), $parents );
foreach ( $insert_parents as $parent ) {
$inserts[] = array(
$parent,
$term['term_id'],
);
}
$this->get_term_insert_values( $inserts, $term['descendants'], $insert_parents );
}
}
/**
* Convert flat terms array into nested array.
*
* @param array $hierarchy Array to put terms into.
* @param array $terms Array of terms (id=>parent).
* @param integer $parent Parent ID.
*/
protected function unflatten_terms( &$hierarchy, &$terms, $parent = 0 ) {
foreach ( $terms as $term_id => $parent_id ) {
if ( (int) $parent_id === $parent ) {
$hierarchy[ $term_id ] = array(
'term_id' => $term_id,
'descendants' => array(),
);
unset( $terms[ $term_id ] );
}
}
foreach ( $hierarchy as $term_id => $terms_array ) {
$this->unflatten_terms( $hierarchy[ $term_id ]['descendants'], $terms, $term_id );
}
}
/**
* Get category descendants.
*
* @param int $category_id The category ID to lookup.
* @return array
*/
protected function get_descendants( $category_id ) {
global $wpdb;
return wp_parse_id_list(
$wpdb->get_col(
$wpdb->prepare(
"SELECT category_id FROM $wpdb->wc_category_lookup WHERE category_tree_id = %d",
$category_id
)
)
);
}
/**
* Return all ancestor category ids for a category.
*
* @param int $category_id The category ID to lookup.
* @return array
*/
protected function get_ancestors( $category_id ) {
global $wpdb;
return wp_parse_id_list(
$wpdb->get_col(
$wpdb->prepare(
"SELECT category_tree_id FROM $wpdb->wc_category_lookup WHERE category_id = %d",
$category_id
)
)
);
}
/**
* Add category lookup table to $wpdb object.
*/
public static function define_category_lookup_tables_in_wpdb() {
global $wpdb;
// List of tables without prefixes.
$tables = array(
'wc_category_lookup' => 'wc_category_lookup',
);
foreach ( $tables as $name => $table ) {
$wpdb->$name = $wpdb->prefix . $table;
$wpdb->tables[] = $table;
}
}
}
PK [1]9 b. . Admin/Translations.phpnu is_readable( $json_filename ) ) {
continue;
}
$file_contents = $wp_filesystem->get_contents( $json_filename );
$chunk_data = \json_decode( $file_contents, true );
if ( empty( $chunk_data ) ) {
continue;
}
if ( ! isset( $chunk_data['comment']['reference'] ) ) {
continue;
}
$reference_file = $chunk_data['comment']['reference'];
// Only combine "app" files (not scripts registered with WP).
if (
false === strpos( $reference_file, WC_ADMIN_DIST_JS_FOLDER . 'app/index.js' ) &&
false === strpos( $reference_file, WC_ADMIN_DIST_JS_FOLDER . 'chunks/' )
) {
continue;
}
if ( empty( $combined_translation_data ) ) {
// Use the first translation file as the base structure.
$combined_translation_data = $chunk_data;
} else {
// Combine all messages from all chunk files.
$combined_translation_data['locale_data']['messages'] = array_merge(
$combined_translation_data['locale_data']['messages'],
$chunk_data['locale_data']['messages']
);
}
}
// Remove inaccurate reference comment.
unset( $combined_translation_data['comment'] );
return $combined_translation_data;
}
/**
* Combines data from translation chunk files based on user-generated file formats,
* such as wp-cli tool or Loco Translate plugin.
*
* @param array $json_i18n_filenames List of JSON chunk files.
* @return array Combined translation chunk data.
*/
private function combine_user_translation_chunks( $json_i18n_filenames ) {
// the filesystem object should be hooked up.
global $wp_filesystem;
$combined_translation_data = array();
foreach ( $json_i18n_filenames as $json_filename ) {
if ( ! $wp_filesystem->is_readable( $json_filename ) ) {
continue;
}
$file_contents = $wp_filesystem->get_contents( $json_filename );
$chunk_data = \json_decode( $file_contents, true );
if ( empty( $chunk_data ) ) {
continue;
}
$reference_file = $chunk_data['source'];
// Only combine "app" files (not scripts registered with WP).
if (
false === strpos( $reference_file, WC_ADMIN_DIST_JS_FOLDER . 'app/index.js' ) &&
false === strpos( $reference_file, WC_ADMIN_DIST_JS_FOLDER . 'chunks/' )
) {
continue;
}
if ( empty( $combined_translation_data ) ) {
// Use the first translation file as the base structure.
$combined_translation_data = $chunk_data;
} else {
// Combine all messages from all chunk files.
$combined_translation_data['locale_data']['woocommerce'] = array_merge(
$combined_translation_data['locale_data']['woocommerce'],
$chunk_data['locale_data']['woocommerce']
);
}
}
// Remove inaccurate reference comment.
unset( $combined_translation_data['source'] );
return $combined_translation_data;
}
/**
* Find and combine translation chunk files.
*
* Only targets files that aren't represented by a registered script (e.g. not passed to wp_register_script()).
*
* @param string $lang_dir Path to language files.
* @param string $domain Text domain.
* @param string $locale Locale being retrieved.
* @return array Combined translation chunk data.
*/
private function get_translation_chunk_data( $lang_dir, $domain, $locale ) {
// So long as this function is called during the 'upgrader_process_complete' action,
// the filesystem object should be hooked up.
global $wp_filesystem;
// Grab all JSON files in the current language pack.
$json_i18n_filenames = glob( $lang_dir . $domain . '-' . $locale . '-*.json' );
$combined_translation_data = array();
if ( false === $json_i18n_filenames ) {
return $combined_translation_data;
}
// Use first JSON file to determine file format. This check is required due to
// file format difference between official language files and user translated files.
$format_determine_file = reset( $json_i18n_filenames );
if ( ! $wp_filesystem->is_readable( $format_determine_file ) ) {
return $combined_translation_data;
}
$file_contents = $wp_filesystem->get_contents( $format_determine_file );
$format_determine_data = \json_decode( $file_contents, true );
if ( empty( $format_determine_data ) ) {
return $combined_translation_data;
}
if ( isset( $format_determine_data['comment'] ) ) {
return $this->combine_official_translation_chunks( $json_i18n_filenames );
} elseif ( isset( $format_determine_data['source'] ) ) {
return $this->combine_user_translation_chunks( $json_i18n_filenames );
} else {
return $combined_translation_data;
}
}
/**
* Combine and save translations for a specific locale.
*
* Note that this assumes \WP_Filesystem is already initialized with write access.
*
* @param string $language_dir Path to language files.
* @param string $plugin_domain Text domain.
* @param string $locale Locale being retrieved.
*/
private function build_and_save_translations( $language_dir, $plugin_domain, $locale ) {
global $wp_filesystem;
$translations_from_chunks = $this->get_translation_chunk_data( $language_dir, $plugin_domain, $locale );
if ( empty( $translations_from_chunks ) ) {
return;
}
$cache_filename = $this->get_combined_translation_filename( $plugin_domain, $locale );
$chunk_translations_json = wp_json_encode( $translations_from_chunks );
// Cache combined translations strings to a file.
$wp_filesystem->put_contents( $language_dir . $cache_filename, $chunk_translations_json );
}
/**
* Combine translation chunks when plugin is activated.
*
* This function combines JSON translation data auto-extracted by GlotPress
* from Webpack-generated JS chunks into a single file. This is necessary
* since the JS chunks are not known to WordPress via wp_register_script()
* and wp_set_script_translations().
*/
private function generate_translation_strings() {
$locale = determine_locale();
$lang_dir = WP_LANG_DIR . '/plugins/';
// Bail early if not localized.
if ( 'en_US' === $locale ) {
return;
}
if ( ! function_exists( 'get_filesystem_method' ) ) {
require_once ABSPATH . 'wp-admin/includes/file.php';
}
$access_type = get_filesystem_method();
if ( 'direct' === $access_type ) {
\WP_Filesystem();
$this->build_and_save_translations( $lang_dir, self::$plugin_domain, $locale );
} else {
// I'm reluctant to add support for other filesystems here as it would require
// user's input on activating plugin - which I don't think is common.
return;
}
}
/**
* Loads the required translation scripts on the correct pages.
*/
public function potentially_load_translation_script_file() {
if ( ! PageController::is_admin_or_embed_page() ) {
return;
}
// Grab translation strings from Webpack-generated chunks.
add_filter( 'load_script_translation_file', array( $this, 'load_script_translation_file' ), 10, 3 );
}
/**
* Load translation strings from language packs for dynamic imports.
*
* @param string $file File location for the script being translated.
* @param string $handle Script handle.
* @param string $domain Text domain.
*
* @return string New file location for the script being translated.
*/
public function load_script_translation_file( $file, $handle, $domain ) {
// Make sure the main app script is being loaded.
if ( WC_ADMIN_APP !== $handle ) {
return $file;
}
// Make sure we're handing the correct domain.
if ( self::$plugin_domain !== $domain ) {
return $file;
}
$locale = determine_locale();
$cache_filename = $this->get_combined_translation_filename( $domain, $locale );
return WP_LANG_DIR . '/plugins/' . $cache_filename;
}
/**
* Run when plugin is activated (can be WooCommerce or WooCommerce Admin).
*
* @param string $filename Activated plugin filename.
*/
public function potentially_generate_translation_strings( $filename ) {
$activated_plugin_domain = explode( '/', $filename )[0];
// Ensure we're only running only on activation hook that originates from our plugin.
if ( self::$plugin_domain === $activated_plugin_domain ) {
$this->generate_translation_strings();
}
}
/**
* Combine translation chunks when files are updated.
*
* This function combines JSON translation data auto-extracted by GlotPress
* from Webpack-generated JS chunks into a single file that can be used in
* subsequent requests. This is necessary since the JS chunks are not known
* to WordPress via wp_register_script() and wp_set_script_translations().
*
* @param Language_Pack_Upgrader $instance Upgrader instance.
* @param array $hook_extra Info about the upgraded language packs.
*/
public function combine_translation_chunk_files( $instance, $hook_extra ) {
if (
! is_a( $instance, 'Language_Pack_Upgrader' ) ||
! isset( $hook_extra['translations'] ) ||
! is_array( $hook_extra['translations'] )
) {
return;
}
$locales = array();
$language_dir = WP_LANG_DIR . '/plugins/';
// Gather the locales that were updated in this operation.
foreach ( $hook_extra['translations'] as $translation ) {
if (
'plugin' === $translation['type'] &&
self::$plugin_domain === $translation['slug']
) {
$locales[] = $translation['language'];
}
}
// Build combined translation files for all updated locales.
foreach ( $locales as $locale ) {
// So long as this function is hooked to the 'upgrader_process_complete' action,
// WP_Filesystem should be hooked up to be able to call build_and_save_translations.
$this->build_and_save_translations( $language_dir, self::$plugin_domain, $locale );
}
}
}
PK [1]_% % 1 Admin/EmailPreview/EmailPreviewRestController.phpnu email_preview = wc_get_container()->get( EmailPreview::class );
}
/**
* Register the REST API endpoints handled by this controller.
*/
public function register_routes() {
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/send-preview',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->send_email_preview( $request ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => $this->get_args_for_send_preview(),
'schema' => $this->get_schema_with_message(),
),
)
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/preview-subject',
array(
array(
'methods' => \WP_REST_Server::READABLE,
'callback' => fn() => array(
'subject' => $this->email_preview->get_subject(),
),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => $this->get_args_for_preview_subject(),
'schema' => $this->get_schema_for_preview_subject(),
),
)
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/save-transient',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->save_transient( $request ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => $this->get_args_for_save_transient(),
'schema' => $this->get_schema_with_message(),
),
)
);
}
/**
* Get the accepted arguments for the POST send-preview request.
*
* @return array[]
*/
private function get_args_for_send_preview() {
return array(
'type' => array(
'description' => __( 'The email type to preview.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'validate_callback' => fn( $key ) => $this->validate_email_type( $key ),
'sanitize_callback' => 'sanitize_text_field',
),
'email' => array(
'description' => __( 'Email address to send the email preview to.', 'woocommerce' ),
'type' => 'string',
'format' => 'email',
'required' => true,
'validate_callback' => 'rest_validate_request_arg',
'sanitize_callback' => 'sanitize_email',
),
);
}
/**
* Get the accepted arguments for the GET preview-subject request.
*
* @return array[]
*/
private function get_args_for_preview_subject() {
return array(
'type' => array(
'description' => __( 'The email type to get subject for.', 'woocommerce' ),
'type' => 'string',
'required' => true,
'validate_callback' => fn( $key ) => $this->validate_email_type( $key ),
'sanitize_callback' => 'sanitize_text_field',
),
);
}
/**
* Get the accepted arguments for the POST save-transient request.
*
* @return array[]
*/
private function get_args_for_save_transient() {
return array(
'key' => array(
'required' => true,
'type' => 'string',
'description' => 'The key for the transient. Must be one of the allowed options.',
'validate_callback' => function ( $key ) {
if ( ! in_array( $key, EmailPreview::get_all_email_setting_ids(), true ) ) {
return new \WP_Error(
'woocommerce_rest_not_allowed_key',
sprintf( 'The provided key "%s" is not allowed.', $key ),
array( 'status' => 400 ),
);
}
return true;
},
'sanitize_callback' => 'sanitize_text_field',
),
'value' => array(
'required' => true,
'type' => 'string',
'description' => 'The value to be saved for the transient.',
'validate_callback' => 'rest_validate_request_arg',
'sanitize_callback' => function ( $value, $request ) {
$key = $request->get_param( 'key' );
if (
'woocommerce_email_footer_text' === $key
|| preg_match( '/_additional_content$/', $key )
) {
return wp_kses_post( trim( $value ) );
}
return sanitize_text_field( $value );
},
),
);
}
/**
* Get the schema for the POST send-preview and save-transient requests.
*
* @return array[]
*/
private function get_schema_with_message() {
return array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'email-preview-with-message',
'type' => 'object',
'properties' => array(
'message' => array(
'description' => __( 'A message indicating that the action completed successfully.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
);
}
/**
* Get the schema for the GET preview_subject request.
*
* @return array[]
*/
private function get_schema_for_preview_subject() {
return array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'email-preview-subject',
'type' => 'object',
'properties' => array(
'subject' => array(
'description' => __( 'A subject for provided email type after filters are applied and placeholders replaced.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
),
);
}
/**
* Validate the email type.
*
* @param string $email_type The email type to validate.
* @return bool|WP_Error True if the email type is valid, otherwise a WP_Error object.
*/
private function validate_email_type( string $email_type ) {
try {
$this->email_preview->set_email_type( $email_type );
} catch ( \InvalidArgumentException $e ) {
return new WP_Error(
'woocommerce_rest_invalid_email_type',
__( 'Invalid email type.', 'woocommerce' ),
array( 'status' => 400 ),
);
}
return true;
}
/**
* Permission check for REST API endpoint.
*
* @param WP_REST_Request $request The request for which the permission is checked.
* @return bool|WP_Error True if the current user has the capability, otherwise a WP_Error object.
*/
private function check_permissions( WP_REST_Request $request ) {
$nonce = $request->get_param( 'nonce' );
if ( ! wp_verify_nonce( $nonce, self::NONCE_KEY ) ) {
return new WP_Error(
'invalid_nonce',
__( 'Invalid nonce.', 'woocommerce' ),
array( 'status' => 403 ),
);
}
return $this->check_permission( $request, 'manage_woocommerce' );
}
/**
* Handle the POST /settings/email/send-preview.
*
* @param WP_REST_Request $request The received request.
* @return array|WP_Error Request response or an error.
*/
public function send_email_preview( WP_REST_Request $request ) {
$email_address = $request->get_param( 'email' );
// Start output buffering to prevent partial renders with PHP notices or warnings.
ob_start();
try {
$email_content = $this->email_preview->render();
} catch ( \Throwable $e ) {
ob_end_clean();
return new WP_Error(
'woocommerce_rest_email_preview_not_rendered',
__( 'There was an error rendering an email preview.', 'woocommerce' ),
array( 'status' => 500 )
);
}
ob_end_clean();
$email_subject = $this->email_preview->get_subject();
$email = new \WC_Emails();
$sent = $email->send( $email_address, $email_subject, $email_content );
if ( $sent ) {
return array(
// translators: %s: Email address.
'message' => sprintf( __( 'Test email sent to %s.', 'woocommerce' ), $email_address ),
);
}
return new WP_Error(
'woocommerce_rest_email_preview_not_sent',
__( 'Error sending test email. Please try again.', 'woocommerce' ),
array( 'status' => 500 )
);
}
/**
* Handle the POST /settings/email/save-transient.
*
* @param WP_REST_Request $request The received request.
* @return array|WP_Error Request response or an error.
*/
public function save_transient( WP_REST_Request $request ) {
$key = $request->get_param( 'key' );
$value = $request->get_param( 'value' );
$is_set = set_transient( $key, $value, HOUR_IN_SECONDS );
if ( ! $is_set ) {
return new WP_Error(
'woocommerce_rest_transient_not_set',
__( 'Error saving transient. Please try again.', 'woocommerce' ),
array( 'status' => 500 )
);
}
return array(
// translators: %s: Email settings color key, e.g., "woocommerce_email_base_color".
'message' => sprintf( __( 'Transient saved for key %s.', 'woocommerce' ), $key ),
);
}
}
PK [1]?e9#b b # Admin/EmailPreview/EmailPreview.phpnu mailer()->get_emails();
foreach ( $emails as $email ) {
self::$email_content_setting_ids = array_merge(
self::$email_content_setting_ids,
self::get_email_content_setting_ids( $email->id )
);
}
self::$email_content_setting_ids = array_unique( self::$email_content_setting_ids );
}
return array_merge(
self::$email_style_setting_ids,
self::$email_content_setting_ids,
);
}
/**
* Get email style setting IDs.
*/
public static function get_email_style_setting_ids() {
/**
* Filter the email style setting IDs. Email preview automatically refreshes when these settings are changed.
*
* @param array $setting_ids The email style setting IDs.
*
* @since 9.8.0
*/
return apply_filters( 'woocommerce_email_preview_email_style_setting_ids', self::$email_style_setting_ids );
}
/**
* Get email content setting IDs for specific email.
*
* @param string|null $email_id Email ID.
*/
public static function get_email_content_setting_ids( ?string $email_id ) {
if ( ! $email_id ) {
return array();
}
$setting_ids = array(
"woocommerce_{$email_id}_subject",
"woocommerce_{$email_id}_heading",
"woocommerce_{$email_id}_additional_content",
"woocommerce_{$email_id}_email_type",
);
/**
* Filter the email content setting IDs for specific email. Email preview automatically refreshes when these settings are changed.
*
* @param array $setting_ids The email content setting IDs.
* @param string $email_id The email ID.
*
* @since 9.8.0
*/
return apply_filters( 'woocommerce_email_preview_email_content_setting_ids', $setting_ids, $email_id );
}
/**
* Set the email type to preview.
*
* @param string $email_type Email type.
*
* @throws \InvalidArgumentException When the email type is invalid.
*/
public function set_email_type( string $email_type ) {
$this->switch_to_site_locale();
$wc_emails = WC()->mailer()->get_emails();
$emails = array_combine(
array_map( 'get_class', $wc_emails ),
$wc_emails
);
if ( ! in_array( $email_type, array_keys( $emails ), true ) ) {
throw new \InvalidArgumentException( 'Invalid email type' );
}
$this->email_type = $email_type;
$this->email = $emails[ $email_type ];
$object = null;
if ( in_array( $email_type, self::USER_OBJECT_EMAILS, true ) ) {
$object = new WP_User( 0 );
$object->user_email = 'user_preview@example.com';
$object->user_login = 'user_preview';
$object->first_name = 'John';
$object->last_name = 'Doe';
$this->email->user_email = $object->user_email;
$this->email->user_login = $object->user_login;
if ( property_exists( $this->email, 'reset_key' ) ) {
$this->email->reset_key = 'reset_key';
}
if ( property_exists( $this->email, 'set_password_url' ) ) {
$this->email->set_password_url = 'https://example.com/set-password';
}
if ( property_exists( $this->email, 'user_id' ) ) {
$this->email->user_id = 0;
}
$this->email->set_object( $object );
} else {
$object = $this->get_dummy_order();
if ( 'WC_Email_Customer_Note' === $email_type ) {
$this->email->customer_note = $object->get_customer_note();
}
if ( 'WC_Email_Customer_Refunded_Order' === $email_type ) {
$this->email->partial_refund = false;
}
$this->email->set_object( $object );
}
$this->email->placeholders = array_merge(
$this->email->placeholders,
$this->get_placeholders( $object )
);
/**
* Allow to modify the email object before rendering the preview to add additional data.
*
* @param WC_Email $email The email object.
*
* @since 9.6.0
*/
$this->email = apply_filters( 'woocommerce_prepare_email_for_preview', $this->email );
$this->restore_locale();
}
/**
* Get the email object.
*
* @return WC_Email
*/
public function get_email() {
return $this->email;
}
/**
* Get the preview email content.
*
* @return string
*/
public function render() {
return $this->render_preview_email();
}
/**
* Ensure links open in new tab. User in WooCommerce Settings,
* so the links don't open inside the iframe.
*
* @param string $content Email content HTML.
* @return string
*/
public function ensure_links_open_in_new_tab( string $content ) {
if ( empty( $content ) || strpos( $content, 'loadHTML(
$html_with_encoding,
LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD | LIBXML_NOWARNING | LIBXML_NOERROR
);
$links = $dom->getElementsByTagName( 'a' );
foreach ( $links as $link ) {
$link->setAttribute( 'target', '_blank' );
$link->setAttribute( 'rel', 'noopener' );
}
$result = $dom->saveHTML();
// Remove the XML declaration we added earlier, it's not meant to be used in an HTML document.
$result = preg_replace( '/<\?xml[^>]*>\s*/i', '', $result );
return $result;
} catch ( \Exception $e ) {
return $content;
} finally {
libxml_use_internal_errors( $previous_use_internal_errors );
libxml_clear_errors();
}
}
/**
* Get the preview email content.
*
* @return string
*/
public function get_subject() {
if ( ! $this->email ) {
return '';
}
$this->set_up_filters();
$subject = $this->email->get_subject();
$this->clean_up_filters();
return $subject;
}
/**
* Return a dummy product when the product is not set in email classes.
*
* @param WC_Product|null $product Order item product.
* @return WC_Product
*/
public function get_dummy_product_when_not_set( $product ) {
if ( $product ) {
return $product;
}
return $this->get_dummy_product();
}
/**
* Render HTML content of the preview email.
*
* @return string
*/
private function render_preview_email() {
if ( ! $this->email_type ) {
$this->set_email_type( self::DEFAULT_EMAIL_TYPE );
}
$this->set_up_filters();
if ( 'plain' === $this->email->get_email_type() ) {
$content = '
';
}
/**
* Renders advice in the event that no orders exist yet.
*
* @return void
*/
public function render_blank_state(): void {
?>
order_query_args['status'] ?? false;
if ( ! current_user_can( $this->wp_post_type->cap->edit_others_posts ) ) {
return array();
}
if ( array( 'trash' ) === $selected_status ) {
$actions = array(
'untrash' => __( 'Restore', 'woocommerce' ),
'delete' => __( 'Delete permanently', 'woocommerce' ),
);
} else {
$actions = array(
'mark_processing' => __( 'Change status to processing', 'woocommerce' ),
'mark_on-hold' => __( 'Change status to on-hold', 'woocommerce' ),
'mark_completed' => __( 'Change status to completed', 'woocommerce' ),
'mark_cancelled' => __( 'Change status to cancelled', 'woocommerce' ),
'trash' => __( 'Move to Trash', 'woocommerce' ),
);
}
if ( wc_string_to_bool( get_option( 'woocommerce_allow_bulk_remove_personal_data', 'no' ) ) ) {
$actions['remove_personal_data'] = __( 'Remove personal data', 'woocommerce' );
}
return $actions;
}
/**
* Gets a list of CSS classes for the WP_List_Table table tag.
*
* @since 7.8.0
*
* @return string[] Array of CSS classes for the table tag.
*/
protected function get_table_classes() {
/**
* Filters the list of CSS class names for the orders list table.
*
* @since 7.8.0
*
* @param string[] $classes An array of CSS class names.
* @param string $order_type The order type.
*/
$css_classes = apply_filters(
'woocommerce_' . $this->order_type . '_list_table_css_classes',
array_merge(
parent::get_table_classes(),
array(
'wc-orders-list-table',
'wc-orders-list-table-' . $this->order_type,
)
),
$this->order_type
);
return array_unique( array_map( 'trim', $css_classes ) );
}
/**
* Prepares the list of items for displaying.
*/
public function prepare_items() {
$limit = $this->get_items_per_page( 'edit_' . $this->order_type . '_per_page' );
$this->order_query_args = array(
'limit' => $limit,
'page' => $this->get_pagenum(),
'paginate' => true,
'type' => $this->order_type,
);
foreach ( array( 'status', 's', 'm', '_customer_user', 'search-filter' ) as $query_var ) {
$this->request[ $query_var ] = sanitize_text_field( wp_unslash( $_REQUEST[ $query_var ] ?? '' ) );
}
/**
* Allows 3rd parties to filter the initial request vars before defaults and other logic is applied.
*
* @param array $request Request to be passed to `wc_get_orders()`.
*
* @since 7.3.0
*/
$this->request = apply_filters( 'woocommerce_' . $this->order_type . '_list_table_request', $this->request );
$this->set_status_args();
$this->set_order_args();
$this->set_date_args();
$this->set_customer_args();
$this->set_search_args();
$this->set_created_via_args();
/**
* Provides an opportunity to modify the query arguments used in the (Custom Order Table-powered) order list
* table.
*
* @since 6.9.0
*
* @param array $query_args Arguments to be passed to `wc_get_orders()`.
*/
$order_query_args = (array) apply_filters( 'woocommerce_order_list_table_prepare_items_query_args', $this->order_query_args );
/**
* Same as `woocommerce_order_list_table_prepare_items_query_args` but for a specific order type.
*
* @param array $query_args Arguments to be passed to `wc_get_orders()`.
*
* @since 7.3.0
*/
$order_query_args = apply_filters( 'woocommerce_' . $this->order_type . '_list_table_prepare_items_query_args', $order_query_args );
// We must ensure the 'paginate' argument is set.
$order_query_args['paginate'] = true;
// Attempt to use cache if no additional query arguments are used.
if ( empty( array_diff( array_keys( $this->order_query_args ), array( 'limit', 'page', 'paginate', 'type', 'status', 'orderby', 'order' ) ) ) ) {
$this->order_query_args['no_found_rows'] = true;
$order_query_args['no_found_rows'] = true;
}
$orders = wc_get_orders( $order_query_args );
$this->items = $orders->orders;
$max_num_pages = $this->get_max_num_pages( $orders );
// Check in case the user has attempted to page beyond the available range of orders.
if ( 0 === $max_num_pages && $this->order_query_args['page'] > 1 ) {
$count_query_args = $order_query_args;
$count_query_args['page'] = 1;
$count_query_args['limit'] = 1;
$order_count = wc_get_orders( $count_query_args );
$max_num_pages = (int) ceil( $order_count->total / $order_query_args['limit'] );
}
$this->set_pagination_args(
array(
'total_items' => $orders->total ?? 0,
'per_page' => $limit,
'total_pages' => $max_num_pages,
)
);
// Are we inside the trash?
$this->is_trash = 'trash' === $this->request['status'];
}
/**
* Get the max number of pages from orders or from cache.
*
* @param WC_Order[]|stdClass Number of pages and an array of order objects.
* @return int
*/
private function get_max_num_pages( &$orders ) {
if ( ! isset( $this->order_query_args['no_found_rows'] ) || ! $this->order_query_args['no_found_rows'] ) {
return $orders->max_num_pages;
}
$count = $this->count_orders_by_status( $this->order_query_args['status'] );
$limit = $this->get_items_per_page( 'edit_' . $this->order_type . '_per_page' );
$orders->total = $count;
return ceil( $count / $limit );
}
/**
* Updates the WC Order Query arguments as needed to support orderable columns.
*/
private function set_order_args() {
$sortable = $this->get_sortable_columns();
$field = sanitize_text_field( wp_unslash( $_GET['orderby'] ?? '' ) );
$direction = strtoupper( sanitize_text_field( wp_unslash( $_GET['order'] ?? '' ) ) );
if ( ! in_array( $field, $sortable, true ) ) {
$this->order_query_args['orderby'] = 'date';
$this->order_query_args['order'] = 'DESC';
return;
}
$this->order_query_args['orderby'] = $field;
$this->order_query_args['order'] = in_array( $direction, array( 'ASC', 'DESC' ), true ) ? $direction : 'ASC';
}
/**
* Implements date (month-based) filtering.
*/
private function set_date_args() {
$year_month = sanitize_text_field( wp_unslash( $_GET['m'] ?? '' ) );
if ( empty( $year_month ) || ! preg_match( '/^[0-9]{6}$/', $year_month ) ) {
return;
}
$year = (int) substr( $year_month, 0, 4 );
$month = (int) substr( $year_month, 4, 2 );
if ( $month < 0 || $month > 12 ) {
return;
}
$last_day_of_month = date_create( "$year-$month" )->format( 'Y-m-t' );
$this->order_query_args['date_created'] = "$year-$month-01..." . $last_day_of_month;
$this->has_filter = true;
}
/**
* Implements filtering of orders by customer.
*/
private function set_customer_args() {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$customer = (int) wp_unslash( $_GET['_customer_user'] ?? '' );
if ( $customer < 1 ) {
return;
}
$this->order_query_args['customer'] = $customer;
$this->has_filter = true;
}
/**
* Implements filtering of orders by status.
*/
private function set_status_args() {
$status = array_filter( array_map( 'trim', (array) $this->request['status'] ) );
if ( empty( $status ) || in_array( 'all', $status, true ) ) {
/**
* Allows 3rd parties to set the default list of statuses for a given order type.
*
* @param string[] $statuses Statuses.
*
* @since 7.3.0
*/
$status = apply_filters(
'woocommerce_' . $this->order_type . '_list_table_default_statuses',
array_intersect(
array_keys( wc_get_order_statuses() ),
get_post_stati( array( 'show_in_admin_all_list' => true ), 'names' )
)
);
} else {
$this->has_filter = true;
}
$this->order_query_args['status'] = $status;
}
/**
* Implements order search.
*/
private function set_search_args(): void {
$search_term = trim( sanitize_text_field( $this->request['s'] ) );
if ( ! empty( $search_term ) ) {
$this->order_query_args['s'] = $search_term;
$this->has_filter = true;
}
$filter = trim( sanitize_text_field( $this->request['search-filter'] ) );
if ( ! empty( $filter ) ) {
$this->order_query_args['search_filter'] = $filter;
}
}
/**
* Implements filtering of orders by created_via value.
*/
private function set_created_via_args(): void {
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$created_via = sanitize_text_field( wp_unslash( $_GET['_created_via'] ?? '' ) );
if ( empty( $created_via ) ) {
return;
}
$this->order_query_args['created_via'] = array_map( 'trim', explode( ',', $created_via ) );
$this->has_filter = true;
}
/**
* Render the created_via filter dropdown.
*
* @return void
*/
public function created_via_filter() {
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$current_created_via = isset( $_GET['_created_via'] ) ? sanitize_text_field( wp_unslash( $_GET['_created_via'] ) ) : '';
$created_via_options = array(
'' => __( 'All sales channels', 'woocommerce' ),
'admin' => __( 'Admin', 'woocommerce' ),
'checkout,store-api' => __( 'Checkout', 'woocommerce' ),
'pos-rest-api' => __( 'Point of Sale', 'woocommerce' ),
);
?>
order_type . '_list_table_view_links', $view_links );
if ( ! empty( $view_links ) ) {
return $view_links;
}
$view_counts = array();
$statuses = $this->get_visible_statuses();
$current = ! empty( $this->request['status'] ) ? sanitize_text_field( $this->request['status'] ) : 'all';
$all_count = 0;
foreach ( array_keys( $statuses ) as $slug ) {
$total_in_status = $this->count_orders_by_status( $slug );
if ( $total_in_status > 0 ) {
$view_counts[ $slug ] = $total_in_status;
}
if ( ( get_post_status_object( $slug ) )->show_in_admin_all_list && 'auto-draft' !== $slug ) {
$all_count += $total_in_status;
}
}
$view_links['all'] = $this->get_view_link( 'all', __( 'All', 'woocommerce' ), $all_count, '' === $current || 'all' === $current );
foreach ( $view_counts as $slug => $count ) {
$view_links[ $slug ] = $this->get_view_link( $slug, $statuses[ $slug ], $count, $slug === $current );
}
return $view_links;
}
/**
* Count orders by status.
*
* @param string|string[] $status The order status we are interested in.
*
* @return int
*/
private function count_orders_by_status( $status ): int {
$status = (array) $status;
$counts = OrderUtil::get_count_for_type( $this->order_type );
$count = array_sum( array_intersect_key( $counts, array_flip( $status ) ) );
/**
* Allows 3rd parties to modify the count of orders by status.
*
* @param int $count Number of orders for the given status.
* @param string[] $status List of order statuses in the count.
* @since 7.3.0
*/
return apply_filters(
'woocommerce_' . $this->order_type . '_list_table_order_count',
$count,
$status
);
}
/**
* Checks whether the blank state should be rendered or not. This depends on whether there are others with a visible
* status.
*
* @return boolean TRUE when the blank state should be rendered, FALSE otherwise.
*/
private function should_render_blank_state(): bool {
/**
* Whether we should render a blank state so that custom count queries can be used.
*
* @since 8.6.0
*
* @param null $should_render_blank_state `null` will use the built-in counts. Sending a boolean will short-circuit that path.
* @param object ListTable The current instance of the class.
*/
$should_render_blank_state = apply_filters(
'woocommerce_' . $this->order_type . '_list_table_should_render_blank_state',
null,
$this
);
if ( is_bool( $should_render_blank_state ) ) {
return $should_render_blank_state;
}
return ( ! $this->has_filter ) && 0 === $this->count_orders_by_status( array_keys( $this->get_visible_statuses() ) );
}
/**
* Returns a list of slug and labels for order statuses that should be visible in the status list.
*
* @return array slug => label array of order statuses.
*/
private function get_visible_statuses(): array {
return array_intersect_key(
array_merge(
wc_get_order_statuses(),
array(
'trash' => ( get_post_status_object( 'trash' ) )->label,
'draft' => ( get_post_status_object( 'draft' ) )->label,
'auto-draft' => ( get_post_status_object( 'auto-draft' ) )->label,
)
),
array_flip( get_post_stati( array( 'show_in_admin_status_list' => true ) ) )
);
}
/**
* Form a link to use in the list of table views.
*
* @param string $slug Slug used to identify the view (usually the order status slug).
* @param string $name Human-readable name of the view (usually the order status label).
* @param int $count Number of items in this view.
* @param bool $current If this is the current view.
*
* @return string
*/
private function get_view_link( string $slug, string $name, int $count, bool $current ): string {
$base_url = get_admin_url( null, 'admin.php?page=wc-orders' . ( 'shop_order' === $this->order_type ? '' : '--' . $this->order_type ) );
$url = esc_url( add_query_arg( 'status', $slug, $base_url ) );
$name = esc_html( $name );
$count = number_format_i18n( $count );
$class = $current ? 'class="current"' : '';
return "$name ($count)";
}
/**
* Extra controls to be displayed between bulk actions and pagination.
*
* @param string $which Either 'top' or 'bottom'.
*/
protected function extra_tablenav( $which ) {
echo '
';
if ( 'top' === $which ) {
ob_start();
$this->months_filter();
/**
* Fires before the "Filter" button on the list table for orders and other order types.
*
* @since 7.3.0
*
* @param string $order_type The order type.
* @param string $which The location of the extra table nav: 'top' or 'bottom'.
*/
do_action( 'woocommerce_order_list_table_restrict_manage_orders', $this->order_type, $which );
$output = ob_get_clean();
if ( ! empty( $output ) ) {
echo $output; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
submit_button( __( 'Filter', 'woocommerce' ), '', 'filter_action', false, array( 'id' => 'order-query-submit' ) );
}
}
if ( $this->is_trash && $this->has_items() && current_user_can( 'edit_others_shop_orders' ) ) {
submit_button( __( 'Empty Trash', 'woocommerce' ), 'apply', 'delete_all', false );
}
/**
* Fires immediately following the closing "actions" div in the tablenav for the order
* list table.
*
* @since 7.3.0
*
* @param string $order_type The order type.
* @param string $which The location of the extra table nav: 'top' or 'bottom'.
*/
do_action( 'woocommerce_order_list_table_extra_tablenav', $this->order_type, $which );
echo '
';
}
/**
* Render the months filter dropdown.
*
* @return void
*/
private function months_filter() {
global $wp_locale;
/**
* Filters whether to remove the 'Months' drop-down from the order list table.
*
* @since 8.6.0
*
* @param bool $disable Whether to disable the drop-down. Default false.
*/
if ( apply_filters( 'woocommerce_' . $this->order_type . '_list_table_disable_months_filter', false ) ) {
return;
}
$m = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0;
echo '';
}
/**
* Get a list of year-month options for filtering the orders list table.
*
* This finds the oldest order and generates a year-month option for every month in the range between then and the
* current month.
*
* @return \stdClass[]
*/
protected function get_months_filter_options(): array {
global $wpdb;
$orders_table = esc_sql( OrdersTableDataStore::get_orders_table_name() );
$min_max_months = $wpdb->get_row(
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table name is escaped above.
$wpdb->prepare(
"
SELECT MIN( t.date_created_gmt ) as min_date_gmt,
MAX( t.date_created_gmt ) as max_date_gmt
FROM `{$orders_table}` t
WHERE type = %s
AND status != %s
",
$this->order_type,
OrderStatus::TRASH
)
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
);
/**
* Normalize "this month" to be the first day of the month in the current timezone of the site.
*/
$this_month = new \WC_DateTime(
'now',
new \DateTimeZone( 'UTC' )
);
$this_month->setTimezone( wp_timezone() );
$this_month->setDate( $this_month->format( 'Y' ), $this_month->format( 'm' ), 1 );
$this_month->setTime( 0, 0 );
$options = array();
if ( isset( $min_max_months ) && ! is_null( $min_max_months->min_date_gmt ) ) {
$start = new \WC_DateTime(
$min_max_months->min_date_gmt,
new \DateTimeZone( 'UTC' )
);
$start->setTimezone( wp_timezone() );
$start->setDate( $start->format( 'Y' ), $start->format( 'm' ), 1 );
$start->setTime( 0, 0 );
$end = new \WC_DateTime(
$min_max_months->max_date_gmt,
new \DateTimeZone( 'UTC' )
);
$end->setTimezone( wp_timezone() );
$end->setDate( $end->format( 'Y' ), $end->format( 'm' ), 1 );
$end->setTime( 0, 0 );
if ( $start > $this_month ) {
$start = $this_month;
}
if ( $end < $this_month ) {
$end = $this_month;
}
$intervals = new \DatePeriod( $start, new \DateInterval( 'P1M' ), $end );
foreach ( $intervals as $interval ) {
$option = new \stdClass();
$option->year = $interval->format( 'Y' );
$option->month = $interval->format( 'n' );
$options[] = $option;
}
$option = new \stdClass();
$option->year = $end->format( 'Y' );
$option->month = $end->format( 'n' );
$options[] = $option;
}
if ( count( $options ) < 1 ) {
$option = new \stdClass();
$option->year = $this_month->format( 'Y' );
$option->month = $this_month->format( 'n' );
$options[] = $option;
}
return array_reverse( $options );
}
/**
* Get order year-months cache. We cache the results in the options table, since these results will change very infrequently.
* We use the heuristic to always return current year-month when getting from cache to prevent an additional query.
*
* @deprecated 9.9.0
*
* @return array List of year-months.
*/
protected function get_and_maybe_update_months_filter_cache(): array {
wc_deprecated_function(
__METHOD__,
'9.9.0',
'get_months_filter_options'
);
return $this->get_months_filter_options();
}
/**
* Render the customer filter dropdown.
*
* @return void
*/
public function customers_filter() {
$user_string = '';
$user_id = '';
// phpcs:disable WordPress.Security.NonceVerification.Recommended
if ( ! empty( $_GET['_customer_user'] ) ) {
$user_id = absint( $_GET['_customer_user'] );
$user = get_user_by( 'id', $user_id );
$user_string = sprintf(
/* translators: 1: user display name 2: user ID 3: user email */
esc_html__( '%1$s (#%2$s – %3$s)', 'woocommerce' ),
$user->display_name,
absint( $user->ID ),
$user->user_email
);
}
// Note: use of htmlspecialchars (below) is to prevent XSS when rendered by selectWoo.
?>
order_type . '_list_table_columns',
array(
'cb' => '',
'order_number' => esc_html__( 'Order', 'woocommerce' ),
'order_date' => esc_html__( 'Date', 'woocommerce' ),
'order_status' => esc_html__( 'Status', 'woocommerce' ),
'billing_address' => esc_html__( 'Billing', 'woocommerce' ),
'shipping_address' => esc_html__( 'Ship to', 'woocommerce' ),
'order_total' => esc_html__( 'Total', 'woocommerce' ),
'wc_actions' => esc_html__( 'Actions', 'woocommerce' ),
)
);
}
/**
* Defines the default sortable columns.
*
* @return string[]
*/
public function get_sortable_columns() {
/**
* Filters the list of sortable columns.
*
* @param array $sortable_columns List of sortable columns.
*
* @since 7.3.0
*/
return apply_filters(
'woocommerce_' . $this->order_type . '_list_table_sortable_columns',
array(
'order_number' => 'ID',
'order_date' => 'date',
'order_total' => 'order_total',
)
);
}
/**
* Specify the columns we wish to hide by default.
*
* @param array $hidden Columns set to be hidden.
* @param WP_Screen $screen Screen object.
*
* @return array
*/
public function default_hidden_columns( array $hidden, WP_Screen $screen ) {
if ( isset( $screen->id ) && wc_get_page_screen_id( 'shop-order' ) === $screen->id ) {
$hidden = array_merge(
$hidden,
array(
'billing_address',
'shipping_address',
'wc_actions',
)
);
}
return $hidden;
}
/**
* Checklist column, used for selecting items for processing by a bulk action.
*
* @param WC_Order $item The order object for the current row.
*
* @return string
*/
public function column_cb( $item ) {
if ( ! $this->wp_post_type || ! current_user_can( $this->wp_post_type->cap->edit_post, $item->get_id() ) ) {
return;
}
ob_start();
?>
get_id() ) );
?>
get_billing_first_name() || $order->get_billing_last_name() ) {
/* translators: 1: first name 2: last name */
$buyer = trim( sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce' ), $order->get_billing_first_name(), $order->get_billing_last_name() ) );
} elseif ( $order->get_billing_company() ) {
$buyer = trim( $order->get_billing_company() );
} elseif ( $order->get_customer_id() ) {
$user = get_user_by( 'id', $order->get_customer_id() );
$buyer = ucwords( $user->display_name );
}
/**
* Filter buyer name in list table orders.
*
* @since 3.7.0
*
* @param string $buyer Buyer name.
* @param WC_Order $order Order data.
*/
$buyer = apply_filters( 'woocommerce_admin_order_buyer_name', $buyer, $order );
if ( $order->get_status() === 'trash' ) {
echo '#' . esc_attr( $order->get_order_number() ) . ' ' . esc_html( $buyer ) . '';
} else {
echo '' . esc_html( __( 'Preview', 'woocommerce' ) ) . '';
echo '#' . esc_attr( $order->get_order_number() ) . ' ' . esc_html( $buyer ) . '';
}
// Used for showing date & status next to order number/buyer name on small screens.
echo '
';
}
/**
* Get the edit link for an order.
*
* @param WC_Order $order Order object.
*
* @return string Edit link for the order.
*/
private function get_order_edit_link( WC_Order $order ): string {
return $this->page_controller->get_edit_url( $order->get_id() );
}
/**
* Renders the order date.
*
* @param WC_Order $order The order object for the current row.
*
* @return void
*/
public function render_order_date_column( WC_Order $order ): void {
$order_timestamp = $order->get_date_created() ? $order->get_date_created()->getTimestamp() : '';
if ( ! $order_timestamp ) {
echo '–';
return;
}
// Check if the order was created within the last 24 hours, and not in the future.
if ( $order_timestamp > strtotime( '-1 day', time() ) && $order_timestamp <= time() ) {
$show_date = sprintf(
/* translators: %s: human-readable time difference */
_x( '%s ago', '%s = human-readable time difference', 'woocommerce' ),
human_time_diff( $order->get_date_created()->getTimestamp(), time() )
);
} else {
$show_date = $order->get_date_created()->date_i18n( apply_filters( 'woocommerce_admin_order_date_format', __( 'M j, Y', 'woocommerce' ) ) ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment
}
printf(
'',
esc_attr( $order->get_date_created()->date( 'c' ) ),
esc_html( $order->get_date_created()->date_i18n( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) ) ),
esc_html( $show_date )
);
}
/**
* Renders the order status.
*
* @param WC_Order $order The order object for the current row.
*
* @return void
*/
public function render_order_status_column( WC_Order $order ): void {
/* translators: %s: order status label */
$tooltip = wc_sanitize_tooltip( $this->get_order_status_label( $order ) );
// Gracefully handle legacy statuses.
if ( in_array( $order->get_status(), array( 'trash', 'draft', 'auto-draft' ), true ) ) {
$status_name = ( get_post_status_object( $order->get_status() ) )->label;
} else {
$status_name = wc_get_order_status_name( $order->get_status() );
}
if ( $tooltip ) {
printf( '%s', esc_attr( sanitize_html_class( 'status-' . $order->get_status() ) ), wp_kses_post( $tooltip ), esc_html( $status_name ) );
} else {
printf( '%s', esc_attr( sanitize_html_class( 'status-' . $order->get_status() ) ), esc_html( $status_name ) );
}
}
/**
* Gets the order status label for an order.
*
* @param WC_Order $order The order object.
*
* @return string
*/
private function get_order_status_label( WC_Order $order ): string {
$status_names = array(
'pending' => __( 'The order has been received, but no payment has been made. Pending payment orders are generally awaiting customer action.', 'woocommerce' ),
'on-hold' => __( 'The order is awaiting payment confirmation. Stock is reduced, but you need to confirm payment.', 'woocommerce' ),
'processing' => __( 'Payment has been received (paid), and the stock has been reduced. The order is awaiting fulfillment.', 'woocommerce' ),
'completed' => __( 'Order fulfilled and complete.', 'woocommerce' ),
'failed' => __( 'The customer’s payment failed or was declined, and no payment has been successfully made.', 'woocommerce' ),
'checkout-draft' => __( 'Draft orders are created when customers start the checkout process while the block version of the checkout is in place.', 'woocommerce' ),
'cancelled' => __( 'The order was canceled by an admin or the customer.', 'woocommerce' ),
'refunded' => __( 'Orders are automatically put in the Refunded status when an admin or shop manager has fully refunded the order’s value after payment.', 'woocommerce' ),
);
/**
* Provides an opportunity to modify and extend the order status labels.
*
* @param array $action Order actions.
* @param WC_Order $order Current order object.
* @since 9.1.0
*/
$status_names = apply_filters( 'woocommerce_get_order_status_labels', $status_names, $order );
$status_name = $order->get_status();
return isset( $status_names[ $status_name ] ) ? $status_names[ $status_name ] : '';
}
/**
* Renders order billing information.
*
* @param WC_Order $order The order object for the current row.
*
* @return void
*/
public function render_billing_address_column( WC_Order $order ): void {
$address = $order->get_formatted_billing_address();
if ( $address ) {
echo esc_html( preg_replace( '##i', ', ', $address ) );
if ( $order->get_payment_method() ) {
/* translators: %s: payment method */
echo '' . sprintf( esc_html__( 'via %s', 'woocommerce' ), esc_html( $order->get_payment_method_title() ) ) . '';
}
} else {
echo '–';
}
}
/**
* Renders order shipping information.
*
* @param WC_Order $order The order object for the current row.
*
* @return void
*/
public function render_shipping_address_column( WC_Order $order ): void {
$address = $order->get_formatted_shipping_address();
if ( $address ) {
echo '' . esc_html( preg_replace( '##i', ', ', $address ) ) . '';
if ( $order->get_shipping_method() ) {
/* translators: %s: shipping method */
echo '' . sprintf( esc_html__( 'via %s', 'woocommerce' ), esc_html( $order->get_shipping_method() ) ) . '';
}
} else {
echo '–';
}
}
/**
* Renders the order total.
*
* @param WC_Order $order The order object for the current row.
*
* @return void
*/
public function render_order_total_column( WC_Order $order ): void {
if ( $order->get_payment_method_title() ) {
/* translators: %s: method */
echo '' . wp_kses_post( $order->get_formatted_order_total() ) . '';
} else {
echo wp_kses_post( $order->get_formatted_order_total() );
}
}
/**
* Renders order actions.
*
* @param WC_Order $order The order object for the current row.
*
* @return void
*/
public function render_wc_actions_column( WC_Order $order ): void {
echo '
';
/**
* Fires before the order action buttons (within the actions column for the order list table)
* are registered.
*
* @param WC_Order $order Current order object.
* @since 6.7.0
*/
do_action( 'woocommerce_admin_order_actions_start', $order );
$actions = array();
if ( $order->has_status( array( 'pending', 'on-hold' ) ) ) {
$actions['processing'] = array(
'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_mark_order_status&status=processing&order_id=' . $order->get_id() ), 'woocommerce-mark-order-status' ),
'name' => __( 'Processing', 'woocommerce' ),
'action' => 'processing',
);
}
if ( $order->has_status( array( 'pending', 'on-hold', 'processing' ) ) ) {
$actions['complete'] = array(
'url' => wp_nonce_url( admin_url( 'admin-ajax.php?action=woocommerce_mark_order_status&status=completed&order_id=' . $order->get_id() ), 'woocommerce-mark-order-status' ),
'name' => __( 'Complete', 'woocommerce' ),
'action' => 'complete',
);
}
/**
* Provides an opportunity to modify the action buttons within the order list table.
*
* @param array $action Order actions.
* @param WC_Order $order Current order object.
* @since 6.7.0
*/
$actions = apply_filters( 'woocommerce_admin_order_actions', $actions, $order );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo wc_render_action_buttons( $actions );
/**
* Fires after the order action buttons (within the actions column for the order list table)
* are rendered.
*
* @param WC_Order $order Current order object.
* @since 6.7.0
*/
do_action( 'woocommerce_admin_order_actions_end', $order );
echo '
';
}
/**
* Outputs hidden fields used to retain state when filtering.
*
* @return void
*/
private function print_hidden_form_fields(): void {
echo ''; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
$state_params = array(
'paged',
'status',
);
foreach ( $state_params as $param ) {
if ( ! isset( $_GET[ $param ] ) ) {
continue;
}
echo '';
}
}
/**
* Gets the current action selected from the bulk actions dropdown.
*
* @return string|false The action name. False if no action was selected.
*/
public function current_action() {
if ( ! empty( $_REQUEST['delete_all'] ) ) {
return 'delete_all';
}
return parent::current_action();
}
/**
* Handle bulk actions.
*/
public function handle_bulk_actions() {
$action = $this->current_action();
if ( ! $action || ! current_user_can( $this->wp_post_type->cap->edit_others_posts ) ) {
return;
}
check_admin_referer( 'bulk-orders' );
$redirect_to = remove_query_arg( array( 'deleted', 'ids' ), wp_get_referer() );
$redirect_to = add_query_arg( 'paged', $this->get_pagenum(), $redirect_to );
if ( 'delete_all' === $action ) {
// Get all trashed orders.
$ids = wc_get_orders(
array(
'type' => $this->order_type,
'status' => 'trash',
'limit' => -1,
'return' => 'ids',
)
);
$action = 'delete';
} else {
$ids = isset( $_REQUEST['id'] ) ? array_reverse( array_map( 'absint', (array) $_REQUEST['id'] ) ) : array();
}
/**
* Allows 3rd parties to modify order IDs about to be affected by a bulk action.
*
* @param array Array of order IDs.
*/
$ids = apply_filters( // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
'woocommerce_bulk_action_ids',
$ids,
$action,
'order'
);
if ( ! $ids ) {
wp_safe_redirect( $redirect_to );
exit;
}
$report_action = '';
$changed = 0;
$action_handled = true;
if ( 'remove_personal_data' === $action ) {
$report_action = 'removed_personal_data';
$changed = $this->do_bulk_action_remove_personal_data( $ids );
} elseif ( 'trash' === $action ) {
$changed = $this->do_delete( $ids );
$report_action = 'trashed';
} elseif ( 'delete' === $action ) {
$changed = $this->do_delete( $ids, true );
$report_action = 'deleted';
} elseif ( 'untrash' === $action ) {
$changed = $this->do_untrash( $ids );
$report_action = 'untrashed';
} elseif ( false !== strpos( $action, 'mark_' ) ) {
$order_statuses = wc_get_order_statuses();
$new_status = substr( $action, 5 );
$report_action = 'marked_' . $new_status;
if ( isset( $order_statuses[ 'wc-' . $new_status ] ) ) {
$changed = $this->do_bulk_action_mark_orders( $ids, $new_status );
} else {
$action_handled = false;
}
} else {
$action_handled = false;
}
// Custom action.
if ( ! $action_handled ) {
$screen = get_current_screen()->id;
/**
* This action is documented in /wp-admin/edit.php (it is a core WordPress hook).
*
* @since 7.2.0
*
* @param string $redirect_to The URL to redirect to after processing the bulk actions.
* @param string $action The current bulk action.
* @param int[] $ids IDs for the orders to be processed.
*/
$custom_sendback = apply_filters( "handle_bulk_actions-{$screen}", $redirect_to, $action, $ids ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
}
if ( ! empty( $custom_sendback ) ) {
$redirect_to = $custom_sendback;
} elseif ( $changed ) {
$redirect_to = add_query_arg(
array(
'bulk_action' => $report_action,
'changed' => $changed,
'ids' => implode( ',', $ids ),
),
$redirect_to
);
}
wp_safe_redirect( $redirect_to );
exit;
}
/**
* Implements the "remove personal data" bulk action.
*
* @param array $order_ids The Order IDs.
* @return int Number of orders modified.
*/
private function do_bulk_action_remove_personal_data( $order_ids ): int {
$changed = 0;
foreach ( $order_ids as $id ) {
$order = wc_get_order( $id );
if ( ! $order ) {
continue;
}
do_action( 'woocommerce_remove_order_personal_data', $order ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment
++$changed;
}
return $changed;
}
/**
* Implements the "mark " bulk action.
*
* @param array $order_ids The order IDs to change.
* @param string $new_status The new order status.
* @return int Number of orders modified.
*/
private function do_bulk_action_mark_orders( $order_ids, $new_status ): int {
$changed = 0;
// Initialize payment gateways in case order has hooked status transition actions.
WC()->payment_gateways();
foreach ( $order_ids as $id ) {
$order = wc_get_order( $id );
if ( ! $order ) {
continue;
}
$order->update_status( $new_status, __( 'Order status changed by bulk edit.', 'woocommerce' ), true );
do_action( 'woocommerce_order_edit_status', $id, $new_status ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment
++$changed;
}
return $changed;
}
/**
* Handles bulk trashing of orders.
*
* @param int[] $ids Order IDs to be trashed.
* @param bool $force_delete When set, the order will be completed deleted. Otherwise, it will be trashed.
*
* @return int Number of orders that were trashed.
*/
private function do_delete( array $ids, bool $force_delete = false ): int {
$changed = 0;
foreach ( $ids as $id ) {
$order = wc_get_order( $id );
$order->delete( $force_delete );
$updated_order = wc_get_order( $id );
if ( ( $force_delete && false === $updated_order ) || ( ! $force_delete && $updated_order->get_status() === 'trash' ) ) {
++$changed;
}
}
return $changed;
}
/**
* Handles bulk restoration of trashed orders.
*
* @param array $ids Order IDs to be restored to their previous status.
*
* @return int Number of orders that were restored from the trash.
*/
private function do_untrash( array $ids ): int {
$orders_store = wc_get_container()->get( OrdersTableDataStore::class );
$changed = 0;
foreach ( $ids as $id ) {
if ( $orders_store->untrash_order( wc_get_order( $id ) ) ) {
++$changed;
}
}
return $changed;
}
/**
* Show confirmation message that order status changed for number of orders.
*/
public function bulk_action_notices() {
if ( empty( $_REQUEST['bulk_action'] ) ) {
return;
}
$order_statuses = wc_get_order_statuses();
$number = absint( $_REQUEST['changed'] ?? 0 );
$bulk_action = wc_clean( wp_unslash( $_REQUEST['bulk_action'] ) );
$message = '';
// Check if any status changes happened.
foreach ( $order_statuses as $slug => $name ) {
if ( 'marked_' . str_replace( 'wc-', '', $slug ) === $bulk_action ) { // WPCS: input var ok, CSRF ok.
/* translators: %s: orders count */
$message = sprintf( _n( '%s order status changed.', '%s order statuses changed.', $number, 'woocommerce' ), number_format_i18n( $number ) );
break;
}
}
switch ( $bulk_action ) {
case 'removed_personal_data':
/* translators: %s: orders count */
$message = sprintf( _n( 'Removed personal data from %s order.', 'Removed personal data from %s orders.', $number, 'woocommerce' ), number_format_i18n( $number ) );
echo '
' . esc_html( $message ) . '
';
break;
case 'trashed':
/* translators: %s: orders count */
$message = sprintf( _n( '%s order moved to the Trash.', '%s orders moved to the Trash.', $number, 'woocommerce' ), number_format_i18n( $number ) );
break;
case 'untrashed':
/* translators: %s: orders count */
$message = sprintf( _n( '%s order restored from the Trash.', '%s orders restored from the Trash.', $number, 'woocommerce' ), number_format_i18n( $number ) );
break;
case 'deleted':
/* translators: %s: orders count */
$message = sprintf( _n( '%s order permanently deleted.', '%s orders permanently deleted.', $number, 'woocommerce' ), number_format_i18n( $number ) );
break;
}
if ( ! empty( $message ) ) {
echo '
' . esc_html( $message ) . '
';
}
}
/**
* Enqueue list table scripts.
*
* @return void
*/
public function enqueue_scripts(): void {
echo $this->get_order_preview_template(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
wp_enqueue_script( 'wc-orders' );
}
/**
* Returns the HTML for the order preview template.
*
* @return string HTML template.
*/
public function get_order_preview_template(): string {
$order_edit_url_placeholder =
wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled()
? esc_url( admin_url( 'admin.php?page=wc-orders&action=edit' ) ) . '&id={{ data.data.id }}'
: esc_url( admin_url( 'post.php?action=edit' ) ) . '&post={{ data.data.id }}';
ob_start();
?>
has_items() ) {
return;
}
$input_id = $input_id . '-search-input';
if ( ! empty( $_REQUEST['orderby'] ) ) {
echo '';
}
if ( ! empty( $_REQUEST['order'] ) ) {
echo '';
}
?>
search_filter(); ?>
'search-submit' ) ); ?>
__( 'Order ID', 'woocommerce' ),
'customer_email' => __( 'Customer Email', 'woocommerce' ),
'customers' => __( 'Customers', 'woocommerce' ),
'products' => __( 'Products', 'woocommerce' ),
'all' => __( 'All', 'woocommerce' ),
);
/**
* Filters the search filters available in the admin order search. Can be used to add new or remove existing filters.
* When adding new filters, `woocommerce_hpos_generate_where_for_search_filter` should also be used to generate the WHERE clause for the new filter
*
* @since 8.9.0.
*
* @param $options array List of available filters.
*/
$options = apply_filters( 'woocommerce_hpos_admin_search_filters', $options );
$saved_setting = get_user_setting( 'wc-search-filter-hpos-admin', 'all' );
$selected = sanitize_text_field( wp_unslash( $_REQUEST['search-filter'] ?? $saved_setting ) );
if ( $saved_setting !== $selected ) {
set_user_setting( 'wc-search-filter-hpos-admin', $selected );
}
?>
get_status() ) {
return;
}
$customer_history = null;
if ( method_exists( $order, 'get_report_customer_id' ) ) {
$customer_history = $this->get_customer_history( $order->get_report_customer_id() );
}
if ( ! $customer_history ) {
$customer_history = array(
'orders_count' => 0,
'total_spend' => 0,
'avg_order_value' => 0,
);
}
wc_get_template( 'order/customer-history.php', $customer_history );
}
/**
* Get the order history for the customer (data matches Customers report).
*
* @param int $customer_report_id The reports customer ID (not necessarily User ID).
*
* @return array|null Order count, total spend, and average spend per order.
*/
private function get_customer_history( $customer_report_id ): ?array {
$args = array(
'customers' => array( $customer_report_id ),
// If unset, these params have default values that affect the results.
'order_after' => null,
'order_before' => null,
);
$customers_query = new CustomersQuery( $args );
$customer_data = $customers_query->get_data();
return $customer_data->data[0] ?? null;
}
}
PK [1] + Admin/Orders/MetaBoxes/OrderAttribution.phpnu set_fields_and_prefix();
}
/**
* Format the meta data for display.
*
* @since 8.5.0
*
* @param array $meta The array of meta data to format.
*
* @return void
*/
public function format_meta_data( array &$meta ) {
if ( array_key_exists( 'device_type', $meta ) ) {
switch ( $meta['device_type'] ) {
case 'Mobile':
$meta['device_type'] = __( 'Mobile', 'woocommerce' );
break;
case 'Tablet':
$meta['device_type'] = __( 'Tablet', 'woocommerce' );
break;
case 'Desktop':
$meta['device_type'] = __( 'Desktop', 'woocommerce' );
break;
default:
$meta['device_type'] = __( 'Unknown', 'woocommerce' );
break;
}
}
}
/**
* Output the attribution data metabox for the order.
*
* @since 8.5.0
*
* @param WC_Order $order The order object.
*
* @return void
*/
public function output( WC_Order $order ) {
$meta = $this->filter_meta_data( $order->get_meta_data() );
$this->format_meta_data( $meta );
// No more details if there is only the origin value - this is for unknown source types.
$has_more_details = array( 'origin' ) !== array_keys( $meta );
// For direct, web admin, mobile app or pos orders, also don't show more details.
$simple_sources = array( 'typein', 'admin', 'mobile_app', 'pos' );
if ( isset( $meta['source_type'] ) && in_array( $meta['source_type'], $simple_sources, true ) ) {
$has_more_details = false;
}
$template_data = array(
'meta' => $meta,
'has_more_details' => $has_more_details,
);
wc_get_template( 'order/attribution-details.php', $template_data );
}
}
PK [1]AB AB ( Admin/Orders/MetaBoxes/CustomMetaBox.phpnu get_meta_data();
$metadata_to_list = array();
foreach ( $metadata as $meta ) {
$data = $meta->get_data();
if ( is_protected_meta( $data['key'], 'order' ) ) {
continue;
}
$metadata_to_list[] = array(
'meta_id' => $data['id'],
'meta_key' => $data['key'], // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key -- False positive, not a meta query.
'meta_value' => maybe_serialize( $data['value'] ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value -- False positive, not a meta query.
);
}
return $metadata_to_list;
}
/**
* Renders the meta box to manage custom meta.
*
* @param \WP_Post|\WC_Order $order_or_post Post or order object that we are rendering for.
*/
public function output( $order_or_post ) {
if ( is_a( $order_or_post, \WP_Post::class ) ) {
$order = wc_get_order( $order_or_post );
} else {
$order = $order_or_post;
}
$this->render_custom_meta_form( $this->get_formatted_order_meta_data( $order ), $order );
}
/**
* Helper method to render layout and actual HTML
*
* @param array $metadata_to_list List of metadata to render.
* @param \WC_Order $order Order object.
*/
private function render_custom_meta_form( array $metadata_to_list, \WC_Order $order ) {
?>
render_meta_form( $order );
?>
',
''
);
?>
get( OrdersTableDataStoreMeta::class )->get_meta_keys( $limit );
}
if ( $keys ) {
natcasesort( $keys );
}
return $keys;
}
/**
* Reimplementation of WP core's `meta_form` function. Renders meta form box.
*
* @param \WC_Order $order WC_Order object.
*
* @return void
*/
public function render_meta_form( \WC_Order $order ) : void {
?>
get_meta( self::META_KEY_NAME, true, 'edit' );
if ( ! $lock ) {
return false;
}
$lock = explode( ':', $lock );
if ( 2 !== count( $lock ) ) {
return false;
}
$time = absint( $lock[0] );
$user_id = isset( $lock[1] ) ? absint( $lock[1] ) : 0;
if ( ! $time || ! get_user_by( 'id', $user_id ) ) {
return false;
}
/** This filter is documented in WP's wp-admin/includes/ajax-actions.php */
$time_window = apply_filters( 'wp_check_post_lock_window', 150 ); // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingSinceComment
if ( time() >= ( $time + $time_window ) ) {
return false;
}
return compact( 'time', 'user_id' );
}
/**
* Checks whether the order is being edited (i.e. locked) by another user.
*
* @param \WC_Order $order Order to check.
* @return bool TRUE if order is locked and currently being edited by another user. FALSE otherwise.
*/
public function is_locked_by_another_user( \WC_Order $order ) : bool {
$lock = $this->get_lock( $order );
return $lock && ( get_current_user_id() !== $lock['user_id'] );
}
/**
* Checks whether the order is being edited by any user.
*
* @param \WC_Order $order Order to check.
* @return boolean TRUE if order is locked and currently being edited by a user. FALSE otherwise.
*/
public function is_locked( \WC_Order $order ) : bool {
return (bool) $this->get_lock( $order );
}
/**
* Assigns an order's edit lock to the current user.
*
* @param \WC_Order $order The order to apply the lock to.
* @return array|bool FALSE if no user is logged-in, an array in the same format as {@see get_lock()} otherwise.
*/
public function lock( \WC_Order $order ) {
$user_id = get_current_user_id();
if ( ! $user_id ) {
return false;
}
$order->update_meta_data( self::META_KEY_NAME, time() . ':' . $user_id );
$order->save_meta_data();
return $order->get_meta( self::META_KEY_NAME, true, 'edit' );
}
/**
* Hooked to 'heartbeat_received' on the edit order page to refresh the lock on an order being edited by the current user.
*
* @param array $response The heartbeat response to be sent.
* @param array $data Data sent through the heartbeat.
* @return array Response to be sent.
*/
public function refresh_lock_ajax( $response, $data ) {
$order_id = absint( $data['wc-refresh-order-lock'] ?? 0 );
if ( ! $order_id ) {
return $response;
}
unset( $response['wp-refresh-post-lock'] );
$order = wc_get_order( $order_id );
if ( ! $order || ! is_a( $order, \WC_Order::class ) || ( ! current_user_can( get_post_type_object( $order->get_type() )->cap->edit_post, $order->get_id() ) && ! current_user_can( 'manage_woocommerce' ) ) ) {
return $response;
}
$response['wc-refresh-order-lock'] = array();
if ( ! $this->is_locked_by_another_user( $order ) ) {
$response['wc-refresh-order-lock']['lock'] = $this->lock( $order );
} else {
$current_lock = $this->get_lock( $order );
$user = get_user_by( 'id', $current_lock['user_id'] );
$response['wc-refresh-order-lock']['error'] = array(
// translators: %s is a user's name.
'message' => sprintf( __( '%s has taken over and is currently editing.', 'woocommerce' ), $user->display_name ),
'user_name' => $user->display_name,
'user_avatar_src' => get_option( 'show_avatars' ) ? get_avatar_url( $user->ID, array( 'size' => 64 ) ) : '',
'user_avatar_src_2x' => get_option( 'show_avatars' ) ? get_avatar_url( $user->ID, array( 'size' => 128 ) ) : '',
);
}
return $response;
}
/**
* Hooked to 'heartbeat_received' on the orders screen to refresh the locked status of orders in the list table.
*
* @param array $response The heartbeat response to be sent.
* @param array $data Data sent through the heartbeat.
* @return array Response to be sent.
*/
public function check_locked_orders_ajax( $response, $data ) {
if ( empty( $data['wc-check-locked-orders'] ) || ! is_array( $data['wc-check-locked-orders'] ) ) {
return $response;
}
$response['wc-check-locked-orders'] = array();
$order_ids = array_unique( array_map( 'absint', $data['wc-check-locked-orders'] ) );
foreach ( $order_ids as $order_id ) {
$order = wc_get_order( $order_id );
if ( ! $order || ! is_a( $order, \WC_Order::class ) ) {
continue;
}
if ( ! $this->is_locked_by_another_user( $order ) || ( ! current_user_can( get_post_type_object( $order->get_type() )->cap->edit_post, $order->get_id() ) && ! current_user_can( 'manage_woocommerce' ) ) ) {
continue;
}
$response['wc-check-locked-orders'][ $order_id ] = true;
}
return $response;
}
/**
* Outputs HTML for the lock dialog based on the status of the lock on the order (if any).
* Depending on who owns the lock, this could be a message with the chance to take over or a message indicating that
* someone else has taken over the order.
*
* @param \WC_Order $order Order object.
* @return void
*/
public function render_dialog( $order ) {
$lock = $this->get_lock( $order );
$user = $lock ? get_user_by( 'id', $lock['user_id'] ) : false;
$locked = $user && ( get_current_user_id() !== $user->ID );
$edit_url = wc_get_container()->get( \Automattic\WooCommerce\Internal\Admin\Orders\PageController::class )->get_edit_url( $order->get_id() );
$sendback_url = wp_get_referer();
if ( ! $sendback_url ) {
$sendback_url = wc_get_container()->get( \Automattic\WooCommerce\Internal\Admin\Orders\PageController::class )->get_base_page_url( $order->get_type() );
}
$sendback_text = __( 'Go back', 'woocommerce' );
?>
ID, 64 ); ?>
display_name ) ) );
?>
is_nexi_in_sandbox_mode( $payment_gateway );
if ( null === $sandbox ) {
return parent::is_account_connected( $payment_gateway );
}
return $sandbox
? ( ! empty( $payment_gateway->get_option( 'dibs_test_key' ) ) && ! empty( $payment_gateway->get_option( 'dibs_test_checkout_key' ) ) )
: ( ! empty( $payment_gateway->get_option( 'dibs_live_key' ) ) && ! empty( $payment_gateway->get_option( 'dibs_checkout_key' ) ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_nexi_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_nexi_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_nexi_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Nexi Checkout payment gateway is in test/sandbox mode.
*
* There are two different environments: test/sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_nexi_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
return \wc_string_to_bool( $payment_gateway->get_option( 'test_mode' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1]ʄ} } + Admin/Settings/PaymentsProviders/Mollie.phpnu id ) {
return $this->get_custom_settings_url();
}
// Target the payment methods section when the gateway is connected.
return $this->get_custom_settings_url( 'mollie_payment_methods' );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
$sandbox_mode = $this->is_mollie_in_sandbox_mode( $payment_gateway );
// Let null results bubble up to the parent class.
if ( true === $sandbox_mode ) {
// If Mollie is in sandbox mode, we consider the account connected if the test API key is set.
return ! empty( get_option( 'mollie-payments-for-woocommerce_test_api_key', '' ) );
} elseif ( false === $sandbox_mode ) {
// In production mode, we check the live API key.
return ! empty( get_option( 'mollie-payments-for-woocommerce_live_api_key', '' ) );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Determine if the payment gateway is in test mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mollie_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mollie_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Determine if at least a Mollie gateway is registered.
*
* @param array $payment_gateways The payment gateways objects.
*
* @return bool True if at least a Mollie gateway is registered, false otherwise.
*/
public function is_gateway_registered( array $payment_gateways ): bool {
$mollie_gateways = array_filter(
$payment_gateways,
function ( $gateway ) {
return str_starts_with( $gateway->id, 'mollie_wc_gateway_' );
}
);
return ! empty( $mollie_gateways );
}
/**
* Get the pseudo Mollie gateway object.
*
* @param array $suggestion The suggestion data.
*
* @return PseudoWCPaymentGateway The pseudo gateway object.
*/
public function get_pseudo_gateway( array $suggestion ): PseudoWCPaymentGateway {
// We will generate a generic gateway to represent Mollie in the settings page.
// The generic gateway's state will be not enabled, not connected, and not onboarded.
// The presentational details will be minimal, letting the suggestion provide most of the information.
return new PseudoWCPaymentGateway(
'mollie_stand_in',
array(
'method_title' => $suggestion['title'],
'method_description' => $suggestion['description'],
'enabled' => false,
'needs_setup' => true,
'test_mode' => false,
'dev_mode' => false,
'account_connected' => false,
'onboarding_started' => false,
'onboarding_completed' => false,
'settings_url' => $this->get_custom_settings_url(),
'plugin_slug' => $suggestion['plugin']['slug'],
'plugin_file' => $suggestion['plugin']['file'],
),
);
}
/**
* Get the URL to the custom settings page for Mollie.
*
* @param string $section Optional. The section to navigate to.
*
* @return string The URL to the custom settings page for Mollie.
*/
private function get_custom_settings_url( string $section = '' ): string {
$settings_url = admin_url( 'admin.php?page=wc-settings&tab=mollie_settings' );
if ( ! empty( $section ) ) {
$settings_url = add_query_arg( 'section', $section, $settings_url );
}
return $settings_url;
}
/**
* Check if the Mollie payment gateway is in sandbox mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_mollie_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
// Unfortunately, Mollie does not provide a standard way to determine if the gateway is in sandbox mode.
return filter_var( get_option( 'mollie-payments-for-woocommerce_test_mode_enabled', 'yes' ), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1] ! + Admin/Settings/PaymentsProviders/Affirm.phpnu isValidForUse() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway needs setup: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::needs_setup( $payment_gateway );
}
}
PK [1]bܒ3 + Admin/Settings/PaymentsProviders/PayPal.phpnu is_paypal_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_paypal_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_paypal_onboarded( $payment_gateway ) ?? parent::is_account_connected( $payment_gateway );
}
/**
* Check if the payment gateway has completed the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has completed the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_completed( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_paypal_onboarded( $payment_gateway ) ?? parent::is_onboarding_completed( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_paypal_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the PayPal payment gateway is in sandbox mode.
*
* For PayPal, there are two different environments: sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_paypal_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
if ( class_exists( '\WooCommerce\PayPalCommerce\PPCP' ) &&
is_callable( '\WooCommerce\PayPalCommerce\PPCP::container' ) ) {
try {
$container = \WooCommerce\PayPalCommerce\PPCP::container();
if ( $container->has( 'settings.connection-state' ) ) {
$state = $container->get( 'settings.connection-state' );
return $state->is_sandbox();
}
// Backwards compatibility with pre 3.0.0 (deprecated).
if ( $container->has( 'onboarding.environment' ) &&
defined( '\WooCommerce\PayPalCommerce\Onboarding\Environment::SANDBOX' ) ) {
$environment = $container->get( 'onboarding.environment' );
$current_environment = $environment->current_environment();
return \WooCommerce\PayPalCommerce\Onboarding\Environment::SANDBOX === $current_environment;
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
}
// Let the caller know that we couldn't determine the environment.
return null;
}
/**
* Check if the PayPal payment gateway is onboarded.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is onboarded, false otherwise.
* Null if we failed to determine the onboarding status.
*/
private function is_paypal_onboarded( WC_Payment_Gateway $payment_gateway ): ?bool {
if ( class_exists( '\WooCommerce\PayPalCommerce\PPCP' ) &&
is_callable( '\WooCommerce\PayPalCommerce\PPCP::container' ) ) {
try {
$container = \WooCommerce\PayPalCommerce\PPCP::container();
if ( $container->has( 'settings.connection-state' ) ) {
$state = $container->get( 'settings.connection-state' );
return $state->is_connected();
}
// Backwards compatibility with pre 3.0.0 (deprecated).
if ( $container->has( 'onboarding.state' ) &&
defined( '\WooCommerce\PayPalCommerce\Onboarding\State::STATE_ONBOARDED' ) ) {
$state = $container->get( 'onboarding.state' );
return $state->current_state() >= \WooCommerce\PayPalCommerce\Onboarding\State::STATE_ONBOARDED;
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is onboarded: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
}
// Let the caller know that we couldn't determine the onboarding status.
return null;
}
}
PK [1] - Admin/Settings/PaymentsProviders/Razorpay.phpnu getSetting( 'key_id' ) ) &&
! empty( $payment_gateway->getSetting( 'key_secret' ) );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( function_exists( '\isTestModeEnabled' ) ) {
return wc_string_to_bool( \isTestModeEnabled() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_in_test_mode( $payment_gateway );
}
}
PK [1]|b * Admin/Settings/PaymentsProviders/Antom.phpnu debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_antom_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_antom_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_antom_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Antom payment gateway is in sandbox mode.
*
* There are two different environments: test and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_antom_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
if ( function_exists( '\antom_get_core_settings' ) ) {
return wc_string_to_bool( \antom_get_core_settings()['test_mode'] );
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1]
3 Admin/Settings/PaymentsProviders/KlarnaCheckout.phpnu credentials;
if ( is_object( $credentials ) && is_callable( array( $credentials, 'get_credentials_from_session' ) ) ) {
return ! empty( $credentials->get_credentials_from_session() );
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for KlarnaCheckout, affecting the API details used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1]l
, Admin/Settings/PaymentsProviders/Vivacom.phpnu is_in_test_mode( $payment_gateway ) ) {
return property_exists( $payment_gateway, 'test_client_id' ) && ! empty( $payment_gateway->test_client_id )
&& property_exists( $payment_gateway, 'test_client_secret' ) && ! empty( $payment_gateway->test_client_secret )
&& property_exists( $payment_gateway, 'test_source_code' ) && ! empty( $payment_gateway->test_source_code );
} else {
return property_exists( $payment_gateway, 'client_id' ) && ! empty( $payment_gateway->client_id )
&& property_exists( $payment_gateway, 'client_secret' ) && ! empty( $payment_gateway->client_secret )
&& property_exists( $payment_gateway, 'source_code' ) && ! empty( $payment_gateway->source_code );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for Viva.com, affecting the used API keys.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1].U - Admin/Settings/PaymentsProviders/Payoneer.phpnu get_option( 'live_mode' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_in_test_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
$sandbox_prefix = $this->is_in_test_mode( $payment_gateway ) ? 'sandbox_' : '';
return ! empty( $payment_gateway->get_option( 'merchant_code' ) ) &&
! empty( $payment_gateway->get_option( $sandbox_prefix . 'merchant_token' ) ) &&
! empty( $payment_gateway->get_option( $sandbox_prefix . 'store_code' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for Payoneer, affecting the API credentials used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1] Y?! ?! + Admin/Settings/PaymentsProviders/Stripe.phpnu debug(
'Failed to determine if gateway is in test mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return false;
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( class_exists( '\WC_Stripe' ) && is_callable( '\WC_Stripe::get_instance' ) ) {
$stripe = \WC_Stripe::get_instance();
if ( is_object( $stripe ) && isset( $stripe->account ) &&
class_exists( '\WC_Stripe_Account' ) &&
defined( '\WC_Stripe_Account::STATUS_NO_ACCOUNT' ) &&
$stripe->account instanceof \WC_Stripe_Account &&
is_callable( array( $stripe->account, 'get_account_status' ) ) ) {
return \WC_Stripe_Account::STATUS_NO_ACCOUNT !== $stripe->account->get_account_status();
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Check if the payment gateway has started the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has started the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_started( WC_Payment_Gateway $payment_gateway ): bool {
// Fall back to inferring this from having a connected account.
return $this->is_account_connected( $payment_gateway );
}
/**
* Check if the payment gateway has completed the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has completed the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_completed( WC_Payment_Gateway $payment_gateway ): bool {
// Sanity check: If the onboarding has not started, it cannot be completed.
if ( ! $this->is_onboarding_started( $payment_gateway ) ) {
return false;
}
// Fall back to inferring this from having a connected account.
return $this->is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( class_exists( '\WC_Stripe' ) && is_callable( '\WC_Stripe::get_instance' ) ) {
$stripe = \WC_Stripe::get_instance();
if ( is_object( $stripe ) && isset( $stripe->connect ) &&
class_exists( '\WC_Stripe_Connect' ) &&
$stripe->connect instanceof \WC_Stripe_Connect &&
is_callable( array( $stripe->connect, 'is_connected' ) ) ) {
return $stripe->connect->is_connected( 'test' )
&& ! $stripe->connect->is_connected( 'live' );
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode onboarding: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Get the settings URL for a payment gateway.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The settings URL for the payment gateway.
*/
public function get_settings_url( WC_Payment_Gateway $payment_gateway ): string {
return Utils::wc_payments_settings_url(
null,
array(
'section' => strtolower( $payment_gateway->id ),
'from' => Payments::FROM_PAYMENTS_SETTINGS,
)
);
}
/**
* Get the onboarding URL for the payment gateway.
*
* This URL should start or continue the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $return_url Optional. The URL to return to after onboarding.
* This will likely get attached to the onboarding URL.
*
* @return string The onboarding URL for the payment gateway.
*/
public function get_onboarding_url( WC_Payment_Gateway $payment_gateway, string $return_url = '' ): string {
// Fall back to pointing users to the payment gateway settings page to handle onboarding.
return $this->get_settings_url( $payment_gateway );
}
/**
* Try and determine a list of recommended payment methods for a payment gateway.
*
* This data is not always available, and it is up to the payment gateway to provide it.
* This is not a definitive list of payment methods that the gateway supports.
* The data is aimed at helping the user understand what payment methods are recommended for the gateway
* and potentially help them make a decision on which payment methods to enable.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which to get recommended payment methods.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The recommended payment methods list for the payment gateway.
* Empty array if there are none.
*/
public function get_recommended_payment_methods( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): array {
return array();
}
}
PK [1]F 4 4 , Admin/Settings/PaymentsProviders/Tilopay.phpnu tpay_key ) &&
property_exists( $payment_gateway, 'tpay_user' ) && ! empty( $payment_gateway->tpay_user ) &&
property_exists( $payment_gateway, 'tpay_password' ) && ! empty( $payment_gateway->tpay_password );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
}
PK [1]$ ) Admin/Settings/PaymentsProviders/Visa.phpnu get_config_settings();
return is_array( $settings ) && isset( $settings['environment'] ) &&
( ( \VISA_ACCEPTANCE_ENVIRONMENT_TEST === $settings['environment'] &&
! empty( $settings['test_merchant_id'] ) &&
! empty( $settings['test_api_key'] ) &&
! empty( $settings['test_api_shared_secret'] ) ) ||
( \VISA_ACCEPTANCE_ENVIRONMENT_PRODUCTION === $settings['environment'] &&
! empty( $settings['merchant_id'] ) &&
! empty( $settings['api_key'] ) &&
! empty( $settings['api_shared_secret'] ) ) );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_visa_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_visa_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_visa_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Visa payment gateway is in test/sandbox mode.
*
* There are two different environments: test/sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_visa_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
if ( is_callable( array( $payment_gateway, 'get_config_settings' ) ) &&
defined( 'VISA_ACCEPTANCE_ENVIRONMENT_TEST' ) &&
defined( 'VISA_ACCEPTANCE_ENVIRONMENT_PRODUCTION' ) ) {
$settings = $payment_gateway->get_config_settings();
if ( is_array( $settings ) && isset( $settings['environment'] ) ) {
if ( \VISA_ACCEPTANCE_ENVIRONMENT_TEST === $settings['environment'] ) {
return true;
}
if ( \VISA_ACCEPTANCE_ENVIRONMENT_PRODUCTION === $settings['environment'] ) {
return false;
}
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1]t
) ) + Admin/Settings/PaymentsProviders/Klarna.phpnu debug(
'Failed to determine if gateway needs setup: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::needs_setup( $payment_gateway );
}
}
PK [1]heI 5 Admin/Settings/PaymentsProviders/AfterpayClearpay.phpnu get_merchant_id() ) &&
! empty( $payment_gateway->get_secret_key() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_afterpay_clearpay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_afterpay_clearpay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_afterpay_clearpay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Afterpay/Clearpay payment gateway is in sandbox mode.
*
* There are two different environments: sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_afterpay_clearpay_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
if ( is_callable( array( $payment_gateway, 'get_api_env' ) ) ) {
return 'production' !== $payment_gateway->get_api_env();
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1]I . Admin/Settings/PaymentsProviders/PayUIndia.phpnu get_option( 'currency1_payu_key' ) ) && ! empty( $payment_gateway->get_option( 'currency1_payu_salt' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
}
PK [1]Vq 3 Admin/Settings/PaymentsProviders/PaymentGateway.phpnu proxy = $proxy;
}
/**
* Extract the payment gateway provider details from the object.
*
* @param WC_Payment_Gateway $gateway The payment gateway object.
* @param int $order Optional. The order to assign.
* Defaults to 0 if not provided.
* @param string $country_code Optional. The country code for which the details are being gathered.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The payment gateway provider details.
*/
public function get_details( WC_Payment_Gateway $gateway, int $order = 0, string $country_code = '' ): array {
$onboarding_supported = $this->is_onboarding_supported( $gateway, $country_code ) ?? true; // Assume supported if unknown.
return array(
'id' => $gateway->id,
'_order' => $order,
'title' => $this->get_title( $gateway ),
'description' => $this->get_description( $gateway ),
'icon' => $this->get_icon( $gateway ),
'supports' => $this->get_supports_list( $gateway ),
'links' => $this->get_provider_links( $gateway, $country_code ),
'state' => array(
'enabled' => $this->is_enabled( $gateway ),
'account_connected' => $this->is_account_connected( $gateway ),
'needs_setup' => $this->needs_setup( $gateway ),
'test_mode' => $this->is_in_test_mode( $gateway ),
'dev_mode' => $this->is_in_dev_mode( $gateway ),
),
'management' => array(
'_links' => array(
'settings' => array(
'href' => $this->get_settings_url( $gateway ),
),
),
),
'onboarding' => array(
'type' => self::ONBOARDING_TYPE_EXTERNAL,
'state' => array(
'supported' => $onboarding_supported,
'started' => $this->is_onboarding_started( $gateway ),
'completed' => $this->is_onboarding_completed( $gateway ),
'test_mode' => $this->is_in_test_mode_onboarding( $gateway ),
),
'messages' => array(
'not_supported' => ! $onboarding_supported ? $this->get_onboarding_not_supported_message( $gateway, $country_code ) : null,
),
'_links' => array(
'onboard' => array(
'href' => $this->get_onboarding_url( $gateway ),
),
),
'recommended_payment_methods' => $this->get_recommended_payment_methods( $gateway, $country_code ),
),
'plugin' => $this->get_plugin_details( $gateway ),
);
}
/**
* Enhance this provider's payment extension suggestion with additional information.
*
* The details added do not require the payment extension to be active or a gateway instance.
*
* @param array $extension_suggestion The extension suggestion details.
*
* @return array The enhanced payment extension suggestion details.
*/
public function enhance_extension_suggestion( array $extension_suggestion ): array {
if ( empty( $extension_suggestion['onboarding'] ) || ! is_array( $extension_suggestion['onboarding'] ) ) {
$extension_suggestion['onboarding'] = array();
}
if ( ! isset( $extension_suggestion['onboarding']['type'] ) ) {
$extension_suggestion['onboarding']['type'] = self::ONBOARDING_TYPE_EXTERNAL;
}
return $extension_suggestion;
}
/**
* Get the provider title of the payment gateway.
*
* This is the intended gateway title to use throughout the WC admin. It should be short.
*
* Note: We don't allow HTML tags in the title. All HTML tags will be stripped, including their contents.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The provider title of the payment gateway.
*/
public function get_title( WC_Payment_Gateway $payment_gateway ): string {
$title = $payment_gateway->get_method_title();
// If we still couldn't get the WC admin title, fall back to the main title.
if ( ! is_string( $title ) || empty( $title ) ) {
$title = $payment_gateway->get_title();
}
// If we still couldn't get the title, return a default value.
if ( ! is_string( $title ) || empty( $title ) ) {
return esc_html__( 'Unknown', 'woocommerce' );
}
// No HTML tags allowed in the title.
$title = wp_strip_all_tags( html_entity_decode( $title, ENT_QUOTES | ENT_SUBSTITUTE ), true );
// Truncate the title.
return Utils::truncate_with_words( $title, 75 );
}
/**
* Get the provider description of the payment gateway.
*
* This is the intended gateway description to use throughout the WC admin. It should be short and to the point.
*
* Note: We don't allow HTML tags in the description. All HTML tags will be stripped, including their contents.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The provider description of the payment gateway.
*/
public function get_description( WC_Payment_Gateway $payment_gateway ): string {
$description = $payment_gateway->get_method_description();
// If we couldn't get the WC admin description, fall back to the main description.
if ( ! is_string( $description ) || empty( $description ) ) {
$description = $payment_gateway->get_description();
}
// If we still couldn't get the description, use an empty string since the description is not critical.
if ( ! is_string( $description ) || empty( $description ) ) {
return '';
}
// No HTML tags allowed in the description.
$description = wp_strip_all_tags( html_entity_decode( $description, ENT_QUOTES | ENT_SUBSTITUTE ), true );
// Truncate the description.
return Utils::truncate_with_words( $description, 130, '…' );
}
/**
* Get the provider icon URL of the payment gateway.
*
* We expect to receive a URL to an image file.
* If the gateway provides an tag or a list of them, we will fall back to the default payments icon.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The provider icon URL of the payment gateway.
*/
public function get_icon( WC_Payment_Gateway $payment_gateway ): string {
$icon_url = $payment_gateway->icon ?? '';
if ( ! is_string( $icon_url ) || empty( $icon_url ) ) {
$icon_url = '';
}
$icon_url = trim( $icon_url );
// Test if it actually is a URL as some gateways put an tag or a list of them.
if ( ! wc_is_valid_url( $icon_url ) ) {
// Fall back to the default payments icon.
return plugins_url( 'assets/images/icons/default-payments.svg', WC_PLUGIN_FILE );
}
return WC_HTTPS::force_https_url( $icon_url );
}
/**
* Get the provider supports list of the payment gateway.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string[] The provider supports list of the payment gateway.
*/
public function get_supports_list( WC_Payment_Gateway $payment_gateway ): array {
$supports_list = $payment_gateway->supports ?? array();
if ( ! is_array( $supports_list ) ) {
return array();
}
// Sanitize the list to ensure it only contains a list of key-like strings.
$sanitized_list = array();
foreach ( $supports_list as $support ) {
if ( ! is_string( $support ) ) {
continue;
}
$sanitized_list[] = sanitize_key( $support );
}
// Ensure the list contains unique values and re-indexed.
return array_values( array_unique( $sanitized_list ) );
}
/**
* Get the provider links list.
*
* These are contextual, in general external links aimed to help the user learn more about the payment provider and
* reach out for help.
*
* Each link is an associative array with '_type' and 'url' keys.
* The type is a string indicating the type of link, e.g., 'documentation', 'support', 'pricing', etc.
* The only accepted types are the ones documented in the PaymentsProviders::LINK_TYPE_* constants.
*
* Example:
* array(
* array(
* '_type' => 'documentation',
* 'url' => 'https://example.com/docs',
* ),
* array(
* '_type' => 'support',
* 'url' => 'https://example.com/support',
* ),
* );
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which the providers are being requested.
* This should be an ISO 3166-1 alpha-2 country code.
* If invalid, it will be ignored.
*
* @return array The provider links list. Empty array if none are available or an error occurs.
*/
public function get_provider_links( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): array {
$country_code = strtoupper( sanitize_text_field( $country_code ) );
// Validate the country code format - expect ISO 3166-1 alpha-2.
// Empty country code is valid (parameter is optional), so only validate non-empty values.
if ( '' !== $country_code && ( strlen( $country_code ) !== 2 || ! ctype_upper( $country_code ) ) ) {
// Log so we can investigate non-empty invalid country codes.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Received invalid country code when getting provider links. Ignoring it.',
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'country' => $country_code,
)
);
$country_code = '';
}
$provider_links = array();
try {
// Try to get the links list from the payment gateway if it provides such method.
if ( method_exists( $payment_gateway, 'get_provider_links' ) &&
is_callable( array( $payment_gateway, 'get_provider_links' ) ) ) {
$provider_links = call_user_func(
array( $payment_gateway, 'get_provider_links' ),
$country_code
);
// Validate and normalize the links list.
$accepted_types = array(
PaymentsProviders::LINK_TYPE_ABOUT,
PaymentsProviders::LINK_TYPE_DOCS,
PaymentsProviders::LINK_TYPE_SUPPORT,
PaymentsProviders::LINK_TYPE_PRICING,
PaymentsProviders::LINK_TYPE_TERMS,
);
$validated_links = array();
if ( is_array( $provider_links ) ) {
foreach ( $provider_links as $link ) {
if ( ! is_array( $link ) ) {
continue;
}
$type = ( isset( $link['_type'] ) && is_scalar( $link['_type'] ) ) ? sanitize_key( (string) $link['_type'] ) : '';
if ( empty( $type ) || ! in_array( $type, $accepted_types, true ) ) {
continue;
}
if ( empty( $link['url'] ) || ! is_string( $link['url'] ) || ! wc_is_valid_url( $link['url'] ) ) {
continue;
}
$url = sanitize_url( $link['url'] );
// Create a unique key for deduplication (type + URL).
$link_key = $type . '|' . $url;
// Skip if we already have this exact link.
if ( isset( $validated_links[ $link_key ] ) ) {
continue;
}
$validated_links[ $link_key ] = array(
'_type' => $type,
'url' => $url,
);
}
}
$provider_links = array_values( $validated_links );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to get provider links: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
return array();
}
return $provider_links;
}
/**
* Check if the payment gateway is enabled.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is enabled, false otherwise.
*/
public function is_enabled( WC_Payment_Gateway $payment_gateway ): bool {
try {
return wc_string_to_bool( $payment_gateway->enabled ?? 'no' );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is enabled: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// If we reach here, just assume that the gateway is not enabled.
return false;
}
/**
* Check if the payment gateway needs setup.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway needs setup, false otherwise.
*/
public function needs_setup( WC_Payment_Gateway $payment_gateway ): bool {
try {
$needs_setup = wc_string_to_bool( $payment_gateway->needs_setup() );
// If we get a true value, it means the gateway needs setup.
if ( $needs_setup ) {
return true;
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway needs setup: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// If we get a false value, it might mean that it doesn't need setup,
// but it can also mean that the gateway does not provide the information and just falls back to the default.
// Check if there is a connected account, as that is the most common indicator of a setup.
if ( ! $this->is_account_connected( $payment_gateway ) ) {
return true;
}
// If we reach here, just assume that the gateway does not need setup.
return false;
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
try {
// Try various gateway methods to check if the payment gateway is in test mode.
if ( is_callable( array( $payment_gateway, 'is_test_mode' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_test_mode() );
}
if ( is_callable( array( $payment_gateway, 'is_in_test_mode' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_in_test_mode() );
}
// Try various gateway public properties to check if the payment gateway is in test mode.
if ( isset( $payment_gateway->testmode ) ) {
return wc_string_to_bool( $payment_gateway->testmode );
}
if ( isset( $payment_gateway->test_mode ) ) {
return wc_string_to_bool( $payment_gateway->test_mode );
}
// Try various gateway option entries to check if the payment gateway is in test mode.
if ( is_callable( array( $payment_gateway, 'get_option' ) ) ) {
$test_mode = filter_var( $payment_gateway->get_option( 'test_mode', 'not_found' ), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );
if ( ! is_null( $test_mode ) ) {
return $test_mode;
}
$test_mode = filter_var( $payment_gateway->get_option( 'testmode', 'not_found' ), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );
if ( ! is_null( $test_mode ) ) {
return $test_mode;
}
$mode = strtolower( (string) $payment_gateway->get_option( 'mode', 'not_found' ) );
if ( in_array( $mode, array( 'test', 'sandbox', 'dev' ), true ) ) {
return true;
} elseif ( in_array( $mode, array( 'live', 'production', 'prod' ), true ) ) {
return false;
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return false;
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
try {
// Try various gateway methods to check if the payment gateway is in dev mode.
if ( is_callable( array( $payment_gateway, 'is_dev_mode' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_dev_mode() );
}
if ( is_callable( array( $payment_gateway, 'is_in_dev_mode' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_in_dev_mode() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in dev mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return false;
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* Note: Be extra careful if you override this method and rely on needs_setup() since it could lead to an infinite loop.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( method_exists( $payment_gateway, 'is_account_connected' ) && is_callable( array( $payment_gateway, 'is_account_connected' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_account_connected() );
}
if ( method_exists( $payment_gateway, 'is_connected' ) && is_callable( array( $payment_gateway, 'is_connected' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_connected() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway account is connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Fall back to assuming that it is connected. This is the safest option.
return true;
}
/**
* Check if the payment gateway supports the current store state for onboarding.
*
* Most of the time the current business location should be the main factor, but could also
* consider other store settings like currency.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which to check.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return bool|null True if the payment gateway supports onboarding, false otherwise.
* If the payment gateway does not provide the information,
* we will return null to indicate that we don't know.
*/
public function is_onboarding_supported( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): ?bool {
try {
if ( method_exists( $payment_gateway, 'is_onboarding_supported' ) &&
is_callable( array( $payment_gateway, 'is_onboarding_supported' ) ) ) {
// Call with positional argument; normalize to bool|null.
$result = call_user_func( array( $payment_gateway, 'is_onboarding_supported' ), $country_code );
// Preserve null to indicate "unknown" state.
if ( is_null( $result ) ) {
return null;
}
if ( is_bool( $result ) ) {
return $result;
}
return filter_var( $result, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway supports onboarding: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'country' => $country_code,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// If we reach here, just assume that we don't know if the gateway supports onboarding.
return null;
}
/**
* Get the message to show when the payment gateway does not support onboarding.
*
* @see self::is_onboarding_supported()
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which to check.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return string|null The message to show when the payment gateway does not support onboarding,
* or null if no specific message should be provided.
*/
public function get_onboarding_not_supported_message( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): ?string {
try {
if ( method_exists( $payment_gateway, 'get_onboarding_not_supported_message' ) &&
is_callable( array( $payment_gateway, 'get_onboarding_not_supported_message' ) ) ) {
$message = call_user_func( array( $payment_gateway, 'get_onboarding_not_supported_message' ), $country_code, );
if ( is_string( $message ) && ! empty( $message ) ) {
return sanitize_textarea_field( trim( $message ) );
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine the gateway onboarding not supported message: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'country' => $country_code,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// If we reach here, just assume that no specific message should be provided.
return null;
}
/**
* Check if the payment gateway has started the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has started the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_started( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( method_exists( $payment_gateway, 'is_onboarding_started' ) && is_callable( array( $payment_gateway, 'is_onboarding_started' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_onboarding_started() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway onboarding started: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Fall back to inferring this from having a connected account.
return $this->is_account_connected( $payment_gateway );
}
/**
* Check if the payment gateway has completed the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has completed the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_completed( WC_Payment_Gateway $payment_gateway ): bool {
// Sanity check: If the onboarding has not started, it cannot be completed.
if ( ! $this->is_onboarding_started( $payment_gateway ) ) {
return false;
}
try {
if ( method_exists( $payment_gateway, 'is_onboarding_completed' ) && is_callable( array( $payment_gateway, 'is_onboarding_completed' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_onboarding_completed() );
}
// Note: This is what WooPayments provides, but it should become standard.
if ( method_exists( $payment_gateway, 'is_account_partially_onboarded' ) && is_callable( array( $payment_gateway, 'is_account_partially_onboarded' ) ) ) {
return ! wc_string_to_bool( $payment_gateway->is_account_partially_onboarded() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway onboarding is completed: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Fall back to inferring this from having a connected account.
return $this->is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
try {
// Try various gateway methods to check if the payment gateway is in test mode onboarding.
if ( method_exists( $payment_gateway, 'is_test_mode_onboarding' ) && is_callable( array( $payment_gateway, 'is_test_mode_onboarding' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_test_mode_onboarding() );
}
if ( method_exists( $payment_gateway, 'is_in_test_mode_onboarding' ) && is_callable( array( $payment_gateway, 'is_in_test_mode_onboarding' ) ) ) {
return wc_string_to_bool( $payment_gateway->is_in_test_mode_onboarding() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode onboarding: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return false;
}
/**
* Get the settings URL for a payment gateway.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The settings URL for the payment gateway.
*/
public function get_settings_url( WC_Payment_Gateway $payment_gateway ): string {
try {
if ( method_exists( $payment_gateway, 'get_settings_url' ) && is_callable( array( $payment_gateway, 'get_settings_url' ) ) ) {
$url = trim( (string) $payment_gateway->get_settings_url() );
if ( ! empty( $url ) && ! wc_is_valid_url( $url ) ) {
// Back-compat: normalize common relative admin URLs.
$url = ltrim( $url, '/' );
// Remove the '/wp-admin/' prefix if it exists.
if ( 0 === strpos( $url, 'wp-admin/' ) ) {
$url = substr( $url, strlen( 'wp-admin/' ) );
}
if ( 0 === strpos( $url, 'admin.php' ) || 0 === strpos( $url, '/admin.php' ) ) {
$url = admin_url( ltrim( $url, '/' ) );
}
}
if ( ! empty( $url ) && wc_is_valid_url( $url ) ) {
return add_query_arg(
array(
'from' => Payments::FROM_PAYMENTS_SETTINGS,
),
$url
);
}
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to get gateway settings URL: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// If we couldn't get a valid settings URL from the gateway, fall back to a general gateway settings URL.
return Utils::wc_payments_settings_url(
null,
array(
'section' => strtolower( $payment_gateway->id ),
'from' => Payments::FROM_PAYMENTS_SETTINGS,
)
);
}
/**
* Get the onboarding URL for the payment gateway.
*
* This URL should start or continue the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $return_url Optional. The URL to return to after onboarding.
* This will likely get attached to the onboarding URL.
*
* @return string The onboarding URL for the payment gateway.
*/
public function get_onboarding_url( WC_Payment_Gateway $payment_gateway, string $return_url = '' ): string {
try {
if ( method_exists( $payment_gateway, 'get_connection_url' ) && is_callable( array( $payment_gateway, 'get_connection_url' ) ) ) {
// If we received no return URL, we will set the WC Payments Settings page as the return URL.
$return_url = ! empty( $return_url ) ? $return_url : admin_url( 'admin.php?page=wc-settings&tab=checkout&from=' . Payments::FROM_PROVIDER_ONBOARDING );
return (string) $payment_gateway->get_connection_url( $return_url );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to get gateway connection URL: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Fall back to pointing users to the payment gateway settings page to handle onboarding.
return $this->get_settings_url( $payment_gateway );
}
/**
* Get the plugin details for a payment gateway.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return array The plugin details for the payment gateway.
*/
public function get_plugin_details( WC_Payment_Gateway $payment_gateway ): array {
$entity_type = $this->get_containing_entity_type( $payment_gateway );
return array(
'_type' => $entity_type,
'slug' => $this->get_plugin_slug( $payment_gateway ),
// Only include the plugin file if the entity type is a regular plugin.
// We don't want to try to change the state of must-use plugins or themes.
'file' => PaymentsProviders::EXTENSION_TYPE_WPORG === $entity_type ? $this->get_plugin_file( $payment_gateway ) : '',
// The gateway's underlying plugin is obviously active (aka the code is running).
'status' => PaymentsProviders::EXTENSION_ACTIVE,
);
}
/**
* Get the source plugin slug of a payment gateway instance.
*
* It accounts for both regular and must-use plugins.
* If the gateway is registered through a theme, it will return the theme slug.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The plugin slug of the payment gateway.
* Empty string if a plugin slug could not be determined.
*/
public function get_plugin_slug( WC_Payment_Gateway $payment_gateway ): string {
global $wp_theme_directories;
// If the payment gateway object has a `plugin_slug` property, use it.
// This is useful for testing.
if ( isset( $payment_gateway->plugin_slug ) ) {
return (string) $payment_gateway->plugin_slug;
}
$gateway_class_filename = $this->get_class_filename( $payment_gateway );
// Bail if we couldn't get the gateway class filename.
if ( ! is_string( $gateway_class_filename ) ) {
return '';
}
$entity_type = $this->get_containing_entity_type( $payment_gateway );
// Bail if we couldn't determine the entity type.
if ( PaymentsProviders::EXTENSION_TYPE_UNKNOWN === $entity_type ) {
return '';
}
if ( PaymentsProviders::EXTENSION_TYPE_THEME === $entity_type ) {
// Find the theme directory it is part of and extract the slug.
// This accounts for both parent and child themes.
if ( is_array( $wp_theme_directories ) ) {
foreach ( $wp_theme_directories as $dir ) {
if ( str_starts_with( $gateway_class_filename, $dir ) ) {
return $this->extract_slug_from_path( substr( $gateway_class_filename, strlen( $dir ) ) );
}
}
}
// Bail if we couldn't find a match.
return '';
}
// By this point, we know that the payment gateway is part of a plugin.
// Extract the relative path of the class file to the plugins directory.
// We account for both regular and must-use plugins.
$gateway_class_plugins_path = trim( plugin_basename( $gateway_class_filename ), DIRECTORY_SEPARATOR );
return $this->extract_slug_from_path( $gateway_class_plugins_path );
}
/**
* Get the corresponding plugin file of the payment gateway, without the .php extension.
*
* This is useful for using the WP API to change the state of the plugin (activate or deactivate).
* We remove the .php extension since the WP API expects plugin files without it.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $plugin_slug Optional. The payment gateway plugin slug to use directly.
*
* @return string The plugin file corresponding to the payment gateway plugin. Does not include the .php extension.
* In case of failures, it will return an empty string.
*/
public function get_plugin_file( WC_Payment_Gateway $payment_gateway, string $plugin_slug = '' ): string {
// If the payment gateway object has a `plugin_file` property, use it.
// This is useful for testing.
if ( isset( $payment_gateway->plugin_file ) ) {
$plugin_file = $payment_gateway->plugin_file;
// Sanity check.
if ( ! is_string( $plugin_file ) ) {
return '';
}
// Remove the .php extension from the file path. The WP API expects it without it.
return Utils::trim_php_file_extension( $plugin_file );
}
if ( empty( $plugin_slug ) ) {
$plugin_slug = $this->get_plugin_slug( $payment_gateway );
}
// Bail if we couldn't determine the plugin slug.
if ( empty( $plugin_slug ) ) {
return '';
}
$plugin_file = PluginsHelper::get_plugin_path_from_slug( $plugin_slug );
// Bail if we couldn't determine the plugin file.
if ( ! is_string( $plugin_file ) || empty( $plugin_file ) ) {
return '';
}
// Remove the .php extension from the file path. The WP API expects it without it.
return Utils::trim_php_file_extension( $plugin_file );
}
/**
* Try and determine a list of recommended payment methods for a payment gateway.
*
* This data is not always available, and it is up to the payment gateway to provide it.
* This is not a definitive list of payment methods that the gateway supports.
* The data is aimed at helping the user understand what payment methods are recommended for the gateway
* and potentially help them make a decision on which payment methods to enable.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which to get recommended payment methods.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The recommended payment methods list for the payment gateway.
* Empty array if there are none.
*/
public function get_recommended_payment_methods( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): array {
// Bail if the payment gateway does not implement the method.
if ( ! method_exists( $payment_gateway, 'get_recommended_payment_methods' ) ||
! is_callable( array( $payment_gateway, 'get_recommended_payment_methods' ) ) ) {
return array();
}
try {
// Get the "raw" recommended payment methods from the payment gateway.
$recommended_pms = call_user_func( array( $payment_gateway, 'get_recommended_payment_methods' ), $country_code );
if ( ! is_array( $recommended_pms ) ) {
// Bail if the recommended payment methods are not an array.
return array();
}
} catch ( Throwable $e ) {
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to get recommended payment methods: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'country' => $country_code,
'source' => 'settings-payments',
'exception' => $e,
)
);
return array();
}
// Validate the received list items.
$recommended_pms = array_filter(
$recommended_pms,
array( $this, 'validate_recommended_payment_method' )
);
// Sort the list.
$recommended_pms = $this->sort_recommended_payment_methods( $recommended_pms );
// Extract, standardize, and sanitize the details for each recommended payment method.
$standardized_pms = array();
foreach ( $recommended_pms as $index => $recommended_pm ) {
// Use the index as the order since we sorted (and normalized) the list earlier.
$standardized_pms[] = $this->standardize_recommended_payment_method( $recommended_pm, $index );
}
return $standardized_pms;
}
/**
* Validate a recommended payment method entry.
*
* @param mixed $recommended_pm The recommended payment method entry to validate.
*
* @return bool True if the recommended payment method entry is valid, false otherwise.
*/
protected function validate_recommended_payment_method( $recommended_pm ): bool {
// We require at least `id` and `title`.
return is_array( $recommended_pm ) &&
! empty( $recommended_pm['id'] ) &&
! empty( $recommended_pm['title'] );
}
/**
* Sort the recommended payment methods.
*
* @param array $recommended_pms The recommended payment methods list to sort.
*
* @return array The sorted recommended payment methods list.
* List keys are not preserved.
*/
protected function sort_recommended_payment_methods( array $recommended_pms ): array {
// Sort the recommended payment methods by order/priority, if available.
usort(
$recommended_pms,
function ( $a, $b ) {
// `order` takes precedence over `priority`.
// Entries that don't have the order/priority are placed at the end.
return array( ( $a['order'] ?? PHP_INT_MAX ), ( $a['priority'] ?? PHP_INT_MAX ) ) <=> array( ( $b['order'] ?? PHP_INT_MAX ), ( $b['priority'] ?? PHP_INT_MAX ) );
}
);
return array_values( $recommended_pms );
}
/**
* Standardize a recommended payment method entry.
*
* @param array $recommended_pm The recommended payment method entry to standardize.
* @param int $order Optional. The order of the recommended payment method.
* Defaults to 0 if not provided.
*
* @return array The standardized recommended payment method entry.
*/
protected function standardize_recommended_payment_method( array $recommended_pm, int $order = 0 ): array {
$standard_details = array(
'id' => sanitize_key( $recommended_pm['id'] ),
'_order' => $order,
// Default to enabled if not explicit.
'enabled' => wc_string_to_bool( $recommended_pm['enabled'] ?? true ),
// Default to not required if not explicit.
'required' => wc_string_to_bool( $recommended_pm['required'] ?? false ),
'title' => sanitize_text_field( $recommended_pm['title'] ),
'description' => '',
'icon' => '',
'category' => self::PAYMENT_METHOD_CATEGORY_PRIMARY, // Default to primary.
);
// If the payment method has a description, sanitize it before use.
if ( ! empty( $recommended_pm['description'] ) ) {
$standard_details['description'] = (string) $recommended_pm['description'];
// Make sure that if we have HTML tags, we only allow stylistic tags and anchors.
if ( preg_match( '/<[^>]+>/', $standard_details['description'] ) ) {
// Only allow stylistic tags with a few modifications.
$allowed_tags = wp_kses_allowed_html( 'data' );
$allowed_tags = array_merge(
$allowed_tags,
array(
'a' => array(
'href' => true,
'target' => true,
),
)
);
$standard_details['description'] = wp_kses( $standard_details['description'], $allowed_tags );
}
}
// If the payment method has an icon, try to use it.
if ( ! empty( $recommended_pm['icon'] ) && wc_is_valid_url( $recommended_pm['icon'] ) ) {
$standard_details['icon'] = sanitize_url( $recommended_pm['icon'] );
}
// If the payment method has a category, use it if it's one of the known categories.
if ( ! empty( $recommended_pm['category'] ) &&
in_array( $recommended_pm['category'], array( self::PAYMENT_METHOD_CATEGORY_PRIMARY, self::PAYMENT_METHOD_CATEGORY_SECONDARY ), true ) ) {
$standard_details['category'] = $recommended_pm['category'];
}
return $standard_details;
}
/**
* Get the filename of the payment gateway class.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string|null The filename of the payment gateway class or null if it cannot be determined.
*/
private function get_class_filename( WC_Payment_Gateway $payment_gateway ): ?string {
// If the payment gateway object has a `class_filename` property, use it.
// It is only used in development environments (including when running tests).
if ( isset( $payment_gateway->class_filename ) && in_array( wp_get_environment_type(), array( 'local', 'development' ), true ) ) {
$class_filename = $payment_gateway->class_filename;
} else {
try {
$reflector = new \ReflectionClass( get_class( $payment_gateway ) );
$class_filename = $reflector->getFileName();
} catch ( Throwable $e ) {
// Bail but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to get gateway class filename: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
return null;
}
}
// Bail if we couldn't get the gateway class filename.
if ( ! is_string( $class_filename ) ) {
return null;
}
return $class_filename;
}
/**
* Get the type of entity the payment gateway class is contained in.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The type of extension containing the payment gateway class.
*/
private function get_containing_entity_type( WC_Payment_Gateway $payment_gateway ): string {
global $wp_plugin_paths, $wp_theme_directories;
// If the payment gateway object has a `extension_type` property, use it.
// This is useful for testing.
if ( isset( $payment_gateway->extension_type ) ) {
// Validate the extension type.
if ( ! in_array(
$payment_gateway->extension_type,
array(
PaymentsProviders::EXTENSION_TYPE_WPORG,
PaymentsProviders::EXTENSION_TYPE_MU_PLUGIN,
PaymentsProviders::EXTENSION_TYPE_THEME,
),
true
) ) {
return PaymentsProviders::EXTENSION_TYPE_UNKNOWN;
}
return $payment_gateway->extension_type;
}
$gateway_class_filename = $this->get_class_filename( $payment_gateway );
// Bail if we couldn't get the gateway class filename.
if ( ! is_string( $gateway_class_filename ) ) {
return PaymentsProviders::EXTENSION_TYPE_UNKNOWN;
}
// Plugin paths logic closely matches the one in plugin_basename().
// $wp_plugin_paths contains normalized paths.
$file = wp_normalize_path( $gateway_class_filename );
arsort( $wp_plugin_paths );
// Account for symlinks in the plugin paths.
foreach ( $wp_plugin_paths as $dir => $realdir ) {
if ( str_starts_with( $file, $realdir ) ) {
$gateway_class_filename = $dir . substr( $gateway_class_filename, strlen( $realdir ) );
}
}
// Test for regular plugins.
if ( str_starts_with( $gateway_class_filename, wp_normalize_path( WP_PLUGIN_DIR ) ) ) {
// For now, all plugins are considered WordPress.org plugins.
return PaymentsProviders::EXTENSION_TYPE_WPORG;
}
// Test for must-use plugins.
if ( str_starts_with( $gateway_class_filename, wp_normalize_path( WPMU_PLUGIN_DIR ) ) ) {
return PaymentsProviders::EXTENSION_TYPE_MU_PLUGIN;
}
// Check if it is part of a theme.
if ( is_array( $wp_theme_directories ) ) {
foreach ( $wp_theme_directories as $dir ) {
// Check if the class file is in a theme directory.
if ( str_starts_with( $gateway_class_filename, $dir ) ) {
return PaymentsProviders::EXTENSION_TYPE_THEME;
}
}
}
// Default to an unknown type.
return PaymentsProviders::EXTENSION_TYPE_UNKNOWN;
}
/**
* Extract the slug from a given path.
*
* It can be a directory or file path.
* This should be a relative path since the top-level directory or file name will be used as the slug.
*
* @param string $path The path to extract the slug from.
*
* @return string The slug extracted from the path.
*/
private function extract_slug_from_path( string $path ): string {
$path = trim( $path );
$path = trim( $path, DIRECTORY_SEPARATOR );
// If the path is just a file name, use it as the slug.
if ( false === strpos( $path, DIRECTORY_SEPARATOR ) ) {
return Utils::trim_php_file_extension( $path );
}
$parts = explode( DIRECTORY_SEPARATOR, $path );
// Bail if we couldn't get the parts.
if ( ! is_array( $parts ) ) {
return '';
}
return reset( $parts );
}
}
PK [1].T - Admin/Settings/PaymentsProviders/Paytrail.phpnu get_option( 'enable_test_mode', 'no' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_in_test_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
// When in test mode onboarding, hard coded credentials are used, so we consider it connected.
if ( $this->is_in_test_mode_onboarding( $payment_gateway ) ) {
return true;
}
return ! empty( $payment_gateway->get_option( 'merchant_id' ) ) &&
! empty( $payment_gateway->get_option( 'secret_key' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for Paytrail, affecting the API keys used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1]x\ . Admin/Settings/PaymentsProviders/AmazonPay.phpnu is_amazon_pay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_amazon_pay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_amazon_pay_onboarded( $payment_gateway ) ?? parent::is_account_connected( $payment_gateway );
}
/**
* Check if the payment gateway has completed the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has completed the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_completed( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_amazon_pay_onboarded( $payment_gateway ) ?? parent::is_onboarding_completed( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_amazon_pay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the AmazonPay payment gateway is in sandbox mode.
*
* For AmazonPay, there are two different environments: sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_amazon_pay_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
if ( class_exists( '\WC_Amazon_Payments_Advanced_API' ) &&
is_callable( '\WC_Amazon_Payments_Advanced_API::get_settings' ) ) {
$settings = \WC_Amazon_Payments_Advanced_API::get_settings();
if ( isset( $settings['sandbox'] ) ) {
return wc_string_to_bool( $settings['sandbox'] );
}
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
/**
* Check if the AmazonPay payment gateway is onboarded.
*
* For AmazonPay, there are two different environments: sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is onboarded, false otherwise.
* Null if we failed to determine the onboarding status.
*/
private function is_amazon_pay_onboarded( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
if ( class_exists( '\WC_Amazon_Payments_Advanced_API' ) &&
is_callable( '\WC_Amazon_Payments_Advanced_API::validate_api_settings' ) ) {
return true === \WC_Amazon_Payments_Advanced_API::validate_api_settings();
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is onboarded: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the onboarding status.
return null;
}
}
PK [1]*a a ; Admin/Settings/PaymentsProviders/PseudoWCPaymentGateway.phpnu id = $id;
// Go through the props and set them on the object.
foreach ( $props as $prop => $value ) {
$this->$prop = $value;
}
}
/**
* Return whether or not this gateway still requires setup to function.
*
* @return bool
*/
public function needs_setup() {
return $this->needs_setup;
}
/**
* Get the gateway settings page URL.
*
* @return string The gateway settings page URL.
*/
public function get_settings_url(): string {
if ( isset( $this->settings_url ) ) {
return $this->settings_url;
}
return admin_url( 'admin.php?page=wc-settings&tab=checkout§ion=' . strtolower( $this->id ) );
}
/**
* Get the gateway onboarding start/continue URL.
*
* @return string The gateway onboarding start/continue URL.
*/
public function get_connection_url(): string {
if ( isset( $this->connection_url ) ) {
return $this->connection_url;
}
return $this->get_settings_url();
}
/**
* Get the recommended payment methods list.
*
* @param string $country_code Optional. The business location country code.
*
* @return array List of recommended payment methods for the given country.
*/
public function get_recommended_payment_methods( string $country_code = '' ): array {
return $this->recommended_payment_methods;
}
/**
* Check if the gateway is in test mode.
*
* @return bool True if the gateway is in test mode, false otherwise.
*/
public function is_test_mode(): bool {
return $this->test_mode;
}
/**
* Check if the gateway is in dev mode.
*
* @return bool True if the gateway is in dev mode, false otherwise.
*/
public function is_dev_mode(): bool {
return $this->dev_mode;
}
/**
* Check if the gateway has an account connected.
*
* @return bool True if the gateway has an account connected, false otherwise.
*/
public function is_account_connected(): bool {
return $this->account_connected;
}
/**
* Check if the gateway has started onboarding.
*
* @return bool True if the gateway has started onboarding, false otherwise.
*/
public function is_onboarding_started(): bool {
return $this->onboarding_started;
}
/**
* Check if the gateway has completed onboarding.
*
* @return bool True if the gateway has completed onboarding, false otherwise.
*/
public function is_onboarding_completed(): bool {
return $this->onboarding_completed;
}
/**
* Check if the gateway is in test mode onboarding.
*
* @return bool True if the gateway is in test mode onboarding, false otherwise.
*/
public function is_test_mode_onboarding(): bool {
return $this->test_mode_onboarding;
}
}
PK [1]l; ; + Admin/Settings/PaymentsProviders/WCCore.phpnu id ) {
case WC_Gateway_BACS::ID:
return plugins_url( 'assets/images/payment_methods/bacs.svg', WC_PLUGIN_FILE );
case WC_Gateway_Cheque::ID:
return plugins_url( 'assets/images/payment_methods/cheque.svg', WC_PLUGIN_FILE );
case WC_Gateway_COD::ID:
return plugins_url( 'assets/images/payment_methods/cod.svg', WC_PLUGIN_FILE );
case WC_Gateway_Paypal::ID:
return plugins_url( 'assets/images/payment_methods/72x72/paypal.png', WC_PLUGIN_FILE );
}
return parent::get_icon( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
// Provide custom account connected logic for core payment gateways.
switch ( $payment_gateway->id ) {
case WC_Gateway_BACS::ID:
// BACS requires bank account details to be set up.
return property_exists( $payment_gateway, 'account_details' ) && ! empty( $payment_gateway->account_details );
case WC_Gateway_Cheque::ID:
case WC_Gateway_COD::ID:
// There is no account setup for these gateways, so we return true.
return true;
case WC_Gateway_Paypal::ID:
// PayPal requires just an account email address to be set up.
return property_exists( $payment_gateway, 'email' ) && is_email( $payment_gateway->email );
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Provide custom test mode onboarding logic for core payment gateways.
switch ( $payment_gateway->id ) {
case WC_Gateway_BACS::ID:
case WC_Gateway_Cheque::ID:
case WC_Gateway_COD::ID:
return false; // These gateways do not have a test mode onboarding.
case WC_Gateway_Paypal::ID:
// Test mode is actually sandbox mode for PayPal, affecting the API keys used.
return $this->is_in_test_mode( $payment_gateway );
}
return parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Get the plugin details for a WC core-provided payment gateway.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return array The plugin details for the payment gateway.
*/
public function get_plugin_details( WC_Payment_Gateway $payment_gateway ): array {
$plugin_details = parent::get_plugin_details( $payment_gateway );
// Since these are core-provided gateways, we need to make sure that the provider (WC) can't be deactivated.
// The way to do this is to NOT provide a plugin file path.
$plugin_details['file'] = '';
return $plugin_details;
}
}
PK [1]! * Admin/Settings/PaymentsProviders/Monei.phpnu getAccountId() ) &&
! empty( $payment_gateway->getApiKey() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for Monei, affecting the API keys used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1]ނ7 7 - Admin/Settings/PaymentsProviders/Paystack.phpnu is_valid_for_use() );
}
return ! $is_valid_for_use || ! $this->is_account_connected( $payment_gateway );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway needs setup: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::needs_setup( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
return property_exists( $payment_gateway, 'public_key' ) && ! empty( $payment_gateway->public_key ) &&
property_exists( $payment_gateway, 'secret_key' ) && ! empty( $payment_gateway->secret_key );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for Paystack, affecting the used API keys.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1]h! . Admin/Settings/PaymentsProviders/Airwallex.phpnu is_airwallex_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( class_exists( '\Airwallex\Services\Util' ) &&
is_callable( '\Airwallex\Services\Util::getClientId' ) &&
is_callable( '\Airwallex\Services\Util::getApiKey' ) &&
is_callable( '\Airwallex\Services\Util::getWebhookSecret' ) ) {
return ! empty( \Airwallex\Services\Util::getClientId() ) &&
! empty( \Airwallex\Services\Util::getApiKey() ) &&
! empty( \Airwallex\Services\Util::getWebhookSecret() );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_airwallex_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Airwallex payment gateway is in sandbox mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_airwallex_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
if ( class_exists( '\Airwallex\Services\Util' ) &&
is_callable( '\Airwallex\Services\Util::getEnvironment' ) ) {
return 'demo' === \Airwallex\Services\Util::getEnvironment();
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1][ , Admin/Settings/PaymentsProviders/Payfast.phpnu get_option( 'merchant_id' ) ) &&
! empty( $payment_gateway->get_option( 'merchant_key' ) ) &&
! empty( $payment_gateway->get_option( 'pass_phrase' ) ) &&
! wc_string_to_bool( get_option( 'woocommerce_payfast_invalid_credentials', 'no' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for Payfast, affecting the API endpoints used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1]? J Admin/Settings/PaymentsProviders/WooPayments/WooPaymentsRestController.phpnu route_namespace,
'/' . $this->rest_base . '/onboarding',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_onboarding_details' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
'schema' => fn() => $this->get_schema_for_get_onboarding_details(),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P[a-zA-Z0-9_-]+)/start',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_start' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P[a-zA-Z0-9_-]+)/save',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_save' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P[a-zA-Z0-9_-]+)/check',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_check' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P[a-zA-Z0-9_-]+)/finish',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_finish' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/(?P[a-zA-Z0-9_-]+)/clean',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_step_clean' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
// Onboarding step specific routes.
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_TEST_ACCOUNT . '/init',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_test_account_init' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_TEST_ACCOUNT . '/reset',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_test_account_reset' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/kyc_session',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_business_verification_kyc_session_init' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/kyc_session/finish',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_business_verification_kyc_session_finish' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
// This is a route to disable test accounts for the native onboarding UX.
// The handler is the same as the one for the non-native onboarding UX.
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/step/' . WooPaymentsService::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/test_account/disable',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_test_account_disable' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'from' => array(
'description' => esc_html__( 'Where from in the onboarding flow this request was triggered.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/preload',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_onboarding_preload' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/reset',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'reset_onboarding' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'from' => array(
'description' => esc_html__( 'Where from in the onboarding flow this request was triggered.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/woopay-eligibility',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_woopay_eligibility' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
),
),
$override
);
// This is the route to disable test accounts when not in a native in-context UX.
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/onboarding/test_account/disable',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'handle_test_account_disable' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to the stored providers business location country code.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
'from' => array(
'description' => esc_html__( 'Where from in the onboarding flow this request was triggered.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
'source' => array(
'description' => esc_html__( 'The upmost entry point from where the merchant entered the onboarding flow.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_text_field',
),
),
),
),
$override
);
}
/**
* Get the controller's REST URL path.
*
* @param string $relative_path Optional. Relative path to append to the REST URL.
*
* @return string The REST URL path.
*/
public function get_rest_url_path( string $relative_path = '' ): string {
$path = '/' . trim( $this->route_namespace, '/' ) . '/' . trim( $this->rest_base, '/' );
if ( ! empty( $relative_path ) ) {
$path .= '/' . ltrim( $relative_path, '/' );
}
return $path;
}
/**
* Initialize the class instance.
*
* @param Payments $payments The general payments settings page service.
* @param WooPaymentsService $woopayments The WooPayments-specific Payments settings page service.
*
* @internal
*/
final public function init( Payments $payments, WooPaymentsService $woopayments ): void {
$this->payments = $payments;
$this->woopayments = $woopayments;
}
/**
* Get the onboarding details for the given location.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function get_onboarding_details( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
$onboarding_details = $this->woopayments->get_onboarding_details( $location, $this->get_rest_url_path( 'onboarding' ), $source );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_woopayments_onboarding_error', $e->getMessage(), array( 'status' => WP_Http::INTERNAL_SERVER_ERROR ) );
}
return rest_ensure_response( $this->prepare_onboarding_details_response( $onboarding_details ) );
}
/**
* Handle the onboarding step start action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_start( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
$previous_status = $this->woopayments->get_onboarding_step_status( $step_id, $location );
$this->woopayments->mark_onboarding_step_started( $step_id, $location, false, $source );
$response = array(
'success' => true,
'previous_status' => $previous_status,
'current_status' => $this->woopayments->get_onboarding_step_status( $step_id, $location ),
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding step save action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response.
*/
protected function handle_onboarding_step_save( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
$this->woopayments->onboarding_step_save( $step_id, $location, $request->get_params() );
// If some step data was saved, we also ensure that the step is marked as started, if not already.
// This way we maintain onboarding state consistency if the frontend does not call the start endpoint.
$this->woopayments->mark_onboarding_step_started( $step_id, $location, false, $source );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( array( 'success' => true ) );
}
/**
* Handle the onboarding step check action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_check( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$result = $this->woopayments->onboarding_step_check( $step_id, $location );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
// Merge the result with the success flag.
$response = array_merge( array( 'success' => true ), $result );
return rest_ensure_response( $response );
}
/**
* Handle the onboarding step finish action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_finish( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
$previous_status = $this->woopayments->get_onboarding_step_status( $step_id, $location );
$this->woopayments->mark_onboarding_step_completed( $step_id, $location, false, $source );
$response = array(
'success' => true,
'previous_status' => $previous_status,
'current_status' => $this->woopayments->get_onboarding_step_status( $step_id, $location ),
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding step clean action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_step_clean( WP_REST_Request $request ) {
$step_id = $request->get_param( 'step' ) ?? '';
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$previous_status = $this->woopayments->get_onboarding_step_status( $step_id, $location );
$this->woopayments->clean_onboarding_step_progress( $step_id, $location );
$response = array(
'success' => true,
'previous_status' => $previous_status,
'current_status' => $this->woopayments->get_onboarding_step_status( $step_id, $location ),
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding test account initialize action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_test_account_init( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
// Mark the step as started, if not already.
$this->woopayments->mark_onboarding_step_started( WooPaymentsService::ONBOARDING_STEP_TEST_ACCOUNT, $location, false, $source );
$result = $this->woopayments->onboarding_test_account_init( $location, $source );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array_merge(
array( 'success' => true ),
$result
)
);
}
/**
* Handle the onboarding test account reset action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_test_account_reset( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
// For now, just "forward" the request to the generic onboarding reset endpoint.
$request->set_param( 'location', $location );
$request->set_param( 'from', WooPaymentsService::ONBOARDING_STEP_TEST_ACCOUNT );
$request->set_param( 'source', $source );
return $this->reset_onboarding( $request );
}
/**
* Handle the onboarding business verification step KYC session initialization action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_business_verification_kyc_session_init( WP_REST_Request $request ) {
// If we receive self-assessment data with the request, we will use it.
$self_assessment = ! empty( $request->get_param( 'self_assessment' ) ) ? wc_clean( wp_unslash( $request->get_param( 'self_assessment' ) ) ) : array();
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
$account_session = $this->woopayments->get_onboarding_kyc_session( $location, $self_assessment, $source );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array(
'success' => true,
'session' => $account_session,
)
);
}
/**
* Handle the onboarding business verification step KYC session finish action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_business_verification_kyc_session_finish( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
$source = $request->get_param( 'source' );
try {
$response = $this->woopayments->finish_onboarding_kyc_session( $location, $source );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
// If there is no success key in the response, we assume the operation was successful.
if ( ! isset( $response['success'] ) ) {
$response['success'] = true;
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding preload action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_onboarding_preload( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$response = $this->woopayments->onboarding_preload( $location );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
// If there is no success key in the response, we assume the operation was successful.
if ( ! isset( $response['success'] ) ) {
$response['success'] = true;
}
return rest_ensure_response( $response );
}
/**
* Handle the onboarding reset action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function reset_onboarding( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$this->woopayments->reset_onboarding( $location, $request->get_param( 'from' ) ?? '', $request->get_param( 'source' ) ?? '' );
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array(
'success' => true,
)
);
}
/**
* Handle the onboarding test mode disable action.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response The response or error.
*/
protected function handle_test_account_disable( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$this->woopayments->disable_test_account(
$location,
$request->get_param( 'from' ) ?? '',
$request->get_param( 'source' ) ?? ''
);
} catch ( ApiException $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
return rest_ensure_response(
array(
'success' => true,
)
);
}
/**
* Get WooPay eligibility status.
*
* @return WP_REST_Response The response.
*/
protected function get_woopay_eligibility() {
// We use the Payments Settings stored business location to determine the eligibility.
$location = $this->payments->get_country();
$woopay_eligible_countries = array( 'US' );
$is_eligible = in_array( $location, $woopay_eligible_countries, true );
return rest_ensure_response(
array(
'is_eligible' => $is_eligible,
)
);
}
/**
* General permissions check for WooPayments settings REST API endpoint.
*
* @param WP_REST_Request $request The request for which the permission is checked.
*
* @return bool|WP_Error True if the current user has the capability, otherwise an "Unauthorized" error or False if no error is available for the request method.
*/
private function check_permissions( WP_REST_Request $request ) {
$context = 'read';
if ( 'POST' === $request->get_method() ) {
$context = 'edit';
} elseif ( 'DELETE' === $request->get_method() ) {
$context = 'delete';
}
if ( wc_rest_check_manager_permissions( 'payment_gateways', $context ) ) {
return true;
}
$error_information = $this->get_authentication_error_by_method( $request->get_method() );
if ( is_null( $error_information ) ) {
return false;
}
return new WP_Error(
$error_information['code'],
$error_information['message'],
array( 'status' => rest_authorization_required_code() )
);
}
/**
* Validate the location argument.
*
* @param mixed $value Value of the argument.
* @param WP_REST_Request $request The current request object.
*
* @return WP_Error|true True if the location argument is valid, otherwise a WP_Error object.
*/
private function check_location_arg( $value, WP_REST_Request $request ) {
// If the 'location' argument is not a string return an error.
if ( ! is_string( $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The location argument must be a string.', 'woocommerce' ), array( 'status' => 400 ) );
}
// Get the registered attributes for this endpoint request.
$attributes = $request->get_attributes();
// Grab the location param schema.
$args = $attributes['args']['location'];
// If the location param doesn't match the regex pattern then we should return an error as well.
if ( ! preg_match( '/^' . $args['pattern'] . '$/', $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The location argument must be a valid ISO3166 alpha-2 country code.', 'woocommerce' ), array( 'status' => 400 ) );
}
return true;
}
/**
* Prepare the response for the GET onboarding details request.
*
* @param array $response The response to prepare.
*
* @return array The prepared response.
*/
private function prepare_onboarding_details_response( array $response ): array {
return $this->prepare_onboarding_details_response_recursive( $response, $this->get_schema_for_get_onboarding_details() );
}
/**
* Recursively prepare the response items for the GET onboarding details request.
*
* @param mixed $response_item The response item to prepare.
* @param array $schema The schema to use for preparing the response.
*
* @return mixed The prepared response item.
*/
private function prepare_onboarding_details_response_recursive( $response_item, array $schema ) {
if ( is_null( $response_item ) ) {
return null;
}
if ( ! array_key_exists( 'properties', $schema ) ||
! is_array( $schema['properties'] ) ) {
// Filter out null values for loosely defined schema types.
if ( is_array( $response_item ) ) {
return ArrayUtil::filter_null_values_recursive( $response_item );
}
return $response_item;
}
$prepared_response = array();
foreach ( $schema['properties'] as $key => $property_schema ) {
if ( is_array( $response_item ) && array_key_exists( $key, $response_item ) ) {
if ( is_array( $property_schema ) && array_key_exists( 'properties', $property_schema ) ) {
$prepared_response[ $key ] = $this->prepare_onboarding_details_response_recursive( $response_item[ $key ], $property_schema );
} elseif ( is_array( $property_schema ) && array_key_exists( 'items', $property_schema ) ) {
$prepared_response[ $key ] = array_map(
fn( $item ) => $this->prepare_onboarding_details_response_recursive( $item, $property_schema['items'] ),
$response_item[ $key ]
);
} else {
$prepared_response[ $key ] = $response_item[ $key ];
}
}
}
// Ensure the order is the same as in the schema.
$prepared_response = array_merge( array_fill_keys( array_keys( $schema['properties'] ), null ), $prepared_response );
// Remove any null values from the response.
return ArrayUtil::filter_null_values_recursive( $prepared_response );
}
/**
* Get the schema for the GET onboarding details request.
*
* @return array[]
*/
private function get_schema_for_get_onboarding_details(): array {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'WooCommerce Settings Payments WooPayments onboarding details for the given location.',
'type' => 'object',
);
$schema['properties'] = array(
'state' => array(
'type' => 'object',
'description' => esc_html__( 'The general state of the onboarding process.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'supported' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether onboarding is supported.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'started' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the onboarding process is started.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'completed' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the onboarding process is completed.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'test_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the onboarding process is in test mode.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'dev_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether WooPayments is in dev mode.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'messages' => array(
'type' => 'object',
'description' => esc_html__( 'Various messages to possibly show the user.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'additionalProperties' => array(
'type' => 'string',
'description' => esc_html__( 'Message to show the user.', 'woocommerce' ),
'readonly' => true,
),
),
'steps' => array(
'type' => 'array',
'description' => esc_html__( 'The onboarding steps.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'path' => array(
'type' => 'string',
'description' => esc_html__( 'The relative path of the step to use for frontend navigation.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'required_steps' => array(
'type' => 'array',
'description' => esc_html__( 'The steps that are required to be completed before this step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
),
),
'status' => array(
'type' => 'string',
'description' => esc_html__( 'The current status of the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'enum' => array(
WooPaymentsService::ONBOARDING_STEP_STATUS_NOT_STARTED,
WooPaymentsService::ONBOARDING_STEP_STATUS_STARTED,
WooPaymentsService::ONBOARDING_STEP_STATUS_COMPLETED,
),
),
'errors' => array(
'type' => 'array',
'description' => esc_html__( 'Errors list for the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'code' => array(
'type' => 'string',
'readonly' => true,
),
'message' => array(
'type' => 'string',
'readonly' => true,
),
'context' => array(
'type' => 'object',
'readonly' => true,
),
),
),
),
'actions' => array(
'type' => 'object',
'description' => esc_html__( 'The available actions for the step.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'start' => array(
'type' => 'object',
'description' => esc_html__( 'Action to signal the step start.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'save' => array(
'type' => 'object',
'description' => esc_html__( 'Action to save step information in the database.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'check' => array(
'type' => 'object',
'description' => esc_html__( 'Action to check the step status.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'finish' => array(
'type' => 'object',
'description' => esc_html__( 'Action to signal the step completion.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'clean' => array(
'type' => 'object',
'description' => esc_html__( 'Action to clean the step progress.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'auth' => array(
'type' => 'object',
'description' => esc_html__( 'Action to authorize the WPCOM connection.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'init' => array(
'type' => 'object',
'description' => esc_html__( 'Action to initialize a test account.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'kyc_session' => array(
'type' => 'object',
'description' => esc_html__( 'Action to create or resume an embedded KYC session.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'kyc_session_finish' => array(
'type' => 'object',
'description' => esc_html__( 'Action to finish an embedded KYC session.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'kyc_fallback' => array(
'type' => 'object',
'description' => esc_html__( 'Action to use as a fallback when dealing with errors with the embedded KYC.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'reset' => array(
'type' => 'object',
'description' => esc_html__( 'Action to reset the onboarding process, either partially, for a certain step, or fully.', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'test_account_disable' => array(
'type' => 'object',
'description' => esc_html__( 'Action to disable the test account currently in use', 'woocommerce' ),
'properties' => $this->get_schema_properties_for_onboarding_step_action(),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'context' => array(
'type' => 'object',
'description' => esc_html__( 'Various contextual data for the step to use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'context' => array(
'type' => 'object',
'description' => esc_html__( 'Various contextual data for the onboarding process to use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
);
return $schema;
}
/**
* Get the schema properties for an onboarding step action.
*
* @return array[] The schema properties for an onboarding step action.
*/
private function get_schema_properties_for_onboarding_step_action(): array {
return array(
'type' => array(
'type' => 'string',
'description' => esc_html__( 'The action type to determine how to use the URL.', 'woocommerce' ),
'enum' => array( WooPaymentsService::ACTION_TYPE_REST, WooPaymentsService::ACTION_TYPE_REDIRECT ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to use for the action.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
);
}
}
PK [1]8+4Ϙ Ϙ C Admin/Settings/PaymentsProviders/WooPayments/WooPaymentsService.phpnu payments_providers = $payment_providers;
$this->proxy = $proxy;
$this->wpcom_connection_manager = $this->proxy->get_instance_of( WPCOM_Connection_Manager::class, 'woocommerce' );
$this->provider = $this->payments_providers->get_payment_gateway_provider_instance( self::GATEWAY_ID );
}
/**
* Get the onboarding details for the Payments settings page.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $rest_path The REST API path to use for constructing REST API URLs.
* @param string|null $source Optional. The source for the onboarding flow.
*
* @return array The onboarding details.
* @throws ApiException If the onboarding action can not be performed due to the current state of the site.
* @throws Exception If there were errors when generating the onboarding details.
*/
public function get_onboarding_details( string $location, string $rest_path, ?string $source = null ): array {
// Since getting the onboarding details is not idempotent, we will check it as an action.
$this->check_if_onboarding_action_is_acceptable();
$source = $this->validate_onboarding_source( $source );
$gateway = $this->get_payment_gateway();
$onboarding_supported = $this->provider->is_onboarding_supported( $gateway, $location ) ?? true;
$onboarding_started = $this->provider->is_onboarding_started( $gateway );
if ( ! $onboarding_started && ! empty( $this->get_nox_profile_onboarding( $location ) ) ) {
// If the onboarding profile is stored, we consider the onboarding started.
$onboarding_started = true;
}
return array(
// This state is high-level data, independent of the type of onboarding flow.
'state' => array(
'supported' => $onboarding_supported,
'started' => $onboarding_started,
'completed' => $this->provider->is_onboarding_completed( $gateway ),
'test_mode' => $this->provider->is_in_test_mode_onboarding( $gateway ),
'dev_mode' => $this->provider->is_in_dev_mode( $gateway ),
),
'messages' => array(
'not_supported' => ! $onboarding_supported ? $this->provider->get_onboarding_not_supported_message( $gateway, $location ) : null,
),
'steps' => $this->get_onboarding_steps( $location, trailingslashit( $rest_path ) . 'step', $source ),
'context' => array(
'urls' => array(
'overview_page' => $this->get_overview_page_url(),
),
),
);
}
/**
* Check if the given onboarding step ID is valid.
*
* @param string $step_id The ID of the onboarding step.
*
* @return bool Whether the given onboarding step ID is valid.
*/
public function is_valid_onboarding_step_id( string $step_id ): bool {
return in_array(
$step_id,
array(
self::ONBOARDING_STEP_PAYMENT_METHODS,
self::ONBOARDING_STEP_WPCOM_CONNECTION,
self::ONBOARDING_STEP_TEST_ACCOUNT,
self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
),
true
);
}
/**
* Get the status of an onboarding step.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return string The status of the onboarding step.
* @throws ApiArgumentException If the given onboarding step ID is invalid.
*/
public function get_onboarding_step_status( string $step_id, string $location ): string {
if ( ! $this->is_valid_onboarding_step_id( $step_id ) ) {
throw new ApiArgumentException(
'woocommerce_woopayments_onboarding_invalid_step_id',
esc_html__( 'Invalid onboarding step ID.', 'woocommerce' ),
(int) WP_Http::BAD_REQUEST
);
}
$meets_requirements = $this->check_onboarding_step_requirements( $step_id, $location );
// First, determine if the step should be reported as completed based on the current state of the store.
// The step can only be auto-completed if the requirements are met.
if ( $meets_requirements ) {
switch ( $step_id ) {
case self::ONBOARDING_STEP_PAYMENT_METHODS:
// If there is already a valid account, report the step as completed
// since allowing the user to configure payment methods won't have any effect.
if ( $this->has_valid_account() ) {
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
case self::ONBOARDING_STEP_WPCOM_CONNECTION:
// If we have a working WPCOM connection, report the step as completed.
// The step can only be auto-completed if the requirements are met.
if ( $this->has_working_wpcom_connection() ) {
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
case self::ONBOARDING_STEP_TEST_ACCOUNT:
// If the account is a valid, working test or sandbox account, the step is completed.
if ( ( $this->has_test_account() || $this->has_sandbox_account() ) && $this->has_valid_account() && $this->has_working_account() ) {
// Since it takes a while for the account to be fully working after the test account initialization,
// we will force mark the step as completed here, if it is not already.
// This is a fail-safe to guard against the case when the frontend doesn't mark the step as completed.
// The step has no reason to be blocked or failed.
$this->clear_onboarding_step_failed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
$this->clear_onboarding_step_blocked( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
case self::ONBOARDING_STEP_BUSINESS_VERIFICATION:
// The step can only be auto-completed if the requirements are met.
// If the current account is fully onboarded and is a live account,
// we report the business verification step as completed.
if ( $this->has_valid_account() && $this->has_live_account() ) {
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
}
}
// Second, try to determine the status of the onboarding step based on the step's stored statuses.
// We take a waterfall approach: completed > blocked > failed > started > not started.
// Reporting a completed status involves additional logic.
switch ( $step_id ) {
case self::ONBOARDING_STEP_WPCOM_CONNECTION:
// Ignore any completed stored statuses because of the critical nature of the WPCOM connection.
break;
case self::ONBOARDING_STEP_TEST_ACCOUNT:
// If there is a stored completed status, we respect that IF there is NO invalid test account.
// This is the case when the user first creates a test account and then switches to live.
// The step can only be completed if the requirements are met.
if ( $meets_requirements &&
$this->was_onboarding_step_marked_completed( $step_id, $location ) &&
! ( $this->has_test_account() && ! $this->has_valid_account() )
) {
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
case self::ONBOARDING_STEP_BUSINESS_VERIFICATION:
// The step can only be completed if the requirements are met. Otherwise, ignore the stored completed status.
// Sanity check: we only report the completed status if there is a live account and the account is valid (i.e. completed KYC).
if ( $meets_requirements &&
$this->was_onboarding_step_marked_completed( $step_id, $location ) &&
$this->has_valid_account() &&
( $this->has_live_account() || $this->has_sandbox_account() )
) {
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
case self::ONBOARDING_STEP_PAYMENT_METHODS:
default:
// The step can only be completed if the requirements are met. Otherwise, ignore the stored completed status.
if ( $meets_requirements && $this->was_onboarding_step_marked_completed( $step_id, $location ) ) {
return self::ONBOARDING_STEP_STATUS_COMPLETED;
}
break;
}
// Blocked and failed statuses are only reported if the step's requirements are met.
if ( $meets_requirements ) {
if ( $this->is_onboarding_step_blocked( $step_id, $location ) ) {
return self::ONBOARDING_STEP_STATUS_BLOCKED;
}
if ( $this->is_onboarding_step_failed( $step_id, $location ) ) {
return self::ONBOARDING_STEP_STATUS_FAILED;
}
}
if ( $this->was_onboarding_step_marked_started( $step_id, $location ) ) {
// Special treatment for the test account step:
// If the step was marked as started more than 1 minutes ago (plenty of time for the slowest of webhooks to
// come through) and it is obviously not completed, and there is no account connected,
// we will unmark it as started (aka clean its progress). Something went wrong with the step!
// This is an auto-healing measure to prevent the step from being stuck in a started state indefinitely.
if ( self::ONBOARDING_STEP_TEST_ACCOUNT === $step_id && ! $this->has_account() ) {
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
$started_timestamp = ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_STARTED ] )
? (int) $statuses[ self::ONBOARDING_STEP_STATUS_STARTED ]
: 0;
if ( $started_timestamp &&
( $this->proxy->call_function( 'time' ) - $started_timestamp ) > 60 // 1 minute.
) {
$this->clean_onboarding_step_progress( $step_id, $location );
// Record an event for the step being cleaned due to timeout.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_step_progress_reset_due_to_timeout',
$location,
array(
'step_id' => $step_id,
)
);
return self::ONBOARDING_STEP_STATUS_NOT_STARTED;
}
}
return self::ONBOARDING_STEP_STATUS_STARTED;
}
// Finally, we default to not started.
return self::ONBOARDING_STEP_STATUS_NOT_STARTED;
}
/**
* Check if an onboarding step has been marked as started.
*
* This means that, at some point, the step was marked/recorded as started in the DB.
* This doesn't mean that the current reported status is started. The step status might be different now.
*
* @see get_onboarding_step_status() for that.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step has been marked as started.
*/
private function was_onboarding_step_marked_started( string $step_id, string $location ): bool {
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
return ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_STARTED ] );
}
/**
* Mark an onboarding step as started.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param bool $overwrite Whether to overwrite the step status if it is already started and update the timestamp.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return bool Whether the onboarding step was marked as started.
* @throws ApiArgumentException If the given onboarding step ID is invalid.
* @throws ApiException If the onboarding action can not be performed due to the current state of the site.
*/
public function mark_onboarding_step_started( string $step_id, string $location, bool $overwrite = false, ?string $source = self::SESSION_ENTRY_DEFAULT ): bool {
$this->check_if_onboarding_step_action_is_acceptable( $step_id, $location );
// Clear possible failed status for the step.
$this->clear_onboarding_step_failed( $step_id, $location );
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
if ( ! $overwrite && ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_STARTED ] ) ) {
return true;
}
// Mark the step as started and record the timestamp.
$statuses[ self::ONBOARDING_STEP_STATUS_STARTED ] = $this->proxy->call_function( 'time' );
// Store the updated step data.
$result = $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', $statuses );
if ( $result ) {
$source = $this->validate_onboarding_source( $source );
// Record an event for the step being started.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_step_started',
$location,
array(
'step_id' => $step_id,
'source' => $source,
)
);
}
return $result;
}
/**
* Check if the onboarding step has a completed status.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step is completed.
* @throws ApiException On invalid step ID.
*/
private function is_onboarding_step_completed( string $step_id, string $location ): bool {
return self::ONBOARDING_STEP_STATUS_COMPLETED === $this->get_onboarding_step_status( $step_id, $location );
}
/**
* Check if an onboarding step has been marked as completed.
*
* This means that, at some point, the step was marked/recorded as completed in the DB.
* This doesn't mean that the current reported status is completed. The step status might be different now.
*
* @see get_onboarding_step_status() for that.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step has been marked as completed.
*/
private function was_onboarding_step_marked_completed( string $step_id, string $location ): bool {
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
return ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_COMPLETED ] );
}
/**
* Mark an onboarding step as completed.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param bool $overwrite Whether to overwrite the step status if it is already completed and update the timestamp.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return bool Whether the onboarding step was marked as completed.
* @throws ApiArgumentException If the given onboarding step ID is invalid.
* @throws ApiException If the onboarding action can not be performed due to the current state of the site.
*/
public function mark_onboarding_step_completed( string $step_id, string $location, bool $overwrite = false, ?string $source = self::SESSION_ENTRY_DEFAULT ): bool {
$this->check_if_onboarding_step_action_is_acceptable( $step_id, $location );
// Clear possible failed status for the step.
$this->clear_onboarding_step_failed( $step_id, $location );
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
if ( ! $overwrite && ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_COMPLETED ] ) ) {
return true;
}
// Mark the step as completed and record the timestamp.
$statuses[ self::ONBOARDING_STEP_STATUS_COMPLETED ] = $this->proxy->call_function( 'time' );
// Store the updated step data.
$result = $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', $statuses );
if ( $result ) {
$source = $this->validate_onboarding_source( $source );
// Record an event for the step being completed.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_step_completed',
$location,
array(
'step_id' => $step_id,
'source' => $source,
)
);
}
return $result;
}
/**
* Cleans an onboarding step progress.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step was cleaned.
* @throws ApiArgumentException If the given onboarding step ID is invalid.
*/
public function clean_onboarding_step_progress( string $step_id, string $location ): bool {
// We need to do reduced acceptance checks here because this is a cleanup action.
// First, check general if the onboarding action is acceptable.
$this->check_if_onboarding_action_is_acceptable();
// Second, check if the step ID is valid.
if ( ! $this->is_valid_onboarding_step_id( $step_id ) ) {
throw new ApiArgumentException(
'woocommerce_woopayments_onboarding_invalid_step_id',
esc_html__( 'Invalid onboarding step ID.', 'woocommerce' ),
(int) WP_Http::BAD_REQUEST
);
}
// Clear possible failed or blocked status for the step.
$this->clear_onboarding_step_failed( $step_id, $location );
$this->clear_onboarding_step_blocked( $step_id, $location );
// Reset the stored step statuses.
$result = $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', array() );
if ( $result ) {
// Record an event for the step being cleaned.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_step_progress_reset',
$location,
array(
'step_id' => $step_id,
)
);
}
return $result;
}
/**
* Check if an onboarding step has a failed status.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step is failed.
*/
private function is_onboarding_step_failed( string $step_id, string $location ): bool {
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
return ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_FAILED ] );
}
/**
* Mark an onboarding step as failed.
*
* This is for internal use only as a failed step status should not be the result of a user action.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $error Optional. An error to be stored for the step to provide context to API consumers.
* The error should be an associative array with the following keys:
* - 'code': A string representing the error code.
* - 'message': A string representing the error message.
* - 'context': Optional. An array of additional data related to the error.
*
* @return bool Whether the onboarding step was marked as failed.
*/
private function mark_onboarding_step_failed( string $step_id, string $location, array $error = array() ): bool {
// There is no need to do onboarding checks because setting a step as failed should be possible at any time.
// Record the error for the step, even if it is empty.
// This will ensure we only store the most recent error.
$this->save_nox_profile_onboarding_step_data_entry( $step_id, $location, 'error', $this->sanitize_onboarding_step_error( $error ) );
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
// Mark the step as failed and record the timestamp.
$statuses[ self::ONBOARDING_STEP_STATUS_FAILED ] = $this->proxy->call_function( 'time' );
// Make sure we clear the blocked status if it was set since blocked and failed should be mutually exclusive.
unset( $statuses[ self::ONBOARDING_STEP_STATUS_BLOCKED ] );
// Store the updated step data.
$result = $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', $statuses );
if ( $result ) {
// Record an event for the step being failed.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_step_failed',
$location,
array(
'step_id' => $step_id,
'error_code' => ! empty( $error['code'] ) ? $error['code'] : '',
)
);
}
return $result;
}
/**
* Clear the failed status of an onboarding step.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step was cleared from failed status.
* Returns false if the step was not failed.
*/
private function clear_onboarding_step_failed( string $step_id, string $location ): bool {
if ( ! $this->is_onboarding_step_failed( $step_id, $location ) ) {
return false;
}
// Clear any error for the step.
$this->save_nox_profile_onboarding_step_data_entry( $step_id, $location, 'error', array() );
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
// Clear the failed status.
unset( $statuses[ self::ONBOARDING_STEP_STATUS_FAILED ] );
// Store the updated step data.
return $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', $statuses );
}
/**
* Check if an onboarding step has a blocked status.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step is blocked.
*/
private function is_onboarding_step_blocked( string $step_id, string $location ): bool {
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
return ! empty( $statuses[ self::ONBOARDING_STEP_STATUS_BLOCKED ] );
}
/**
* Mark an onboarding step as blocked.
*
* This is for internal use only as a blocked step status should not be the result of a user action.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $errors Optional. A list of errors to be stored for the step to provide context to API consumers.
*
* @return bool Whether the onboarding step was marked as blocked.
*/
private function mark_onboarding_step_blocked( string $step_id, string $location, array $errors = array() ): bool {
// There is no need to do onboarding checks because setting a step as blocked should be possible at any time.
// Record the error for the step, even if it is empty.
// This will ensure we only store the most recent error.
$this->save_nox_profile_onboarding_step_data_entry( $step_id, $location, 'error', $this->sanitize_onboarding_step_error( $errors ) );
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
// Mark the step as blocked and record the timestamp.
$statuses[ self::ONBOARDING_STEP_STATUS_BLOCKED ] = $this->proxy->call_function( 'time' );
// Make sure we clear the failed status if it was set since blocked and failed should be mutually exclusive.
unset( $statuses[ self::ONBOARDING_STEP_STATUS_FAILED ] );
// Store the updated step data.
return $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', $statuses );
}
/**
* Clear the blocked status of an onboarding step.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step was cleared from blocked status.
* Returns false if the step was not blocked.
*/
private function clear_onboarding_step_blocked( string $step_id, string $location ): bool {
if ( ! $this->is_onboarding_step_blocked( $step_id, $location ) ) {
return false;
}
// Clear any error for the step.
$this->save_nox_profile_onboarding_step_data_entry( $step_id, $location, 'error', array() );
$statuses = (array) $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses' );
// Clear the blocked status.
unset( $statuses[ self::ONBOARDING_STEP_STATUS_BLOCKED ] );
// Store the updated step data.
return $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'statuses', $statuses );
}
/**
* Get the current stored error for an onboarding step.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return array The error for the onboarding step.
*/
private function get_onboarding_step_error( string $step_id, string $location ): array {
return (array) $this->get_nox_profile_onboarding_step_data_entry( $step_id, $location, 'error', array() );
}
/**
* Sanitize an error for an onboarding step.
*
* @param array $error The error to sanitize.
*
* @return array The sanitized error.
*/
private function sanitize_onboarding_step_error( array $error ): array {
$sanitized_error = array(
'code' => isset( $error['code'] ) ? sanitize_text_field( $error['code'] ) : '',
'message' => isset( $error['message'] ) ? sanitize_text_field( $error['message'] ) : '',
'context' => array(),
);
// Move all extra keys (not code, message, context) into the context.
$reserved_keys = array( 'code', 'message', 'context' );
foreach ( $error as $key => $value ) {
if ( ! in_array( $key, $reserved_keys, true ) ) {
$sanitized_error['context'][ $key ] = $value;
}
}
// Merge any existing context data.
if ( isset( $error['context'] ) && ( is_array( $error['context'] ) || is_object( $error['context'] ) ) ) {
// Make sure we are dealing with an array.
$existing_context = json_decode( wp_json_encode( $error['context'] ), true );
if ( is_array( $existing_context ) ) {
$sanitized_error['context'] = array_merge( $sanitized_error['context'], $existing_context );
}
}
// Flatten any nested 'context' key (e.g., from WP_Error data that includes its own context).
// The nested context values take precedence over the top-level values.
if ( isset( $sanitized_error['context']['context'] ) && is_array( $sanitized_error['context']['context'] ) ) {
$nested_context = $sanitized_error['context']['context'];
unset( $sanitized_error['context']['context'] );
$sanitized_error['context'] = array_merge( $sanitized_error['context'], $nested_context );
}
if ( ! empty( $sanitized_error['context'] ) ) {
// Sanitize the context data.
// It can only contain strings or arrays of strings.
// Scalar values will be converted to strings. Other types will be ignored.
foreach ( $sanitized_error['context'] as $key => $value ) {
if ( is_string( $value ) ) {
$sanitized_error['context'][ $key ] = sanitize_text_field( $value );
} elseif ( is_array( $value ) ) {
// Arrays can only contain strings.
$sanitized_error['context'][ $key ] = array_map(
function ( $item ) {
if ( is_string( $item ) ) {
return sanitize_text_field( $item );
} elseif ( is_scalar( $item ) ) {
return sanitize_text_field( (string) $item );
} else {
return '';
}
},
$value
);
// Remove any empty values from the array.
$sanitized_error['context'][ $key ] = array_filter(
$sanitized_error['context'][ $key ],
function ( $item ) {
return '' !== $item;
}
);
} else {
unset( $sanitized_error['context'][ $key ] );
}
}
}
return $sanitized_error;
}
/**
* Save the data for an onboarding step.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $request_data The entire data received in the request.
*
* @return bool Whether the onboarding step data was saved.
* @throws ApiArgumentException If the given onboarding step ID or step data is invalid.
* @throws ApiException If the onboarding action can not be performed due to the current state of the site.
*/
public function onboarding_step_save( string $step_id, string $location, array $request_data ): bool {
$this->check_if_onboarding_step_action_is_acceptable( $step_id, $location );
// Validate the received step data.
// If we didn't receive any known data for the step, we consider it an invalid save operation.
if ( ! $this->is_valid_onboarding_step_data( $step_id, $request_data ) ) {
throw new ApiArgumentException(
'woocommerce_woopayments_onboarding_invalid_step_data',
esc_html__( 'Invalid onboarding step data.', 'woocommerce' ),
(int) WP_Http::BAD_REQUEST
);
}
$step_details = $this->get_nox_profile_onboarding_step( $step_id, $location );
if ( empty( $step_details['data'] ) ) {
$step_details['data'] = array();
}
// Extract the data for the step.
switch ( $step_id ) {
case self::ONBOARDING_STEP_PAYMENT_METHODS:
if ( isset( $request_data['payment_methods'] ) ) {
$step_details['data']['payment_methods'] = $request_data['payment_methods'];
}
break;
case self::ONBOARDING_STEP_BUSINESS_VERIFICATION:
if ( isset( $request_data['self_assessment'] ) ) {
$step_details['data']['self_assessment'] = $request_data['self_assessment'];
}
if ( isset( $request_data['sub_steps'] ) ) {
$step_details['data']['sub_steps'] = $request_data['sub_steps'];
}
break;
default:
throw new ApiException(
'woocommerce_woopayments_onboarding_step_action_not_supported',
esc_html__( 'Save action not supported for the onboarding step ID.', 'woocommerce' ),
(int) WP_Http::NOT_ACCEPTABLE
);
}
// Store the updated step data.
return $this->save_nox_profile_onboarding_step( $step_id, $location, $step_details );
}
/**
* Check if the given onboarding step data is valid.
*
* If we didn't receive any known data for the step, we consider it invalid.
*
* @param string $step_id The ID of the onboarding step.
* @param array $request_data The entire data received in the request.
*
* @return bool Whether the given onboarding step data is valid.
*/
private function is_valid_onboarding_step_data( string $step_id, array $request_data ): bool {
switch ( $step_id ) {
case self::ONBOARDING_STEP_PAYMENT_METHODS:
// Check that we have at least one piece of data.
if ( ! isset( $request_data['payment_methods'] ) ) {
return false;
}
// Check that the data is in the expected format.
if ( ! is_array( $request_data['payment_methods'] ) ) {
return false;
}
break;
case self::ONBOARDING_STEP_BUSINESS_VERIFICATION:
// Check that we have at least one piece of data.
if ( ! isset( $request_data['self_assessment'] ) &&
! isset( $request_data['sub_steps'] ) ) {
return false;
}
// Check that the data is in the expected format.
if ( isset( $request_data['self_assessment'] ) && ! is_array( $request_data['self_assessment'] ) ) {
return false;
}
if ( isset( $request_data['sub_steps'] ) && ! is_array( $request_data['sub_steps'] ) ) {
return false;
}
break;
default:
// If we don't know how to validate the data, we assume it is valid.
return true;
}
return true;
}
/**
* Check an onboarding step's status/progress.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return array The check result.
* @throws ApiArgumentException If the given onboarding step ID or step data is invalid.
* @throws ApiException If the onboarding action can not be performed due to the current state of the site.
*/
public function onboarding_step_check( string $step_id, string $location ): array {
$this->check_if_onboarding_step_action_is_acceptable( $step_id, $location );
return array(
'status' => $this->get_onboarding_step_status( $step_id, $location ),
'error' => $this->get_onboarding_step_error( $step_id, $location ),
);
}
/**
* Get the recommended payment methods details for onboarding.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return array The recommended payment methods details.
*/
public function get_onboarding_recommended_payment_methods( string $location ): array {
return $this->provider->get_recommended_payment_methods( $this->get_payment_gateway(), $location );
}
/**
* Initialize the test account for onboarding.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return array The result of the test account initialization.
* @throws ApiException If the given onboarding step ID or step data is invalid.
* If the onboarding action can not be performed due to the current state
* of the site or there was an error initializing the test account.
*/
public function onboarding_test_account_init( string $location, ?string $source = self::SESSION_ENTRY_DEFAULT ): array {
$this->check_if_onboarding_step_action_is_acceptable( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
// Nothing to do if we already have a connected test account.
if ( $this->has_test_account() ) {
throw new ApiException(
'woocommerce_woopayments_test_account_already_exists',
esc_html__( 'A test account is already set up.', 'woocommerce' ),
(int) WP_Http::FORBIDDEN
);
}
// Nothing to do if there is a connected account, but it is not a test account.
if ( $this->has_account() ) {
// Mark the onboarding step as completed, if it is not already.
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
throw new ApiException(
'woocommerce_woopayments_onboarding_action_error',
esc_html__( 'An account is already set up. Reset the onboarding first.', 'woocommerce' ),
(int) WP_Http::FORBIDDEN
);
}
// Clear any previous failed status for the step.
$this->clear_onboarding_step_failed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
$configured_payment_methods = $this->get_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_PAYMENT_METHODS, $location, 'payment_methods', array() );
// Ensure the payment gateways logic is initialized in case actions need to be taken on payment gateway changes.
WC()->payment_gateways();
$source = $this->validate_onboarding_source( $source );
// Lock the onboarding to prevent concurrent actions.
$this->set_onboarding_lock();
try {
// Call the WooPayments API to initialize the test account.
$response = $this->proxy->call_static(
Utils::class,
'rest_endpoint_post_request',
'/wc/v3/payments/onboarding/test_drive_account/init',
array(
'country' => $location,
'capabilities' => $configured_payment_methods,
'source' => $source,
'from' => self::FROM_NOX_IN_CONTEXT,
)
);
} catch ( Exception $e ) {
// Catch any exceptions to allow for proper error handling and onboarding unlock.
$response = new WP_Error(
'woocommerce_woopayments_onboarding_client_api_exception',
esc_html__( 'An unexpected error happened while initializing the test account.', 'woocommerce' ),
array(
'code' => $e->getCode(),
'message' => $e->getMessage(),
'trace' => $e->getTrace(),
)
);
}
// Unlock the onboarding after the API call finished or errored.
$this->clear_onboarding_lock();
if ( is_wp_error( $response ) ) {
// Mark the onboarding step as failed.
$this->mark_onboarding_step_failed(
self::ONBOARDING_STEP_TEST_ACCOUNT,
$location,
array(
'code' => $response->get_error_code(),
'message' => $response->get_error_message(),
'context' => $response->get_error_data(),
)
);
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html( $response->get_error_message() ),
(int) WP_Http::FAILED_DEPENDENCY,
map_deep( (array) $response->get_error_data(), 'esc_html' )
);
}
if ( ! is_array( $response ) || empty( $response['success'] ) ) {
// Mark the onboarding step as failed.
$this->mark_onboarding_step_failed(
self::ONBOARDING_STEP_TEST_ACCOUNT,
$location,
array(
'code' => 'malformed_response',
'message' => esc_html__( 'Received an unexpected response from the platform.', 'woocommerce' ),
'context' => array(
'response' => $response,
),
)
);
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html__( 'Failed to initialize the test account.', 'woocommerce' ),
(int) WP_Http::FAILED_DEPENDENCY
);
}
// Record an event for the test account being initialized.
$payment_methods_enabled = array();
$payment_methods_disabled = array();
if ( ! empty( $configured_payment_methods ) && is_array( $configured_payment_methods ) ) {
foreach ( $configured_payment_methods as $pm_id => $enabled ) {
if ( ! is_string( $pm_id ) || ! is_bool( $enabled ) ) {
continue; // Skip invalid entries.
}
if ( $enabled ) {
$payment_methods_enabled[] = sanitize_key( $pm_id );
} else {
$payment_methods_disabled[] = sanitize_key( $pm_id );
}
}
}
$payment_methods_enabled = array_unique( $payment_methods_enabled );
$payment_methods_disabled = array_unique( $payment_methods_disabled );
$event_props = array(
'payment_methods_enabled' => implode( ', ', $payment_methods_enabled ),
'payment_methods_disabled' => implode( ', ', $payment_methods_disabled ),
'source' => $source,
);
$this->record_event(
self::EVENT_PREFIX . 'onboarding_test_account_init',
$location,
$event_props
);
return $response;
}
/**
* Get the onboarding KYC account session.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $self_assessment Optional. The self-assessment data.
* If not provided, the stored data will be used.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return array The KYC account session data.
* @throws ApiException If the extension is not active, step requirements are not met, or
* the KYC session data could not be retrieved.
*/
public function get_onboarding_kyc_session( string $location, array $self_assessment = array(), ?string $source = self::SESSION_ENTRY_DEFAULT ): array {
$this->check_if_onboarding_step_action_is_acceptable( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location );
if ( empty( $self_assessment ) ) {
// Get the stored self-assessment data.
$self_assessment = (array) $this->get_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location, 'self_assessment' );
}
// Clear any previous failed status for the step.
$this->clear_onboarding_step_failed( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location );
// Get the selected payment methods from the NOX profile.
$selected_payment_methods = $this->get_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_PAYMENT_METHODS, $location, 'payment_methods', array() );
// Ensure the payment gateways logic is initialized in case actions need to be taken on payment gateway changes.
WC()->payment_gateways();
$source = $this->validate_onboarding_source( $source );
// Lock the onboarding to prevent concurrent actions.
$this->set_onboarding_lock();
try {
// Call the WooPayments API to get the KYC session.
$response = $this->proxy->call_static(
Utils::class,
'rest_endpoint_post_request',
'/wc/v3/payments/onboarding/kyc/session',
array(
'self_assessment' => $self_assessment,
'capabilities' => $selected_payment_methods,
)
);
} catch ( Exception $e ) {
// Catch any exceptions to allow for proper error handling and onboarding unlock.
$response = new WP_Error(
'woocommerce_woopayments_onboarding_client_api_exception',
esc_html__( 'An unexpected error happened while creating the KYC session.', 'woocommerce' ),
array(
'code' => $e->getCode(),
'message' => $e->getMessage(),
'trace' => $e->getTrace(),
)
);
}
// Unlock the onboarding after the API call finished or errored.
$this->clear_onboarding_lock();
if ( is_wp_error( $response ) ) {
// Mark the onboarding step as failed.
$this->mark_onboarding_step_failed(
self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
$location,
array(
'code' => $response->get_error_code(),
'message' => $response->get_error_message(),
'context' => $response->get_error_data(),
)
);
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html( $response->get_error_message() ),
(int) WP_Http::FAILED_DEPENDENCY,
map_deep( (array) $response->get_error_data(), 'esc_html' )
);
}
if ( ! is_array( $response ) ) {
// Mark the onboarding step as failed.
$this->mark_onboarding_step_failed(
self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
$location,
array(
'code' => 'malformed_response',
'message' => esc_html__( 'Received an unexpected response from the platform.', 'woocommerce' ),
'context' => array(
'response' => $response,
),
)
);
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html__( 'Failed to get the KYC session data.', 'woocommerce' ),
(int) WP_Http::FAILED_DEPENDENCY
);
}
// Add the user locale to the account session data to allow for localized KYC sessions.
$response['locale'] = $this->proxy->call_function( 'get_user_locale' );
// For sanity, make sure the test account step is marked as completed, if not already,
// since we are doing live account KYC.
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location, false, $source );
// Record an event for the KYC session being created.
$event_props = array(
'new_account_created' => $response['accountCreated'] ?? false,
'account_mode' => ( $response['isLive'] ?? false ) ? 'live' : 'test',
'source' => $source,
);
$this->record_event(
self::EVENT_PREFIX . 'onboarding_kyc_session_created',
$location,
$event_props
);
return $response;
}
/**
* Finish the onboarding KYC account session.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return array The response from the WooPayments API.
* @throws ApiException If the extension is not active, step requirements are not met, or
* the KYC session could not be finished.
*/
public function finish_onboarding_kyc_session( string $location, ?string $source = self::SESSION_ENTRY_DEFAULT ): array {
$this->check_if_onboarding_step_action_is_acceptable( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location );
// Ensure the payment gateways logic is initialized in case actions need to be taken on payment gateway changes.
WC()->payment_gateways();
$source = $this->validate_onboarding_source( $source );
// Lock the onboarding to prevent concurrent actions.
$this->set_onboarding_lock();
try {
// Call the WooPayments API to finalize the KYC session.
$response = $this->proxy->call_static(
Utils::class,
'rest_endpoint_post_request',
'/wc/v3/payments/onboarding/kyc/finalize',
array(
'source' => $source,
'from' => self::FROM_NOX_IN_CONTEXT,
)
);
} catch ( Exception $e ) {
// Catch any exceptions to allow for proper error handling and onboarding unlock.
$response = new WP_Error(
'woocommerce_woopayments_onboarding_client_api_exception',
esc_html__( 'An unexpected error happened while finalizing the KYC session.', 'woocommerce' ),
array(
'code' => $e->getCode(),
'message' => $e->getMessage(),
'trace' => $e->getTrace(),
)
);
}
// Unlock the onboarding after the API call finished or errored.
$this->clear_onboarding_lock();
if ( is_wp_error( $response ) ) {
// Mark the onboarding step as failed.
$this->mark_onboarding_step_failed(
self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
$location,
array(
'code' => $response->get_error_code(),
'message' => $response->get_error_message(),
'context' => $response->get_error_data(),
)
);
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html( $response->get_error_message() ),
(int) WP_Http::FAILED_DEPENDENCY,
map_deep( (array) $response->get_error_data(), 'esc_html' )
);
}
if ( ! is_array( $response ) ) {
// Mark the onboarding step as failed.
$this->mark_onboarding_step_failed(
self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
$location,
array(
'code' => 'malformed_response',
'message' => esc_html__( 'Received an unexpected response from the platform.', 'woocommerce' ),
'context' => array(
'response' => $response,
),
)
);
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html__( 'Failed to finish the KYC session.', 'woocommerce' ),
(int) WP_Http::FAILED_DEPENDENCY
);
}
// For sanity, make sure the test account step is marked as completed, if not already,
// since we are doing live account KYC.
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location, false, $source );
// Record an event for the KYC session being finished.
$event_props = array(
'successful_kyc' => filter_var( $response['success'] ?? false, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE ) ?? false,
'account_mode' => ( 'live' === ( $response['mode'] ?? false ) ) ? 'live' : 'test',
'details_submitted' => filter_var( $response['details_submitted'] ?? false, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE ) ?? false,
'promotion_id' => $response['promotion_id'] ?? 'none',
'source' => $source,
);
$this->record_event(
self::EVENT_PREFIX . 'onboarding_kyc_session_finished',
$location,
$event_props
);
// Mark the business verification step as completed.
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location, false, $source );
return $response;
}
/**
* Preload the onboarding process.
*
* This method is used to run the heavier logic required for onboarding ahead of time,
* so that we can be quicker to respond to the user when they start the onboarding process.
*
* @return array An array containing the success status and any errors encountered during the preload.
* 'success' => true if the preload was successful, false otherwise.
* 'errors' => An array of error messages if any errors occurred, empty if no errors.
* @throws ApiException If the onboarding preload failed or the onboarding is locked.
*/
public function onboarding_preload(): array {
// If the onboarding is locked, we shouldn't do anything.
if ( $this->is_onboarding_locked() ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_locked',
esc_html__( 'Another onboarding action is already in progress. Please wait for it to finish.', 'woocommerce' ),
(int) WP_Http::CONFLICT
);
}
$result = true;
// Register the site to WPCOM if it is not already registered.
// This sets up the site for connection. For new sites, this tends to take a while.
// It is a prerequisite to generating the WPCOM/Jetpack authorization URL.
if ( ! $this->wpcom_connection_manager->is_connected() ) {
$result = $this->wpcom_connection_manager->try_registration();
if ( is_wp_error( $result ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_action_error',
esc_html( $result->get_error_message() ),
(int) WP_Http::INTERNAL_SERVER_ERROR,
map_deep( (array) $result->get_error_data(), 'esc_html' )
);
}
}
return array(
'success' => $result,
);
}
/**
* Reset onboarding.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $from Optional. Where in the UI the request is coming from.
* If not provided, it will identify the origin as the WC Admin Payments settings.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return array The response from the WooPayments API.
* @throws ApiException If we could not reset onboarding or there was an error.
*/
public function reset_onboarding( string $location, string $from = '', ?string $source = self::SESSION_ENTRY_DEFAULT ): array {
$this->check_if_onboarding_action_is_acceptable();
// Ensure the payment gateways logic is initialized in case actions need to be taken on payment gateway changes.
WC()->payment_gateways();
$event_props = array();
$source = $this->validate_onboarding_source( $source );
// Lock the onboarding to prevent concurrent actions.
$this->set_onboarding_lock();
try {
// Before resetting the onboarding, record its details for tracking purposes.
$event_props = array(
'has_account' => $this->has_account(),
'account_mode' => $this->has_account() ? ( $this->has_live_account() ? 'live' : 'test' ) : 'none',
'test_account' => $this->has_test_account(),
'source' => $source,
);
if ( $this->has_account() ) {
// Call the WooPayments API to reset onboarding.
$response = $this->proxy->call_static(
Utils::class,
'rest_endpoint_post_request',
'/wc/v3/payments/onboarding/reset',
array(
'from' => ! empty( $from ) ? esc_attr( $from ) : self::FROM_PAYMENT_SETTINGS,
'source' => $source,
)
);
} else {
// If there is no account to reset, we can just use a success response.
$response = array(
'success' => true,
);
}
} catch ( Exception $e ) {
// Catch any exceptions to allow for proper error handling and onboarding unlock.
$response = new WP_Error(
'woocommerce_woopayments_onboarding_client_api_exception',
esc_html__( 'An unexpected error happened while resetting onboarding.', 'woocommerce' ),
array(
'code' => $e->getCode(),
'message' => $e->getMessage(),
'trace' => $e->getTrace(),
)
);
}
// Unlock the onboarding after the API call finished or errored.
$this->clear_onboarding_lock();
// Clean up any NOX-specific onboarding data, regardless of the API response.
$this->proxy->call_function( 'delete_option', self::NOX_PROFILE_OPTION_KEY );
// Make sure the onboarding mode is reset.
if ( class_exists( 'WC_Payments_Onboarding_Service' ) && defined( 'WC_Payments_Onboarding_Service::TEST_MODE_OPTION' ) ) {
$this->proxy->call_function( 'update_option', Constants::get_constant( 'WC_Payments_Onboarding_Service::TEST_MODE_OPTION' ), 'no' );
}
if ( is_wp_error( $response ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html( $response->get_error_message() ),
(int) WP_Http::FAILED_DEPENDENCY,
map_deep( (array) $response->get_error_data(), 'esc_html' )
);
}
if ( ! is_array( $response ) || empty( $response['success'] ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html__( 'Failed to reset onboarding.', 'woocommerce' ),
(int) WP_Http::FAILED_DEPENDENCY
);
}
// Record an event for the onboarding reset.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_reset',
$location,
$event_props
);
return $response;
}
/**
* Disable a test account during the switch-to-live onboarding flow.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $from Optional. Where in the UI the request is coming from.
* If not provided, it will identify the origin as the WC Admin Payments settings.
* @param string|null $source Optional. The source for the current onboarding flow.
* If not provided, it will identify the source as the WC Admin Payments settings.
*
* @return array The response from the WooPayments API.
* @throws ApiException If we could not disable the test account or there was an error.
*/
public function disable_test_account( string $location, string $from = '', ?string $source = self::SESSION_ENTRY_DEFAULT ): array {
$this->check_if_onboarding_action_is_acceptable();
// Ensure the payment gateways logic is initialized in case actions need to be taken on payment gateway changes.
WC()->payment_gateways();
$response = array(
'success' => true,
);
$event_props = array();
$source = $this->validate_onboarding_source( $source );
// Lock the onboarding to prevent concurrent actions.
$this->set_onboarding_lock();
try {
$has_test_account = $this->has_test_account();
$has_sandbox_account = $this->has_sandbox_account();
$event_props = array(
'account_type' => $has_test_account ? 'test_drive' : ( $has_sandbox_account ? 'sandbox' : 'unknown' ),
'source' => $source,
);
// First, check if we have a test account to disable.
if ( $has_test_account ) {
// Call the WooPayments API to disable the test account and prepare for the switch to live.
$response = $this->proxy->call_static(
Utils::class,
'rest_endpoint_post_request',
'/wc/v3/payments/onboarding/test_drive_account/disable',
array(
'from' => ! empty( $from ) ? esc_attr( $from ) : self::FROM_PAYMENT_SETTINGS,
'source' => $source,
)
);
} elseif ( $has_sandbox_account ) {
// Call the WooPayments API to reset onboarding.
$response = $this->proxy->call_static(
Utils::class,
'rest_endpoint_post_request',
'/wc/v3/payments/onboarding/reset',
array(
'from' => ! empty( $from ) ? esc_attr( $from ) : self::FROM_PAYMENT_SETTINGS,
'source' => $source,
)
);
}
} catch ( Exception $e ) {
// Catch any exceptions to allow for proper error handling and onboarding unlock.
$response = new WP_Error(
'woocommerce_woopayments_onboarding_client_api_exception',
esc_html__( 'An unexpected error happened while disabling the test account.', 'woocommerce' ),
array(
'code' => $e->getCode(),
'message' => $e->getMessage(),
'trace' => $e->getTrace(),
)
);
}
// Unlock the onboarding after the API call finished or errored.
$this->clear_onboarding_lock();
// Make sure the onboarding mode is reset.
if ( class_exists( 'WC_Payments_Onboarding_Service' ) && defined( 'WC_Payments_Onboarding_Service::TEST_MODE_OPTION' ) ) {
$this->proxy->call_function( 'update_option', Constants::get_constant( 'WC_Payments_Onboarding_Service::TEST_MODE_OPTION' ), 'no' );
}
// Track the failure to disable the test account.
if ( is_wp_error( $response ) || ! is_array( $response ) || empty( $response['success'] ) ) {
$this->record_event(
self::EVENT_PREFIX . 'onboarding_test_account_disable_error',
$location,
array(
'source' => $source,
)
);
}
if ( is_wp_error( $response ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html( $response->get_error_message() ),
(int) WP_Http::FAILED_DEPENDENCY,
map_deep( (array) $response->get_error_data(), 'esc_html' )
);
}
if ( ! is_array( $response ) || empty( $response['success'] ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_client_api_error',
esc_html__( 'Failed to disable the test account.', 'woocommerce' ),
(int) WP_Http::FAILED_DEPENDENCY
);
}
// For sanity, make sure the payment methods step is marked as completed.
// This is to avoid the user being prompted to set up payment methods again.
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_PAYMENT_METHODS, $location );
// For sanity, make sure the test account step is marked as completed and not blocked or failed.
// After disabling a test account, the user should be prompted to set up a live account.
$this->mark_onboarding_step_completed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
$this->clear_onboarding_step_blocked( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
$this->clear_onboarding_step_failed( self::ONBOARDING_STEP_TEST_ACCOUNT, $location );
// Clear the NOX profile data for the business verification step sub-step data.
// This way the user will be prompted to complete ALL the business verification sub-steps.
$business_verification_sub_step_data = $this->get_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location, 'sub_steps', array() );
if ( ! empty( $business_verification_sub_step_data ) ) {
$this->save_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location, 'sub_steps', array() );
}
// Record an event for the test account being disabled.
$this->record_event(
self::EVENT_PREFIX . 'onboarding_test_account_disabled',
$location,
$event_props
);
return $response;
}
/**
* Send a Tracks event.
*
* By default, Woo adds `url`, `blog_lang`, `blog_id`, `store_id`, `products_count`, and `wc_version`
* properties to every event.
*
* @param string $name The event name.
* If it is not prefixed with self::EVENT_PREFIX, it will be prefixed with it.
* @param string $business_country The business registration country code as set in the WooCommerce Payments settings.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $properties Optional. The event custom properties.
* These properties will be merged with the default properties.
* Default properties values take precedence over the provided ones.
*
* @return void
*/
public function record_event( string $name, string $business_country, array $properties = array() ) {
if ( ! function_exists( 'wc_admin_record_tracks_event' ) ) {
return;
}
// If the event name is empty, we don't record it.
if ( empty( $name ) ) {
return;
}
// If the event name is not prefixed with `settings_payments_`, we prefix it.
if ( ! str_starts_with( $name, self::EVENT_PREFIX ) ) {
$name = self::EVENT_PREFIX . $name;
}
// Add default properties to every event and overwrite custom properties with the same keys.
$properties = array_merge(
$properties,
array(
'business_country' => $business_country,
),
);
wc_admin_record_tracks_event( $name, $properties );
}
/**
* Check if an onboarding action should be allowed to be processed.
*
* @return void
* @throws ApiException If the extension is not active or onboarding is locked.
*/
private function check_if_onboarding_action_is_acceptable() {
// If the WooPayments plugin is not active, we can't do anything.
if ( ! $this->is_extension_active() ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_extension_not_active',
/* translators: %s: WooPayments. */
sprintf( esc_html__( 'The %s extension is not active.', 'woocommerce' ), 'WooPayments' ),
(int) WP_Http::FORBIDDEN
);
}
// If the WooPayments installed version is less than the minimum required version, we can't do anything.
if ( Constants::is_defined( 'WCPAY_VERSION_NUMBER' ) &&
version_compare( Constants::get_constant( 'WCPAY_VERSION_NUMBER' ), self::EXTENSION_MINIMUM_VERSION, '<' ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_extension_version',
/* translators: %s: WooPayments. */
sprintf( esc_html__( 'The %s extension is not up-to-date. Please update to the latest version and try again.', 'woocommerce' ), 'WooPayments' ),
(int) WP_Http::FORBIDDEN
);
}
// If the onboarding is locked, we shouldn't do anything.
if ( $this->is_onboarding_locked() ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_locked',
esc_html__( 'Another onboarding action is already in progress. Please wait for it to finish.', 'woocommerce' ),
(int) WP_Http::CONFLICT
);
}
}
/**
* Check if an onboarding step action should be allowed to be processed.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return void
* @throws ApiArgumentException If the onboarding step ID is invalid.
* @throws ApiException If the extension is not active or step requirements are not met.
*/
private function check_if_onboarding_step_action_is_acceptable( string $step_id, string $location ): void {
// First, check general onboarding actions.
$this->check_if_onboarding_action_is_acceptable();
// Second, do onboarding step specific checks.
if ( ! $this->is_valid_onboarding_step_id( $step_id ) ) {
throw new ApiArgumentException(
'woocommerce_woopayments_onboarding_invalid_step_id',
esc_html__( 'Invalid onboarding step ID.', 'woocommerce' ),
(int) WP_Http::BAD_REQUEST
);
}
if ( ! $this->check_onboarding_step_requirements( $step_id, $location ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_step_requirements_not_met',
esc_html__( 'Onboarding step requirements are not met.', 'woocommerce' ),
(int) WP_Http::FORBIDDEN
);
}
if ( $this->is_onboarding_step_blocked( $step_id, $location ) ) {
throw new ApiException(
'woocommerce_woopayments_onboarding_step_blocked',
esc_html__( 'There are environment or store setup issues which are blocking progress. Please resolve them to proceed.', 'woocommerce' ),
(int) WP_Http::FORBIDDEN,
array(
'error' => map_deep( $this->get_onboarding_step_error( $step_id, $location ), 'esc_html' ),
),
);
}
}
/**
* Check if the onboarding is locked.
*
* @return bool Whether the onboarding is locked.
*/
private function is_onboarding_locked(): bool {
$lock_timestamp = (int) $this->proxy->call_function(
'absint',
$this->proxy->call_function( 'get_option', self::NOX_ONBOARDING_LOCKED_KEY, 0 )
);
if ( 0 === $lock_timestamp ) {
return false;
}
$now = $this->proxy->call_function( 'time' );
// If the lock timestamp is older than the TTL, consider it unlocked and self-heal.
if ( $lock_timestamp < ( $now - self::NOX_ONBOARDING_LOCKED_TTL_SECONDS ) ) {
$this->clear_onboarding_lock();
return false;
}
return true;
}
/**
* Lock the onboarding.
*
* This will save a flag in the database to indicate that onboarding is locked.
* This is used to prevent certain onboarding actions to happen while others have not finished.
* This is especially important for actions that modify the account (initializing it, deleting it, etc.)
* These actions tend to be longer-running and we want to have backstops in place to prevent race conditions.
*
* @return void
*/
private function set_onboarding_lock(): void {
$now = $this->proxy->call_function( 'time' );
$this->proxy->call_function( 'update_option', self::NOX_ONBOARDING_LOCKED_KEY, $now, false );
}
/**
* Unlock the onboarding.
*
* @return void
*/
private function clear_onboarding_lock(): void {
// We update rather than delete the option for performance reasons.
$this->proxy->call_function( 'update_option', self::NOX_ONBOARDING_LOCKED_KEY, 0, false );
}
/**
* Get the onboarding details for each step.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $rest_path The REST API path to use for constructing REST API URLs.
* @param string|null $source Optional. The source for the onboarding flow.
*
* @return array[] The list of onboarding steps details.
* @throws Exception If there was an error generating the onboarding steps details.
*/
private function get_onboarding_steps( string $location, string $rest_path, ?string $source = self::SESSION_ENTRY_DEFAULT ): array {
$steps = array();
// Add the payment methods onboarding step details, but only if we have recommended payment methods.
$recommended_pms = $this->get_onboarding_recommended_payment_methods( $location );
if ( ! empty( $recommended_pms ) ) {
$steps[] = $this->standardize_onboarding_step_details(
array(
'id' => self::ONBOARDING_STEP_PAYMENT_METHODS,
'context' => array(
'recommended_pms' => $recommended_pms,
'pms_state' => $this->get_onboarding_payment_methods_state( $location, $recommended_pms ),
),
'actions' => array(
'start' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_PAYMENT_METHODS . '/start' ),
),
'save' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_PAYMENT_METHODS . '/save' ),
),
'finish' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_PAYMENT_METHODS . '/finish' ),
),
),
),
$location,
$rest_path
);
}
// Add the WPCOM connection onboarding step details.
$wpcom_step = $this->standardize_onboarding_step_details(
array(
'id' => self::ONBOARDING_STEP_WPCOM_CONNECTION,
'context' => array(
'connection_state' => $this->get_wpcom_connection_state(),
),
),
$location,
$rest_path
);
// If the WPCOM connection is already set up, we don't need to add anything more.
if ( self::ONBOARDING_STEP_STATUS_COMPLETED !== $wpcom_step['status'] ) {
// Craft the return URL.
switch ( $source ) {
case self::SESSION_ENTRY_LYS:
// If the source is LYS, we return the user to the Launch Your Store flow.
$return_url = $this->proxy->call_function(
'admin_url',
'admin.php?page=wc-admin&path=/launch-your-store' . self::ONBOARDING_PATH_BASE . '&sidebar=hub&content=payments'
);
break;
default:
// By default, we return the user to the onboarding modal in the Settings > Payments page.
$return_url = $this->proxy->call_static(
Utils::class,
'wc_payments_settings_url',
self::ONBOARDING_PATH_BASE
);
break;
}
// Add standardized query arguments to the return URL.
$return_url = add_query_arg(
array(
// URL query flag so we can properly identify when the user returns
// either by accepting or rejecting the WPCOM connection.
self::WPCOM_CONNECTION_RETURN_PARAM => '1',
// Keep the source.
'source' => $source,
// Attach the `from` parameter to more easily identify where the return request is coming from.
'from' => self::FROM_WPCOM,
),
$return_url
);
// Try to generate the authorization URL.
$wpcom_connection = $this->get_wpcom_connection_authorization( $return_url );
if ( ! $wpcom_connection['success'] ) {
// In case of errors, make sure we work with a list of error messages.
$wpcom_step['errors'] = array_values( (array) ( $wpcom_connection['errors'] ?? array() ) );
}
$wpcom_step['actions'] = array(
'start' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_WPCOM_CONNECTION . '/start' ),
),
'auth' => array(
'type' => self::ACTION_TYPE_REDIRECT,
'href' => $wpcom_connection['url'],
),
);
}
$steps[] = $wpcom_step;
// Test account onboarding step is unavailable in UAE and Singapore.
if ( ! in_array( $location, array( 'AE', 'SG' ), true ) ) {
$test_account_step = $this->standardize_onboarding_step_details(
array(
'id' => self::ONBOARDING_STEP_TEST_ACCOUNT,
),
$location,
$rest_path
);
// If the step is not completed, we need to add the actions.
if ( self::ONBOARDING_STEP_STATUS_COMPLETED !== $test_account_step['status'] ) {
$test_account_step['actions'] = array(
'start' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_TEST_ACCOUNT . '/start' ),
),
'init' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_TEST_ACCOUNT . '/init' ),
),
'finish' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_TEST_ACCOUNT . '/finish' ),
),
);
}
$test_account_step['actions']['reset'] = array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_TEST_ACCOUNT . '/reset' ),
);
$steps[] = $test_account_step;
}
// Add the live account business verification onboarding step details.
$business_verification_step_sub_steps = $this->get_nox_profile_onboarding_step_data_entry(
self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
$location,
'sub_steps',
array()
);
// Sanity check: If there is no account connected, the sub-steps details should be forced empty.
// This way we allow for the Transact Platform account reset to take effect and
// allow the user to restart the business verification process, including the self-assessment business step.
if ( ! $this->has_account() ) {
$business_verification_step_sub_steps = array();
}
$business_verification_step = $this->standardize_onboarding_step_details(
array(
'id' => self::ONBOARDING_STEP_BUSINESS_VERIFICATION,
'context' => array(
'fields' => array(),
'sub_steps' => $business_verification_step_sub_steps,
'self_assessment' => $this->get_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location, 'self_assessment', array() ),
'has_test_account' => $this->has_test_account(),
'has_sandbox_account' => $this->has_sandbox_account(),
),
),
$location,
$rest_path
);
// Try to get the pre-KYC fields, but only if the required step is completed.
// This is because WooPayments needs a working WPCOM connection to be able to fetch the fields.
if ( $this->check_onboarding_step_requirements( self::ONBOARDING_STEP_BUSINESS_VERIFICATION, $location ) ) {
try {
$business_verification_step['context']['fields'] = $this->get_onboarding_kyc_fields( $location );
} catch ( Exception $e ) {
$business_verification_step['errors'][] = array(
'code' => 'fields_error',
'message' => $e->getMessage(),
);
}
}
// If the step is not completed, we need to add the actions.
if ( self::ONBOARDING_STEP_STATUS_COMPLETED !== $business_verification_step['status'] ) {
$business_verification_step['actions'] = array(
'start' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/start' ),
),
'save' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/save' ),
),
'kyc_session' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/kyc_session' ),
),
'kyc_session_finish' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/kyc_session/finish' ),
),
'kyc_fallback' => array(
'type' => self::ACTION_TYPE_REDIRECT,
'href' => $this->get_onboarding_kyc_fallback_url(),
),
'finish' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/finish' ),
),
'test_account_disable' => array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . self::ONBOARDING_STEP_BUSINESS_VERIFICATION . '/test_account/disable' ),
),
);
}
$steps[] = $business_verification_step;
// Do a complete list standardization, for safety.
return $this->standardize_onboarding_steps_details( $steps, $location, $rest_path );
}
/**
* Standardize (and sanity check) the onboarding step details.
*
* @param array $step_details The onboarding step details to standardize.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $rest_path The REST API path to use for constructing REST API URLs.
*
* @return array The standardized onboarding step details.
* @throws Exception If the onboarding step details are missing required entries or if the step ID is invalid.
*/
private function standardize_onboarding_step_details( array $step_details, string $location, string $rest_path ): array {
// If the required keys are not present, throw.
if ( ! isset( $step_details['id'] ) ) {
/* translators: %s: The required key that is missing. */
throw new Exception( sprintf( esc_html__( 'The onboarding step is missing required entries: %s', 'woocommerce' ), 'id' ) );
}
// Validate the step ID.
if ( ! $this->is_valid_onboarding_step_id( $step_details['id'] ) ) {
/* translators: %s: The invalid step ID. */
throw new Exception( sprintf( esc_html__( 'The onboarding step ID is invalid: %s', 'woocommerce' ), esc_attr( $step_details['id'] ) ) );
}
if ( empty( $step_details['status'] ) ) {
$step_details['status'] = $this->get_onboarding_step_status( $step_details['id'], $location );
}
if ( empty( $step_details['errors'] ) ) {
$step_details['errors'] = array();
// For blocked or failed steps, we include any stored error.
if ( in_array( $step_details['status'], array( self::ONBOARDING_STEP_STATUS_BLOCKED, self::ONBOARDING_STEP_STATUS_FAILED ), true ) ) {
$stored_error = $this->get_onboarding_step_error( $step_details['id'], $location );
if ( ! empty( $stored_error ) ) {
$step_details['errors'] = array( $stored_error );
}
}
}
// Standardize errors to be a list of arrays with `code`, `message`, and optional extra keys.
$standardized_errors = array();
// If the errors is not a list of errors or it has any of the reserved entries,
// treat it as a single error.
if ( ! is_array( $step_details['errors'] )
|| array_key_exists( 'code', $step_details['errors'] )
|| array_key_exists( 'message', $step_details['errors'] )
|| array_key_exists( 'context', $step_details['errors'] )
) {
$raw_errors = array( $step_details['errors'] );
} else {
$raw_errors = $step_details['errors'];
}
foreach ( $raw_errors as $error ) {
if ( $error instanceof \WP_Error ) {
$error = array(
'code' => $error->get_error_code(),
'message' => $error->get_error_message(),
'context' => $error->get_error_data(),
);
} elseif ( is_array( $error ) ) {
if ( empty( $error['code'] ) ) {
$error['code'] = 'general_error';
}
if ( ! array_key_exists( 'message', $error ) ) {
$error['message'] = '';
}
} else {
$error = array(
'code' => 'general_error',
'message' => (string) $error,
);
}
$standardized_errors[] = $this->sanitize_onboarding_step_error( $error );
}
$step_details['errors'] = $standardized_errors;
// Ensure that any step has the general actions.
if ( empty( $step_details['actions'] ) ) {
$step_details['actions'] = array();
}
// Any step can be checked for its status.
if ( empty( $step_details['actions']['check'] ) ) {
$step_details['actions']['check'] = array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . $step_details['id'] . '/check' ),
);
}
// Any step can be cleaned of its progress.
if ( empty( $step_details['actions']['clean'] ) ) {
$step_details['actions']['clean'] = array(
'type' => self::ACTION_TYPE_REST,
'href' => rest_url( trailingslashit( $rest_path ) . $step_details['id'] . '/clean' ),
);
}
return array(
'id' => $step_details['id'],
'path' => $step_details['path'] ?? trailingslashit( self::ONBOARDING_PATH_BASE ) . $step_details['id'],
'required_steps' => $step_details['required_steps'] ?? $this->get_onboarding_step_required_steps( $step_details['id'] ),
'status' => $step_details['status'],
'errors' => $step_details['errors'],
'actions' => $step_details['actions'],
'context' => $step_details['context'] ?? array(),
);
}
/**
* Standardize (and sanity check) the onboarding steps list.
*
* @param array $steps The onboarding steps list to standardize.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $rest_path The REST API path to use for constructing REST API URLs.
*
* @return array The standardized onboarding steps list.
* @throws Exception If some onboarding steps are missing required entries or if invalid step IDs are present.
*/
private function standardize_onboarding_steps_details( array $steps, string $location, string $rest_path ): array {
$standardized_steps = array();
foreach ( $steps as $step ) {
$standardized_steps[] = $this->standardize_onboarding_step_details( $step, $location, $rest_path );
}
return $standardized_steps;
}
/**
* Get the entire stored NOX profile data.
*
* @return array The stored NOX profile.
*/
private function get_nox_profile(): array {
$nox_profile = $this->proxy->call_function( 'get_option', self::NOX_PROFILE_OPTION_KEY, array() );
if ( empty( $nox_profile ) ) {
$nox_profile = array();
} else {
$nox_profile = maybe_unserialize( $nox_profile );
}
return $nox_profile;
}
/**
* Save the NOX profile data.
*
* @param array $data The data to save in the profile.
*
* @return bool Whether the data was saved.
*/
private function save_nox_profile( array $data ): bool {
return $this->proxy->call_function( 'update_option', self::NOX_PROFILE_OPTION_KEY, $data, false );
}
/**
* Get the onboarding data from the NOX profile.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return array The onboarding stored data from the NOX profile.
* If the step data is not found, an empty array is returned.
*/
private function get_nox_profile_onboarding( string $location ): array {
$nox_profile = $this->get_nox_profile();
if ( empty( $nox_profile['onboarding'] ) ) {
$nox_profile['onboarding'] = array();
}
if ( empty( $nox_profile['onboarding'][ $location ] ) ) {
$nox_profile['onboarding'][ $location ] = array();
}
return $nox_profile['onboarding'][ $location ];
}
/**
* Save the onboarding data in the NOX profile.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $data The onboarding step data to save in the profile.
*
* @return bool Whether the onboarding data was saved.
*/
private function save_nox_profile_onboarding( string $location, array $data ): bool {
$nox_profile = $this->get_nox_profile();
if ( empty( $nox_profile['onboarding'] ) ) {
$nox_profile['onboarding'] = array();
}
// Update the stored data.
$nox_profile['onboarding'][ $location ] = $data;
return $this->save_nox_profile( $nox_profile );
}
/**
* Get the onboarding step data from the NOX profile.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return array The onboarding step stored data from the NOX profile.
* If the step data is not found, an empty array is returned.
*/
private function get_nox_profile_onboarding_step( string $step_id, string $location ): array {
$nox_profile_onboarding = $this->get_nox_profile_onboarding( $location );
if ( empty( $nox_profile_onboarding['steps'] ) ) {
$nox_profile_onboarding['steps'] = array();
}
if ( empty( $nox_profile_onboarding['steps'][ $step_id ] ) ) {
$nox_profile_onboarding['steps'][ $step_id ] = array();
}
return $nox_profile_onboarding['steps'][ $step_id ];
}
/**
* Save the onboarding step data in the NOX profile.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array $data The onboarding step data to save in the profile.
*
* @return bool Whether the onboarding step data was saved.
*/
private function save_nox_profile_onboarding_step( string $step_id, string $location, array $data ): bool {
$nox_profile_onboarding = $this->get_nox_profile_onboarding( $location );
if ( empty( $nox_profile_onboarding['steps'] ) ) {
$nox_profile_onboarding['steps'] = array();
}
// Update the stored step data.
$nox_profile_onboarding['steps'][ $step_id ] = $data;
return $this->save_nox_profile_onboarding( $location, $nox_profile_onboarding );
}
/**
* Get an entry from the NOX profile onboarding step details.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $entry The entry to get from the step data.
* @param mixed $default_value The default value to return if the entry is not found.
*
* @return mixed The entry from the NOX profile step details. If the entry is not found, the default value is returned.
*/
private function get_nox_profile_onboarding_step_entry( string $step_id, string $location, string $entry, $default_value = array() ): array {
$step_details = $this->get_nox_profile_onboarding_step( $step_id, $location );
if ( ! isset( $step_details[ $entry ] ) ) {
return $default_value;
}
return $step_details[ $entry ];
}
/**
* Save an entry in the NOX profile onboarding step details.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $entry The entry key under which to save in the step data.
* @param array $data The data to save in the step data.
*
* @return bool Whether the onboarding step data was saved.
*/
private function save_nox_profile_onboarding_step_entry( string $step_id, string $location, string $entry, array $data ): bool {
$step_details = $this->get_nox_profile_onboarding_step( $step_id, $location );
// Update the stored step data.
$step_details[ $entry ] = $data;
return $this->save_nox_profile_onboarding_step( $step_id, $location, $step_details );
}
/**
* Get a data entry from the NOX profile onboarding step details.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $entry The entry to get from the step `data`.
* @param mixed $default_value The default value to return if the entry is not found.
*
* @return mixed The entry value from the NOX profile stored step data.
* If the entry is not found, the default value is returned.
*/
private function get_nox_profile_onboarding_step_data_entry( string $step_id, string $location, string $entry, $default_value = false ) {
$step_details_data = $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'data' );
if ( ! isset( $step_details_data[ $entry ] ) ) {
return $default_value;
}
return $step_details_data[ $entry ];
}
/**
* Save a data entry in the NOX profile onboarding step details.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param string $entry The entry key under which to save in the step `data`.
* @param mixed $data The value to save.
*
* @return bool Whether the onboarding step data was saved.
*/
private function save_nox_profile_onboarding_step_data_entry( string $step_id, string $location, string $entry, $data ): bool {
$step_details_data = $this->get_nox_profile_onboarding_step_entry( $step_id, $location, 'data' );
// Update the stored step data.
$step_details_data[ $entry ] = $data;
return $this->save_nox_profile_onboarding_step_entry( $step_id, $location, 'data', $step_details_data );
}
/**
* Get the IDs of the onboarding steps that are required for the given step.
*
* @param string $step_id The ID of the onboarding step.
*
* @return array|string[] The IDs of the onboarding steps that are required for the given step.
*/
private function get_onboarding_step_required_steps( string $step_id ): array {
switch ( $step_id ) {
// Both the test account and business verification (live account) steps require a working WPCOM connection.
case self::ONBOARDING_STEP_TEST_ACCOUNT:
case self::ONBOARDING_STEP_BUSINESS_VERIFICATION:
return array(
self::ONBOARDING_STEP_WPCOM_CONNECTION,
);
default:
return array();
}
}
/**
* Check if the requirements for an onboarding step are met.
*
* @param string $step_id The ID of the onboarding step.
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return bool Whether the onboarding step requirements are met.
* @throws ApiArgumentException If the given onboarding step ID is invalid.
*/
private function check_onboarding_step_requirements( string $step_id, string $location ): bool {
$requirements = $this->get_onboarding_step_required_steps( $step_id );
foreach ( $requirements as $required_step_id ) {
if ( $this->get_onboarding_step_status( $required_step_id, $location ) !== self::ONBOARDING_STEP_STATUS_COMPLETED ) {
return false;
}
}
return true;
}
/**
* Get the payment methods state for onboarding.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
* @param array|null $recommended_pms Optional. The recommended payment methods to use.
*
* @return array The onboarding payment methods state.
*/
private function get_onboarding_payment_methods_state( string $location, ?array $recommended_pms ): array {
// First, get the recommended payment methods details from the provider.
// We will use their enablement state as the default.
// Note: The list is validated and standardized by the provider, so we don't need to do it here.
if ( null === $recommended_pms ) {
$recommended_pms = $this->get_onboarding_recommended_payment_methods( $location );
}
if ( empty( $recommended_pms ) ) {
// If there are no recommended payment methods, return an empty array.
return array();
}
// Grab the stored payment methods state
// (a key-value array of payment method IDs and if they should be automatically enabled or not).
$step_pms_data = (array) $this->get_nox_profile_onboarding_step_data_entry( self::ONBOARDING_STEP_PAYMENT_METHODS, $location, 'payment_methods' );
$payment_methods_state = array();
$apple_pay_enabled = false;
$google_pay_enabled = false;
foreach ( $recommended_pms as $recommended_pm ) {
$pm_id = $recommended_pm['id'];
/**
* We need to handle Apple Pay and Google Pay separately.
* They are not stored in the same way as the other payment methods.
*/
if ( 'apple_pay' === $pm_id ) {
$apple_pay_enabled = $recommended_pm['enabled'];
continue;
}
if ( 'google_pay' === $pm_id ) {
$google_pay_enabled = $recommended_pm['enabled'];
continue;
}
// Start with the recommended enabled state.
$payment_methods_state[ $pm_id ] = $recommended_pm['enabled'];
// Force enable if required.
if ( $recommended_pm['required'] ) {
$payment_methods_state[ $pm_id ] = true;
continue;
}
// Check the stored state, if any.
if ( isset( $step_pms_data[ $pm_id ] ) ) {
$payment_methods_state[ $pm_id ] = wc_string_to_bool( $step_pms_data[ $pm_id ] );
}
}
// Combine Apple Pay and Google Pay into a single `apple_google` entry.
// First check if apple_google is explicitly stored, otherwise fallback to combining individual states.
if ( isset( $step_pms_data['apple_google'] ) ) {
$apple_google_enabled = wc_string_to_bool( $step_pms_data['apple_google'] );
} else {
// Fallback to OR logic for backward compatibility.
$apple_google_enabled = $apple_pay_enabled || $google_pay_enabled;
}
$payment_methods_state['apple_google'] = $apple_google_enabled;
return $payment_methods_state;
}
/**
* Get the WPCOM (Jetpack) connection authorization details.
*
* @param string $return_url The URL to redirect to after the connection is set up.
*
* @return array The WPCOM connection authorization details.
*/
private function get_wpcom_connection_authorization( string $return_url ): array {
return $this->proxy->call_static( Utils::class, 'get_wpcom_connection_authorization', $return_url );
}
/**
* Get the store's WPCOM (Jetpack) connection state.
*
* @return array The WPCOM connection state.
*/
private function get_wpcom_connection_state(): array {
$is_connected = $this->wpcom_connection_manager->is_connected();
$has_connected_owner = $this->wpcom_connection_manager->has_connected_owner();
return array(
'has_working_connection' => $this->has_working_wpcom_connection(),
'is_store_connected' => $is_connected,
'has_connected_owner' => $has_connected_owner,
'is_connection_owner' => $has_connected_owner && $this->wpcom_connection_manager->is_connection_owner(),
);
}
/**
* Check if the store has a working WPCOM connection.
*
* The store is considered to have a working WPCOM connection if:
* - The store is connected to WPCOM (blog ID and tokens are set).
* - The store connection has a connected owner (connection owner is set).
*
* @return bool Whether the store has a working WPCOM connection.
*/
private function has_working_wpcom_connection(): bool {
return $this->wpcom_connection_manager->is_connected() && $this->wpcom_connection_manager->has_connected_owner();
}
/**
* Check if the WooPayments plugin is active.
*
* @return boolean
*/
private function is_extension_active(): bool {
return $this->proxy->call_function( 'class_exists', '\WC_Payments' );
}
/**
* Get the main payment gateway instance.
*
* @return \WC_Payment_Gateway The main payment gateway instance.
*/
private function get_payment_gateway(): \WC_Payment_Gateway {
return $this->proxy->call_static( '\WC_Payments', 'get_gateway' );
}
/**
* Determine if WooPayments has an account set up.
*
* @return bool Whether WooPayments has an account set up.
*/
private function has_account(): bool {
return $this->provider->is_account_connected( $this->get_payment_gateway() );
}
/**
* Determine if WooPayments has a valid, fully onboarded account set up.
*
* @return bool Whether WooPayments has a valid, fully onboarded account set up.
*/
private function has_valid_account(): bool {
if ( ! $this->has_account() ) {
return false;
}
$account_service = $this->proxy->call_static( '\WC_Payments', 'get_account_service' );
return $account_service->is_stripe_account_valid();
}
/**
* Determine if WooPayments has a working account set up.
*
* This is a more specific check than has_valid_account() and checks if payments are enabled for the account.
*
* @return bool Whether WooPayments has a working account set up.
*/
private function has_working_account(): bool {
if ( ! $this->has_account() ) {
return false;
}
$account_service = $this->proxy->call_static( '\WC_Payments', 'get_account_service' );
$account_status = $account_service->get_account_status_data();
return ! empty( $account_status['paymentsEnabled'] );
}
/**
* Determine if WooPayments has a test account set up.
*
* @return bool Whether WooPayments has a test account set up.
*/
private function has_test_account(): bool {
if ( ! $this->has_account() ) {
return false;
}
$account_service = $this->proxy->call_static( '\WC_Payments', 'get_account_service' );
$account_status = $account_service->get_account_status_data();
return ! empty( $account_status['testDrive'] );
}
/**
* Determine if WooPayments has a sandbox account set up.
*
* @return bool Whether WooPayments has a sandbox account set up.
*/
private function has_sandbox_account(): bool {
if ( ! $this->has_account() ) {
return false;
}
$account_service = $this->proxy->call_static( '\WC_Payments', 'get_account_service' );
$account_status = $account_service->get_account_status_data();
return empty( $account_status['isLive'] ) && empty( $account_status['testDrive'] );
}
/**
* Determine if WooPayments has a live account set up.
*
* @return bool Whether WooPayments has a test account set up.
*/
private function has_live_account(): bool {
if ( ! $this->has_account() ) {
return false;
}
$account_service = $this->proxy->call_static( '\WC_Payments', 'get_account_service' );
$account_status = $account_service->get_account_status_data();
return ! empty( $account_status['isLive'] );
}
/**
* Get the onboarding fields data for the KYC business verification.
*
* @param string $location The location for which we are onboarding.
* This is an ISO 3166-1 alpha-2 country code.
*
* @return array The onboarding fields data.
* @throws Exception If the onboarding fields data could not be retrieved or there was an error.
*/
private function get_onboarding_kyc_fields( string $location ): array {
// Call the WooPayments API to get the onboarding fields.
$response = $this->proxy->call_static( Utils::class, 'rest_endpoint_get_request', '/wc/v3/payments/onboarding/fields' );
if ( is_wp_error( $response ) ) {
throw new Exception( esc_html( $response->get_error_message() ) );
}
if ( ! is_array( $response ) || ! isset( $response['data'] ) ) {
throw new Exception( esc_html__( 'Failed to get onboarding fields data.', 'woocommerce' ) );
}
$fields = $response['data'];
// If there is no available_countries entry, add it.
if ( ! isset( $fields['available_countries'] ) &&
class_exists( '\WC_Payments_Utils' ) &&
$this->proxy->call_function( 'is_callable', '\WC_Payments_Utils::supported_countries' ) ) {
$fields['available_countries'] = $this->proxy->call_static( '\WC_Payments_Utils', 'supported_countries' );
}
$fields['location'] = $location;
return $fields;
}
/**
* Get the fallback URL for the embedded KYC flow.
*
* @return string The fallback URL for the embedded KYC flow.
*/
private function get_onboarding_kyc_fallback_url(): string {
if ( $this->proxy->call_function( 'is_callable', '\WC_Payments_Account::get_connect_url' ) ) {
return $this->proxy->call_static( '\WC_Payments_Account', 'get_connect_url', self::FROM_NOX_IN_CONTEXT );
}
// Fall back to the provider onboarding URL.
return $this->provider->get_onboarding_url(
$this->get_payment_gateway(),
Utils::wc_payments_settings_url( self::ONBOARDING_PATH_BASE, array( 'from' => self::FROM_KYC ) )
);
}
/**
* Get the WooPayments Overview page URL.
*
* @return string The WooPayments Overview page URL.
*/
private function get_overview_page_url(): string {
if ( $this->proxy->call_function( 'is_callable', '\WC_Payments_Account::get_overview_page_url' ) ) {
return add_query_arg(
array(
'from' => self::FROM_NOX_IN_CONTEXT,
),
$this->proxy->call_static( '\WC_Payments_Account', 'get_overview_page_url' )
);
}
// Fall back to the known WooPayments Overview page URL.
return add_query_arg(
array(
'page' => 'wc-admin',
'path' => '/payments/overview',
'from' => self::FROM_NOX_IN_CONTEXT,
),
admin_url( 'admin.php' )
);
}
/**
* Check the onboarding source and ensure it is a valid value.
*
* @param string|null $source The source of the onboarding request.
*
* @return string The validated onboarding source.
*/
private function validate_onboarding_source( ?string $source ): string {
if ( empty( $source ) ) {
return self::SESSION_ENTRY_DEFAULT;
}
$valid_sources = array(
self::SESSION_ENTRY_DEFAULT,
self::SESSION_ENTRY_LYS,
);
return in_array( $source, $valid_sources, true ) ? $source : self::SESSION_ENTRY_DEFAULT;
}
}
PK [1]9O F Admin/Settings/PaymentsProviders/WooPayments/WooPaymentsController.phpnu payments = $payments;
$this->woopayments = $woopayments;
}
/**
* Handle returns from WordPress.com after the user has accepted or declined the WPCOM connection.
*
* @internal
*/
public function handle_returns_from_wpcom(): void {
// Handle the return from WPCOM after the user has accepted or declined the WordPress.com connection.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( ! empty( $_GET[ WooPaymentsService::WPCOM_CONNECTION_RETURN_PARAM ] ) ) {
// We are only interested in connection flows that are initiated from NOX session entry points.
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( empty( $_GET['source'] ) ) {
return;
}
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
$source = sanitize_text_field( wp_unslash( $_GET['source'] ) );
if ( ! in_array( $source, array( WooPaymentsService::SESSION_ENTRY_DEFAULT, WooPaymentsService::SESSION_ENTRY_LYS ), true ) ) {
return;
}
$location = $this->payments->get_country();
// Determine the connection state by querying the WPCOM connection onboarding step status.
$wpcom_connected = WooPaymentsService::ONBOARDING_STEP_STATUS_COMPLETED === $this->woopayments->get_onboarding_step_status( WooPaymentsService::ONBOARDING_STEP_WPCOM_CONNECTION, $location );
// Track the connection attempt result.
$event_props = array(
'step_id' => WooPaymentsService::ONBOARDING_STEP_WPCOM_CONNECTION,
'source' => $source,
);
$this->woopayments->record_event(
$wpcom_connected ? 'wpcom_connection_success' : 'wpcom_connection_failure',
$location,
$event_props
);
// On successful connection, mark the onboarding step as completed, if not already.
if ( $wpcom_connected ) {
$this->woopayments->mark_onboarding_step_completed( WooPaymentsService::ONBOARDING_STEP_WPCOM_CONNECTION, $location );
}
}
}
}
PK [1] pwMdo do 0 Admin/Settings/PaymentsProviders/WooPayments.phpnu has_test_account();
$has_sandbox_account = $this->has_sandbox_account();
// Switch the onboarding type to native.
$details['onboarding']['type'] = self::ONBOARDING_TYPE_NATIVE;
// Add the test [drive] account details to the onboarding state.
$details['onboarding']['state']['test_drive_account'] = $has_test_account;
// Add WPCOM/Jetpack connection details to the onboarding state.
$details['onboarding']['state'] = array_merge( $details['onboarding']['state'], $this->get_wpcom_connection_state() );
// If the WooPayments installed version is less than minimum required version,
// we can't use the in-context onboarding flows.
if ( Constants::is_defined( 'WCPAY_VERSION_NUMBER' ) &&
version_compare( Constants::get_constant( 'WCPAY_VERSION_NUMBER' ), WooPaymentsService::EXTENSION_MINIMUM_VERSION, '<' ) ) {
return $details;
}
// Switch the onboarding type to native in-context.
$details['onboarding']['type'] = self::ONBOARDING_TYPE_NATIVE_IN_CONTEXT;
// Provide the native, in-context onboarding URL instead of the external one.
// This is a catch-all URL that should start or continue the onboarding process.
$details['onboarding']['_links']['onboard'] = array(
'href' => Utils::wc_payments_settings_url( '/woopayments/onboarding', array( 'from' => Payments::FROM_PAYMENTS_SETTINGS ) ),
);
try {
/**
* The WooPayments REST controller instance.
*
* @var WooPaymentsRestController $rest_controller
*/
$rest_controller = wc_get_container()->get( WooPaymentsRestController::class );
// Add disable test account URL to onboarding links, if the current account is a test or sandbox account.
if ( $has_test_account || $has_sandbox_account ) {
$details['onboarding']['_links']['disable_test_account'] = array(
'href' => rest_url( $rest_controller->get_rest_url_path( 'onboarding/test_account/disable' ) ),
);
}
// Add reset account/onboarding URL to onboarding links.
$details['onboarding']['_links']['reset'] = array(
'href' => rest_url( $rest_controller->get_rest_url_path( 'onboarding/reset' ) ),
);
} catch ( \Throwable $e ) {
// If the REST controller is not available, we can't generate the REST API endpoint URLs.
// This is not a critical error, so we just ignore it.
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get the WooPayments REST controller instance: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
}
// Override the onboarding state with the entries provided by the WooPayments service.
if ( ! empty( $country_code ) ) {
try {
/**
* The WooPayments service instance.
*
* @var WooPaymentsService $service
*/
$service = wc_get_container()->get( WooPaymentsService::class );
// Ensure we have a valid rest_controller from the earlier try block.
if ( ! isset( $rest_controller ) ) {
throw new \RuntimeException( 'WooPayments REST controller not available' );
}
$onboarding_details = $service->get_onboarding_details( $country_code, $rest_controller->get_rest_url_path( 'onboarding' ) );
// Merge the onboarding state with the one provided by the service.
if ( ! empty( $onboarding_details['state'] ) && is_array( $onboarding_details['state'] ) ) {
$details['onboarding']['state'] = array_merge(
$details['onboarding']['state'],
$onboarding_details['state']
);
}
// Merge any messages provided by the service.
if ( ! empty( $onboarding_details['messages'] ) && is_array( $onboarding_details['messages'] ) ) {
if ( ! isset( $details['onboarding']['messages'] ) || ! is_array( $details['onboarding']['messages'] ) ) {
$details['onboarding']['messages'] = array();
}
$details['onboarding']['messages'] = array_merge(
$details['onboarding']['messages'],
$onboarding_details['messages']
);
}
// The steps provided by the service override any existing steps.
if ( ! empty( $onboarding_details['steps'] ) && is_array( $onboarding_details['steps'] ) ) {
$details['onboarding']['steps'] = $onboarding_details['steps'];
}
// Merge any context provided by the service.
if ( ! empty( $onboarding_details['context'] ) && is_array( $onboarding_details['context'] ) ) {
if ( ! isset( $details['onboarding']['context'] ) || ! is_array( $details['onboarding']['context'] ) ) {
$details['onboarding']['context'] = array();
}
$details['onboarding']['context'] = array_merge(
$details['onboarding']['context'],
$onboarding_details['context']
);
}
} catch ( \Throwable $e ) {
// If the service is not available, we can't impose the more specific logic.
// This is not a critical error, so we just ignore it.
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get the WooPayments service instance: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
}
}
return $details;
}
/**
* Enhance this provider's payment extension suggestion with additional information.
*
* The details added do not require the payment extension to be active or a gateway instance.
*
* @param array $extension_suggestion The extension suggestion details.
*
* @return array The enhanced payment extension suggestion details.
*/
public function enhance_extension_suggestion( array $extension_suggestion ): array {
$extension_suggestion = parent::enhance_extension_suggestion( $extension_suggestion );
// If the extension is installed, we can get the plugin data and act upon it.
if ( ! empty( $extension_suggestion['plugin']['file'] ) &&
isset( $extension_suggestion['plugin']['status'] ) &&
in_array( $extension_suggestion['plugin']['status'], array( PaymentsProviders::EXTENSION_INSTALLED, PaymentsProviders::EXTENSION_ACTIVE ), true ) ) {
// Switch to the native in-context onboarding type if the WooPayments extension its version is compatible.
// We need to put back the '.php' extension to construct the plugin filename.
$plugin_data = $this->proxy->call_static( PluginsHelper::class, 'get_plugin_data', $extension_suggestion['plugin']['file'] . '.php' );
if ( $plugin_data && ! empty( $plugin_data['Version'] ) &&
version_compare( $plugin_data['Version'], PaymentsProviders\WooPayments\WooPaymentsService::EXTENSION_MINIMUM_VERSION, '>=' ) ) {
$extension_suggestion['onboarding']['type'] = self::ONBOARDING_TYPE_NATIVE_IN_CONTEXT;
}
} else {
// We assume the latest version of the WooPayments extension will be installed.
$extension_suggestion['onboarding']['type'] = self::ONBOARDING_TYPE_NATIVE_IN_CONTEXT;
}
// Add onboarding state.
if ( ! isset( $extension_suggestion['onboarding']['state'] ) || ! is_array( $extension_suggestion['onboarding']['state'] ) ) {
$extension_suggestion['onboarding']['state'] = array();
}
// Add the store's WPCOM/Jetpack connection state to the onboarding state.
$extension_suggestion['onboarding']['state'] = array_merge(
$extension_suggestion['onboarding']['state'],
$this->get_wpcom_connection_state()
);
// Add onboarding links.
if ( empty( $extension_suggestion['onboarding']['_links'] ) || ! is_array( $extension_suggestion['onboarding']['_links'] ) ) {
$extension_suggestion['onboarding']['_links'] = array();
}
// We only add the preload link if we don't have a working WPCOM connection.
// This is because WooPayments onboarding preloading focuses on hydrating the WPCOM connection.
if ( ! $extension_suggestion['onboarding']['state']['wpcom_has_working_connection'] ) {
try {
/**
* The WooPayments REST controller instance.
*
* @var WooPaymentsRestController $rest_controller
*/
$rest_controller = wc_get_container()->get( WooPaymentsRestController::class );
// Add the onboarding preload URL.
$extension_suggestion['onboarding']['_links']['preload'] = array(
'href' => rest_url( $rest_controller->get_rest_url_path( 'onboarding/preload' ) ),
);
} catch ( Throwable $e ) {
// If the REST controller is not available, we can't preload the onboarding data.
// This is not a critical error, so we just ignore it.
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get the WooPayments REST controller instance: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
}
}
return $extension_suggestion;
}
/**
* Check if the payment gateway needs setup.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway needs setup, false otherwise.
*/
public function needs_setup( WC_Payment_Gateway $payment_gateway ): bool {
// No account means we need setup.
if ( ! $this->is_account_connected( $payment_gateway ) ) {
return true;
}
// Test-drive accounts don't need setup.
if ( $this->has_test_account() ) {
return false;
}
return parent::needs_setup( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
if ( $this->proxy->call_function( 'class_exists', 'WC_Payments' ) &&
$this->proxy->call_function( 'is_callable', 'WC_Payments::mode' ) ) {
$woopayments_mode = $this->proxy->call_static( 'WC_Payments', 'mode' );
if ( $this->proxy->call_function( 'method_exists', $woopayments_mode, 'is_test' ) &&
$this->proxy->call_function( 'is_callable', array( $woopayments_mode, 'is_test' ) ) ) {
return $woopayments_mode->is_test();
}
}
return parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
if ( $this->proxy->call_function( 'class_exists', 'WC_Payments' ) &&
$this->proxy->call_function( 'is_callable', 'WC_Payments::mode' ) ) {
$woopayments_mode = $this->proxy->call_static( 'WC_Payments', 'mode' );
if ( $this->proxy->call_function( 'method_exists', $woopayments_mode, 'is_dev' ) &&
$this->proxy->call_function( 'is_callable', array( $woopayments_mode, 'is_dev' ) ) ) {
return $woopayments_mode->is_dev();
}
}
return parent::is_in_dev_mode( $payment_gateway );
}
/**
* Check if the payment gateway supports the current store state for onboarding.
*
* Most of the time the current business location should be the main factor, but could also
* consider other store settings like currency.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which to check.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return bool|null True if the payment gateway supports onboarding, false otherwise.
* If the payment gateway does not provide the information,
* we will return null to indicate that we don't know.
*/
public function is_onboarding_supported( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): ?bool {
$is_onboarding_supported = parent::is_onboarding_supported( $payment_gateway, $country_code );
if ( ! is_null( $is_onboarding_supported ) ) {
return $is_onboarding_supported;
}
// Without a country code to check against, we assume onboarding is supported to avoid blocking the user.
if ( empty( $country_code ) ) {
return true;
}
// Normalize the country code.
$country_code = strtoupper( $country_code );
// The payment gateway didn't provide the information. We will do it the hard way.
$supported_country_codes = $this->get_supported_country_codes();
// If we can't get the supported countries, we assume onboarding supported to avoid blocking the user.
if ( is_null( $supported_country_codes ) ) {
return true;
}
return in_array( $country_code, $supported_country_codes, true );
}
/**
* Get the message to show when the payment gateway does not support onboarding.
*
* @see self::is_onboarding_supported()
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code Optional. The country code for which to check.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return string|null The message to show when the payment gateway does not support onboarding,
* or null if no specific message should be provided.
*/
public function get_onboarding_not_supported_message( WC_Payment_Gateway $payment_gateway, string $country_code = '' ): ?string {
$message = parent::get_onboarding_not_supported_message( $payment_gateway, $country_code );
if ( ! is_null( $message ) ) {
return $message;
}
return sprintf(
/* translators: %s: WooPayments. */
esc_html__( '%s is not supported in the selected business location.', 'woocommerce' ),
'WooPayments'
);
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
if ( $this->proxy->call_function( 'class_exists', 'WC_Payments' ) &&
$this->proxy->call_function( 'is_callable', 'WC_Payments::mode' ) ) {
$woopayments_mode = $this->proxy->call_static( 'WC_Payments', 'mode' );
if ( $this->proxy->call_function( 'method_exists', $woopayments_mode, 'is_test_mode_onboarding' ) &&
$this->proxy->call_function( 'is_callable', array( $woopayments_mode, 'is_test_mode_onboarding' ) ) ) {
return $woopayments_mode->is_test_mode_onboarding();
}
}
return parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Get the onboarding URL for the payment gateway.
*
* This URL should start or continue the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $return_url Optional. The URL to return to after onboarding.
* This will likely get attached to the onboarding URL.
*
* @return string The onboarding URL for the payment gateway.
*/
public function get_onboarding_url( WC_Payment_Gateway $payment_gateway, string $return_url = '' ): string {
if ( $this->proxy->call_function( 'class_exists', 'WC_Payments_Account' ) &&
$this->proxy->call_function( 'is_callable', 'WC_Payments_Account::get_connect_url' ) ) {
$connect_url = $this->proxy->call_static( 'WC_Payments_Account', 'get_connect_url' );
} else {
$connect_url = parent::get_onboarding_url( $payment_gateway, $return_url );
}
// Default URL params to set, regardless if they exist.
$params = array(
'from' => Constants::is_defined( 'WC_Payments_Onboarding_Service::FROM_WCADMIN_PAYMENTS_SETTINGS' ) ? (string) Constants::get_constant( 'WC_Payments_Onboarding_Service::FROM_WCADMIN_PAYMENTS_SETTINGS' ) : 'WCADMIN_PAYMENT_SETTINGS',
'source' => Constants::is_defined( 'WC_Payments_Onboarding_Service::SOURCE_WCADMIN_SETTINGS_PAGE' ) ? (string) Constants::get_constant( 'WC_Payments_Onboarding_Service::SOURCE_WCADMIN_SETTINGS_PAGE' ) : 'wcadmin-settings-page',
'redirect_to_settings_page' => 'true',
);
// First, sanity check to handle existing accounts.
// Such accounts should keep their current onboarding mode.
// Do not force things either way.
if ( $this->is_account_connected( $payment_gateway ) ) {
return add_query_arg( $params, $connect_url );
}
// We don't have an account yet, so the onboarding link is used to kickstart the process.
// Default to test-account-first onboarding.
$live_onboarding = false;
/*
* Apply our routing logic to determine if we should do a live onboarding/account.
*
* For new stores (not yet launched aka in Coming Soon mode),
* based on the answers provided in the onboarding profile, we will do live onboarding if:
* - Merchant selected “I’m already selling” AND answered either:
* - Yes, I’m selling online.
* - I’m selling both online and offline.
*
* For launched stores, we will only consider live onboarding if all are true:
* - Store is at least 90 days old.
* - Store has an active payments gateway (other than WooPayments).
* - Store has processed a live electronic payment in the past 90 days (any gateway).
*
* @see plugins/woocommerce/client/admin/client/core-profiler/pages/UserProfile.tsx for the values.
*/
if ( filter_var( get_option( 'woocommerce_coming_soon' ), FILTER_VALIDATE_BOOLEAN ) ) {
$onboarding_profile = get_option( OnboardingProfile::DATA_OPTION, array() );
if (
isset( $onboarding_profile['business_choice'] ) && 'im_already_selling' === $onboarding_profile['business_choice'] &&
isset( $onboarding_profile['selling_online_answer'] ) && (
'yes_im_selling_online' === $onboarding_profile['selling_online_answer'] ||
'im_selling_both_online_and_offline' === $onboarding_profile['selling_online_answer']
)
) {
$live_onboarding = true;
}
} elseif (
WCAdminHelper::is_wc_admin_active_for( 90 * DAY_IN_SECONDS ) &&
$this->has_enabled_other_ecommerce_gateways() &&
$this->has_orders()
) {
$live_onboarding = true;
}
// If we are doing live onboarding, we don't need to add more to the URL.
// But for test-drive/sandbox mode, we have work to do.
if ( ! $live_onboarding ) {
$params['test_drive'] = 'true';
$params['auto_start_test_drive_onboarding'] = 'true';
}
return add_query_arg( $params, $connect_url );
}
/**
* Check if the store has any paid orders.
*
* Currently, we look at the past 90 days and only consider orders
* with status `wc-completed`, `wc-processing`, or `wc-refunded`.
*
* @return boolean Whether the store has any paid orders.
*/
private function has_orders(): bool {
$store_has_orders_transient_name = self::PREFIX . 'store_has_orders';
// First, get the stored value, if it exists.
// This way we avoid costly DB queries and API calls.
$has_orders = get_transient( $store_has_orders_transient_name );
if ( false !== $has_orders ) {
return wc_string_to_bool( $has_orders );
}
// We need to determine the value.
// Start with the assumption that the store doesn't have orders in the timeframe we look at.
$has_orders = false;
// By default, we will check for new orders every 6 hours.
$expiration = 6 * HOUR_IN_SECONDS;
// Get the latest completed, processing, or refunded order.
$latest_order = wc_get_orders(
array(
'status' => array( OrderInternalStatus::COMPLETED, OrderInternalStatus::PROCESSING, OrderInternalStatus::REFUNDED ),
'limit' => 1,
'orderby' => 'date',
'order' => 'DESC',
)
);
if ( ! empty( $latest_order ) ) {
$latest_order = reset( $latest_order );
// If the latest order is within the timeframe we look at, we consider the store to have orders.
// Otherwise, it clearly doesn't have orders.
if ( $latest_order instanceof WC_Abstract_Order
&& strtotime( (string) $latest_order->get_date_created() ) >= strtotime( '-90 days' ) ) {
$has_orders = true;
// For ultimate efficiency, we will check again after 90 days from the latest order
// because in all that time we will consider the store to have orders regardless of new orders.
$expiration = strtotime( (string) $latest_order->get_date_created() ) + 90 * DAY_IN_SECONDS - time();
}
}
// Store the value for future use.
set_transient( $store_has_orders_transient_name, $has_orders ? 'yes' : 'no', $expiration );
return $has_orders;
}
/**
* Check if the store has any other enabled ecommerce gateways.
*
* We exclude offline payment methods from this check.
*
* @return bool True if the store has any enabled ecommerce gateways, false otherwise.
*/
private function has_enabled_other_ecommerce_gateways(): bool {
$gateways = WC()->payment_gateways()->payment_gateways;
$other_ecommerce_gateways = array_filter(
$gateways,
function ( $gateway ) {
// Filter out offline gateways and WooPayments.
return 'yes' === $gateway->enabled &&
! in_array(
$gateway->id,
array( 'woocommerce_payments', ...PaymentsProviders::OFFLINE_METHODS ),
true
);
}
);
return ! empty( $other_ecommerce_gateways );
}
/**
* Determines if the current account is a test account.
*
* Test accounts are test-drive accounts.
* They are different from sandbox accounts (i.e. accounts onboarded in test mode).
*
* @return bool True if the account is a test account, false otherwise.
*/
private function has_test_account(): bool {
if ( $this->proxy->call_function( 'function_exists', 'wcpay_get_container' ) &&
$this->proxy->call_function( 'class_exists', 'WC_Payments_Account' ) ) {
$woopayments_container = $this->proxy->call_function( 'wcpay_get_container' );
$account_service = $woopayments_container->get( 'WC_Payments_Account' );
if ( ! empty( $account_service ) &&
$this->proxy->call_function( 'method_exists', $account_service, 'get_account_status_data' ) &&
$this->proxy->call_function( 'is_callable', array( $account_service, 'get_account_status_data' ) ) ) {
$account_status = $account_service->get_account_status_data();
return ! empty( $account_status['testDrive'] );
}
}
return false;
}
/**
* Determines if the current account is a sandbox account.
*
* Sandbox accounts are accounts that were onboarded in test mode.
* They are different from test accounts (i.e. test-drive accounts).
*
* Sandbox accounts are generally created in development or staging environments when simulating live onboarding.
*
* @return bool True if the account is a sandbox account, false otherwise.
*/
private function has_sandbox_account(): bool {
if ( $this->proxy->call_function( 'function_exists', 'wcpay_get_container' ) &&
$this->proxy->call_function( 'class_exists', 'WC_Payments_Account' ) ) {
$woopayments_container = $this->proxy->call_function( 'wcpay_get_container' );
$account_service = $woopayments_container->get( 'WC_Payments_Account' );
if ( ! empty( $account_service ) &&
$this->proxy->call_function( 'method_exists', $account_service, 'get_account_status_data' ) &&
$this->proxy->call_function( 'is_callable', array( $account_service, 'get_account_status_data' ) ) ) {
$account_status = $account_service->get_account_status_data();
return empty( $account_status['isLive'] ) && empty( $account_status['testDrive'] );
}
}
return false;
}
/**
* Get the list of supported country codes for WooPayments.
*
* @return array|null The list of supported countries as ISO 3166-1 alpha-2 country codes.
* The country codes are normalized in uppercase.
* If the list cannot be retrieved, null is returned.
*/
private function get_supported_country_codes(): ?array {
try {
if ( $this->proxy->call_function( 'class_exists', 'WC_Payments_Utils' ) &&
$this->proxy->call_function( 'is_callable', 'WC_Payments_Utils::supported_countries' ) ) {
$supported_country_codes = $this->proxy->call_static( 'WC_Payments_Utils', 'supported_countries' );
if ( is_array( $supported_country_codes ) ) {
return array_unique( array_map( 'strtoupper', array_keys( $supported_country_codes ) ) );
}
}
} catch ( Throwable $e ) {
// This is not a critical error, so we just ignore it.
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get the WooPayments supported country codes list: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
}
return null;
}
/**
* Get the current state of the store's WPCOM/Jetpack connection.
*
* @return array The store's WPCOM/Jetpack connection state.
*/
private function get_wpcom_connection_state(): array {
try {
$wpcom_connection_manager = $this->proxy->get_instance_of( WPCOM_Connection_Manager::class, 'woocommerce' );
} catch ( \Throwable $e ) {
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get the WPCOM/Jetpack Connection Manager instance: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
// Assume no connection.
return array(
'wpcom_has_working_connection' => false,
'wpcom_is_store_connected' => false,
'wpcom_has_connected_owner' => false,
'wpcom_is_connection_owner' => false,
);
}
$is_connected = $wpcom_connection_manager->is_connected();
$has_connected_owner = $wpcom_connection_manager->has_connected_owner();
return array(
'wpcom_has_working_connection' => $is_connected && $has_connected_owner,
'wpcom_is_store_connected' => $is_connected,
'wpcom_has_connected_owner' => $has_connected_owner,
'wpcom_is_connection_owner' => $has_connected_owner && $wpcom_connection_manager->is_connection_owner(),
);
}
}
PK [1][Qm ) Admin/Settings/PaymentsProviders/Eway.phpnu get_option( 'customer_api' ) ) && ! empty( $payment_gateway->get_option( 'customer_password' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_eway_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_eway_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_eway_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Eway payment gateway is in test/sandbox mode.
*
* There are two different environments: test/sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_eway_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
// Prefer option over property.
$raw_option = $payment_gateway->get_option( 'testmode' );
if ( '' !== $raw_option && null !== $raw_option ) {
return \wc_string_to_bool( $raw_option );
}
if ( isset( $payment_gateway->testmode ) ) {
return \wc_string_to_bool( $payment_gateway->testmode );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1]ϡ
- Admin/Settings/PaymentsProviders/HelioPay.phpnu get_option( \HELIO_DEVNET_ENABLED ) );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in test mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_in_test_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
try {
if ( $this->is_in_test_mode( $payment_gateway ) ) {
if ( defined( 'HELIO_API_KEY_DEVNET' ) &&
defined( 'HELIO_API_SECRET_DEVNET' ) ) {
return ! empty( $payment_gateway->get_option( \HELIO_API_KEY_DEVNET ) ) && ! empty( $payment_gateway->get_option( \HELIO_API_SECRET_DEVNET ) );
}
} elseif ( defined( 'HELIO_API_KEY_MAINNET' ) &&
defined( 'HELIO_API_SECRET_MAINNET' ) ) {
return ! empty( $payment_gateway->get_option( \HELIO_API_KEY_MAINNET ) ) && ! empty( $payment_gateway->get_option( \HELIO_API_SECRET_MAINNET ) );
}
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for HelioPay, affecting the API credentials used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1] / Admin/Settings/PaymentsProviders/GoCardless.phpnu get_option( 'access_token', '' ) );
} catch ( Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway has an account connected: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
return parent::is_account_connected( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
// Test mode is actually sandbox mode for GoCardless, affecting the API keys used.
return $this->is_in_test_mode( $payment_gateway );
}
}
PK [1]"W\ + Admin/Settings/PaymentsProviders/Paymob.phpnu needs_setup() );
// If we get a true value, it means the gateway needs setup.
if ( $needs_setup ) {
return true;
}
// If we reach here, just assume that the gateway does not need setup.
return false;
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_paymob_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
// The Paymob gateway ties needs_setup only to the API keys, so if they are set, we consider the account connected.
return ! $this->needs_setup( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_paymob_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the Paymob payment gateway is in sandbox mode.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_paymob_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
try {
// Unfortunately, Paymob does not provide a standard way to determine if the gateway is in sandbox mode.
$options = get_option( 'woocommerce_paymob-main_settings', array() );
return 'test' === ( $options['mode'] ?? 'test' );
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
}
PK [1]}e e 0 Admin/Settings/PaymentsProviders/MercadoPago.phpnu is_mercado_pago_onboarded( $payment_gateway );
if ( ! is_null( $is_onboarded ) ) {
return ! $is_onboarded;
}
return parent::needs_setup( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode, false otherwise.
*/
public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mercado_pago_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in dev mode.
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in dev mode, false otherwise.
*/
public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mercado_pago_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
}
/**
* Check if the payment gateway has a payments processor account connected.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway account is connected, false otherwise.
* If the payment gateway does not provide the information, it will return true.
*/
public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mercado_pago_onboarded( $payment_gateway ) ?? parent::is_account_connected( $payment_gateway );
}
/**
* Check if the payment gateway has completed the onboarding process.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway has completed the onboarding process, false otherwise.
* If the payment gateway does not provide the information,
* it will infer it from having a connected account.
*/
public function is_onboarding_completed( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mercado_pago_onboarded( $payment_gateway ) ?? parent::is_onboarding_completed( $payment_gateway );
}
/**
* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
*
* This is a best-effort attempt, as there is no standard way to determine this.
* Trust the true value, but don't consider a false value as definitive.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
*/
public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
return $this->is_mercado_pago_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
}
/**
* Check if the MercadoPago payment gateway is in sandbox mode.
*
* For MercadoPago, there are two different environments: sandbox and production.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
* Null if the environment could not be determined.
*/
private function is_mercado_pago_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
global $mercadopago;
try {
// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
if ( class_exists( '\MercadoPago\Woocommerce\WoocommerceMercadoPago' ) &&
class_exists( '\MercadoPago\Woocommerce\Configs\Store' ) &&
$mercadopago instanceof \MercadoPago\Woocommerce\WoocommerceMercadoPago &&
! is_null( $mercadopago->storeConfig ) &&
$mercadopago->storeConfig instanceof \MercadoPago\Woocommerce\Configs\Store &&
is_callable( array( $mercadopago->storeConfig, 'isTestMode' ) )
) {
return wc_string_to_bool( $mercadopago->storeConfig->isTestMode() );
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the environment.
return null;
}
/**
* Check if the MercadoPago payment gateway is onboarded.
*
* For MercadoPago, there are two different environments: sandbox/test and production/sale.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return ?bool True if the payment gateway is onboarded, false otherwise.
* Null if we failed to determine the onboarding status.
*/
private function is_mercado_pago_onboarded( WC_Payment_Gateway $payment_gateway ): ?bool {
global $mercadopago;
try {
// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
if ( class_exists( '\MercadoPago\Woocommerce\WoocommerceMercadoPago' ) &&
class_exists( '\MercadoPago\Woocommerce\Configs\Seller' ) &&
$mercadopago instanceof \MercadoPago\Woocommerce\WoocommerceMercadoPago &&
! is_null( $mercadopago->sellerConfig ) &&
$mercadopago->sellerConfig instanceof \MercadoPago\Woocommerce\Configs\Seller &&
is_callable( array( $mercadopago->sellerConfig, 'getCredentialsPublicKey' ) ) &&
is_callable( array( $mercadopago->sellerConfig, 'getCredentialsAccessToken' ) )
) {
return ! empty( $mercadopago->sellerConfig->getCredentialsPublicKey() ) &&
! empty( $mercadopago->sellerConfig->getCredentialsAccessToken() );
}
} catch ( \Throwable $e ) {
// Do nothing but log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->debug(
'Failed to determine if gateway is onboarded: ' . $e->getMessage(),
array(
'gateway' => $payment_gateway->id,
'source' => 'settings-payments',
'exception' => $e,
)
);
}
// Let the caller know that we couldn't determine the onboarding status.
return null;
}
}
PK [1] =! ! * Admin/Settings/Exceptions/ApiException.phpnu error_code = $error_code;
$this->additional_data = array_filter( (array) $additional_data );
parent::__construct( $message, $http_status_code );
}
/**
* Returns the error code.
*
* @return string The machine-readable error code.
*/
public function getErrorCode(): string {
return $this->error_code;
}
/**
* Returns additional error data.
*
* @return array Extra data (key value pairs).
*/
public function getAdditionalData(): array {
return $this->additional_data;
}
}
PK [1]0_ 2 Admin/Settings/Exceptions/ApiArgumentException.phpnu route_namespace,
'/' . $this->rest_base . '/country',
array(
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'set_country' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'The ISO3166 alpha-2 country code to save for the current user.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => true,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/providers',
array(
array(
'methods' => \WP_REST_Server::CREATABLE,
'callback' => fn( $request ) => $this->run( $request, 'get_providers' ),
'validation_callback' => 'rest_validate_request_arg',
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'location' => array(
'description' => esc_html__( 'ISO3166 alpha-2 country code. Defaults to WooCommerce\'s base location country.', 'woocommerce' ),
'type' => 'string',
'pattern' => '[a-zA-Z]{2}', // Two alpha characters.
'required' => false,
'validate_callback' => fn( $value, $request ) => $this->check_location_arg( $value, $request ),
),
),
),
'schema' => fn() => $this->get_schema_for_get_payment_providers(),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/providers/order',
array(
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'update_providers_order' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'order_map' => array(
'description' => esc_html__( 'A map of provider ID to integer values representing the sort order.', 'woocommerce' ),
'type' => 'object',
'required' => true,
'validate_callback' => fn( $value ) => $this->check_providers_order_map_arg( $value ),
'sanitize_callback' => fn( $value ) => $this->sanitize_providers_order_arg( $value ),
),
),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/suggestion/(?P[\w\d\-]+)/attach',
array(
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'attach_payment_extension_suggestion' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/suggestion/(?P[\w\d\-]+)/hide',
array(
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'hide_payment_extension_suggestion' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
),
),
$override
);
register_rest_route(
$this->route_namespace,
'/' . $this->rest_base . '/suggestion/(?P[\w\d\-]+)/incentive/(?P[\w\d\-]+)/dismiss',
array(
array(
'methods' => \WP_REST_Server::EDITABLE,
'callback' => fn( $request ) => $this->run( $request, 'dismiss_payment_extension_suggestion_incentive' ),
'permission_callback' => fn( $request ) => $this->check_permissions( $request ),
'args' => array(
'context' => array(
'description' => esc_html__( 'The context ID for which to dismiss the incentive. If not provided, will dismiss the incentive for all contexts.', 'woocommerce' ),
'type' => 'string',
'required' => false,
'sanitize_callback' => 'sanitize_key',
),
'do_not_track' => array(
'description' => esc_html__( 'If true, the incentive dismissal will be ignored by tracking.', 'woocommerce' ),
'type' => 'boolean',
'required' => false,
'default' => false,
'sanitize_callback' => 'rest_sanitize_boolean',
),
),
),
),
$override
);
}
/**
* Initialize the class instance.
*
* @param Payments $payments The payments settings page service.
*
* @internal
*/
final public function init( Payments $payments ): void {
$this->payments = $payments;
}
/**
* Get the payment providers for the given location.
*
* @param WP_REST_Request $request The request object.
* @return WP_Error|WP_REST_Response
*/
protected function get_providers( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
if ( empty( $location ) ) {
// Fall back to the providers country if no location is provided.
$location = $this->payments->get_country();
}
try {
$providers = $this->payments->get_payment_providers( $location );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_payment_providers_error', $e->getMessage(), array( 'status' => 500 ) );
}
try {
$suggestions = $this->get_extension_suggestions( $location );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_payment_providers_error', $e->getMessage(), array( 'status' => 500 ) );
}
// Separate the offline PMs from the main providers list.
$offline_payment_providers = array_values(
array_filter(
$providers,
fn( $provider ) => PaymentsProviders::TYPE_OFFLINE_PM === $provider['_type']
)
);
$providers = array_values(
array_filter(
$providers,
fn( $provider ) => PaymentsProviders::TYPE_OFFLINE_PM !== $provider['_type']
)
);
$response = array(
'providers' => $providers,
'offline_payment_methods' => $offline_payment_providers,
'suggestions' => $suggestions,
'suggestion_categories' => $this->payments->get_payment_extension_suggestion_categories(),
);
return rest_ensure_response( $this->prepare_payment_providers_response( $response ) );
}
/**
* Set the country for the payment providers.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response
*/
protected function set_country( WP_REST_Request $request ) {
$location = $request->get_param( 'location' );
$result = $this->payments->set_country( $location );
return rest_ensure_response( array( 'success' => $result ) );
}
/**
* Update the payment providers order.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response
*/
protected function update_providers_order( WP_REST_Request $request ) {
$order_map = $request->get_param( 'order_map' );
$result = $this->payments->update_payment_providers_order_map( $order_map );
return rest_ensure_response( array( 'success' => $result ) );
}
/**
* Attach a payment extension suggestion.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response
*/
protected function attach_payment_extension_suggestion( WP_REST_Request $request ) {
$suggestion_id = $request->get_param( 'id' );
try {
$result = $this->payments->attach_payment_extension_suggestion( $suggestion_id );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_payment_extension_suggestion_error', $e->getMessage(), array( 'status' => 400 ) );
}
return rest_ensure_response( array( 'success' => $result ) );
}
/**
* Hide a payment extension suggestion.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response
*/
protected function hide_payment_extension_suggestion( WP_REST_Request $request ) {
$suggestion_id = $request->get_param( 'id' );
try {
$result = $this->payments->hide_payment_extension_suggestion( $suggestion_id );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_payment_extension_suggestion_error', $e->getMessage(), array( 'status' => 400 ) );
}
return rest_ensure_response( array( 'success' => $result ) );
}
/**
* Dismiss a payment extension suggestion incentive.
*
* @param WP_REST_Request $request The request object.
*
* @return WP_Error|WP_REST_Response
*/
protected function dismiss_payment_extension_suggestion_incentive( WP_REST_Request $request ) {
$suggestion_id = $request->get_param( 'suggestion_id' );
$incentive_id = $request->get_param( 'incentive_id' );
$context = $request->get_param( 'context' ) ?? 'all';
$do_not_track = $request->get_param( 'do_not_track' ) ?? false;
try {
$result = $this->payments->dismiss_extension_suggestion_incentive( $suggestion_id, $incentive_id, $context, $do_not_track );
} catch ( Exception $e ) {
return new WP_Error( 'woocommerce_rest_payment_extension_suggestion_incentive_error', $e->getMessage(), array( 'status' => 400 ) );
}
return rest_ensure_response( array( 'success' => $result ) );
}
/**
* Get the payment extension suggestions (other) for the given location.
*
* @param string $location The location for which the suggestions are being fetched.
*
* @return array[] The payment extension suggestions for the given location,
* excluding the ones part of the main providers list.
* @throws Exception If there are malformed or invalid suggestions.
*/
private function get_extension_suggestions( string $location ): array {
// If the requesting user can't install plugins, we don't suggest any extensions.
if ( ! current_user_can( 'install_plugins' ) ) {
return array();
}
$suggestions = $this->payments->get_payment_extension_suggestions( $location );
return $suggestions['other'] ?? array();
}
/**
* General permissions check for payments settings REST API endpoint.
*
* @param WP_REST_Request $request The request for which the permission is checked.
* @return bool|WP_Error True if the current user has the capability, otherwise an "Unauthorized" error or False if no error is available for the request method.
*/
private function check_permissions( WP_REST_Request $request ) {
$context = 'read';
if ( 'POST' === $request->get_method() ) {
$context = 'edit';
} elseif ( 'DELETE' === $request->get_method() ) {
$context = 'delete';
}
if ( wc_rest_check_manager_permissions( 'payment_gateways', $context ) ) {
return true;
}
$error_information = $this->get_authentication_error_by_method( $request->get_method() );
if ( is_null( $error_information ) ) {
return false;
}
return new WP_Error(
$error_information['code'],
$error_information['message'],
array( 'status' => rest_authorization_required_code() )
);
}
/**
* Validate the location argument.
*
* @param mixed $value Value of the argument.
* @param WP_REST_Request $request The current request object.
*
* @return WP_Error|true True if the location argument is valid, otherwise a WP_Error object.
*/
private function check_location_arg( $value, WP_REST_Request $request ) {
// If the 'location' argument is not a string return an error.
if ( ! is_string( $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The location argument must be a string.', 'woocommerce' ), array( 'status' => 400 ) );
}
// Get the registered attributes for this endpoint request.
$attributes = $request->get_attributes();
// Grab the location param schema.
$args = $attributes['args']['location'];
// If the location param doesn't match the regex pattern then we should return an error as well.
if ( ! preg_match( '/^' . $args['pattern'] . '$/', $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The location argument must be a valid ISO3166 alpha-2 country code.', 'woocommerce' ), array( 'status' => 400 ) );
}
return true;
}
/**
* Validate the providers order map argument.
*
* @param mixed $value Value of the argument.
*
* @return WP_Error|true True if the providers order map argument is valid, otherwise a WP_Error object.
*/
private function check_providers_order_map_arg( $value ) {
if ( ! is_array( $value ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The ordering argument must be an object.', 'woocommerce' ), array( 'status' => 400 ) );
}
foreach ( $value as $provider_id => $order ) {
if ( ! is_string( $provider_id ) || ! is_numeric( $order ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The ordering argument must be an object with provider IDs as keys and numeric values as values.', 'woocommerce' ), array( 'status' => 400 ) );
}
if ( $this->sanitize_provider_id( $provider_id ) !== $provider_id ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The provider ID must be a string with only ASCII letters, digits, underscores, and dashes.', 'woocommerce' ), array( 'status' => 400 ) );
}
if ( false === filter_var( $order, FILTER_VALIDATE_INT ) ) {
return new WP_Error( 'rest_invalid_param', esc_html__( 'The order value must be an integer.', 'woocommerce' ), array( 'status' => 400 ) );
}
}
return true;
}
/**
* Sanitize the providers ordering argument.
*
* @param array $value Value of the argument.
*
* @return array
*/
private function sanitize_providers_order_arg( array $value ): array {
// Sanitize the ordering object to ensure that the order values are integers and the provider IDs are safe strings.
foreach ( $value as $provider_id => $order ) {
$id = $this->sanitize_provider_id( $provider_id );
$value[ $id ] = intval( $order );
}
return $value;
}
/**
* Sanitize a provider ID.
*
* This method ensures that the provider ID is a safe string by removing any unwanted characters.
* It strips all HTML tags, removes accents, percent-encoded characters, and HTML entities,
* and allows only lowercase and uppercase letters, digits, underscores, and dashes.
*
* @param string $provider_id The provider ID to sanitize.
*
* @return string The sanitized provider ID.
*/
private function sanitize_provider_id( string $provider_id ): string {
$provider_id = wp_strip_all_tags( $provider_id );
$provider_id = remove_accents( $provider_id );
// Remove percent-encoded characters.
$provider_id = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $provider_id );
// Remove HTML entities.
$provider_id = preg_replace( '/&.+?;/', '', $provider_id );
// Only lowercase and uppercase ASCII letters, digits, underscores, and dashes are allowed.
$provider_id = preg_replace( '|[^a-z0-9_\-]|i', '', $provider_id );
return $provider_id;
}
/**
* Prepare the response for the GET payment providers request.
*
* @param array $response The response to prepare.
*
* @return array The prepared response.
*/
private function prepare_payment_providers_response( array $response ): array {
$response = $this->prepare_payment_providers_response_recursive( $response, $this->get_schema_for_get_payment_providers() );
$response['providers'] = $this->add_provider_links( $response['providers'] );
$response['suggestions'] = $this->add_suggestion_links( $response['suggestions'] );
return $response;
}
/**
* Recursively prepare the response items for the GET payment providers request.
*
* @param mixed $response_item The response item to prepare.
* @param array $schema The schema to use for preparing the response.
*
* @return mixed The prepared response item.
*/
private function prepare_payment_providers_response_recursive( $response_item, array $schema ) {
if ( is_null( $response_item ) ) {
return null;
}
if ( ! array_key_exists( 'properties', $schema ) ||
! is_array( $schema['properties'] ) ) {
// Filter out null values for loosely defined schema types.
if ( is_array( $response_item ) ) {
return ArrayUtil::filter_null_values_recursive( $response_item );
}
return $response_item;
}
$prepared_response = array();
foreach ( $schema['properties'] as $key => $property_schema ) {
if ( is_array( $response_item ) && array_key_exists( $key, $response_item ) ) {
if ( is_array( $property_schema ) && array_key_exists( 'properties', $property_schema ) ) {
$prepared_response[ $key ] = $this->prepare_payment_providers_response_recursive( $response_item[ $key ], $property_schema );
} elseif ( is_array( $property_schema ) && array_key_exists( 'items', $property_schema ) ) {
$prepared_response[ $key ] = array_map(
fn( $item ) => $this->prepare_payment_providers_response_recursive( $item, $property_schema['items'] ),
$response_item[ $key ]
);
} else {
$prepared_response[ $key ] = $response_item[ $key ];
}
}
}
// Ensure the order is the same as in the schema.
$prepared_response = array_merge( array_fill_keys( array_keys( $schema['properties'] ), null ), $prepared_response );
// Remove any null values from the response.
return ArrayUtil::filter_null_values_recursive( $prepared_response );
}
/**
* Add links to providers list items.
*
* @param array $providers The providers list.
*
* @return array The providers list with added links.
*/
private function add_provider_links( array $providers ): array {
foreach ( $providers as $key => $provider ) {
if ( empty( $provider['_links'] ) ) {
$providers[ $key ]['_links'] = array();
}
// If this is a suggestion, add dedicated links.
if ( ! empty( $provider['_type'] ) &&
PaymentsProviders::TYPE_SUGGESTION === $provider['_type'] &&
! empty( $provider['_suggestion_id'] )
) {
$providers[ $key ]['_links']['attach'] = array(
'href' => rest_url( sprintf( '/%s/%s/suggestion/%s/attach', $this->route_namespace, $this->rest_base, $provider['_suggestion_id'] ) ),
);
$providers[ $key ]['_links']['hide'] = array(
'href' => rest_url( sprintf( '/%s/%s/suggestion/%s/hide', $this->route_namespace, $this->rest_base, $provider['_suggestion_id'] ) ),
);
}
// If we have an incentive, add a link to dismiss it.
if ( ! empty( $provider['_incentive'] ) && ! empty( $provider['_suggestion_id'] ) ) {
if ( empty( $provider['_incentive']['_links'] ) ) {
$providers[ $key ]['_incentive']['_links'] = array();
}
$providers[ $key ]['_incentive']['_links']['dismiss'] = array(
'href' => rest_url( sprintf( '/%s/%s/suggestion/%s/incentive/%s/dismiss', $this->route_namespace, $this->rest_base, $provider['_suggestion_id'], $provider['_incentive']['id'] ) ),
);
}
}
return $providers;
}
/**
* Add links to suggestions list items.
*
* @param array $suggestions The suggestions list.
*
* @return array The suggestions list with added links.
*/
private function add_suggestion_links( array $suggestions ): array {
foreach ( $suggestions as $key => $suggestion ) {
if ( empty( $suggestion['id'] ) ) {
continue;
}
if ( empty( $suggestion['_links'] ) ) {
$suggestions[ $key ]['_links'] = array();
}
$suggestions[ $key ]['_links']['attach'] = array(
'href' => rest_url( sprintf( '/%s/%s/suggestion/%s/attach', $this->route_namespace, $this->rest_base, $suggestion['id'] ) ),
);
$suggestions[ $key ]['_links']['hide'] = array(
'href' => rest_url( sprintf( '/%s/%s/suggestion/%s/hide', $this->route_namespace, $this->rest_base, $suggestion['id'] ) ),
);
}
return $suggestions;
}
/**
* Get the schema for the GET payment providers request.
*
* @return array[]
*/
private function get_schema_for_get_payment_providers(): array {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'WooCommerce Settings Payments providers for the given location.',
'type' => 'object',
);
$schema['properties'] = array(
'providers' => array(
'type' => 'array',
'description' => esc_html__( 'The ordered providers list. This includes registered payment gateways, suggestions, and offline payment methods group entry. The individual offline payment methods are separate.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => $this->get_schema_for_payment_provider(),
),
'offline_payment_methods' => array(
'type' => 'array',
'description' => esc_html__( 'The ordered offline payment methods providers list.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => $this->get_schema_for_payment_provider(),
),
'suggestions' => array(
'type' => 'array',
'description' => esc_html__( 'The list of suggestions, excluding the ones part of the providers list.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => $this->get_schema_for_suggestion(),
),
'suggestion_categories' => array(
'type' => 'array',
'description' => esc_html__( 'The suggestion categories.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'description' => esc_html__( 'A suggestion category.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the category.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_priority' => array(
'type' => 'integer',
'description' => esc_html__( 'The priority of the category.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The title of the category.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The description of the category.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
);
return $schema;
}
/**
* Get the schema for a payment provider.
*
* @return array The schema for a payment provider.
*/
private function get_schema_for_payment_provider(): array {
return array(
'type' => 'object',
'description' => esc_html__( 'A payment provider in the context of the main Payments Settings page list.', 'woocommerce' ),
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_order' => array(
'type' => 'integer',
'description' => esc_html__( 'The sort order of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of payment provider. Use this to differentiate between the various items in the list and determine their intended use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The title of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The description of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'supports' => array(
'description' => esc_html__( 'Supported features for this provider.', 'woocommerce' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
),
),
'plugin' => array(
'type' => 'object',
'description' => esc_html__( 'The corresponding plugin details of the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'_type' => array(
'type' => 'string',
'enum' => array(
PaymentsProviders::EXTENSION_TYPE_WPORG,
PaymentsProviders::EXTENSION_TYPE_MU_PLUGIN,
PaymentsProviders::EXTENSION_TYPE_THEME,
PaymentsProviders::EXTENSION_TYPE_UNKNOWN,
),
'description' => esc_html__( 'The type of the containing entity. Generally this is a regular plugin but it can also be a non-standard entity like a theme or a must-user plugin.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'type' => 'string',
'description' => esc_html__( 'The slug of the containing entity.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'file' => array(
'type' => 'string',
'description' => esc_html__( 'The plugin main file. This is a relative path to the plugins directory.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'status' => array(
'type' => 'string',
'enum' => array(
PaymentsProviders::EXTENSION_NOT_INSTALLED,
PaymentsProviders::EXTENSION_INSTALLED,
PaymentsProviders::EXTENSION_ACTIVE,
),
'description' => esc_html__( 'The status of the containing entity.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'image' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the provider image.', 'woocommerce' ),
'readonly' => true,
),
'icon' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the provider icon (square aspect ratio - 72px by 72px).', 'woocommerce' ),
'readonly' => true,
),
'links' => array(
'type' => 'array',
'description' => esc_html__( 'Links for the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'_type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of the link.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'url' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the link.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'state' => array(
'type' => 'object',
'description' => esc_html__( 'The general state of the provider with regards to it\'s payments processing.', 'woocommerce' ),
'properties' => array(
'enabled' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider is enabled for use on checkout.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'account_connected' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider has a payments processing account connected.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'needs_setup' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider needs setup.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'test_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider is in test mode for payments processing.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'dev_mode' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the provider is in dev mode. Having this true usually leads to forcing test payments. ', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'management' => array(
'type' => 'object',
'description' => esc_html__( 'The management details of the provider.', 'woocommerce' ),
'properties' => array(
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'settings' => array(
'type' => 'object',
'description' => esc_html__( 'The link to the settings page for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to the settings page for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
),
'onboarding' => array(
'type' => 'object',
'description' => esc_html__( 'Onboarding-related details for the provider.', 'woocommerce' ),
'properties' => array(
'type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of onboarding process the provider supports.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'state' => array(
'type' => 'object',
'description' => esc_html__( 'The state of the onboarding process.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
),
'messages' => array(
'type' => 'object',
'description' => esc_html__( 'Various messages to possibly show the user.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'additionalProperties' => array(
'type' => 'string',
'description' => esc_html__( 'Message to show the user.', 'woocommerce' ),
'readonly' => true,
),
),
'steps' => array(
'type' => 'array',
'description' => esc_html__( 'The onboarding steps in case this provider supports native in-context onboarding.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'preload' => array(
'type' => 'object',
'description' => esc_html__( 'The onboarding preload link for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to do onboarding preload for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'onboard' => array(
'type' => 'object',
'description' => esc_html__( 'The start/continue onboarding link for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to start/continue onboarding for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'disable_test_account' => array(
'type' => 'object',
'description' => esc_html__( 'The link to disable the test account for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to POST to disable the test account for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'reset' => array(
'type' => 'object',
'description' => esc_html__( 'The link to reset the provider state/account and restart the onboarding.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to POST to for resetting the provider onboarding.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
'recommended_payment_methods' => array(
'type' => 'array',
'description' => esc_html__( 'The list of recommended payment methods details for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'description' => esc_html__( 'The details for a recommended payment method.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the payment method.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_order' => array(
'type' => 'integer',
'description' => esc_html__( 'The sort order of the payment method.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'enabled' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the payment method should be recommended as enabled or not.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'required' => array(
'type' => 'boolean',
'description' => esc_html__( 'Whether the payment method should be required (and force-enabled) or not.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The title of the payment method. Does not include HTML tags.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The description of the payment method. It can contain basic HTML.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'icon' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the payment method icon or a base64-encoded SVG image.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'context' => array(
'type' => 'object',
'description' => esc_html__( 'Various contextual data for the onboarding process to use.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'tags' => array(
'type' => 'array',
'description' => esc_html__( 'The tags associated with the provider.', 'woocommerce' ),
'uniqueItems' => true,
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
'description' => esc_html__( 'Tag associated with the provider.', 'woocommerce' ),
'readonly' => true,
),
),
'_suggestion_id' => array(
'type' => 'string',
'description' => esc_html__( 'The suggestion ID matching this provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_incentive' => $this->get_schema_for_incentive(),
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'attach' => array(
'type' => 'object',
'description' => esc_html__( 'The link to mark the suggestion as attached. This should be called when an extension is installed.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to attach the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'hide' => array(
'type' => 'object',
'description' => esc_html__( 'The link to hide the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to hide the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
);
}
/**
* Get the schema for a suggestion.
*
* @return array The schema for a suggestion.
*/
private function get_schema_for_suggestion(): array {
return array(
'type' => 'object',
'description' => esc_html__( 'A suggestion with full details.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The unique identifier for the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_priority' => array(
'type' => 'integer',
'description' => esc_html__( 'The priority of the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The title of the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The description of the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'plugin' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'_type' => array(
'type' => 'string',
'enum' => array( PaymentsProviders::EXTENSION_TYPE_WPORG ),
'description' => esc_html__( 'The type of the plugin.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'slug' => array(
'type' => 'string',
'description' => esc_html__( 'The slug of the plugin.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'status' => array(
'type' => 'string',
'enum' => array(
PaymentsProviders::EXTENSION_NOT_INSTALLED,
PaymentsProviders::EXTENSION_INSTALLED,
PaymentsProviders::EXTENSION_ACTIVE,
),
'description' => esc_html__( 'The status of the plugin.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'image' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the image.', 'woocommerce' ),
'readonly' => true,
),
'icon' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the icon (square aspect ratio).', 'woocommerce' ),
'readonly' => true,
),
'links' => array(
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'_type' => array(
'type' => 'string',
'description' => esc_html__( 'The type of the link.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'url' => array(
'type' => 'string',
'description' => esc_html__( 'The URL of the link.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
'_incentive' => $this->get_schema_for_incentive(),
'tags' => array(
'description' => esc_html__( 'The tags associated with the suggestion.', 'woocommerce' ),
'type' => 'array',
'uniqueItems' => true,
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'string',
'description' => esc_html__( 'The tags associated with the suggestion.', 'woocommerce' ),
'readonly' => true,
),
),
'category' => array(
'type' => 'string',
'description' => esc_html__( 'The category of the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'attach' => array(
'type' => 'object',
'description' => esc_html__( 'The link to mark the suggestion as attached. This should be called when an extension is installed.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to attach the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'hide' => array(
'type' => 'object',
'description' => esc_html__( 'The link to hide the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to hide the suggestion.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
);
}
/**
* Get the schema for an incentive.
*
* @return array The incentive schema.
*/
private function get_schema_for_incentive(): array {
return array(
'type' => 'object',
'description' => esc_html__( 'The active incentive for the provider.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'id' => array(
'type' => 'string',
'description' => esc_html__( 'The incentive unique ID. This ID needs to be used for incentive dismissals.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'promo_id' => array(
'type' => 'string',
'description' => esc_html__( 'The incentive promo ID. This ID need to be fed into the onboarding flow.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'title' => array(
'type' => 'string',
'description' => esc_html__( 'The incentive title. It can contain stylistic HTML.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'description' => array(
'type' => 'string',
'description' => esc_html__( 'The incentive description. It can contain stylistic HTML.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'short_description' => array(
'type' => 'string',
'description' => esc_html__( 'The short description of the incentive. It can contain stylistic HTML.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'cta_label' => array(
'type' => 'string',
'description' => esc_html__( 'The call to action label for the incentive.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'tc_url' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to the terms and conditions for the incentive.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'badge' => array(
'type' => 'string',
'description' => esc_html__( 'The badge label for the incentive.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'_dismissals' => array(
'type' => 'array',
'description' => esc_html__( 'The dismissals list for the incentive. Each dismissal entry includes a context and a timestamp. The `all` entry means the incentive was dismissed for all contexts.', 'woocommerce' ),
'uniqueItems' => true,
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'context' => array(
'type' => 'string',
'description' => esc_html__( 'Context ID in which the incentive was dismissed.', 'woocommerce' ),
'readonly' => true,
),
'timestamp' => array(
'type' => 'integer',
'description' => esc_html__( 'Unix timestamp representing when the incentive was dismissed.', 'woocommerce' ),
'readonly' => true,
),
),
),
),
'_links' => array(
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'dismiss' => array(
'type' => 'object',
'description' => esc_html__( 'The link to dismiss the incentive.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to dismiss the incentive.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
'onboard' => array(
'type' => 'object',
'description' => esc_html__( 'The start/continue onboarding link for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => array(
'href' => array(
'type' => 'string',
'description' => esc_html__( 'The URL to start/continue onboarding for the payment gateway.', 'woocommerce' ),
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
),
),
),
),
),
);
}
}
PK [1]R1m m Admin/Settings/Payments.phpnu providers = $payment_providers;
$this->extension_suggestions = $payment_extension_suggestions;
}
/**
* Get the payment provider details list for the settings page.
*
* @param string $location The location for which the providers are being determined.
* This is an ISO 3166-1 alpha-2 country code.
* @param bool $for_display Optional. Whether the payment providers list is intended for display purposes or
* it is meant to be used for internal business logic.
* Primarily, this means that when it is not for display, we will use the raw
* payment gateways list (all the registered gateways), not just the ones that
* should be shown to the user on the Payments Settings page.
* This complication is for backward compatibility as it relates to legacy settings hooks
* being fired or not.
* @param bool $remove_shells Optional. Whether to remove the payment providers shells from the list.
* If the $for_display is true, this will be ignored since the display logic will
* handle the shells itself.
*
* @return array The payment providers details list.
* @throws Exception If there are malformed or invalid suggestions.
*/
public function get_payment_providers( string $location, bool $for_display = true, bool $remove_shells = false ): array {
$payment_gateways = $this->providers->get_payment_gateways( $for_display );
if ( ! $for_display && $remove_shells ) {
$payment_gateways = $this->providers->remove_shell_payment_gateways( $payment_gateways, $location );
}
$providers_order_map = $this->providers->get_order_map();
$payment_providers = array();
// Only include suggestions if the requesting user can install plugins.
$suggestions = array();
if ( current_user_can( 'install_plugins' ) ) {
$suggestions = $this->providers->get_extension_suggestions( $location, self::SUGGESTIONS_CONTEXT );
}
// If we have preferred suggestions, add them to the providers list.
if ( ! empty( $suggestions['preferred'] ) ) {
// Sort them by priority, ASC.
usort(
$suggestions['preferred'],
function ( $a, $b ) {
return $a['_priority'] <=> $b['_priority'];
}
);
// By default, we will add the preferred suggestions at the top of the list.
$last_preferred_order = -1;
// If WooPayments is already present, we add the preferred suggestions after it.
// This way we ensure default installed WooPayments is at the same place as its suggestion would be.
if ( isset( $providers_order_map[ WooPaymentsService::GATEWAY_ID ] ) ) {
$last_preferred_order = $providers_order_map[ WooPaymentsService::GATEWAY_ID ];
}
foreach ( $suggestions['preferred'] as $suggestion ) {
$suggestion_order_map_id = $this->providers->get_suggestion_order_map_id( $suggestion['id'] );
// Determine the suggestion's order value.
// If we don't have an order for it, add it to the top but keep the relative order:
// PSP first, APM after PSP, offline PSP after PSP and APM.
if ( ! isset( $providers_order_map[ $suggestion_order_map_id ] ) ) {
$providers_order_map = Utils::order_map_add_at_order( $providers_order_map, $suggestion_order_map_id, $last_preferred_order + 1 );
}
// Save the preferred provider's order to know where we should be inserting next.
// But only if the last preferred order is less than the current one.
if ( $last_preferred_order < $providers_order_map[ $suggestion_order_map_id ] ) {
$last_preferred_order = $providers_order_map[ $suggestion_order_map_id ];
}
// Change suggestion details to align it with a regular payment gateway.
$suggestion['_suggestion_id'] = $suggestion['id'];
$suggestion['id'] = $suggestion_order_map_id;
$suggestion['_type'] = PaymentsProviders::TYPE_SUGGESTION;
$suggestion['_order'] = $providers_order_map[ $suggestion_order_map_id ];
unset( $suggestion['_priority'] );
$payment_providers[] = $suggestion;
}
}
foreach ( $payment_gateways as $payment_gateway ) {
// Determine the gateway's order value.
// If we don't have an order for it, add it to the end.
if ( ! isset( $providers_order_map[ $payment_gateway->id ] ) ) {
$providers_order_map = Utils::order_map_add_at_order( $providers_order_map, $payment_gateway->id, count( $payment_providers ) );
}
$payment_providers[] = $this->providers->get_payment_gateway_details(
$payment_gateway,
$providers_order_map[ $payment_gateway->id ],
$location
);
}
// Add offline payment methods group entry if we have offline payment methods.
if ( in_array( PaymentsProviders::TYPE_OFFLINE_PM, array_column( $payment_providers, '_type' ), true ) ) {
// Determine the item's order value.
// If we don't have an order for it, add it to the end.
if ( ! isset( $providers_order_map[ PaymentsProviders::OFFLINE_METHODS_ORDERING_GROUP ] ) ) {
$providers_order_map = Utils::order_map_add_at_order( $providers_order_map, PaymentsProviders::OFFLINE_METHODS_ORDERING_GROUP, count( $payment_providers ) );
}
$payment_providers[] = array(
'id' => PaymentsProviders::OFFLINE_METHODS_ORDERING_GROUP,
'_type' => PaymentsProviders::TYPE_OFFLINE_PMS_GROUP,
'_order' => $providers_order_map[ PaymentsProviders::OFFLINE_METHODS_ORDERING_GROUP ],
'title' => esc_html__( 'Take offline payments', 'woocommerce' ),
'description' => esc_html__( 'Accept payments offline using multiple different methods. These can also be used to test purchases.', 'woocommerce' ),
'icon' => plugins_url( 'assets/images/payment_methods/cod.svg', WC_PLUGIN_FILE ),
// The offline PMs (and their group) are obviously from WooCommerce, and WC is always active.
'plugin' => array(
'_type' => 'wporg',
'slug' => 'woocommerce',
'file' => '', // This pseudo-provider should have no use for the plugin file.
'status' => PaymentsProviders::EXTENSION_ACTIVE,
),
'management' => array(
'_links' => array(
'settings' => array(
'href' => Utils::wc_payments_settings_url( '/' . ( class_exists( '\WC_Settings_Payment_Gateways' ) ? \WC_Settings_Payment_Gateways::OFFLINE_SECTION_NAME : 'offline' ) ),
),
),
),
);
}
// Determine the final, standardized providers order map.
$providers_order_map = $this->providers->enhance_order_map( $providers_order_map );
// Enforce the order map on all providers, just in case.
foreach ( $payment_providers as $key => $provider ) {
$payment_providers[ $key ]['_order'] = $providers_order_map[ $provider['id'] ];
}
// NOTE: For now, save it back to the DB. This is temporary until we have a better way to handle this!
$this->providers->save_order_map( $providers_order_map );
// Sort the payment providers by order, ASC.
usort(
$payment_providers,
function ( $a, $b ) {
return $a['_order'] <=> $b['_order'];
}
);
// Only process payment provider states if we are displaying the providers.
// This is to ensure we don't introduce any performance issues outside the Payments settings page.
if ( $for_display ) {
$this->process_payment_provider_states( $payment_providers );
}
return $payment_providers;
}
/**
* Get the payment extension suggestions for the given location.
*
* @param string $location The location for which the suggestions are being fetched.
*
* @return array[] The payment extension suggestions for the given location, split into preferred and other.
* @throws Exception If there are malformed or invalid suggestions.
*/
public function get_payment_extension_suggestions( string $location ): array {
return $this->providers->get_extension_suggestions( $location, self::SUGGESTIONS_CONTEXT );
}
/**
* Get the payment extension suggestions categories details.
*
* @return array The payment extension suggestions categories.
*/
public function get_payment_extension_suggestion_categories(): array {
return $this->providers->get_extension_suggestion_categories();
}
/**
* Get the business location country code for the Payments settings.
*
* @return string The ISO 3166-1 alpha-2 country code to use for the overall business location.
* If the user didn't set a location, the WC base location country code is used.
*/
public function get_country(): string {
$user_nox_meta = get_user_meta( get_current_user_id(), self::PAYMENTS_NOX_PROFILE_KEY, true );
if ( ! empty( $user_nox_meta['business_country_code'] ) ) {
return $user_nox_meta['business_country_code'];
}
return WC()->countries->get_base_country();
}
/**
* Set the business location country for the Payments settings.
*
* @param string $location The country code. This should be an ISO 3166-1 alpha-2 country code.
*/
public function set_country( string $location ): bool {
$previous_country = $this->get_country();
$user_payments_nox_profile = get_user_meta( get_current_user_id(), self::PAYMENTS_NOX_PROFILE_KEY, true );
if ( empty( $user_payments_nox_profile ) ) {
$user_payments_nox_profile = array();
} else {
$user_payments_nox_profile = maybe_unserialize( $user_payments_nox_profile );
}
$user_payments_nox_profile['business_country_code'] = $location;
$result = false !== update_user_meta( get_current_user_id(), self::PAYMENTS_NOX_PROFILE_KEY, $user_payments_nox_profile );
if ( $result && $previous_country !== $location ) {
// Record an event that the business location (registration country code) was changed.
$this->record_event(
'business_location_update',
array(
'business_country' => $location,
'previous_business_country' => $previous_country,
)
);
}
return $result;
}
/**
* Update the payment providers order map.
*
* @param array $order_map The new order for payment providers.
*
* @return bool True if the payment providers ordering was successfully updated, false otherwise.
*/
public function update_payment_providers_order_map( array $order_map ): bool {
$result = $this->providers->update_payment_providers_order_map( $order_map );
if ( $result ) {
// Record an event that the payment providers order map was updated.
$this->record_event(
'payment_providers_order_map_updated',
array(
'order_map' => implode( ', ', array_keys( $this->providers->get_order_map() ) ),
)
);
}
return $result;
}
/**
* Attach a payment extension suggestion.
*
* This is only an internal recording of attachment. No actual extension installation or activation happens.
*
* @param string $id The ID of the payment extension suggestion to attach.
*
* @return bool True if the suggestion was successfully marked as attached, false otherwise.
* @throws Exception If the suggestion ID is invalid.
*/
public function attach_payment_extension_suggestion( string $id ): bool {
$result = $this->providers->attach_extension_suggestion( $id );
if ( $result ) {
// Record an event that the suggestion was attached.
$this->record_event(
'extension_suggestion_attached',
array(
'suggestion_id' => $id,
)
);
}
return $result;
}
/**
* Hide a payment extension suggestion.
*
* @param string $id The ID of the payment extension suggestion to hide.
*
* @return bool True if the suggestion was successfully hidden, false otherwise.
* @throws Exception If the suggestion ID is invalid.
*/
public function hide_payment_extension_suggestion( string $id ): bool {
$result = $this->providers->hide_extension_suggestion( $id );
if ( $result ) {
// Record an event that the suggestion was hidden.
$this->record_event(
'extension_suggestion_hidden',
array(
'suggestion_id' => $id,
)
);
}
return $result;
}
/**
* Dismiss a payment extension suggestion incentive.
*
* @param string $suggestion_id The suggestion ID.
* @param string $incentive_id The incentive ID.
* @param string $context Optional. The context in which the incentive should be dismissed.
* Default is to dismiss the incentive in all contexts.
* @param bool $do_not_track Optional. If true, the incentive dismissal will not be tracked.
*
* @return bool True if the incentive was not previously dismissed and now it is.
* False if the incentive was already dismissed or could not be dismissed.
* @throws Exception If the incentive could not be dismissed due to an error.
*/
public function dismiss_extension_suggestion_incentive( string $suggestion_id, string $incentive_id, string $context = 'all', bool $do_not_track = false ): bool {
$result = $this->extension_suggestions->dismiss_incentive( $incentive_id, $suggestion_id, $context );
if ( ! $do_not_track && $result ) {
// Record an event that the incentive was dismissed.
$this->record_event(
'incentive_dismiss',
array(
'suggestion_id' => $suggestion_id,
'incentive_id' => $incentive_id,
'display_context' => $context,
)
);
}
return $result;
}
/**
* Send a Tracks event.
*
* By default, Woo adds `url`, `blog_lang`, `blog_id`, `store_id`, `products_count`, and `wc_version`
* properties to every event.
*
* @param string $name The event name.
* If it is not prefixed with self::EVENT_PREFIX, it will be prefixed with it.
* @param array $properties Optional. The event custom properties.
* These properties will be merged with the default properties.
* Default properties values take precedence over the provided ones.
*
* @return void
*/
private function record_event( string $name, array $properties = array() ) {
if ( ! function_exists( 'wc_admin_record_tracks_event' ) ) {
return;
}
// If the event name is empty, we don't record it.
if ( empty( $name ) ) {
return;
}
// If the event name is not prefixed with `settings_payments_`, we prefix it.
if ( ! str_starts_with( $name, self::EVENT_PREFIX ) ) {
$name = self::EVENT_PREFIX . $name;
}
// Add default properties to every event and overwrite custom properties with the same keys.
$properties = array_merge(
$properties,
array(
'business_country' => $this->get_country(),
),
);
wc_admin_record_tracks_event( $name, $properties );
}
/**
* Process the payment providers states and update the snapshots in the DB.
*
* @param array $payment_providers The payment providers details list.
*/
private function process_payment_provider_states( array $payment_providers ): void {
// Read the current state snapshots from the DB.
$snapshots = get_option( self::PAYMENTS_PROVIDER_STATE_SNAPSHOTS_KEY, array() );
if ( ! is_array( $snapshots ) ) {
$snapshots = array();
}
$default_snapshot = array(
'extension_active' => false,
'account_connected' => false,
'account_test_mode' => false,
'needs_setup' => false,
'test_mode' => false,
);
// Iterate through the payment providers and generate their updated snapshots.
// We will use the provider's plugin slug as the key for the snapshot to ensure uniqueness.
// For now, we will only focus on the provider state for official extensions, not all the gateways.
$new_snapshots = array();
foreach ( $payment_providers as $provider ) {
if ( empty( $provider['plugin']['slug'] ) ||
empty( $provider['id'] ) ||
empty( $provider['state'] ) || ! is_array( $provider['state'] ) ||
empty( $provider['onboarding']['state'] ) || ! is_array( $provider['onboarding']['state'] ) ||
empty( $provider['_type'] ) ||
PaymentsProviders::TYPE_GATEWAY !== $provider['_type'] ||
empty( $provider['_suggestion_id'] )
) {
continue;
}
$snapshot_key = $provider['plugin']['slug'];
// Since we are going after the provider general state, not that of the specific gateway,
// we only need to look at the first found gateway from a given provider.
if ( isset( $new_snapshots[ $snapshot_key ] ) ) {
continue;
}
// If we don't have an already existing snapshot for this provider, we create one with default values.
// This way we can track changes even for the first time we see a provider.
if ( ! isset( $snapshots[ $snapshot_key ] ) ) {
$snapshots[ $snapshot_key ] = $default_snapshot;
} else {
// Make sure the old snapshot has the same keys as the default one.
$snapshots[ $snapshot_key ] = array_merge( $default_snapshot, $snapshots[ $snapshot_key ] );
// Remove any keys that are not in the default snapshot.
$snapshot_keys = array_keys( $default_snapshot );
foreach ( $snapshots[ $snapshot_key ] as $key => $v ) {
if ( ! in_array( $key, $snapshot_keys, true ) ) {
unset( $snapshots[ $snapshot_key ][ $key ] );
}
}
// Always sort the old snapshot by keys to ensure consistency.
ksort( $snapshots[ $snapshot_key ] );
}
// Generate the new snapshot for the provider.
$new_snapshots[ $snapshot_key ] = array(
'extension_active' => true, // The extension is definitely active since we have a gateway from it.
'account_connected' => $provider['state']['account_connected'] ?? $default_snapshot['account_connected'],
'account_test_mode' => $provider['onboarding']['state']['test_mode'] ?? $default_snapshot['account_test_mode'],
'needs_setup' => $provider['state']['needs_setup'] ?? $default_snapshot['needs_setup'],
'test_mode' => $provider['state']['test_mode'] ?? $default_snapshot['test_mode'],
);
// Always sort the new snapshot by keys to ensure consistency.
ksort( $new_snapshots[ $snapshot_key ] );
}
// Provider snapshots that are not in the new snapshots but were in the old ones should be kept but marked as inactive.
foreach ( $snapshots as $snapshot_key => $old_snapshot ) {
if ( ! isset( $new_snapshots[ $snapshot_key ] ) ) {
$new_snapshots[ $snapshot_key ] = $old_snapshot;
$new_snapshots[ $snapshot_key ]['extension_active'] = false;
}
}
// Always order the new snapshots by keys to ensure DB updates happen only when the data changes.
ksort( $new_snapshots );
// Save the new snapshots back to the DB, as soon as we have them ready to avoid concurrent state change tracking.
// No need to autoload this option since it will be used only in the Payments Settings area.
$result = update_option( self::PAYMENTS_PROVIDER_STATE_SNAPSHOTS_KEY, $new_snapshots, false );
if ( ! $result ) {
// If we didn't update the option, we don't need to track any changes.
return;
}
try {
$this->maybe_track_providers_state_change( $payment_providers, $snapshots, $new_snapshots );
} catch ( \Throwable $exception ) {
// If we failed to track the changes, we log the error but don't throw it.
// This is to avoid breaking the Payments Settings page.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to track payment providers state change: ' . $exception->getMessage(),
array(
'source' => 'settings-payments',
)
);
}
}
/**
* Maybe track the payment providers state change.
*
* This method will iterate through the new snapshots and compare them with the old ones.
* If there are any changes, it will track them.
*
* @param array $providers The list of payment provider details.
* @param array $old_snapshots The old snapshots of the providers' states.
* @param array $new_snapshots The new snapshots of the providers' states.
*/
private function maybe_track_providers_state_change( array $providers, array $old_snapshots, array $new_snapshots ): void {
foreach ( $new_snapshots as $provider_extension_slug => $new_snapshot ) {
if ( ! isset( $old_snapshots[ $provider_extension_slug ] ) ) {
// If we don't have an old snapshot for this provider, we can't track the change.
continue;
}
// If there are no changes, we don't need to track anything.
if ( maybe_serialize( $old_snapshots[ $provider_extension_slug ] ) === maybe_serialize( $new_snapshot ) ) {
continue;
}
// Search for the provider by its plugin slug.
$provider = null;
foreach ( $providers as $p ) {
if ( isset( $p['plugin']['slug'] ) && $p['plugin']['slug'] === $provider_extension_slug ) {
$provider = $p;
break;
}
}
if ( ! $provider ) {
// If we couldn't find the provider in the list it means the extension was deactivated.
// Get the matching suggestion by its slug.
$provider = $this->providers->get_extension_suggestion_by_plugin_slug( $provider_extension_slug );
if ( ! empty( $provider['id'] ) ) {
// If we found the suggestion, we can use it as a replacement provider.
// We need to set the `_suggestion_id` so we can handle the date more uniformly.
$provider['_suggestion_id'] = $provider['id'];
}
}
if ( ! $provider ) {
continue;
}
$this->maybe_track_provider_state_change( $provider, $old_snapshots[ $provider_extension_slug ], $new_snapshot );
}
}
/**
* Track the payment provider state change.
*
* @param array $provider The payment provider details.
* @param array $old_snapshot The old snapshot of the provider's state.
* @param array $new_snapshot The new snapshot of the provider's state.
*/
private function maybe_track_provider_state_change( array $provider, array $old_snapshot, array $new_snapshot ): void {
// Note: Keep the order of the events in a way that makes sense for the onboarding flow.
// Track extension_active change.
if ( $old_snapshot['extension_active'] && ! $new_snapshot['extension_active'] ) {
$this->record_event(
'provider_extension_deactivated',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
// If the extension was also uninstalled, we can track that as well.
if ( ! empty( $provider['plugin']['status'] ) && PaymentsProviders::EXTENSION_NOT_INSTALLED === $provider['plugin']['status'] ) {
$this->record_event(
'provider_extension_uninstalled',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
}
} elseif ( ! $old_snapshot['extension_active'] && $new_snapshot['extension_active'] ) {
$this->record_event(
'provider_extension_activated',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
}
// Track account_connected change.
if ( $old_snapshot['account_connected'] && ! $new_snapshot['account_connected'] ) {
$this->record_event(
'provider_account_disconnected',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
'provider_account_test_mode' => $old_snapshot['account_test_mode'] ? 'yes' : 'no',
)
);
} elseif ( ! $old_snapshot['account_connected'] && $new_snapshot['account_connected'] ) {
$this->record_event(
'provider_account_connected',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
'provider_account_test_mode' => $new_snapshot['account_test_mode'] ? 'yes' : 'no',
)
);
}
// Track needs_setup change.
if ( $old_snapshot['needs_setup'] && ! $new_snapshot['needs_setup'] ) {
$this->record_event(
'provider_setup_completed',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
} elseif ( ! $old_snapshot['needs_setup'] && $new_snapshot['needs_setup'] ) {
$this->record_event(
'provider_setup_required',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
}
// Track payments test_mode change, but only if an account is connected.
if ( $new_snapshot['account_connected'] ) {
if ( $old_snapshot['test_mode'] && ! $new_snapshot['test_mode'] ) {
$this->record_event(
'provider_live_payments_enabled',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
} elseif ( ! $old_snapshot['test_mode'] && $new_snapshot['test_mode'] ) {
$this->record_event(
'provider_test_payments_enabled',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
}
}
// Track account_test_mode change, but only if the account is connected.
if ( $new_snapshot['account_connected'] ) {
if ( $old_snapshot['account_test_mode'] && ! $new_snapshot['account_test_mode'] ) {
$this->record_event(
'provider_account_live_mode_enabled',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
} elseif ( ! $old_snapshot['account_test_mode'] && $new_snapshot['account_test_mode'] ) {
$this->record_event(
'provider_account_test_mode_enabled',
array(
'provider_id' => $provider['id'],
'suggestion_id' => $provider['_suggestion_id'],
'provider_extension_slug' => $provider['plugin']['slug'],
)
);
}
}
}
}
PK [1]C>̬; ; Admin/Settings/Utils.phpnu $order ) {
// If the ID is not in the base map, we ADD it at the desired order. Otherwise, we MOVE it.
if ( ! isset( $base_map[ $id ] ) ) {
$updated_map = self::order_map_add_at_order( $updated_map, $id, $order );
continue;
}
$updated_map = self::order_map_move_at_order( $updated_map, $id, $order );
}
return self::order_map_normalize( $updated_map );
}
/**
* Move an id at a specific order in an order map.
*
* This method is used to simulate the behavior of a drag&drop sorting UI:
* - When moving an id down, all the ids with an order equal or lower than the desired order
* but equal or higher than the current order are decreased by 1.
* - When moving an id up, all the ids with an order equal or higher than the desired order
* but equal or lower than the current order are increased by 1.
*
* @param array $order_map The order map.
* @param string $id The id to place.
* @param int $order The order at which to place the id.
*
* @return array The updated order map. This map is not normalized.
*/
public static function order_map_move_at_order( array $order_map, string $id, int $order ): array {
// If the id is not in the order map, return the order map as is.
if ( ! isset( $order_map[ $id ] ) ) {
return $order_map;
}
// If the id is already at the desired order, return the order map as is.
if ( $order_map[ $id ] === $order ) {
return $order_map;
}
// If there is no id at the desired order, just place the id there.
if ( ! in_array( $order, $order_map, true ) ) {
$order_map[ $id ] = $order;
return $order_map;
}
// We apply the normal behavior of a drag&drop sorting UI.
$existing_order = $order_map[ $id ];
if ( $order > $existing_order ) {
// Moving down.
foreach ( $order_map as $key => $value ) {
if ( $value <= $order && $value >= $existing_order ) {
--$order_map[ $key ];
}
}
} else {
// Moving up.
foreach ( $order_map as $key => $value ) {
if ( $value >= $order && $value <= $existing_order ) {
++$order_map[ $key ];
}
}
}
// Place the id at the desired order.
$order_map[ $id ] = $order;
return $order_map;
}
/**
* Place an id at a specific order in an order map.
*
* @param array $order_map The order map.
* @param string $id The id to place.
* @param int $order The order at which to place the id.
*
* @return array The updated order map.
*/
public static function order_map_place_at_order( array $order_map, string $id, int $order ): array {
// If the id is already at the desired order, return the order map as is.
if ( isset( $order_map[ $id ] ) && $order_map[ $id ] === $order ) {
return $order_map;
}
// If there is no id at the desired order, just place the id there.
if ( ! in_array( $order, $order_map, true ) ) {
$order_map[ $id ] = $order;
return $order_map;
}
// Bump the order of everything with an order equal or higher than the desired order.
foreach ( $order_map as $key => $value ) {
if ( $value >= $order ) {
++$order_map[ $key ];
}
}
// Place the id at the desired order.
$order_map[ $id ] = $order;
return $order_map;
}
/**
* Add an id to a specific order in an order map.
*
* @param array $order_map The order map.
* @param string $id The id to move.
* @param int $order The order to move the id to.
*
* @return array The updated order map. If the id is already in the order map, the order map is returned as is.
*/
public static function order_map_add_at_order( array $order_map, string $id, int $order ): array {
// If the id is in the order map, return the order map as is.
if ( isset( $order_map[ $id ] ) ) {
return $order_map;
}
return self::order_map_place_at_order( $order_map, $id, $order );
}
/**
* Normalize an order map.
*
* Sort the order map by the order and ensure the order values start from 0 and are consecutive.
*
* @param array $order_map The order map.
*
* @return array The normalized order map.
*/
public static function order_map_normalize( array $order_map ): array {
asort( $order_map );
return array_flip( array_keys( $order_map ) );
}
/**
* Change the minimum order of an order map.
*
* @param array $order_map The order map.
* @param int $new_min_order The new minimum order.
*
* @return array The updated order map.
*/
public static function order_map_change_min_order( array $order_map, int $new_min_order ): array {
// Sanity checks.
if ( empty( $order_map ) ) {
return array();
}
$updated_map = array();
$bump = $new_min_order - min( $order_map );
foreach ( $order_map as $id => $order ) {
$updated_map[ $id ] = $order + $bump;
}
asort( $updated_map );
return $updated_map;
}
/**
* Get the list of plugin slug suffixes used for handling non-standard testing slugs.
*
* @return string[] The list of plugin slug suffixes used for handling non-standard testing slugs.
*/
public static function get_testing_plugin_slug_suffixes(): array {
return array( '-dev', '-rc', '-test', '-beta', '-alpha' );
}
/**
* Generate a list of testing plugin slugs from a standard/official plugin slug.
*
* @param string $slug The standard/official plugin slug. Most likely the WPORG slug.
* @param bool $include_original Optional. Whether to include the original slug in the list.
* If true, the original slug will be the first item in the list.
*
* @return string[] The list of testing plugin slugs generated from the standard/official plugin slug.
*/
public static function generate_testing_plugin_slugs( string $slug, bool $include_original = false ): array {
$slugs = array();
if ( $include_original ) {
$slugs[] = $slug;
}
foreach ( self::get_testing_plugin_slug_suffixes() as $suffix ) {
$slugs[] = $slug . $suffix;
}
return $slugs;
}
/**
* Normalize a plugin slug to a standard/official slug.
*
* This is a best-effort approach.
* It will remove beta testing suffixes and lowercase the slug.
* It will NOT convert plugin titles to slugs or sanitize the slug like sanitize_title() does.
*
* @param string $slug The plugin slug.
*
* @return string The normalized plugin slug.
*/
public static function normalize_plugin_slug( string $slug ): string {
// If the slug is empty or contains anything other than alphanumeric and dash characters, it will be left as is.
if ( empty( $slug ) || ! preg_match( '/^[\w-]+$/', $slug, $matches ) ) {
return $slug;
}
// Lowercase the slug.
$slug = strtolower( $slug );
// Remove testing suffixes.
foreach ( self::get_testing_plugin_slug_suffixes() as $suffix ) {
$slug = str_ends_with( $slug, $suffix ) ? substr( $slug, 0, -strlen( $suffix ) ) : $slug;
}
return $slug;
}
/**
* Trim the .php file extension from a path.
*
* @param string $path The path to trim.
*
* @return string The trimmed path. If the path does not end with .php, it will be returned as is.
*/
public static function trim_php_file_extension( string $path ): string {
if ( ! empty( $path ) && str_ends_with( $path, '.php' ) ) {
$path = substr( $path, 0, - 4 );
}
return $path;
}
/**
* Truncate a text to a target character length while preserving whole words.
*
* We take a greedy approach: if some characters of a word fit in the target length, the whole word is included.
* This means we might exceed the target length by a few characters.
* The append string length is not included in the character count.
*
* @param string $text The text to truncate.
* It will not be sanitized, stripped of HTML tags, or modified in any way before truncation.
* @param int $target_length The target character length of the truncated text.
* @param string $append Optional. The string to append to the truncated text, if there is any truncation.
*
* @return string The truncated text.
*/
public static function truncate_with_words( string $text, int $target_length, string $append = '' ): string {
// First, deal with locale that doesn't have words separated by spaces, but instead deals with characters.
// Borrowed from wp_trim_words().
if ( str_starts_with( wp_get_word_count_type(), 'characters' ) && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {
$text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' );
preg_match_all( '/./u', $text, $words_array );
// Nothing to do if the text is already short enough.
if ( count( $words_array[0] ) <= $target_length ) {
return $text;
}
$words_array = array_slice( $words_array[0], 0, $target_length );
$truncated = implode( '', $words_array );
if ( $append ) {
$truncated .= $append;
}
return $truncated;
}
// Deal with locale that has words separated by spaces.
if ( strlen( $text ) <= $target_length ) {
return $text;
}
$words_array = preg_split( "/[\n\r\t ]+/", $text, - 1, PREG_SPLIT_NO_EMPTY );
$sep = ' ';
// Include words until the target length is reached.
$truncated = '';
$remaining_length = $target_length;
while ( $remaining_length > 0 && ! empty( $words_array ) ) {
$word = array_shift( $words_array );
$truncated .= $word . $sep;
$remaining_length -= strlen( $word . $sep );
}
// Remove the last separator.
$truncated = rtrim( $truncated, $sep );
if ( null !== $append ) {
$truncated .= $append;
}
return $truncated;
}
/**
* Retrieves a URL to relative path inside WooCommerce admin Payments settings with
* the provided query parameters.
*
* @param string|null $path Relative path of the desired page.
* @param array $query Query parameters to append to the path.
*
* @return string Fully qualified URL pointing to the desired path.
*/
public static function wc_payments_settings_url( ?string $path = null, array $query = array() ): string {
$path = $path ? '&path=' . $path : '';
$query_string = '';
if ( ! empty( $query ) ) {
$query_string = '&' . http_build_query( $query );
}
return admin_url( 'admin.php?page=wc-settings&tab=checkout' . $path . $query_string );
}
/**
* Get data from a WooCommerce API endpoint.
*
* @param string $endpoint Endpoint.
* @param array $params Params to pass with request query.
*
* @return array|\WP_Error The response data or a WP_Error object.
*/
public static function rest_endpoint_get_request( string $endpoint, array $params = array() ) {
$request = new \WP_REST_Request( 'GET', $endpoint );
if ( $params ) {
$request->set_query_params( $params );
}
// Do the internal request.
// This has minimal overhead compared to an external request.
$response = rest_do_request( $request );
$server = rest_get_server();
$response_data = json_decode( wp_json_encode( $server->response_to_data( $response, false ) ), true );
// Handle non-200 responses.
if ( 200 !== $response->get_status() ) {
return new \WP_Error(
'woocommerce_settings_payments_rest_error',
sprintf(
/* translators: 1: the endpoint relative URL, 2: error code, 3: error message */
esc_html__( 'REST request GET %1$s failed with: (%2$s) %3$s', 'woocommerce' ),
$endpoint,
$response_data['code'] ?? 'unknown_error',
$response_data['message'] ?? esc_html__( 'Unknown error', 'woocommerce' )
),
$response_data
);
}
// If the response is 200, return the data.
return $response_data;
}
/**
* Post data to a WooCommerce API endpoint and return the response data.
*
* @param string $endpoint Endpoint.
* @param array $params Params to pass with request body.
*
* @return array|\WP_Error The response data or a WP_Error object.
*/
public static function rest_endpoint_post_request( string $endpoint, array $params = array() ) {
$request = new \WP_REST_Request( 'POST', $endpoint );
if ( $params ) {
$request->set_body_params( $params );
}
// Do the internal request.
// This has minimal overhead compared to an external request.
$response = rest_do_request( $request );
$server = rest_get_server();
$response_data = json_decode( wp_json_encode( $server->response_to_data( $response, false ) ), true );
// Handle non-200 responses.
if ( 200 !== $response->get_status() ) {
return new \WP_Error(
'woocommerce_settings_payments_rest_error',
sprintf(
/* translators: 1: the endpoint relative URL, 2: error code, 3: error message */
esc_html__( 'REST request POST %1$s failed with: (%2$s) %3$s', 'woocommerce' ),
$endpoint,
$response_data['code'] ?? 'unknown_error',
$response_data['message'] ?? esc_html__( 'Unknown error', 'woocommerce' )
),
$response_data
);
}
// If the response is 200, return the data.
return $response_data;
}
/**
* Get the details to authorize a connection to WordPress.com.
*
* The most important part of the result is the URL to redirect to for authorization.
*
* @param string $return_url The URL to redirect to after the connection is authorized.
*
* @return array {
* 'success' => bool Whether the request was successful.
* 'errors' => array An array of error messages, if any.
* 'color_scheme' => string The color scheme to use for the authorization page.
* 'url' => string The URL to redirect to for authorization.
* }
*/
public static function get_wpcom_connection_authorization( string $return_url ): array {
$result = JetpackConnection::get_authorization_url( $return_url );
if ( ! empty( $result['url'] ) ) {
$result['url'] = add_query_arg(
array(
// We use the new WooDNA value.
'from' => 'woocommerce-onboarding',
// We inform Calypso that this is a WooPayments onboarding flow.
'plugin_name' => 'woocommerce-payments',
// Use the current user's WP admin color scheme.
'color_scheme' => $result['color_scheme'],
),
$result['url']
);
}
return $result;
}
}
PK [1]V1 1 % Admin/Settings/PaymentsController.phpnu payments = $payments;
}
/**
* Adds the Payments top-level menu item.
*/
public function add_menu() {
global $menu;
// When the WooPayments account is onboarded, WooPayments will own the Payments menu item since it is the native Woo payments solution.
if ( $this->is_woopayments_account_onboarded() ) {
return;
} else {
// Otherwise, remove the Payments menu item linking to the Connect page to avoid Payments menu item duplication.
remove_menu_page( 'wc-admin&path=/payments/connect' );
}
$menu_title = esc_html__( 'Payments', 'woocommerce' );
$menu_icon = 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NTIiIGhlaWdodD0iNjg0Ij48cGF0aCBmaWxsPSIjYTJhYWIyIiBkPSJNODIgODZ2NTEyaDY4NFY4NlptMCA1OThjLTQ4IDAtODQtMzgtODQtODZWODZDLTIgMzggMzQgMCA4MiAwaDY4NGM0OCAwIDg0IDM4IDg0IDg2djUxMmMwIDQ4LTM2IDg2LTg0IDg2em0zODQtNTU2djQ0aDg2djg0SDM4MnY0NGgxMjhjMjQgMCA0MiAxOCA0MiA0MnYxMjhjMCAyNC0xOCA0Mi00MiA0MmgtNDR2NDRoLTg0di00NGgtODZ2LTg0aDE3MHYtNDRIMzM4Yy0yNCAwLTQyLTE4LTQyLTQyVjIxNGMwLTI0IDE4LTQyIDQyLTQyaDQ0di00NHoiLz48L3N2Zz4=';
// Link to the Payments settings page.
$menu_path = 'admin.php?page=wc-settings&tab=checkout&from=' . Payments::FROM_PAYMENTS_MENU_ITEM;
add_menu_page(
$menu_title,
$menu_title,
'manage_woocommerce', // Capability required to see the menu item.
$menu_path,
null,
$menu_icon,
56, // Position after WooCommerce Product menu item.
);
// If there are providers with an active incentive, add a notice badge to the Payments menu item.
if ( $this->store_has_providers_with_incentive() ) {
$badge = ' 1';
foreach ( $menu as $index => $menu_item ) {
// Only add the badge markup if not already present, and the menu item is the Payments menu item.
if ( 0 === strpos( $menu_item[0], $menu_title )
&& $menu_path === $menu_item[2]
&& false === strpos( $menu_item[0], $badge ) ) {
$menu[ $index ][0] .= $badge; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
// One menu item with a badge is more than enough.
break;
}
}
}
}
/**
* Adds body classes when in the Payments Settings admin area.
*
* @param string $classes The existing body classes for the admin area.
*
* @return string The modified body classes for the admin area.
*/
public function add_body_classes( $classes = '' ) {
global $current_tab;
// Bail if the type is invalid.
if ( ! is_string( $classes ) ) {
return $classes;
}
if ( 'checkout' === $current_tab && ! str_contains( 'woocommerce-settings-payments-tab', $classes ) ) {
$classes = "$classes woocommerce-settings-payments-tab";
}
return $classes;
}
/**
* Preload settings to make them available to the Payments settings page frontend logic.
*
* Added keys will be available in the window.wcSettings.admin object.
*
* @param array $settings The settings array.
*
* @return array Settings array with additional settings added.
*/
public function preload_settings( $settings = array() ) {
// We only preload settings in the WP admin.
if ( ! is_admin() ) {
return $settings;
}
// Reset the received value if the type is invalid.
if ( ! is_array( $settings ) ) {
$settings = array();
}
// Add the business location country to the settings.
if ( ! isset( $settings[ Payments::PAYMENTS_NOX_PROFILE_KEY ] ) ) {
$settings[ Payments::PAYMENTS_NOX_PROFILE_KEY ] = array();
}
$settings[ Payments::PAYMENTS_NOX_PROFILE_KEY ]['business_country_code'] = $this->payments->get_country();
return $settings;
}
/**
* Adds promo note IDs to the list of allowed ones.
*
* @param array $promo_notes Allowed promo note IDs.
*
* @return array The updated list of allowed promo note IDs.
*/
public function add_allowed_promo_notes( $promo_notes = array() ): array {
// Reset the value if the type is invalid.
if ( ! is_array( $promo_notes ) ) {
$promo_notes = array();
}
try {
$providers = $this->payments->get_payment_providers( $this->payments->get_country(), false );
} catch ( Throwable $e ) {
// Catch everything since we don't want to break all the WP admin pages.
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get payment providers: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
return $promo_notes;
}
// Add all incentive promo IDs to the allowed promo notes list.
foreach ( $providers as $provider ) {
if ( ! empty( $provider['_incentive']['promo_id'] ) ) {
$promo_notes[] = $provider['_incentive']['promo_id'];
}
}
return $promo_notes;
}
/**
* Alter the Payments tab sections under certain conditions.
*
* @param array $sections The payments/checkout tab sections.
*
* @return array The filtered sections.
*/
public function handle_sections( $sections = array() ): array {
global $current_section;
// Reset the value if the type is invalid.
if ( ! is_array( $sections ) ) {
$sections = array();
}
// Bail if the current section global is empty or of the wrong type.
if ( empty( $current_section ) || ! is_string( $current_section ) ) {
return $sections;
}
// For WooPayments and offline payment methods settings pages, we don't want any section navigation.
if ( in_array( $current_section, array( WooPaymentsService::GATEWAY_ID, WC_Gateway_BACS::ID, WC_Gateway_Cheque::ID, WC_Gateway_COD::ID ), true ) ) {
return array();
}
return $sections;
}
/**
* Handle the payments extension suggestion incentive dismissed event.
*
* @return void
*/
public function handle_incentive_dismissed(): void {
// Clear the transient to force a new check for providers with an incentive.
delete_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY );
}
/**
* Check if the store has any enabled gateways (including offline payment methods).
*
* @return bool True if the store has any enabled gateways, false otherwise.
*/
private function store_has_enabled_gateways(): bool {
$gateways = WC()->payment_gateways->get_available_payment_gateways();
$enabled_gateways = array_filter(
$gateways,
function ( $gateway ) {
return 'yes' === $gateway->enabled;
}
);
return ! empty( $enabled_gateways );
}
/**
* Check if the store has any payment providers that have an active incentive.
*
* @return bool True if the store has providers with an active incentive.
*/
private function store_has_providers_with_incentive(): bool {
// First, try to use the transient value.
$transient = get_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY );
if ( false !== $transient ) {
return filter_var( $transient, FILTER_VALIDATE_BOOLEAN );
}
try {
$providers = $this->payments->get_payment_providers( $this->payments->get_country(), false );
} catch ( Throwable $e ) {
// Catch everything since we don't want to break all the WP admin pages.
// Log so we can investigate.
SafeGlobalFunctionProxy::wc_get_logger()->error(
'Failed to get payment providers: ' . $e->getMessage(),
array(
'source' => 'settings-payments',
)
);
// In case of an error, default to false.
// Set the transient to avoid repeated errors.
set_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY, 'no', HOUR_IN_SECONDS );
return false;
}
$has_providers_with_incentive = false;
// Go through the providers and check if any of them have a "prominently" visible incentive (i.e., modal or banner).
foreach ( $providers as $provider ) {
if ( empty( $provider['_incentive'] ) ) {
continue;
}
$dismissals = $provider['_incentive']['_dismissals'] ?? array();
// If there are no dismissals at all, the incentive is prominently visible.
if ( empty( $dismissals ) ) {
$has_providers_with_incentive = true;
break;
}
// First, we check to see if the incentive was dismissed in the banner context.
// The banner context has the lowest priority, so if it was dismissed, we don't need to check the modal context.
// If the banner is dismissed, there is no prominent incentive.
$is_dismissed_banner = ! empty(
array_filter(
$dismissals,
function ( $dismissal ) {
return isset( $dismissal['context'] ) && 'wc_settings_payments__banner' === $dismissal['context'];
}
)
);
if ( $is_dismissed_banner ) {
continue;
}
// In case an incentive uses the modal surface also (like the WooPayments Switch incentive),
// we rely on the fact that the modal falls back to the banner, once dismissed, after 30 days.
// @see here's its frontend "brother" in client/admin/client/settings-payments/settings-payments-main.tsx.
$is_dismissed_modal = ! empty(
array_filter(
$dismissals,
function ( $dismissal ) {
return isset( $dismissal['context'] ) && 'wc_settings_payments__modal' === $dismissal['context'];
}
)
);
// If there are no modal dismissals, the incentive is still visible.
if ( ! $is_dismissed_modal ) {
$has_providers_with_incentive = true;
break;
}
$is_dismissed_modal_more_than_30_days_ago = ! empty(
array_filter(
$dismissals,
function ( $dismissal ) {
return isset( $dismissal['context'], $dismissal['timestamp'] ) &&
'wc_settings_payments__modal' === $dismissal['context'] &&
$dismissal['timestamp'] < strtotime( '-30 days' );
}
)
);
// If the modal was dismissed less than 30 days ago, there is no prominent incentive (aka the banner is not shown).
if ( ! $is_dismissed_modal_more_than_30_days_ago ) {
continue;
}
// The modal was dismissed more than 30 days ago, so the banner is visible.
$has_providers_with_incentive = true;
break;
}
// Save the value in a transient to avoid unnecessary processing throughout the WP admin.
// Incentives don't change frequently, so it is safe to cache the value for 1 hour.
set_transient( self::TRANSIENT_HAS_PROVIDERS_WITH_INCENTIVE_KEY, $has_providers_with_incentive ? 'yes' : 'no', HOUR_IN_SECONDS );
return $has_providers_with_incentive;
}
/**
* Check if the WooPayments account is onboarded.
*
* @return boolean
*/
private function is_woopayments_account_onboarded(): bool {
// Sanity check: the WooPayments extension must be active.
if ( ! class_exists( '\WC_Payments' ) ) {
return false;
}
$account_data = get_option( 'wcpay_account_data', array() );
// The account ID must be present.
if ( empty( $account_data['data']['account_id'] ) ) {
return false;
}
// We consider the store to have an onboarded WooPayments account if account data in the WooPayments account cache
// contains a details_submitted = true entry. This implies that WooPayments is also connected.
if ( empty( $account_data['data']['details_submitted'] ) ) {
return false;
}
return filter_var( $account_data['data']['details_submitted'], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE ) ?? false;
}
}
PK [1]ic $ Admin/Settings/PaymentsProviders.phpnu WCCore::class,
WC_Gateway_Cheque::ID => WCCore::class,
WC_Gateway_COD::ID => WCCore::class,
WC_Gateway_Paypal::ID => WCCore::class,
'woocommerce_payments' => WooPayments::class,
'ppcp-gateway' => PayPal::class,
'stripe' => Stripe::class,
'stripe_*' => Stripe::class,
'mollie' => Mollie::class,
'mollie_wc_gateway_*' => Mollie::class, // Target all the Mollie gateways.
'amazon_payments_advanced*' => AmazonPay::class,
'woo-mercado-pago-*' => MercadoPago::class,
'affirm' => Affirm::class,
'klarna_payments' => Klarna::class,
'afterpay' => AfterpayClearpay::class,
'clearpay' => AfterpayClearpay::class,
'antom_*' => Antom::class,
'razorpay' => Razorpay::class,
'paystack' => Paystack::class,
'paystack-*' => Paystack::class,
'payfast' => Payfast::class,
'payoneer-*' => Payoneer::class,
'payubiz' => PayUIndia::class,
'paymob' => Paymob::class,
'paymob-*' => Paymob::class,
'airwallex_*' => Airwallex::class,
'vivawallet*' => Vivacom::class,
'tilopay' => Tilopay::class,
'helio' => HelioPay::class,
'paytrail' => Paytrail::class,
'monei' => Monei::class,
'monei_*' => Monei::class,
'gocardless' => GoCardless::class,
'kco' => KlarnaCheckout::class,
'visa_acceptance_solutions_*' => Visa::class,
'eway' => Eway::class,
'dibs_easy' => NexiCheckout::class,
);
/**
* The map of payment extension suggestion IDs to their respective provider classes.
*
* This is used to instantiate providers to provide details for the payment extension suggestions, pre-attachment.
*
* @var \class-string[]
*/
private array $payment_extension_suggestions_providers_class_map = array(
ExtensionSuggestions::WOOPAYMENTS => WooPayments::class,
ExtensionSuggestions::PAYPAL_FULL_STACK => PayPal::class,
ExtensionSuggestions::PAYPAL_WALLET => PayPal::class,
ExtensionSuggestions::STRIPE => Stripe::class,
ExtensionSuggestions::MOLLIE => Mollie::class,
ExtensionSuggestions::AMAZON_PAY => AmazonPay::class,
ExtensionSuggestions::MERCADO_PAGO => MercadoPago::class,
ExtensionSuggestions::AFFIRM => Affirm::class,
ExtensionSuggestions::KLARNA => Klarna::class,
ExtensionSuggestions::AFTERPAY => AfterpayClearpay::class,
ExtensionSuggestions::CLEARPAY => AfterpayClearpay::class,
ExtensionSuggestions::ANTOM => Antom::class,
ExtensionSuggestions::RAZORPAY => Razorpay::class,
ExtensionSuggestions::PAYSTACK => Paystack::class,
ExtensionSuggestions::PAYFAST => Payfast::class,
ExtensionSuggestions::PAYONEER => Payoneer::class,
ExtensionSuggestions::PAYU_INDIA => PayUIndia::class,
ExtensionSuggestions::PAYMOB => Paymob::class,
ExtensionSuggestions::AIRWALLEX => Airwallex::class,
ExtensionSuggestions::VIVA_WALLET => Vivacom::class,
ExtensionSuggestions::TILOPAY => Tilopay::class,
ExtensionSuggestions::HELIOPAY => HelioPay::class,
ExtensionSuggestions::PAYTRAIL => Paytrail::class,
ExtensionSuggestions::MONEI => Monei::class,
ExtensionSuggestions::GOCARDLESS => GoCardless::class,
ExtensionSuggestions::KLARNA_CHECKOUT => KlarnaCheckout::class,
ExtensionSuggestions::VISA => Visa::class,
ExtensionSuggestions::EWAY => Eway::class,
ExtensionSuggestions::NEXI_CHECKOUT => NexiCheckout::class,
);
/**
* The instances of the payment providers.
*
* @var PaymentGateway[]
*/
private array $instances = array();
/**
* The memoized payment gateways to avoid computing the list multiple times during a request.
*
* @var array
*/
private array $payment_gateways_memo = array();
/**
* The memoized payment gateways for display to avoid computing the list multiple times during a request.
*
* This is especially important since it avoids triggering the legacy action multiple times during a request.
*
* @var array
*/
private array $payment_gateways_for_display_memo = array();
/**
* The payment extension suggestions service.
*
* @var ExtensionSuggestions
*/
private ExtensionSuggestions $extension_suggestions;
/**
* The LegacyProxy instance.
*
* @var LegacyProxy
*/
private LegacyProxy $proxy;
/**
* Initialize the class instance.
*
* @param ExtensionSuggestions $payment_extension_suggestions The payment extension suggestions service.
* @param LegacyProxy $proxy The LegacyProxy instance.
*
* @internal
*/
final public function init( ExtensionSuggestions $payment_extension_suggestions, LegacyProxy $proxy ): void {
$this->extension_suggestions = $payment_extension_suggestions;
$this->proxy = $proxy;
}
/**
* Get the payment gateways for the settings page.
*
* We apply the same actions and logic that the non-React Payments settings page uses to get the gateways.
* This way we maintain backwards compatibility.
*
* @param bool $for_display Whether the payment gateway list is intended for display purposes.
* This triggers the legacy `woocommerce_admin_field_payment_gateways` action and
* the exclusion of "shell" gateways.
* Default is true.
* @param string $country_code Optional. The country code for which the payment gateways are being generated.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The payment gateway objects list.
*/
public function get_payment_gateways( bool $for_display = true, string $country_code = '' ): array {
// Normalize the country code to uppercase.
$country_code = strtoupper( $country_code );
// If we are asked for a display gateways list, we need to fire legacy actions and filter out "shells".
if ( $for_display ) {
if ( isset( $this->payment_gateways_for_display_memo[ $country_code ] ) ) {
return $this->payment_gateways_for_display_memo[ $country_code ];
}
// We don't want to output anything from the action. So we buffer it and discard it.
// We just want to give the payment extensions a chance to adjust the payment gateways list for the settings page.
// This is primarily for backwards compatibility.
ob_start();
/**
* Fires before the payment gateways settings fields are rendered.
*
* @since 1.5.7
*/
do_action( 'woocommerce_admin_field_payment_gateways' );
ob_end_clean();
// Get all payment gateways, ordered by the user.
$payment_gateways = WC()->payment_gateways()->payment_gateways;
// Handle edge-cases for certain providers.
$payment_gateways = $this->handle_non_standard_registration_for_payment_gateways( $payment_gateways );
// Remove "shell" gateways from the list.
$payment_gateways = $this->remove_shell_payment_gateways( $payment_gateways, $country_code );
// Store the entire payment gateways list for display for later use.
$this->payment_gateways_for_display_memo[ $country_code ] = $payment_gateways;
return $payment_gateways;
}
// We were asked for the raw payment gateways list.
if ( isset( $this->payment_gateways_memo[ $country_code ] ) ) {
return $this->payment_gateways_memo[ $country_code ];
}
// Get all payment gateways, ordered by the user.
$payment_gateways = WC()->payment_gateways()->payment_gateways;
// Handle edge-cases for certain providers.
$payment_gateways = $this->handle_non_standard_registration_for_payment_gateways( $payment_gateways );
// Store the entire payment gateways list for later use.
$this->payment_gateways_memo[ $country_code ] = $payment_gateways;
return $payment_gateways;
}
/**
* Remove "shell" gateways from the provided payment gateways list.
*
* We consider a gateway to be a "shell" if it has no WC admin title or description.
* The removal is done in a way that ensures we do not remove all gateways from an extension,
* thus preventing user access to the settings page(s) for that extension.
*
* @param array $payment_gateways The payment gateways list to process.
* @param string $country_code Optional. The country code for which the payment gateways are being generated.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The processed payment gateways list.
*/
public function remove_shell_payment_gateways( array $payment_gateways, string $country_code = '' ): array {
// Normalize the country code to uppercase.
$country_code = strtoupper( $country_code );
$grouped_payment_gateways = $this->group_gateways_by_extension( $payment_gateways, $country_code );
return array_filter(
$payment_gateways,
function ( $gateway ) use ( $grouped_payment_gateways, $country_code ) {
// If the gateway is a shell, we only remove it if there are other, non-shell gateways from that extension.
// This is to avoid removing all the gateways registered by an extension and
// preventing user access to the settings page(s) for that extension.
if ( $this->is_shell_payment_gateway( $gateway ) ) {
$gateway_details = $this->get_payment_gateway_details( $gateway, 0, $country_code );
// In case we don't have the needed extension details,
// we allow the gateway to be displayed (aka better safe than sorry).
if ( empty( $gateway_details ) || ! isset( $gateway_details['plugin'] ) || empty( $gateway_details['plugin']['file'] ) ) {
return true;
}
if ( empty( $grouped_payment_gateways[ $gateway_details['plugin']['file'] ] ) ||
count( $grouped_payment_gateways[ $gateway_details['plugin']['file'] ] ) <= 1 ) {
// If there are no other gateways from the same extension, we let the shell gateway be displayed.
return true;
}
// Check if there are any other gateways from the same extension that are NOT shells.
foreach ( $grouped_payment_gateways[ $gateway_details['plugin']['file'] ] as $extension_gateway ) {
if ( ! $this->is_shell_payment_gateway( $extension_gateway ) ) {
// If we found a gateway from the same extension that is not a shell,
// we hide all shells from that extension.
return false;
}
}
}
// By this point, we know that the gateway is not a shell or that it is a shell
// but there are no non-shell gateways from the same extension. Include it.
return true;
}
);
}
/**
* Get the payment gateway provider instance.
*
* @param string $gateway_id The gateway ID.
*
* @return PaymentGateway The payment gateway provider instance.
* Will return the general provider of no specific provider is found.
*/
public function get_payment_gateway_provider_instance( string $gateway_id ): PaymentGateway {
if ( isset( $this->instances[ $gateway_id ] ) ) {
return $this->instances[ $gateway_id ];
}
/**
* The provider class for the gateway.
*
* @var class-string|null $provider_class
*/
$provider_class = null;
if ( isset( $this->payment_gateways_providers_class_map[ $gateway_id ] ) ) {
$provider_class = $this->payment_gateways_providers_class_map[ $gateway_id ];
} else {
// Check for wildcard mappings.
foreach ( $this->payment_gateways_providers_class_map as $gateway_id_pattern => $mapped_class ) {
// Try to see if we have a wildcard mapping and if the gateway ID matches it.
// Use the first found match.
if ( false !== strpos( $gateway_id_pattern, '*' ) ) {
$gateway_id_pattern = str_replace( '*', '.*', $gateway_id_pattern );
if ( preg_match( '/^' . $gateway_id_pattern . '$/', $gateway_id ) ) {
$provider_class = $mapped_class;
break;
}
}
}
}
// Check that the provider class extends the PaymentGateway class.
if ( ! is_null( $provider_class ) && ! is_subclass_of( $provider_class, PaymentGateway::class ) ) {
wc_doing_it_wrong(
__METHOD__,
sprintf(
/* translators: %s: Gateway ID. */
esc_html__( 'The provider class for gateway ID "%s" must extend the PaymentGateway class.', 'woocommerce' ),
$gateway_id
),
'10.4.0'
);
// Return the generic provider as a fallback.
$provider_class = null;
}
// If the gateway ID is not mapped to a provider class, return the generic provider.
if ( is_null( $provider_class ) ) {
if ( ! isset( $this->instances['generic'] ) ) {
$this->instances['generic'] = new PaymentGateway( $this->proxy );
}
return $this->instances['generic'];
}
$this->instances[ $gateway_id ] = new $provider_class( $this->proxy );
return $this->instances[ $gateway_id ];
}
/**
* Get the payment extension suggestion (PES) provider instance.
*
* @param string $pes_id The payment extension suggestion ID.
*
* @return PaymentGateway The payment extension suggestion provider instance.
* Will return the general provider of no specific provider is found.
*/
public function get_payment_extension_suggestion_provider_instance( string $pes_id ): PaymentGateway {
if ( isset( $this->instances[ $pes_id ] ) ) {
return $this->instances[ $pes_id ];
}
/**
* The provider class for the payment extension suggestion (PES).
*
* @var class-string|null $provider_class
*/
$provider_class = null;
if ( isset( $this->payment_extension_suggestions_providers_class_map[ $pes_id ] ) ) {
if ( ! is_subclass_of( $this->payment_extension_suggestions_providers_class_map[ $pes_id ], PaymentGateway::class ) ) {
wc_doing_it_wrong(
__METHOD__,
sprintf(
/* translators: %s: Payment extension suggestion ID. */
esc_html__( 'The provider class for payment extension suggestion ID "%s" must extend the PaymentGateway class.', 'woocommerce' ),
$pes_id
),
'10.4.0'
);
// Return the generic provider as a fallback.
} else {
$provider_class = $this->payment_extension_suggestions_providers_class_map[ $pes_id ];
}
}
// If the gateway ID is not mapped to a provider class, return the generic provider.
if ( is_null( $provider_class ) ) {
if ( ! isset( $this->instances['generic'] ) ) {
$this->instances['generic'] = new PaymentGateway( $this->proxy );
}
return $this->instances['generic'];
}
$this->instances[ $pes_id ] = new $provider_class( $this->proxy );
return $this->instances[ $pes_id ];
}
/**
* Get the payment gateways details.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param int $payment_gateway_order The order of the payment gateway.
* @param string $country_code Optional. The country code for which the details are being gathered.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The payment gateway details.
*/
public function get_payment_gateway_details( WC_Payment_Gateway $payment_gateway, int $payment_gateway_order, string $country_code = '' ): array {
// Normalize the country code to uppercase.
$country_code = strtoupper( $country_code );
return $this->enhance_payment_gateway_details(
$this->get_payment_gateway_base_details( $payment_gateway, $payment_gateway_order, $country_code ),
$payment_gateway,
$country_code
);
}
/**
* Get the payment gateways details from the object.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param int $payment_gateway_order The order of the payment gateway.
* @param string $country_code Optional. The country code for which the details are being gathered.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The payment gateway base details.
*/
public function get_payment_gateway_base_details( WC_Payment_Gateway $payment_gateway, int $payment_gateway_order, string $country_code = '' ): array {
// Normalize the country code to uppercase.
$country_code = strtoupper( $country_code );
$provider = $this->get_payment_gateway_provider_instance( $payment_gateway->id );
return $provider->get_details( $payment_gateway, $payment_gateway_order, $country_code );
}
/**
* Get the source plugin slug of a payment gateway instance.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
*
* @return string The plugin slug of the payment gateway.
* Empty string if a plugin slug could not be determined.
*/
public function get_payment_gateway_plugin_slug( WC_Payment_Gateway $payment_gateway ): string {
$provider = $this->get_payment_gateway_provider_instance( $payment_gateway->id );
return $provider->get_plugin_slug( $payment_gateway );
}
/**
* Get the plugin file of payment gateway, without the .php extension.
*
* This is useful for the WP API, which expects the plugin file without the .php extension.
*
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $plugin_slug Optional. The payment gateway plugin slug to use directly.
*
* @return string The plugin file corresponding to the payment gateway plugin. Does not include the .php extension.
*/
public function get_payment_gateway_plugin_file( WC_Payment_Gateway $payment_gateway, string $plugin_slug = '' ): string {
$provider = $this->get_payment_gateway_provider_instance( $payment_gateway->id );
return $provider->get_plugin_file( $payment_gateway, $plugin_slug );
}
/**
* Get the offline payment methods gateways.
*
* @return array The registered offline payment methods gateways keyed by their global gateways list order/index.
*/
public function get_offline_payment_methods_gateways(): array {
return array_filter(
$this->get_payment_gateways( false ), // We request the raw gateways list to get the global order/index.
function ( $gateway ) {
return $this->is_offline_payment_method( $gateway->id );
}
);
}
/**
* Check if a payment gateway is an offline payment method.
*
* @param string $id The ID of the payment gateway.
*
* @return bool True if the payment gateway is an offline payment method, false otherwise.
*/
public function is_offline_payment_method( string $id ): bool {
return in_array( $id, self::OFFLINE_METHODS, true );
}
/**
* Check if a payment gateway is a shell payment gateway.
*
* A shell payment gateway is generally one that has no method title or description.
* This is used to identify gateways that are not intended for display in the admin UI.
*
* @param WC_Payment_Gateway $gateway The payment gateway object.
*
* @return bool True if the payment gateway is a shell, false otherwise.
*/
public function is_shell_payment_gateway( WC_Payment_Gateway $gateway ): bool {
return ( empty( $gateway->get_method_title() ) && empty( $gateway->get_method_description() ) ) ||
// Special case for WooPayments gateways that are not the main one: their method title is "WooPayments",
// but their ID is made up of the main gateway ID and a suffix for the payment method.
( 'WooPayments' === $gateway->get_method_title() && str_starts_with( $gateway->id, WooPaymentsService::GATEWAY_ID . '_' ) );
}
/**
* Get the payment extension suggestions for the given location.
*
* @param string $location The location for which the suggestions are being fetched.
* @param string $context Optional. The context ID of where these extensions are being used.
*
* @return array[] The payment extension suggestions for the given location, split into preferred and other.
* @throws Exception If there are malformed or invalid suggestions.
*/
public function get_extension_suggestions( string $location, string $context = '' ): array {
// Normalize the location to uppercase.
$location = strtoupper( $location );
$preferred_psp = null;
$preferred_apm = null;
$preferred_offline_psp = null;
$other = array();
$extensions = $this->extension_suggestions->get_country_extensions( $location, $context );
// Sort them by _priority.
usort(
$extensions,
function ( $a, $b ) {
return $a['_priority'] <=> $b['_priority'];
}
);
$has_enabled_ecommerce_gateways = $this->has_enabled_ecommerce_gateways();
// Keep track of the active extensions.
$active_extensions = array();
foreach ( $extensions as $extension ) {
$extension = $this->enhance_extension_suggestion( $extension );
if ( self::EXTENSION_ACTIVE === $extension['plugin']['status'] ) {
// If the suggested extension is active, we no longer suggest it.
// But remember it for later.
$active_extensions[] = $extension['id'];
continue;
}
// Determine if the suggestion is preferred or not by looking at its tags.
$is_preferred = in_array( ExtensionSuggestions::TAG_PREFERRED, $extension['tags'], true );
// Determine if the suggestion is hidden (from the preferred locations).
$is_hidden = $this->is_payment_extension_suggestion_hidden( $extension );
if ( ! $is_hidden && $is_preferred ) {
// If we don't have a preferred offline payments PSP and the suggestion is an offline payments preferred PSP,
// add it to the preferred list.
// Check this first so we don't inadvertently "fill" the preferred PSP slot.
if ( empty( $preferred_offline_psp ) &&
ExtensionSuggestions::TYPE_PSP === $extension['_type'] &&
in_array( ExtensionSuggestions::TAG_PREFERRED_OFFLINE, $extension['tags'], true ) ) {
$preferred_offline_psp = $extension;
continue;
}
// If we don't have a preferred PSP and the suggestion is a preferred PSP, add it to the preferred list.
if ( empty( $preferred_psp ) && ExtensionSuggestions::TYPE_PSP === $extension['_type'] ) {
$preferred_psp = $extension;
continue;
}
// If we don't have a preferred APM and the suggestion is a preferred APM, add it to the preferred list.
// In the preferred APM slot we might surface APMs but also Express Checkouts (PayPal Wallet).
if ( empty( $preferred_apm ) &&
in_array( $extension['_type'], array( ExtensionSuggestions::TYPE_APM, ExtensionSuggestions::TYPE_EXPRESS_CHECKOUT ), true ) ) {
$preferred_apm = $extension;
continue;
}
}
if ( $is_hidden &&
ExtensionSuggestions::TYPE_APM === $extension['_type'] &&
ExtensionSuggestions::PAYPAL_FULL_STACK === $extension['id'] ) {
// If the PayPal Full Stack suggestion is hidden, we no longer suggest it,
// because we have the PayPal Express Checkout (Wallet) suggestion.
continue;
}
// If there are no enabled ecommerce gateways (no PSP selected),
// we don't suggest express checkout, BNPL, or crypto extensions.
if ( ! $has_enabled_ecommerce_gateways &&
in_array( $extension['_type'], array( ExtensionSuggestions::TYPE_EXPRESS_CHECKOUT, ExtensionSuggestions::TYPE_BNPL, ExtensionSuggestions::TYPE_CRYPTO ), true )
) {
continue;
}
// If WooPayments or Stripe is active, we don't suggest other BNPLs.
// Note: Affirm is available in the UK even with WooPayments or Stripe active
// because Stripe does not support it there, yet.
if ( ExtensionSuggestions::TYPE_BNPL === $extension['_type'] &&
(
in_array( ExtensionSuggestions::STRIPE, $active_extensions, true ) ||
in_array( ExtensionSuggestions::WOOPAYMENTS, $active_extensions, true )
) &&
! (
ExtensionSuggestions::AFFIRM === $extension['id'] &&
'GB' === $location
)
) {
continue;
}
// If we made it to this point, the suggestion goes into the other list.
// But first, make sure there isn't already an extension added to the other list with the same plugin slug.
// This can happen if the same extension is suggested as both a PSP and an APM.
// The first entry that we encounter is the one that we keep.
$extension_slug = $extension['plugin']['slug'];
$extension_exists = array_filter(
$other,
function ( $suggestion ) use ( $extension_slug ) {
return $suggestion['plugin']['slug'] === $extension_slug;
}
);
if ( ! empty( $extension_exists ) ) {
continue;
}
$other[] = $extension;
}
// Make sure that the preferred suggestions are not among the other list by removing any entries with their plugin slug.
$other = array_values(
array_filter(
$other,
function ( $suggestion ) use ( $preferred_psp, $preferred_apm ) {
return ( empty( $preferred_psp ) || $suggestion['plugin']['slug'] !== $preferred_psp['plugin']['slug'] ) &&
( empty( $preferred_apm ) || $suggestion['plugin']['slug'] !== $preferred_apm['plugin']['slug'] );
}
)
);
// The preferred PSP gets a recommended tag that instructs the UI to highlight it further.
if ( ! empty( $preferred_psp ) ) {
$preferred_psp['tags'][] = ExtensionSuggestions::TAG_RECOMMENDED;
}
return array(
'preferred' => array_values(
array_filter(
array(
// The PSP should naturally have a higher priority than the APM, with the preferred offline PSP last.
// No need to impose a specific order here.
$preferred_psp,
$preferred_apm,
$preferred_offline_psp,
)
)
),
'other' => $other,
);
}
/**
* Get a payment extension suggestion by ID.
*
* @param string $id The ID of the payment extension suggestion.
*
* @return ?array The payment extension suggestion details, or null if not found.
*/
public function get_extension_suggestion_by_id( string $id ): ?array {
$suggestion = $this->extension_suggestions->get_by_id( $id );
if ( ! is_null( $suggestion ) ) {
// Enhance the suggestion details.
$suggestion = $this->enhance_extension_suggestion( $suggestion );
}
return $suggestion;
}
/**
* Get a payment extension suggestion by plugin slug.
*
* @param string $slug The plugin slug of the payment extension suggestion.
* @param string $country_code Optional. The business location country code to get the suggestions for.
*
* @return ?array The payment extension suggestion details, or null if not found.
*/
public function get_extension_suggestion_by_plugin_slug( string $slug, string $country_code = '' ): ?array {
// Normalize the country code to uppercase.
$country_code = strtoupper( $country_code );
$suggestion = $this->extension_suggestions->get_by_plugin_slug( $slug, $country_code, Payments::SUGGESTIONS_CONTEXT );
if ( ! is_null( $suggestion ) ) {
// Enhance the suggestion details.
$suggestion = $this->enhance_extension_suggestion( $suggestion );
}
return $suggestion;
}
/**
* Attach a payment extension suggestion.
*
* Attachment is a broad concept that can mean different things depending on the suggestion.
* Currently, we use it to record the extension installation. This is why we expect to receive
* instructions to record attachment when the extension is installed.
*
* @param string $id The ID of the payment extension suggestion to attach.
*
* @return bool True if the suggestion was successfully marked as attached, false otherwise.
* @throws Exception If the suggestion ID is invalid.
*/
public function attach_extension_suggestion( string $id ): bool {
// We may receive a suggestion ID that is actually an order map ID used in the settings page providers list.
// Extract the suggestion ID from the order map ID.
if ( $this->is_suggestion_order_map_id( $id ) ) {
$id = $this->get_suggestion_id_from_order_map_id( $id );
}
$suggestion = $this->get_extension_suggestion_by_id( $id );
if ( is_null( $suggestion ) ) {
throw new Exception( esc_html__( 'Invalid suggestion ID.', 'woocommerce' ) );
}
$payments_nox_profile = get_option( Payments::PAYMENTS_NOX_PROFILE_KEY, array() );
if ( empty( $payments_nox_profile ) ) {
$payments_nox_profile = array();
} else {
$payments_nox_profile = maybe_unserialize( $payments_nox_profile );
}
// Check if it is already marked as attached.
if ( ! empty( $payments_nox_profile['suggestions'][ $id ]['attached']['timestamp'] ) ) {
return true;
}
// Mark the suggestion as attached.
if ( empty( $payments_nox_profile['suggestions'] ) ) {
$payments_nox_profile['suggestions'] = array();
}
if ( empty( $payments_nox_profile['suggestions'][ $id ] ) ) {
$payments_nox_profile['suggestions'][ $id ] = array();
}
if ( empty( $payments_nox_profile['suggestions'][ $id ]['attached'] ) ) {
$payments_nox_profile['suggestions'][ $id ]['attached'] = array();
}
$payments_nox_profile['suggestions'][ $id ]['attached']['timestamp'] = time();
// Store the modified profile data.
$result = update_option( Payments::PAYMENTS_NOX_PROFILE_KEY, $payments_nox_profile, false );
// Since we already check if the suggestion is already attached, we should not get a false result
// for trying to update with the same value.
// False means the update failed and the suggestion is not marked as attached.
if ( false === $result ) {
return false;
}
// Handle custom attachment logic per-provider.
switch ( $id ) {
case ExtensionSuggestions::PAYPAL_FULL_STACK:
case ExtensionSuggestions::PAYPAL_WALLET:
// Set an option to inform the extension.
update_option( 'woocommerce_paypal_branded', 'payments_settings', false );
break;
default:
break;
}
return true;
}
/**
* Hide a payment extension suggestion.
*
* @param string $id The ID of the payment extension suggestion to hide.
*
* @return bool True if the suggestion was successfully hidden, false otherwise.
* @throws Exception If the suggestion ID is invalid.
*/
public function hide_extension_suggestion( string $id ): bool {
// We may receive a suggestion ID that is actually an order map ID used in the settings page providers list.
// Extract the suggestion ID from the order map ID.
if ( $this->is_suggestion_order_map_id( $id ) ) {
$id = $this->get_suggestion_id_from_order_map_id( $id );
}
$suggestion = $this->get_extension_suggestion_by_id( $id );
if ( is_null( $suggestion ) ) {
throw new Exception( esc_html__( 'Invalid suggestion ID.', 'woocommerce' ) );
}
$user_payments_nox_profile = get_user_meta( get_current_user_id(), Payments::PAYMENTS_NOX_PROFILE_KEY, true );
if ( empty( $user_payments_nox_profile ) ) {
$user_payments_nox_profile = array();
} else {
$user_payments_nox_profile = maybe_unserialize( $user_payments_nox_profile );
}
// Mark the suggestion as hidden.
if ( empty( $user_payments_nox_profile['hidden_suggestions'] ) ) {
$user_payments_nox_profile['hidden_suggestions'] = array();
}
// Check if it is already hidden.
if ( in_array( $id, array_column( $user_payments_nox_profile['hidden_suggestions'], 'id' ), true ) ) {
return true;
}
$user_payments_nox_profile['hidden_suggestions'][] = array(
'id' => $id,
'timestamp' => time(),
);
$result = update_user_meta( get_current_user_id(), Payments::PAYMENTS_NOX_PROFILE_KEY, $user_payments_nox_profile );
// Since we already check if the suggestion is already hidden, we should not get a false result
// for trying to update with the same value. False means the update failed and the suggestion is not hidden.
if ( false === $result ) {
return false;
}
return true;
}
/**
* Get the payment extension suggestions categories details.
*
* @return array The payment extension suggestions categories.
*/
public function get_extension_suggestion_categories(): array {
$categories = array();
$categories[] = array(
'id' => self::CATEGORY_EXPRESS_CHECKOUT,
'_priority' => 10,
'title' => esc_html__( 'Wallets & Express checkouts', 'woocommerce' ),
'description' => esc_html__( 'Allow shoppers to fast-track the checkout process with express options like Apple Pay and Google Pay.', 'woocommerce' ),
);
$categories[] = array(
'id' => self::CATEGORY_BNPL,
'_priority' => 20,
'title' => esc_html__( 'Buy Now, Pay Later', 'woocommerce' ),
'description' => esc_html__( 'Offer flexible payment options to your shoppers.', 'woocommerce' ),
);
$categories[] = array(
'id' => self::CATEGORY_CRYPTO,
'_priority' => 30,
'title' => esc_html__( 'Crypto Payments', 'woocommerce' ),
'description' => esc_html__( 'Offer cryptocurrency payment options to your shoppers.', 'woocommerce' ),
);
$categories[] = array(
'id' => self::CATEGORY_PSP,
'_priority' => 40,
'title' => esc_html__( 'Payment Providers', 'woocommerce' ),
'description' => esc_html__( 'Give your shoppers additional ways to pay.', 'woocommerce' ),
);
return $categories;
}
/**
* Get the payment providers order map.
*
* @return array The payment providers order map.
*/
public function get_order_map(): array {
// This will also handle backwards compatibility.
return $this->enhance_order_map( get_option( self::PROVIDERS_ORDER_OPTION, array() ) );
}
/**
* Save the payment providers order map.
*
* @param array $order_map The order map to save.
*
* @return bool True if the payment providers order map was successfully saved, false otherwise.
*/
public function save_order_map( array $order_map ): bool {
return update_option( self::PROVIDERS_ORDER_OPTION, $order_map );
}
/**
* Update the payment providers order map.
*
* This has effects both on the Payments settings page and the checkout page
* since registered payment gateways (enabled or not) are among the providers.
*
* @param array $order_map The new order for payment providers.
* The order map should be an associative array where the keys are the payment provider IDs
* and the values are the new integer order for the payment provider.
* This can be a partial list of payment providers and their orders.
* It can also contain new IDs and their orders.
*
* @return bool True if the payment providers ordering was successfully updated, false otherwise.
*/
public function update_payment_providers_order_map( array $order_map ): bool {
$existing_order_map = get_option( self::PROVIDERS_ORDER_OPTION, array() );
$new_order_map = $this->payment_providers_order_map_apply_mappings( $existing_order_map, $order_map );
// This will also handle backwards compatibility.
$new_order_map = $this->enhance_order_map( $new_order_map );
// Save the new order map to the DB.
return $this->save_order_map( $new_order_map );
}
/**
* Enhance a payment providers order map.
*
* If the payments providers order map is empty, it will be initialized with the current WC payment gateway ordering.
* If there are missing entries (registered payment gateways, suggestions, offline PMs, etc.), they will be added.
* Various rules will be enforced (e.g., offline PMs and their relation with the offline PMs group).
*
* @param array $order_map The payment providers order map.
*
* @return array The updated payment providers order map.
*/
public function enhance_order_map( array $order_map ): array {
// We don't request the display gateways list because we need to get the order of all the registered payment gateways.
$payment_gateways = $this->get_payment_gateways( false );
// Make it a list keyed by the payment gateway ID.
$payment_gateways = array_combine(
array_map(
fn( $gateway ) => $gateway->id,
$payment_gateways
),
$payment_gateways
);
// Get the payment gateways order map.
$payment_gateways_order_map = array_flip( array_keys( $payment_gateways ) );
// Get the payment gateways to suggestions map.
// There will be null entries for payment gateways where we couldn't find a suggestion.
$payment_gateways_to_suggestions_map = array_map(
fn( $gateway ) => $this->extension_suggestions->get_by_plugin_slug( Utils::normalize_plugin_slug( $this->get_payment_gateway_plugin_slug( $gateway ) ) ),
$payment_gateways
);
/*
* Initialize the order map with the current ordering.
*/
if ( empty( $order_map ) ) {
$order_map = $payment_gateways_order_map;
}
$order_map = Utils::order_map_normalize( $order_map );
$handled_suggestion_ids = array();
/*
* Go through the registered gateways and add any missing ones.
*/
// Use a map to keep track of the insertion offset for each suggestion ID.
// We need this so we can place multiple PGs matching a suggestion right after it but maintain their relative order.
$suggestion_order_map_id_to_offset_map = array();
foreach ( $payment_gateways_order_map as $id => $order ) {
if ( isset( $order_map[ $id ] ) ) {
continue;
}
// If there is a suggestion entry matching this payment gateway,
// we will add the payment gateway right after it so gateways pop-up in place of matching suggestions.
// We rely on suggestions and matching registered PGs being mutually exclusive in the UI.
if ( ! empty( $payment_gateways_to_suggestions_map[ $id ] ) ) {
$suggestion_id = $payment_gateways_to_suggestions_map[ $id ]['id'];
$suggestion_order_map_id = $this->get_suggestion_order_map_id( $suggestion_id );
if ( isset( $order_map[ $suggestion_order_map_id ] ) ) {
// Determine the offset for placing missing PGs after this suggestion.
if ( ! isset( $suggestion_order_map_id_to_offset_map[ $suggestion_order_map_id ] ) ) {
$suggestion_order_map_id_to_offset_map[ $suggestion_order_map_id ] = 0;
}
$suggestion_order_map_id_to_offset_map[ $suggestion_order_map_id ] += 1;
// Place the missing payment gateway right after the suggestion,
// with an offset to maintain relative order between multiple PGs matching the same suggestion.
$order_map = Utils::order_map_place_at_order(
$order_map,
$id,
$order_map[ $suggestion_order_map_id ] + $suggestion_order_map_id_to_offset_map[ $suggestion_order_map_id ]
);
// Remember that we handled this suggestion - don't worry about remembering it multiple times.
$handled_suggestion_ids[] = $suggestion_id;
continue;
}
}
// Add the missing payment gateway at the end.
$order_map[ $id ] = empty( $order_map ) ? 0 : max( $order_map ) + 1;
}
$handled_suggestion_ids = array_unique( $handled_suggestion_ids );
/*
* Place not yet handled suggestion entries right before their matching registered payment gateway IDs.
* This means that registered PGs already in the order map force the suggestions
* to be placed/moved right before them. We rely on suggestions and registered PGs being mutually exclusive.
*/
foreach ( array_keys( $order_map ) as $id ) {
// If the id is not of a payment gateway or there is no suggestion for this payment gateway, ignore it.
if ( ! array_key_exists( $id, $payment_gateways_to_suggestions_map ) ||
empty( $payment_gateways_to_suggestions_map[ $id ] )
) {
continue;
}
$suggestion = $payment_gateways_to_suggestions_map[ $id ];
// If the suggestion was already handled, skip it.
if ( in_array( $suggestion['id'], $handled_suggestion_ids, true ) ) {
continue;
}
// Place the suggestion at the same order as the payment gateway
// thus ensuring that the suggestion is placed right before the payment gateway.
$order_map = Utils::order_map_place_at_order(
$order_map,
$this->get_suggestion_order_map_id( $suggestion['id'] ),
$order_map[ $id ]
);
// Remember that we've handled this suggestion to avoid adding it multiple times.
// We only want to attach the suggestion to the first payment gateway that matches the plugin slug.
$handled_suggestion_ids[] = $suggestion['id'];
}
// Extract all the registered offline PMs and keep their order values.
$offline_methods = array_filter(
$order_map,
array( $this, 'is_offline_payment_method' ),
ARRAY_FILTER_USE_KEY
);
if ( ! empty( $offline_methods ) ) {
/*
* If the offline PMs group is missing, add it before the last offline PM.
*/
if ( ! array_key_exists( self::OFFLINE_METHODS_ORDERING_GROUP, $order_map ) ) {
$last_offline_method_order = max( $offline_methods );
$order_map = Utils::order_map_place_at_order( $order_map, self::OFFLINE_METHODS_ORDERING_GROUP, $last_offline_method_order );
}
/*
* Place all the offline PMs right after the offline PMs group entry.
*/
$target_order = $order_map[ self::OFFLINE_METHODS_ORDERING_GROUP ] + 1;
// Sort the offline PMs by their order.
asort( $offline_methods );
foreach ( $offline_methods as $offline_method => $order ) {
$order_map = Utils::order_map_place_at_order( $order_map, $offline_method, $target_order );
++$target_order;
}
}
return Utils::order_map_normalize( $order_map );
}
/**
* Get the ID of the suggestion order map entry.
*
* @param string $suggestion_id The ID of the suggestion.
*
* @return string The ID of the suggestion order map entry.
*/
public function get_suggestion_order_map_id( string $suggestion_id ): string {
return self::SUGGESTION_ORDERING_PREFIX . $suggestion_id;
}
/**
* Check if the ID is a suggestion order map entry ID.
*
* @param string $id The ID to check.
*
* @return bool True if the ID is a suggestion order map entry ID, false otherwise.
*/
public function is_suggestion_order_map_id( string $id ): bool {
return 0 === strpos( $id, self::SUGGESTION_ORDERING_PREFIX );
}
/**
* Get the ID of the suggestion from the suggestion order map entry ID.
*
* @param string $order_map_id The ID of the suggestion order map entry.
*
* @return string The ID of the suggestion.
*/
public function get_suggestion_id_from_order_map_id( string $order_map_id ): string {
return str_replace( self::SUGGESTION_ORDERING_PREFIX, '', $order_map_id );
}
/**
* Reset the memoized data. Useful for testing purposes.
*
* @internal
* @return void
*/
public function reset_memo(): void {
$this->payment_gateways_memo = array();
$this->payment_gateways_for_display_memo = array();
}
/**
* Handle payment gateways with non-standard registration behavior.
*
* @param array $payment_gateways The payment gateways list.
*
* @return array The payment gateways list with the necessary adjustments.
*/
private function handle_non_standard_registration_for_payment_gateways( array $payment_gateways ): array {
/*
* Handle the Mollie gateway's particular behavior: if there are no API keys or no PMs enabled,
* the extension doesn't register a gateway instance.
* We will need to register a mock gateway to represent Mollie in the settings page.
*/
$payment_gateways = $this->maybe_add_pseudo_mollie_gateway( $payment_gateways );
return $payment_gateways;
}
/**
* Add the pseudo Mollie gateway to the payment gateways list if necessary.
*
* @param array $payment_gateways The payment gateways list.
*
* @return array The payment gateways list with the pseudo Mollie gateway added if necessary.
*/
private function maybe_add_pseudo_mollie_gateway( array $payment_gateways ): array {
$mollie_provider = $this->get_payment_gateway_provider_instance( 'mollie' );
// Do nothing if there is a Mollie gateway registered.
if ( $mollie_provider->is_gateway_registered( $payment_gateways ) ) {
return $payment_gateways;
}
// Get the Mollie suggestion and determine if the plugin is active.
$mollie_suggestion = $this->get_extension_suggestion_by_id( ExtensionSuggestions::MOLLIE );
if ( empty( $mollie_suggestion ) ) {
return $payment_gateways;
}
// Do nothing if the plugin is not active.
if ( self::EXTENSION_ACTIVE !== $mollie_suggestion['plugin']['status'] ) {
return $payment_gateways;
}
// Add the pseudo Mollie gateway to the list since the plugin is active but there is no Mollie gateway registered.
$payment_gateways[] = $mollie_provider->get_pseudo_gateway( $mollie_suggestion );
return $payment_gateways;
}
/**
* Enhance the payment gateway details with additional information from other sources.
*
* @param array $gateway_details The gateway details to enhance.
* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
* @param string $country_code The country code for which the details are being enhanced.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The enhanced gateway details.
*/
private function enhance_payment_gateway_details( array $gateway_details, WC_Payment_Gateway $payment_gateway, string $country_code ): array {
// We discriminate between offline payment methods and gateways.
$gateway_details['_type'] = $this->is_offline_payment_method( $payment_gateway->id ) ? self::TYPE_OFFLINE_PM : self::TYPE_GATEWAY;
$plugin_slug = $gateway_details['plugin']['slug'];
// The payment gateway plugin might use a non-standard directory name.
// Try to normalize it to the common slug to avoid false negatives when matching.
$normalized_plugin_slug = Utils::normalize_plugin_slug( $plugin_slug );
// If we have a matching suggestion, hoist details from there.
// The suggestions only know about the normalized (aka official) plugin slug.
$suggestion = $this->get_extension_suggestion_by_plugin_slug( $normalized_plugin_slug, $country_code );
if ( ! is_null( $suggestion ) ) {
// The title, description, icon, and image from the suggestion take precedence over the ones from the gateway.
// This is temporary until we update the partner extensions.
// Do not override the title and description for certain suggestions because theirs are more descriptive
// (like including the payment method when registering multiple gateways for the same provider).
if ( ! in_array(
$suggestion['id'],
array(
ExtensionSuggestions::PAYPAL_FULL_STACK,
ExtensionSuggestions::PAYPAL_WALLET,
ExtensionSuggestions::MOLLIE,
ExtensionSuggestions::MONEI,
ExtensionSuggestions::ANTOM,
ExtensionSuggestions::MERCADO_PAGO,
ExtensionSuggestions::AMAZON_PAY,
ExtensionSuggestions::SQUARE,
ExtensionSuggestions::PAYONEER,
ExtensionSuggestions::AIRWALLEX,
ExtensionSuggestions::COINBASE, // We don't have suggestion details yet.
ExtensionSuggestions::AUTHORIZE_NET, // We don't have suggestion details yet.
ExtensionSuggestions::BOLT, // We don't have suggestion details yet.
ExtensionSuggestions::DEPAY, // We don't have suggestion details yet.
ExtensionSuggestions::ELAVON, // We don't have suggestion details yet.
ExtensionSuggestions::FORTISPAY, // We don't have suggestion details yet.
ExtensionSuggestions::PAYPAL_ZETTLE, // We don't have suggestion details yet.
ExtensionSuggestions::RAPYD, // We don't have suggestion details yet.
ExtensionSuggestions::PAYPAL_BRAINTREE, // We don't have suggestion details yet.
),
true
) ) {
if ( ! empty( $suggestion['title'] ) ) {
$gateway_details['title'] = $suggestion['title'];
}
if ( ! empty( $suggestion['description'] ) ) {
$gateway_details['description'] = $suggestion['description'];
}
}
if ( ! empty( $suggestion['icon'] ) ) {
$gateway_details['icon'] = $suggestion['icon'];
}
if ( ! empty( $suggestion['image'] ) ) {
$gateway_details['image'] = $suggestion['image'];
}
if ( empty( $gateway_details['links'] ) && ! empty( $suggestion['links'] ) ) {
$gateway_details['links'] = $suggestion['links'];
}
if ( empty( $gateway_details['tags'] ) && ! empty( $suggestion['tags'] ) ) {
$gateway_details['tags'] = $suggestion['tags'];
}
if ( empty( $gateway_details['plugin'] ) && ! empty( $suggestion['plugin'] ) ) {
$gateway_details['plugin'] = $suggestion['plugin'];
}
if ( empty( $gateway_details['_incentive'] ) && ! empty( $suggestion['_incentive'] ) ) {
$gateway_details['_incentive'] = $suggestion['_incentive'];
}
// Attach the suggestion ID to the gateway details so we can reference it with precision.
$gateway_details['_suggestion_id'] = $suggestion['id'];
}
// Get the gateway's corresponding plugin details.
$plugin_data = $this->proxy->call_static( PluginsHelper::class, 'get_plugin_data', $plugin_slug );
if ( ! empty( $plugin_data ) ) {
// If there are no links, try to get them from the plugin data.
if ( empty( $gateway_details['links'] ) ) {
if ( is_array( $plugin_data ) && ! empty( $plugin_data['PluginURI'] ) ) {
$gateway_details['links'] = array(
array(
'_type' => self::LINK_TYPE_ABOUT,
'url' => esc_url( $plugin_data['PluginURI'] ),
),
);
} elseif ( ! empty( $gateway_details['plugin']['_type'] ) &&
ExtensionSuggestions::PLUGIN_TYPE_WPORG === $gateway_details['plugin']['_type'] ) {
// Fallback to constructing the WPORG plugin URI from the normalized plugin slug.
$gateway_details['links'] = array(
array(
'_type' => self::LINK_TYPE_ABOUT,
'url' => 'https://wordpress.org/plugins/' . $normalized_plugin_slug,
),
);
}
}
}
return $gateway_details;
}
/**
* Check if the store has any enabled ecommerce gateways.
*
* We exclude offline payment methods from this check.
*
* @return bool True if the store has any enabled ecommerce gateways, false otherwise.
*/
private function has_enabled_ecommerce_gateways(): bool {
$gateways = $this->get_payment_gateways( false ); // We want the raw gateways list.
$enabled_gateways = array_filter(
$gateways,
function ( $gateway ) {
// Filter out offline gateways.
return 'yes' === $gateway->enabled && ! $this->is_offline_payment_method( $gateway->id );
}
);
return ! empty( $enabled_gateways );
}
/**
* Enhance a payment extension suggestion with additional information.
*
* @param array $extension_suggestion The extension suggestion.
*
* @return array The enhanced payment extension suggestion.
*/
private function enhance_extension_suggestion( array $extension_suggestion ): array {
// Determine the category of the extension.
switch ( $extension_suggestion['_type'] ) {
case ExtensionSuggestions::TYPE_PSP:
$extension_suggestion['category'] = self::CATEGORY_PSP;
break;
case ExtensionSuggestions::TYPE_EXPRESS_CHECKOUT:
$extension_suggestion['category'] = self::CATEGORY_EXPRESS_CHECKOUT;
break;
case ExtensionSuggestions::TYPE_BNPL:
$extension_suggestion['category'] = self::CATEGORY_BNPL;
break;
case ExtensionSuggestions::TYPE_CRYPTO:
$extension_suggestion['category'] = self::CATEGORY_CRYPTO;
break;
default:
$extension_suggestion['category'] = '';
break;
}
// Determine the PES's plugin status.
// Default to not installed.
$extension_suggestion['plugin']['status'] = self::EXTENSION_NOT_INSTALLED;
// Put in the default plugin file.
$extension_suggestion['plugin']['file'] = '';
if ( ! empty( $extension_suggestion['plugin']['slug'] ) ) {
// This is a best-effort approach, as the plugin might be sitting under a directory (slug) that we can't handle.
// Always try the official plugin slug first, then the testing variations.
$plugin_slug_variations = Utils::generate_testing_plugin_slugs( $extension_suggestion['plugin']['slug'], true );
// Favor active plugins by checking the entire variations list for active plugins first.
// This way we handle cases where there are multiple variations installed and one is active.
$found = false;
foreach ( $plugin_slug_variations as $plugin_slug ) {
if ( $this->proxy->call_static( PluginsHelper::class, 'is_plugin_active', $plugin_slug ) ) {
$found = true;
$extension_suggestion['plugin']['status'] = self::EXTENSION_ACTIVE;
// Make sure we put in the actual slug and file path that we found.
$extension_suggestion['plugin']['slug'] = $plugin_slug;
$extension_suggestion['plugin']['file'] = $this->proxy->call_static( PluginsHelper::class, 'get_plugin_path_from_slug', $plugin_slug );
// Sanity check.
if ( ! is_string( $extension_suggestion['plugin']['file'] ) ) {
$extension_suggestion['plugin']['file'] = '';
break;
}
// Remove the .php extension from the file path. The WP API expects it without it.
$extension_suggestion['plugin']['file'] = Utils::trim_php_file_extension( $extension_suggestion['plugin']['file'] );
break;
}
}
if ( ! $found ) {
foreach ( $plugin_slug_variations as $plugin_slug ) {
if ( $this->proxy->call_static( PluginsHelper::class, 'is_plugin_installed', $plugin_slug ) ) {
$extension_suggestion['plugin']['status'] = self::EXTENSION_INSTALLED;
// Make sure we put in the actual slug and file path that we found.
$extension_suggestion['plugin']['slug'] = $plugin_slug;
$extension_suggestion['plugin']['file'] = $this->proxy->call_static( PluginsHelper::class, 'get_plugin_path_from_slug', $plugin_slug );
// Sanity check.
if ( ! is_string( $extension_suggestion['plugin']['file'] ) ) {
$extension_suggestion['plugin']['file'] = '';
break;
}
// Remove the .php extension from the file path. The WP API expects it without it.
$extension_suggestion['plugin']['file'] = Utils::trim_php_file_extension( $extension_suggestion['plugin']['file'] );
break;
}
}
}
}
// Finally, allow the extension suggestion's matching provider to add further details.
$gateway_provider = $this->get_payment_extension_suggestion_provider_instance( $extension_suggestion['id'] );
$extension_suggestion = $gateway_provider->enhance_extension_suggestion( $extension_suggestion );
return $extension_suggestion;
}
/**
* Check if a payment extension suggestion has been hidden by the user.
*
* @param array $extension The extension suggestion.
*
* @return bool True if the extension suggestion is hidden, false otherwise.
*/
private function is_payment_extension_suggestion_hidden( array $extension ): bool {
$user_payments_nox_profile = get_user_meta( get_current_user_id(), Payments::PAYMENTS_NOX_PROFILE_KEY, true );
if ( empty( $user_payments_nox_profile ) ) {
return false;
}
$user_payments_nox_profile = maybe_unserialize( $user_payments_nox_profile );
if ( empty( $user_payments_nox_profile['hidden_suggestions'] ) ) {
return false;
}
return in_array( $extension['id'], array_column( $user_payments_nox_profile['hidden_suggestions'], 'id' ), true );
}
/**
* Apply order mappings to a base payment providers order map.
*
* @param array $base_map The base order map.
* @param array $new_mappings The order mappings to apply.
* This can be a full or partial list of the base one,
* but it can also contain (only) new provider IDs and their orders.
*
* @return array The updated base order map, normalized.
*/
private function payment_providers_order_map_apply_mappings( array $base_map, array $new_mappings ): array {
// Sanity checks.
// Remove any null or non-integer values.
$new_mappings = array_filter( $new_mappings, 'is_int' );
if ( empty( $new_mappings ) ) {
$new_mappings = array();
}
// If we have no existing order map or
// both the base and the new map have the same length and keys, we can simply use the new map.
if ( empty( $base_map ) ||
( count( $base_map ) === count( $new_mappings ) &&
empty( array_diff( array_keys( $base_map ), array_keys( $new_mappings ) ) ) )
) {
$new_order_map = $new_mappings;
} else {
// If we are dealing with ONLY offline PMs updates (for all that are registered) and their group is present,
// normalize the new order map to keep behavior as intended (i.e., reorder only inside the offline PMs list).
$offline_pms = $this->get_offline_payment_methods_gateways();
// Make it a list keyed by the payment gateway ID.
$offline_pms = array_combine(
array_map(
fn( $gateway ) => $gateway->id,
$offline_pms
),
$offline_pms
);
if (
isset( $base_map[ self::OFFLINE_METHODS_ORDERING_GROUP ] ) &&
count( $new_mappings ) === count( $offline_pms ) &&
empty( array_diff( array_keys( $new_mappings ), array_keys( $offline_pms ) ) )
) {
$new_mappings = Utils::order_map_change_min_order( $new_mappings, $base_map[ self::OFFLINE_METHODS_ORDERING_GROUP ] + 1 );
}
$new_order_map = Utils::order_map_apply_mappings( $base_map, $new_mappings );
}
return Utils::order_map_normalize( $new_order_map );
}
/**
* Group payment gateways by their plugin extension filename.
*
* @param WC_Payment_Gateway[] $gateways The list of payment gateway instances to group.
* @param string $country_code Optional. The country code for which the gateways are being generated.
* This should be an ISO 3166-1 alpha-2 country code.
*
* @return array The grouped payment gateway instances, keyed by the plugin file.
* Each group contains an array of payment gateway instances that belong to the same plugin.
* If a payment gateway does not have a corresponding plugin file,
* it will be grouped under the 'unknown_extension' key.
*/
private function group_gateways_by_extension( array $gateways, string $country_code = '' ): array {
$grouped = array(
// This is the group for gateways that we don't know how to group by extension.
// It can be used for gateways that are not registered by a WP plugin.
'unknown_extension' => array(),
);
foreach ( $gateways as $gateway ) {
// Get the payment gateway details, but use a dummy gateway order since it is inconsequential here.
$gateway_details = $this->get_payment_gateway_details( $gateway, 0, $country_code );
// If we don't have the necessary plugin details, put it in the unknown group.
if ( empty( $gateway_details ) || ! isset( $gateway_details['plugin'] ) || empty( $gateway_details['plugin']['file'] ) ) {
$grouped['unknown_extension'][] = $gateway;
continue;
}
if ( empty( $grouped[ $gateway_details['plugin']['file'] ] ) ) {
$grouped[ $gateway_details['plugin']['file'] ] = array();
}
$grouped[ $gateway_details['plugin']['file'] ][] = $gateway;
}
return $grouped;
}
}
PK [1] GH H & Admin/ImportExport/CSVUploadHelper.phpnu get_import_subdir_name();
if ( $create ) {
FilesystemUtil::mkdir_p_not_indexable( $upload_dir );
}
return $upload_dir;
}
/**
* Handles a CSV file upload.
*
* @param string $import_type Type of upload or context.
* @param string $files_index $_FILES index that contains the file to upload.
* @param array|null $allowed_mime_types List of allowed MIME types.
* @return array {
* Details for the uploaded file.
*
* @type int $id Attachment ID.
* @type string $file Full path to uploaded file.
* }
*
* @throws \Exception In case of error.
*/
public function handle_csv_upload( string $import_type, string $files_index = 'import', ?array $allowed_mime_types = null ): array {
$import_type = sanitize_key( $import_type );
if ( ! $import_type ) {
throw new \Exception( 'Import type is invalid.' );
}
if ( ! $allowed_mime_types ) {
$allowed_mime_types = array(
'csv' => 'text/csv',
'txt' => 'text/plain',
);
}
$file = $_FILES[ $files_index ] ?? null; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Missing
if ( ! isset( $file['tmp_name'] ) || ! is_uploaded_file( $file['tmp_name'] ) ) {
throw new \Exception( esc_html__( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your php.ini or by post_max_size being defined as smaller than upload_max_filesize in php.ini.', 'woocommerce' ) );
}
if ( ! function_exists( 'wp_import_handle_upload' ) ) {
require_once ABSPATH . 'wp-admin/includes/import.php';
}
// Make sure upload dir exists.
$this->get_import_dir();
// Add prefix.
$file['name'] = $import_type . '-' . $file['name'];
$overrides_callback = function ( $overrides_ ) use ( $allowed_mime_types ) {
$overrides_['test_form'] = false;
$overrides_['test_type'] = true;
$overrides_['mimes'] = $allowed_mime_types;
return $overrides_;
};
add_filter( 'upload_dir', array( $this, 'override_upload_dir' ) );
add_filter( 'wp_unique_filename', array( $this, 'override_unique_filename' ), 0, 2 );
add_filter( 'wp_handle_upload_overrides', $overrides_callback, 999 );
add_filter( 'wp_handle_upload_prefilter', array( $this, 'remove_txt_from_uploaded_file' ), 0 );
add_filter( 'wp_check_filetype_and_ext', array( $this, 'filter_woocommerce_check_filetype_for_csv' ), 10, 5 );
$orig_files_import = $_FILES['import'] ?? null; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Missing
$_FILES['import'] = $file; // wp_import_handle_upload() expects the file to be in 'import'.
$upload = wp_import_handle_upload();
remove_filter( 'upload_dir', array( $this, 'override_upload_dir' ) );
remove_filter( 'wp_unique_filename', array( $this, 'override_unique_filename' ), 0 );
remove_filter( 'wp_handle_upload_overrides', $overrides_callback, 999 );
remove_filter( 'wp_handle_upload_prefilter', array( $this, 'remove_txt_from_uploaded_file' ), 0 );
remove_filter( 'wp_check_filetype_and_ext', array( $this, 'filter_woocommerce_check_filetype_for_csv' ), 10 );
if ( $orig_files_import ) {
$_FILES['import'] = $orig_files_import;
} else {
unset( $_FILES['import'] );
}
if ( ! empty( $upload['error'] ) ) {
throw new \Exception( esc_html( $upload['error'] ) );
}
if ( ! wc_is_file_valid_csv( $upload['file'], false ) ) {
wp_delete_attachment( $file['id'], true );
throw new \Exception( esc_html__( 'Invalid file type for a CSV import.', 'woocommerce' ) );
}
return $upload;
}
/**
* Hooked onto 'upload_dir' to override the default upload directory for a CSV upload.
*
* @param array $uploads WP upload dir details.
* @return array
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function override_upload_dir( $uploads ): array {
$new_subdir = '/' . $this->get_import_subdir_name();
$uploads['path'] = $uploads['basedir'] . $new_subdir;
$uploads['url'] = $uploads['baseurl'] . $new_subdir;
$uploads['subdir'] = $new_subdir;
return $uploads;
}
/**
* Adds a random string to the name of an uploaded CSV file to make it less discoverable. Hooked onto 'wp_unique_filename'.
*
* @param string $filename File name.
* @param string $ext File extension.
* @return string
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function override_unique_filename( string $filename, string $ext ): string {
$length = min( 10, 255 - strlen( $filename ) - 1 );
if ( 1 < $length ) {
$suffix = strtolower( wp_generate_password( $length, false, false ) );
$filename = substr( $filename, 0, strlen( $filename ) - strlen( $ext ) ) . '-' . $suffix . $ext;
}
return $filename;
}
/**
* `wp_import_handle_upload()` appends .txt to any file name. This function is hooked onto 'wp_handle_upload_prefilter'
* to remove those extra characters.
*
* @param array $file File details in the form of a $_FILES entry.
* @return array Modified file details.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function remove_txt_from_uploaded_file( array $file ): array {
$file['name'] = substr( $file['name'], 0, -4 );
return $file;
}
/**
* Filters the WordPress determination of a file's type and extension, specifically to correct
* CSV files that are misidentified as 'text/html'.
*
* @param array $data An array of file data: ['ext'] (string), ['type'] (string), ['proper_filename'] (string|false).
* @param string $file Full path to the file.
* @param string $filename The Mime type of the file.
* @param array $mimes Array of mime types.
* @param string $real_mime The actual mime type or empty string.
* @return array Filtered file data.
*/
public function filter_woocommerce_check_filetype_for_csv( $data, $file, $filename, $mimes, $real_mime ) {
// Check if the file was misidentified as 'text/html' by PHP.
if ( 'text/html' === $real_mime ) {
// Determine the expected file type based on the filename extension.
// $mimes here is the context-specific list of mimes for the current upload.
$filename_check = wp_check_filetype( $filename, $mimes );
$file_ext = $filename_check['ext'];
$file_type = $filename_check['type'];
if ( ( 'csv' === $file_ext && 'text/csv' === $file_type ) ) {
$data['ext'] = 'csv';
$data['type'] = 'text/csv';
}
}
return $data;
}
}
PK [1]3ls
s
# Admin/RemoteFreeExtensions/Init.phpnu 0;
}
);
if ( empty( $plugins ) ) {
// When no plugins are visible, replace it with defaults and save for 3 hours.
$specs_to_save = DefaultFreeExtensions::get_all();
$specs_to_return = EvaluateExtension::evaluate_bundles( $specs_to_save, $allowed_bundles )['bundles'];
} elseif ( count( $results['errors'] ) > 0 ) {
// When suggestions is not empty but has errors, save it for 3 hours.
$specs_to_save = $specs;
}
// When plugins is not empty but has errors, save it for 3 hours.
if ( count( $results['errors'] ) > 0 ) {
self::log_errors( $results['errors'] );
}
if ( $specs_to_save ) {
RemoteFreeExtensionsDataSourcePoller::get_instance()->set_specs_transient( array( $locale => $specs_to_save ), 3 * HOUR_IN_SECONDS );
}
return $specs_to_return;
}
/**
* Delete the specs transient.
*/
public static function delete_specs_transient() {
RemoteFreeExtensionsDataSourcePoller::get_instance()->delete_specs_transient();
}
/**
* Get specs or fetch remotely if they don't exist.
*/
public static function get_specs() {
if ( 'no' === get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) ) {
return DefaultFreeExtensions::get_all();
}
$specs = RemoteFreeExtensionsDataSourcePoller::get_instance()->get_specs_from_data_sources();
// Fetch specs if they don't yet exist.
if ( false === $specs || ! is_array( $specs ) || 0 === count( $specs ) ) {
return DefaultFreeExtensions::get_all();
}
return $specs;
}
}
PK [1]J[ J[ 4 Admin/RemoteFreeExtensions/DefaultFreeExtensions.phpnu 'obw/basics',
'title' => __( 'Get the basics', 'woocommerce' ),
'plugins' => array(
self::get_plugin( 'woocommerce-payments' ),
self::get_plugin( 'woocommerce-shipping' ),
self::get_plugin( 'woocommerce-services:tax' ),
self::get_plugin( 'jetpack' ),
),
),
array(
'key' => 'obw/grow',
'title' => __( 'Grow your store', 'woocommerce' ),
'plugins' => array(
self::get_plugin( 'mailpoet' ),
self::get_plugin( 'google-listings-and-ads' ),
self::get_plugin( 'pinterest-for-woocommerce' ),
self::get_plugin( 'facebook-for-woocommerce' ),
),
),
array(
'key' => 'task-list/reach',
'title' => __( 'Reach out to customers', 'woocommerce' ),
'plugins' => array(
self::get_plugin( 'mailpoet:alt' ),
// IMPORTANT: Klaviyo needs to be above Mailchimp as per partnership agreement.
// P2 for context: pdibGW-3XM-p2.
self::get_plugin( 'klaviyo:alt' ),
self::get_plugin( 'mailchimp-for-woocommerce' ),
),
),
array(
'key' => 'task-list/grow',
'title' => __( 'Grow your store', 'woocommerce' ),
'plugins' => array(
self::get_plugin( 'google-listings-and-ads:alt' ),
self::get_plugin( 'tiktok-for-business' ),
self::get_plugin( 'pinterest-for-woocommerce:alt' ),
self::get_plugin( 'facebook-for-woocommerce:alt' ),
),
),
array(
'key' => 'obw/core-profiler',
'title' => __( 'Grow your store', 'woocommerce' ),
'plugins' => self::with_core_profiler_fields(
array(
self::get_plugin( 'woocommerce-payments' ),
self::get_plugin( 'woocommerce-shipping' ),
self::get_plugin( 'jetpack' ),
self::get_plugin( 'pinterest-for-woocommerce' ),
self::get_plugin( 'mailpoet' ),
self::get_plugin( 'klaviyo' ),
self::get_plugin( 'google-listings-and-ads' ),
self::get_plugin( 'woocommerce-services:tax' ),
self::get_plugin( 'tiktok-for-business' ),
)
),
),
);
$bundles = wp_json_encode( $bundles );
return json_decode( $bundles );
}
/**
* Get the plugin arguments by slug.
*
* @param string $slug Slug.
* @return array
*/
public static function get_plugin( $slug ) {
$plugins = array(
'google-listings-and-ads' => array(
'min_php_version' => '7.4',
'name' => __( 'Google for WooCommerce', 'woocommerce' ),
'description' => sprintf(
/* translators: 1: opening product link tag. 2: closing link tag */
__( 'Drive sales with %1$sGoogle for WooCommerce%2$s', 'woocommerce' ),
'',
''
),
'image_url' => plugins_url( '/assets/images/onboarding/google.svg', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=wc-admin&path=%2Fgoogle%2Fstart',
'is_built_by_wc' => true,
'is_visible' => array(
array(
'type' => 'not',
'operand' => array(
array(
'type' => 'plugins_activated',
'plugins' => array( 'google-listings-and-ads' ),
),
),
),
),
),
'google-listings-and-ads:alt' => array(
'name' => __( 'Google for WooCommerce', 'woocommerce' ),
'description' => __( 'Reach more shoppers and drive sales for your store. Integrate with Google to list your products for free and launch paid ad campaigns.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/google.svg', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=wc-admin&path=%2Fgoogle%2Fstart',
'is_built_by_wc' => true,
),
'facebook-for-woocommerce' => array(
'name' => __( 'Facebook for WooCommerce', 'woocommerce' ),
'description' => __( 'List products and create ads on Facebook and Instagram with Facebook for WooCommerce', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/facebook.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=wc-facebook',
'is_visible' => false,
'is_built_by_wc' => false,
),
'facebook-for-woocommerce:alt' => array(
'name' => __( 'Facebook for WooCommerce', 'woocommerce' ),
'description' => __( 'List products and create ads on Facebook and Instagram.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/facebook.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=wc-facebook',
'is_visible' => false,
'is_built_by_wc' => false,
),
'pinterest-for-woocommerce' => array(
'name' => __( 'Pinterest for WooCommerce', 'woocommerce' ),
'description' => __( 'Get your products in front of Pinners searching for ideas and things to buy.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/pinterest.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=wc-admin&path=%2Fpinterest%2Flanding',
'is_visible' => true,
'is_built_by_wc' => true,
'min_php_version' => '7.3',
),
'pinterest-for-woocommerce:alt' => array(
'name' => __( 'Pinterest for WooCommerce', 'woocommerce' ),
'description' => __( 'Get your products in front of Pinterest users searching for ideas and things to buy. Get started with Pinterest and make your entire product catalog browsable.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/pinterest.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=wc-admin&path=%2Fpinterest%2Flanding',
'is_built_by_wc' => true,
),
'mailpoet' => array(
'name' => __( 'MailPoet', 'woocommerce' ),
'description' => __( 'Create and send purchase follow-up emails, newsletters, and promotional campaigns straight from your dashboard.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/mailpoet.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=mailpoet-newsletters',
'is_visible' => array(
array(
'type' => 'option',
'option_name' => 'woocommerce_remote_variant_assignment',
'value' => array( 1, 84 ), // 70% segment with klaviyo
'default' => false,
'operation' => 'range',
),
),
'is_built_by_wc' => true,
),
'kliken-ads-pixel-for-meta' => array(
'name' => __( 'Meta Ads & Pixel for WooCommerce', 'woocommerce' ),
'description' => __( 'Sync your store catalog, set up pixel tracking, and run targeted ad campaigns.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/kliken.svg', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=kliken-ads-pixel-for-meta',
'is_visible' => false,
),
'mailchimp-for-woocommerce' => array(
'name' => __( 'Mailchimp', 'woocommerce' ),
'description' => __( 'Send targeted campaigns, recover abandoned carts and much more with Mailchimp.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/mailchimp-for-woocommerce.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=mailchimp-woocommerce',
'is_built_by_wc' => false,
),
'klaviyo' => array(
'name' => __( 'Klaviyo', 'woocommerce' ),
'description' => __( 'Grow and retain customers with email, SMS, automations, and a consolidated view of customer interactions.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/klaviyo.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=klaviyo_settings',
'is_visible' => array(
array(
'type' => 'option',
'option_name' => 'woocommerce_remote_variant_assignment',
'value' => array( 85, 120 ), // 30% segment with mailpoet
'default' => false,
'operation' => 'range',
),
),
'is_built_by_wc' => false,
),
'klaviyo:alt' => array(
'name' => __( 'Klaviyo', 'woocommerce' ),
'description' => __( 'Grow and retain customers with intelligent, impactful email and SMS marketing automation and a consolidated view of customer interactions.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/klaviyo.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=klaviyo_settings',
'is_built_by_wc' => false,
),
'woocommerce-payments' => array(
'name' => __( 'WooPayments', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/wcpay.svg', WC_PLUGIN_FILE ),
'description' => sprintf(
/* translators: 1: opening product link tag. 2: closing link tag */
__( 'Accept credit cards and other popular payment methods with %1$sWooPayments%2$s', 'woocommerce' ),
'',
''
),
'is_visible' => array(
array(
'type' => 'base_location_country',
'value' => array(
'US',
'PR',
'AU',
'CA',
'DE',
'ES',
'FR',
'GB',
'IE',
'IT',
'NZ',
'AT',
'BE',
'NL',
'PL',
'PT',
'CH',
'HK',
'SG',
'CY',
'DK',
'EE',
'FI',
'GR',
'LU',
'LT',
'LV',
'NO',
'MT',
'SI',
'SK',
'BG',
'CZ',
'HR',
'HU',
'RO',
'SE',
'JP',
'AE',
),
'operation' => 'in',
),
DefaultPaymentGateways::get_rules_for_cbd( false ),
),
'is_built_by_wc' => true,
'min_wp_version' => '5.9',
),
'woocommerce-shipping' => array(
'name' => __( 'WooCommerce Shipping', 'woocommerce' ),
'image_url' => self::get_woo_logo(),
'description' => sprintf(
/* translators: 1: opening product link tag. 2: closing link tag */
__( 'Print shipping labels with %1$sWooCommerce Shipping%2$s', 'woocommerce' ),
'',
''
),
'is_visible' => array(
array(
'type' => 'base_location_country',
'value' => 'US',
'operation' => '=',
),
array(
'type' => 'or',
'operands' => array(
array(
array(
'type' => 'option',
'transformers' => array(
array(
'use' => 'dot_notation',
'arguments' => array(
'path' => 'product_types',
),
),
array(
'use' => 'count',
),
),
'option_name' => 'woocommerce_onboarding_profile',
'value' => 1,
'default' => array(),
'operation' => '!=',
),
),
array(
array(
'type' => 'option',
'transformers' => array(
array(
'use' => 'dot_notation',
'arguments' => array(
'path' => 'product_types.0',
),
),
),
'option_name' => 'woocommerce_onboarding_profile',
'value' => 'downloads',
'default' => '',
'operation' => '!=',
),
),
),
),
),
'is_built_by_wc' => true,
),
'woocommerce-services:tax' => array(
'name' => __( 'WooCommerce Tax', 'woocommerce' ),
'image_url' => self::get_woo_logo(),
'description' => sprintf(
/* translators: 1: opening product link tag. 2: closing link tag */
__( 'Get automated sales tax with %1$sWooCommerce Tax%2$s', 'woocommerce' ),
'',
''
),
'is_visible' => array(
self::get_rules_for_wcservices_tax_countries(),
),
'is_built_by_wc' => true,
),
'jetpack' => array(
'name' => __( 'Jetpack', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/jetpack.svg', WC_PLUGIN_FILE ),
'description' => sprintf(
/* translators: 1: opening product link tag. 2: closing link tag */
__( 'Enhance speed and security with %1$sJetpack%2$s', 'woocommerce' ),
'',
''
),
'is_visible' => array(
array(
'type' => 'not',
'operand' => array(
array(
'type' => 'plugins_activated',
'plugins' => array( 'jetpack' ),
),
),
),
),
'is_built_by_wc' => false,
'min_wp_version' => '6.0',
),
'mailpoet:alt' => array(
'name' => __( 'MailPoet', 'woocommerce' ),
'description' => __( 'Create and send purchase follow-up emails, newsletters, and promotional campaigns straight from your dashboard.', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/mailpoet.png', WC_PLUGIN_FILE ),
'manage_url' => 'admin.php?page=mailpoet-newsletters',
'is_built_by_wc' => true,
),
'tiktok-for-business' => array(
'name' => __( 'TikTok for WooCommerce', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/tiktok.svg', WC_PLUGIN_FILE ),
'description' =>
__( 'Grow your online sales by promoting your products on TikTok to over one billion monthly active users around the world.', 'woocommerce' ),
'manage_url' => 'admin.php?page=tiktok',
'is_visible' => array(
array(
'type' => 'base_location_country',
'value' => array(
'US',
'CA',
'MX',
'AT',
'BE',
'CZ',
'DK',
'FI',
'FR',
'DE',
'GR',
'HU',
'IE',
'IT',
'NL',
'PL',
'PT',
'RO',
'ES',
'SE',
'GB',
'CH',
'NO',
'AU',
'NZ',
'SG',
'MY',
'PH',
'ID',
'VN',
'TH',
'KR',
'IL',
'AE',
'RU',
'UA',
'TR',
'SA',
'BR',
'JP',
),
'operation' => 'in',
),
),
'is_built_by_wc' => false,
),
'tiktok-for-business:alt' => array(
'name' => __( 'TikTok for WooCommerce', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/tiktok.svg', WC_PLUGIN_FILE ),
'description' => sprintf(
/* translators: 1: opening product link tag. 2: closing link tag */
__( 'Create ad campaigns and reach one billion global users with %1$sTikTok for WooCommerce%2$s', 'woocommerce' ),
'',
''
),
'manage_url' => 'admin.php?page=tiktok',
'is_built_by_wc' => false,
'is_visible' => false,
),
);
$plugin = $plugins[ $slug ];
$plugin['key'] = $slug;
return $plugin;
}
/**
* Decorate plugin data with core profiler fields.
*
* - Updated description for the core-profiler.
* - Adds learn_more_link and label.
* - Adds install_priority, which is used to sort the plugins. The value is determined by the plugin size. Lower = smaller.
*
* @param array $plugins Array of plugins.
*
* @return array
*/
public static function with_core_profiler_fields( array $plugins ) {
$_plugins = array(
'woocommerce-payments' => array(
/* translators: %s: Payment provider name. */
'label' => sprintf( __( 'Get paid with %s', 'woocommerce' ), 'WooPayments' ),
'image_url' => self::get_woo_logo(),
'description' => __( "Securely accept payments and manage payment activity straight from your store's dashboard", 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/woocommerce-payments?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 5,
'requires_jpc' => true,
),
'woocommerce-shipping' => array(
'label' => __( 'Save on shipping with WooCommerce Shipping', 'woocommerce' ),
'image_url' => self::get_woo_logo(),
'description' => __( 'Print discounted USPS, UPS, and DHL labels', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/woocommerce-shipping?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 3,
),
'jetpack' => array(
'label' => __( 'Protect your store and your shoppers with Jetpack', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/core-profiler/logo-jetpack.svg', WC_PLUGIN_FILE ),
'description' => __( 'Keep your store online with full security and backups', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/jetpack?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 8,
'requires_jpc' => true,
),
'pinterest-for-woocommerce' => array(
'label' => __( 'Showcase your products with Pinterest', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/core-profiler/logo-pinterest.svg', WC_PLUGIN_FILE ),
'description' => __( 'Get your products in front of a highly engaged audience.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/pinterest-for-woocommerce?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 2,
),
'kliken-ads-pixel-for-meta' => array(
'label' => __( 'Grow your business with Facebook and Instagram', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/core-profiler/logo-kliken.svg', WC_PLUGIN_FILE ),
'description' => __( 'Sync your store catalog, set up pixel tracking, and run targeted ad campaigns.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/meta-ads-and-pixel?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 2,
),
'mailpoet' => array(
'label' => __( 'Reach your customers with MailPoet', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/core-profiler/logo-mailpoet.svg', WC_PLUGIN_FILE ),
'description' => __( 'Send purchase follow-up emails, newsletters, and promotional campaigns.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/mailpoet?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 7,
),
'klaviyo' => array(
'label' => __( 'Klaviyo', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/onboarding/klaviyo.png', WC_PLUGIN_FILE ),
'description' => __( 'Grow and retain customers with email, SMS, automations, and a consolidated view of customer interactions.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/klaviyo-for-woocommerce?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 7,
),
'tiktok-for-business' => array(
'label' => __( 'Create ad campaigns with TikTok', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/core-profiler/logo-tiktok.png', WC_PLUGIN_FILE ),
'description' => __( 'Create advertising campaigns and reach one billion global users.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/tiktok-for-woocommerce?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 1,
),
'google-listings-and-ads' => array(
'label' => __( 'Drive sales with Google for WooCommerce', 'woocommerce' ),
'image_url' => plugins_url( '/assets/images/core-profiler/logo-google.svg', WC_PLUGIN_FILE ),
'description' => __( 'Reach millions of active shoppers across Google with free product listings and ads.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/google-listings-and-ads?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 6,
),
'woocommerce-services:tax' => array(
'label' => __( 'Get automated tax rates with WooCommerce Tax', 'woocommerce' ),
'image_url' => self::get_woo_logo(),
'description' => __( 'Automatically calculate how much sales tax should be collected – by city, country, or state.', 'woocommerce' ),
'learn_more_link' => 'https://woocommerce.com/products/tax?utm_source=storeprofiler&utm_medium=product&utm_campaign=freefeatures',
'install_priority' => 4,
),
);
$_plugins['woocommerce-shipping']['is_visible'] = array(
array(
'type' => 'base_location_country',
'value' => 'US',
'operation' => '=',
),
);
$_plugins['woocommerce-services:tax']['is_visible'] = array(
self::get_rules_for_wcservices_tax_countries(),
);
$remove_plugins_activated_rule = function ( $is_visible ) {
$is_visible = array_filter(
array_map(
function ( $rule ) {
if ( is_object( $rule ) || ! isset( $rule['operand'] ) ) {
return $rule;
}
return array_filter(
$rule['operand'],
function ( $operand ) {
return 'plugins_activated' !== $operand['type'];
}
);
},
$is_visible
)
);
return empty( $is_visible ) ? true : $is_visible;
};
foreach ( $plugins as &$plugin ) {
if ( isset( $_plugins[ $plugin['key'] ] ) ) {
$plugin = array_merge( $plugin, $_plugins[ $plugin['key'] ] );
if ( isset( $plugin['is_visible'] ) && is_array( $plugin['is_visible'] ) ) {
$plugin['is_visible'] = $remove_plugins_activated_rule( $plugin['is_visible'] );
}
}
}
return $plugins;
}
/**
* Returns the country restrictions for use in the `is_visible` key for
* recommending the tax functionality of WooCommerce Shipping & Tax.
*
* @return array
*/
private static function get_rules_for_wcservices_tax_countries() {
return array(
'type' => 'base_location_country',
'operation' => 'in',
'value' => array(
'US',
'FR',
'GB',
'DE',
'CA',
'AU',
'GR',
'BE',
'PT',
'DK',
'SE',
),
);
}
}
PK [1]9 F Admin/RemoteFreeExtensions/ProcessCoreProfilerPluginInstallOptions.phpnu plugins = $plugins;
$this->slug = $slug;
$this->logger = $logger ?? wc_get_logger();
}
/**
* Retrieve install options for a plugin.
*
* @param string $plugin_slug Plugin slug.
* @return array|null Install options or null if not found.
*/
public function get_install_options( string $plugin_slug ): ?array {
foreach ( $this->plugins as $plugin ) {
if ( $this->matches_plugin_slug( $plugin, $plugin_slug ) ) {
return $plugin->install_options ?? null;
}
}
return null;
}
/**
* Process install options based on a filtering function.
*/
public function process_install_options() {
$install_options = $this->get_install_options( $this->slug );
if ( ! $install_options ) {
return;
}
foreach ( $install_options as $install_option ) {
$this->add_install_option( $install_option );
}
}
/**
* Updates an install option in the WordPress database.
*
* @param object $install_option Install option object.
*/
protected function add_install_option( object $install_option ) {
$default_options = array(
'force_array' => false,
'autoload' => false,
);
$options = isset( $install_option->options )
? (object) $install_option->options
: new \stdClass();
foreach ( $default_options as $key => $value ) {
if ( ! isset( $options->$key ) ) {
$options->$key = $value;
}
}
if ( $options->force_array ) {
$install_option->value = json_decode( wp_json_encode( $install_option->value ), true );
// In case of JSON error, return early.
if ( json_last_error() !== JSON_ERROR_NONE ) {
$this->logger && $this->logger->error( 'Failed to decode JSON for install option value for ' . $install_option->name . ': ' . json_last_error_msg() );
return;
}
}
$autoload = null;
if ( isset( $options->autoload ) ) {
if ( 'yes' === $options->autoload ) {
$autoload = true;
} elseif ( 'no' === $options->autoload ) {
$autoload = false;
} elseif ( true === $options->autoload || false === $options->autoload ) {
$autoload = $options->autoload;
}
}
$this->add_option( $install_option->name, $install_option->value, $autoload );
}
/**
* Updates an option in the WordPress database.
*
* @param string $name Option name.
* @param mixed $value Option value.
* @param string $autoload Autoload option.
*
* @return void
*/
protected function add_option( string $name, $value, $autoload = null ) {
if ( in_array( $name, self::DISALLOWED_OPTIONS, true ) ) {
$this->logger && $this->logger->error( 'Disallowed option: ' . $name );
return;
}
add_option( $name, $value, '', $autoload );
}
/**
* Checks if the given plugin matches the provided slug.
*
* @param object $plugin Plugin object.
* @param string $plugin_slug Plugin slug.
* @return bool True if it matches, false otherwise.
*/
private function matches_plugin_slug( object $plugin, string $plugin_slug ): bool {
return explode( ':', $plugin->key )[0] === $plugin_slug;
}
}
PK [1]0& 0 Admin/RemoteFreeExtensions/EvaluateExtension.phpnu is_visible ) ) {
$is_visible = $rule_evaluator->evaluate( $extension->is_visible );
$extension->is_visible = $is_visible;
} else {
$extension->is_visible = true;
}
// Run PHP and WP version chcecks.
if ( true === $extension->is_visible ) {
if ( isset( $extension->min_php_version ) && ! version_compare( PHP_VERSION, $extension->min_php_version, '>=' ) ) {
$extension->is_visible = false;
}
if ( isset( $extension->min_wp_version ) && ! version_compare( $wp_version, $extension->min_wp_version, '>=' ) ) {
$extension->is_visible = false;
}
}
$installed_plugins = PluginsHelper::get_installed_plugin_slugs();
$activated_plugins = PluginsHelper::get_active_plugin_slugs();
$extension->is_installed = in_array( explode( ':', $extension->key )[0], $installed_plugins, true );
$extension->is_activated = in_array( explode( ':', $extension->key )[0], $activated_plugins, true );
return $extension;
}
/**
* Evaluates the specs and returns the bundles with visible extensions.
*
* @param array $specs extensions spec array.
* @param array $allowed_bundles Optional array of allowed bundles to be returned.
* @return array The bundles and errors.
*/
public static function evaluate_bundles( $specs, $allowed_bundles = array() ) {
$bundles = array();
$evaluate_order = new EvaluateOverrides();
$context = array();
foreach ( $specs as $spec ) {
$spec = (object) $spec;
$bundle = (array) $spec;
$bundle['plugins'] = array();
if ( ! empty( $allowed_bundles ) && ! in_array( $spec->key, $allowed_bundles, true ) ) {
continue;
}
$errors = array();
foreach ( $spec->plugins as $plugin ) {
try {
$extension = self::evaluate( (object) $plugin );
if ( ! property_exists( $extension, 'is_visible' ) || $extension->is_visible ) {
$bundle['plugins'][] = $extension;
}
} catch ( \Throwable $e ) {
$errors[] = $e;
}
}
$context['plugins'] = $bundle['plugins'];
$bundle['plugins'] = $evaluate_order->evaluate( $bundle['plugins'], $context );
$bundles[] = $bundle;
}
return array(
'bundles' => $bundles,
'errors' => $errors,
);
}
}
PK [1]ǫJ'D D C Admin/RemoteFreeExtensions/RemoteFreeExtensionsDataSourcePoller.phpnu 'key',
)
);
}
return self::$instance;
}
/**
* Get data sources.
*
* @return array
*/
public static function get_data_sources() {
return array(
WC_Helper::get_woocommerce_com_base_url() . 'wp-json/wccom/obw-free-extensions/4.0/extensions.json',
);
}
}
PK [1]lGQF F # Admin/CustomerEffortScoreTracks.phpnu enable_survey_enqueing_if_tracking_is_enabled();
}
/**
* Add actions that require woocommerce_allow_tracking.
*/
private function enable_survey_enqueing_if_tracking_is_enabled() {
// Only hook up the action handlers if in wp-admin.
if ( ! is_admin() ) {
return;
}
// Do not hook up the action handlers if a mobile device is used.
if ( wp_is_mobile() ) {
return;
}
// Only enqueue a survey if tracking is allowed.
$allow_tracking = 'yes' === get_option( 'woocommerce_allow_tracking', 'no' );
if ( ! $allow_tracking ) {
return;
}
add_action( 'admin_init', array( $this, 'maybe_clear_ces_tracks_queue' ) );
add_action( 'woocommerce_update_options', array( $this, 'run_on_update_options' ), 10, 3 );
add_action( 'product_cat_add_form', array( $this, 'add_script_track_product_categories' ), 10, 3 );
add_action( 'product_tag_add_form', array( $this, 'add_script_track_product_tags' ), 10, 3 );
add_action( 'woocommerce_attribute_added', array( $this, 'run_on_add_product_attributes' ), 10, 3 );
add_action( 'load-edit.php', array( $this, 'run_on_load_edit_php' ), 10, 3 );
add_action( 'product_page_product_importer', array( $this, 'run_on_product_import' ), 10, 3 );
// Only hook up the transition_post_status action handler
// if on the edit page.
global $pagenow;
if ( 'post.php' === $pagenow ) {
add_action(
'transition_post_status',
array(
$this,
'run_on_transition_post_status',
),
10,
3
);
}
$this->onsubmit_label = __( 'Thank you for your feedback!', 'woocommerce' );
}
/**
* Returns a generated script for tracking tags added on edit-tags.php page.
* CES survey is triggered via direct access to wc/customer-effort-score store
* via wp.data.dispatch method.
*
* Due to lack of options to directly hook ourselves into the ajax post request
* initiated by edit-tags.php page, we infer a successful request by observing
* an increase of the number of rows in tags table
*
* @param string $action Action name for the survey.
* @param string $title Title for the snackbar.
* @param string $first_question The text for the first question.
* @param string $second_question The text for the second question.
*
* @return string Generated JavaScript to append to page.
*/
private function get_script_track_edit_php( $action, $title, $first_question, $second_question ) {
return sprintf(
"(function( $ ) {
'use strict';
// Hook on submit button and sets a 1000ms interval function
// to determine successful add tag or otherwise.
$('#addtag #submit').on( 'click', function() {
const initialCount = $('.tags tbody > tr').length;
const interval = setInterval( function() {
if ( $('.tags tbody > tr').length > initialCount ) {
// New tag detected.
clearInterval( interval );
wp.data.dispatch('wc/customer-effort-score').addCesSurvey({ action: '%s', title: '%s', firstQuestion: '%s', secondQuestion: '%s', onsubmitLabel: '%s' });
} else {
// Form is no longer loading, most likely failed.
if ( $( '#addtag .submit .spinner.is-active' ).length < 1 ) {
clearInterval( interval );
}
}
}, 1000 );
});
})( jQuery );",
esc_js( $action ),
esc_js( $title ),
esc_js( $first_question ),
esc_js( $second_question ),
esc_js( $this->onsubmit_label )
);
}
/**
* Get the current published product count.
*
* @return integer The current published product count.
*/
private function get_product_count() {
$query = new \WC_Product_Query(
array(
'limit' => 1,
'paginate' => true,
'return' => 'ids',
'status' => array( 'publish' ),
)
);
$products = $query->get_products();
$product_count = intval( $products->total );
return $product_count;
}
/**
* Get the current shop order count.
*
* @return integer The current shop order count.
*/
private function get_shop_order_count() {
$query = new \WC_Order_Query(
array(
'limit' => 1,
'paginate' => true,
'return' => 'ids',
)
);
$shop_orders = $query->get_orders();
$shop_order_count = intval( $shop_orders->total );
return $shop_order_count;
}
/**
* Return whether the action has already been shown.
*
* @param string $action The action to check.
*
* @return bool Whether the action has already been shown.
*/
private function has_been_shown( $action ) {
$shown_for_features = get_option( self::SHOWN_FOR_ACTIONS_OPTION_NAME, array() );
$has_been_shown = in_array( $action, $shown_for_features, true );
return $has_been_shown;
}
/**
* Enqueue the item to the CES tracks queue.
*
* @param array $item The item to enqueue.
*/
private function enqueue_to_ces_tracks( $item ) {
$queue = get_option(
self::CES_TRACKS_QUEUE_OPTION_NAME,
array()
);
$queue = is_array( $queue ) ? $queue : array();
$has_duplicate = array_filter(
$queue,
function ( $queue_item ) use ( $item ) {
return $queue_item['action'] === $item['action'];
}
);
if ( $has_duplicate ) {
return;
}
$queue[] = $item;
update_option(
self::CES_TRACKS_QUEUE_OPTION_NAME,
$queue
);
}
/**
* Enqueue the CES survey on using search dynamically.
*
* @param string $search_area Search area such as "product" or "shop_order".
* @param string $page_now Value of window.pagenow.
* @param string $admin_page Value of window.adminpage.
*/
public function enqueue_ces_survey_for_search( $search_area, $page_now, $admin_page ) {
if ( $this->has_been_shown( self::SEARCH_ACTION_NAME ) ) {
return;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::SEARCH_ACTION_NAME,
'title' => __(
'How easy was it to use search?',
'woocommerce'
),
'firstQuestion' => __(
'The search feature in WooCommerce is easy to use.',
'woocommerce'
),
'secondQuestion' => __(
'The search\'s functionality meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => $page_now,
'adminpage' => $admin_page,
'props' => (object) array(
'search_area' => $search_area,
),
)
);
}
/**
* Hook into the post status lifecycle, to detect relevant user actions
* that we want to survey about.
*
* @param string $new_status The new status.
* @param string $old_status The old status.
* @param Post $post The post.
*/
public function run_on_transition_post_status(
$new_status,
$old_status,
$post
) {
if ( 'product' === $post->post_type ) {
$this->maybe_enqueue_ces_survey_for_product( $new_status, $old_status );
} elseif ( 'shop_order' === $post->post_type ) {
$this->enqueue_ces_survey_for_edited_shop_order();
}
}
/**
* Maybe enqueue the CES survey, if product is being added or edited.
*
* @param string $new_status The new status.
* @param string $old_status The old status.
*/
private function maybe_enqueue_ces_survey_for_product(
$new_status,
$old_status
) {
if ( 'publish' !== $new_status ) {
return;
}
if ( 'publish' !== $old_status ) {
$this->enqueue_ces_survey_for_new_product();
} else {
$this->enqueue_ces_survey_for_edited_product();
}
}
/**
* Enqueue the CES survey trigger for a new product.
*/
private function enqueue_ces_survey_for_new_product() {
if ( $this->has_been_shown( self::PRODUCT_ADD_PUBLISH_ACTION_NAME ) ) {
return;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::PRODUCT_ADD_PUBLISH_ACTION_NAME,
'title' => __(
'🎉 Congrats on adding your first product!',
'woocommerce'
),
'firstQuestion' => __(
'The product creation screen is easy to use.',
'woocommerce'
),
'secondQuestion' => __(
'The product creation screen\'s functionality meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'product',
'adminpage' => 'post-php',
'props' => array(
'product_count' => $this->get_product_count(),
),
)
);
}
/**
* Enqueue the CES survey trigger for an existing product.
*/
private function enqueue_ces_survey_for_edited_product() {
if ( $this->has_been_shown( self::PRODUCT_UPDATE_ACTION_NAME ) ) {
return;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::PRODUCT_UPDATE_ACTION_NAME,
'title' => __(
'How easy was it to edit your product?',
'woocommerce'
),
'firstQuestion' => __(
'The product update process is easy to complete.',
'woocommerce'
),
'secondQuestion' => __(
'The product update process meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'product',
'adminpage' => 'post-php',
'props' => array(
'product_count' => $this->get_product_count(),
),
)
);
}
/**
* Enqueue the CES survey trigger for an existing shop order.
*/
private function enqueue_ces_survey_for_edited_shop_order() {
if ( $this->has_been_shown( self::SHOP_ORDER_UPDATE_ACTION_NAME ) ) {
return;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::SHOP_ORDER_UPDATE_ACTION_NAME,
'title' => __(
'How easy was it to update an order?',
'woocommerce'
),
'firstQuestion' => __(
'The order details screen is easy to use.',
'woocommerce'
),
'secondQuestion' => __(
'The order details screen\'s functionality meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'shop_order',
'adminpage' => 'post-php',
'props' => array(
'order_count' => $this->get_shop_order_count(),
),
)
);
}
/**
* Maybe clear the CES tracks queue, executed on every page load. If the
* clear option is set it clears the queue. In practice, this executes a
* page load after the queued CES tracks are displayed on the client, which
* sets the clear option.
*/
public function maybe_clear_ces_tracks_queue() {
$clear_ces_tracks_queue_for_page = get_option(
self::CLEAR_CES_TRACKS_QUEUE_FOR_PAGE_OPTION_NAME,
false
);
if ( ! $clear_ces_tracks_queue_for_page ) {
return;
}
$queue = get_option(
self::CES_TRACKS_QUEUE_OPTION_NAME,
array()
);
$queue = is_array( $queue ) ? $queue : array();
$remaining_items = array_filter(
$queue,
function ( $item ) use ( $clear_ces_tracks_queue_for_page ) {
return $clear_ces_tracks_queue_for_page['pagenow'] !== $item['pagenow']
|| $clear_ces_tracks_queue_for_page['adminpage'] !== $item['adminpage'];
}
);
update_option(
self::CES_TRACKS_QUEUE_OPTION_NAME,
array_values( $remaining_items )
);
update_option( self::CLEAR_CES_TRACKS_QUEUE_FOR_PAGE_OPTION_NAME, false );
}
/**
* Appends a script to footer to trigger CES on adding product categories.
*/
public function add_script_track_product_categories() {
if ( $this->has_been_shown( self::ADD_PRODUCT_CATEGORIES_ACTION_NAME ) ) {
return;
}
$handle = 'wc-tracks-customer-effort-score-product-categories';
wp_register_script( $handle, '', array( 'jquery' ), WC_VERSION, true );
wp_enqueue_script( $handle );
wp_add_inline_script(
$handle,
$this->get_script_track_edit_php(
self::ADD_PRODUCT_CATEGORIES_ACTION_NAME,
__( 'How easy was it to add product category?', 'woocommerce' ),
__( 'The product category details screen is easy to use.', 'woocommerce' ),
__( "The product category details screen's functionality meets my needs.", 'woocommerce' )
)
);
}
/**
* Appends a script to footer to trigger CES on adding product tags.
*/
public function add_script_track_product_tags() {
if ( $this->has_been_shown( self::ADD_PRODUCT_TAGS_ACTION_NAME ) ) {
return;
}
$handle = 'wc-tracks-customer-effort-score-product-tags';
wp_register_script( $handle, '', array( 'jquery' ), WC_VERSION, true );
wp_enqueue_script( $handle );
wp_add_inline_script(
$handle,
$this->get_script_track_edit_php(
self::ADD_PRODUCT_TAGS_ACTION_NAME,
__( 'How easy was it to add a product tag?', 'woocommerce' ),
__( 'The product tag details screen is easy to use.', 'woocommerce' ),
__( "The product tag details screen's functionality meets my needs.", 'woocommerce' )
)
);
}
/**
* Maybe enqueue the CES survey on product import, if step is done.
*/
public function run_on_product_import() {
// We're only interested in when the importer completes.
if ( empty( $_GET['step'] ) || 'done' !== $_GET['step'] ) { // phpcs:ignore CSRF ok.
return;
}
if ( $this->has_been_shown( self::IMPORT_PRODUCTS_ACTION_NAME ) ) {
return;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::IMPORT_PRODUCTS_ACTION_NAME,
'title' => __(
'How easy was it to import products?',
'woocommerce'
),
'firstQuestion' => __(
'The product import process is easy to complete.',
'woocommerce'
),
'secondQuestion' => __(
'The product import process meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'product_page_product_importer',
'adminpage' => 'product_page_product_importer',
'props' => (object) array(),
)
);
}
/**
* Enqueue the CES survey trigger for setting changes.
*/
public function run_on_update_options() {
// $current_tab is set when WC_Admin_Settings::save_settings is called.
global $current_tab;
global $current_section;
if ( $this->has_been_shown( self::SETTINGS_CHANGE_ACTION_NAME ) ) {
return;
}
$props = array(
'settings_area' => $current_tab,
);
if ( $current_section ) {
$props['settings_section'] = $current_section;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::SETTINGS_CHANGE_ACTION_NAME,
'title' => __(
'How easy was it to update your settings?',
'woocommerce'
),
'firstQuestion' => __(
'The settings screen is easy to use.',
'woocommerce'
),
'secondQuestion' => __(
'The settings screen\'s functionality meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'woocommerce_page_wc-settings',
'adminpage' => 'woocommerce_page_wc-settings',
'props' => (object) $props,
)
);
}
/**
* Enqueue the CES survey on adding new product attributes.
*/
public function run_on_add_product_attributes() {
if ( $this->has_been_shown( self::ADD_PRODUCT_ATTRIBUTES_ACTION_NAME ) ) {
return;
}
$this->enqueue_to_ces_tracks(
array(
'action' => self::ADD_PRODUCT_ATTRIBUTES_ACTION_NAME,
'title' => __(
'How easy was it to add a product attribute?',
'woocommerce'
),
'firstQuestion' => __(
'Product attributes are easy to use.',
'woocommerce'
),
'secondQuestion' => __(
'Product attributes\' functionality meets my needs.',
'woocommerce'
),
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'product_page_product_attributes',
'adminpage' => 'product_page_product_attributes',
'props' => (object) array(),
)
);
}
/**
* Determine on initiating CES survey on searching for product or orders.
*/
public function run_on_load_edit_php() {
$allowed_types = array( 'product', 'shop_order' );
$post_type = get_current_screen()->post_type;
// We're only interested for certain post types.
if ( ! in_array( $post_type, $allowed_types, true ) ) {
return;
}
// Determine whether request is search by "s" GET parameter.
if ( empty( $_GET['s'] ) ) { // phpcs:disable WordPress.Security.NonceVerification.Recommended
return;
}
$page_now = 'edit-' . $post_type;
$this->enqueue_ces_survey_for_search( $post_type, $page_now, 'edit-php' );
}
}
PK [1]#UȨ" " Admin/Events.phpnu possibly_add_notes();
$this->possibly_delete_notes();
$this->possibly_update_notes();
$this->possibly_refresh_data_source_pollers();
if ( $this->is_remote_inbox_notifications_enabled() ) {
RemoteInboxNotificationsDataSourcePoller::get_instance()->read_specs_from_data_sources();
RemoteInboxNotificationsEngine::run();
}
if ( Features::is_enabled( 'core-profiler' ) ) {
( new MailchimpScheduler() )->run();
}
}
/**
* Get note.
*
* @param Note $note_from_db The note object from the database.
*/
public function get_note_from_db( $note_from_db ) {
if ( ! $note_from_db instanceof Note || get_user_locale() === $note_from_db->get_locale() ) {
return $note_from_db;
}
$note_classes = array_merge( self::$note_classes_to_added_or_updated, self::$other_note_classes );
foreach ( $note_classes as $note_class ) {
if ( defined( "$note_class::NOTE_NAME" ) && $note_class::NOTE_NAME === $note_from_db->get_name() ) {
$note_from_class = method_exists( $note_class, 'get_note' ) ? $note_class::get_note() : null;
if ( $note_from_class instanceof Note ) {
$note = clone $note_from_db;
$note->set_title( $note_from_class->get_title() );
$note->set_content( $note_from_class->get_content() );
$actions = $note_from_class->get_actions();
foreach ( $actions as $action ) {
$matching_action = $note->get_action( $action->name );
if ( $matching_action && $matching_action->id ) {
$action->id = $matching_action->id;
}
}
$note->set_actions( $actions );
return $note;
}
break;
}
}
return $note_from_db;
}
/**
* Adds notes that should be added.
*/
protected function possibly_add_notes() {
foreach ( self::$note_classes_to_added_or_updated as $note_class ) {
if ( method_exists( $note_class, 'possibly_add_note' ) ) {
$note_class::possibly_add_note();
}
}
}
/**
* Deletes notes that should be deleted.
*/
protected function possibly_delete_notes() {
PaymentsRemindMeLater::delete_if_not_applicable();
PaymentsMoreInfoNeeded::delete_if_not_applicable();
}
/**
* Updates notes that should be updated.
*/
protected function possibly_update_notes() {
foreach ( self::$note_classes_to_added_or_updated as $note_class ) {
if ( method_exists( $note_class, 'possibly_update_note' ) ) {
$note_class::possibly_update_note();
}
}
}
/**
* Checks if remote inbox notifications are enabled.
*
* @return bool Whether remote inbox notifications are enabled.
*/
protected function is_remote_inbox_notifications_enabled() {
// Check if the feature flag is disabled.
if ( ! Features::is_enabled( 'remote-inbox-notifications' ) ) {
return false;
}
// Check if the site has opted out of marketplace suggestions.
if ( get_option( 'woocommerce_show_marketplace_suggestions', 'yes' ) !== 'yes' ) {
return false;
}
// All checks have passed.
return true;
}
/**
* Checks if merchant email notifications are enabled.
*
* @return bool Whether merchant email notifications are enabled.
*/
protected function is_merchant_email_notifications_enabled() {
// Check if the feature flag is disabled.
if ( get_option( 'woocommerce_merchant_email_notifications', 'no' ) !== 'yes' ) {
return false;
}
// All checks have passed.
return true;
}
/**
* Refresh transient for the following DataSourcePollers on wc_admin_daily cron job.
* - PaymentGatewaySuggestionsDataSourcePoller
* - RemoteFreeExtensionsDataSourcePoller
*/
protected function possibly_refresh_data_source_pollers() {
$completed_tasks = get_option( 'woocommerce_task_list_tracked_completed_tasks', array() );
if ( ! in_array( 'payments', $completed_tasks, true ) && ! in_array( 'woocommerce-payments', $completed_tasks, true ) ) {
PaymentGatewaySuggestionsDataSourcePoller::get_instance()->read_specs_from_data_sources();
}
if ( ! in_array( 'store_details', $completed_tasks, true ) && ! in_array( 'marketing', $completed_tasks, true ) ) {
RemoteFreeExtensionsDataSourcePoller::get_instance()->read_specs_from_data_sources();
}
}
}
PK [1] " Admin/RemoteInboxNotifications.phpnu get_marketplace_pages();
foreach ( $marketplace_pages as $marketplace_page ) {
if ( ! is_null( $marketplace_page ) ) {
wc_admin_register_page( $marketplace_page );
}
}
}
/**
* Get report pages.
*/
public function get_marketplace_pages() {
$marketplace_pages = array(
array(
'id' => 'woocommerce-marketplace',
'parent' => 'woocommerce',
'title' => __( 'Extensions', 'woocommerce' ) . $this->badge(),
'page_title' => __( 'Extensions', 'woocommerce' ),
'path' => '/extensions',
),
);
/**
* The marketplace items used in the menu.
*
* @since 8.0
*/
return apply_filters( 'woocommerce_marketplace_menu_items', $marketplace_pages );
}
private function badge(): string {
$option = WC_Helper_Options::get( 'my_subscriptions_tab_loaded' );
if ( ! $option ) {
return WC_Helper_Updater::get_updates_count_html();
}
return '';
}
/**
* Enqueue update script.
*
* @param string $hook_suffix The current admin page.
*/
public function enqueue_scripts( $hook_suffix ) {
// phpcs:disable WordPress.Security.NonceVerification.Recommended
if ( 'woocommerce_page_wc-admin' !== $hook_suffix ) {
return;
}
if ( ! isset( $_GET['path'] ) || '/extensions' !== $_GET['path'] ) {
return;
}
// Enqueue WordPress updates script to enable plugin and theme installs and updates.
wp_enqueue_script( 'updates' );
// phpcs:enable WordPress.Security.NonceVerification.Recommended
}
/**
* Add a Woo Marketplace link to the plugin install action links.
*
* @param array $tabs Plugins list tabs.
* @return array
*/
public function add_woo_plugin_install_action_link( $tabs ) {
$tabs[ self::MARKETPLACE_TAB_SLUG ] = 'WooCommerce Marketplace';
return $tabs;
}
/**
* Open the Woo tab when the user clicks on the Woo link in the plugin installer.
*/
public function maybe_open_woo_tab() {
// phpcs:disable WordPress.Security.NonceVerification.Recommended
if ( ! isset( $_GET['tab'] ) || self::MARKETPLACE_TAB_SLUG !== $_GET['tab'] ) {
return;
}
// phpcs:enable WordPress.Security.NonceVerification.Recommended
$woo_url = add_query_arg(
array(
'page' => 'wc-admin',
'path' => '/extensions',
'tab' => 'extensions',
'ref' => 'plugins',
),
admin_url( 'admin.php' )
);
wc_admin_record_tracks_event( 'marketplace_plugin_install_woo_clicked' );
wp_safe_redirect( $woo_url );
exit;
}
}
PK [1]H^ ) Admin/ProductReviews/ReviewsListTable.phpnu Reviews
*/
namespace Automattic\WooCommerce\Internal\Admin\ProductReviews;
use WC_Product;
use WP_Comment;
use WP_Comments_List_Table;
use WP_List_Table;
use WP_Post;
/**
* Handles the Product Reviews page.
*/
class ReviewsListTable extends WP_List_Table {
/**
* Memoization flag to determine if the current user can edit the current review.
*
* @var bool
*/
private $current_user_can_edit_review = false;
/**
* Memoization flag to determine if the current user can moderate reviews.
*
* @var bool
*/
private $current_user_can_moderate_reviews;
/**
* Current rating of reviews to display.
*
* @var int
*/
private $current_reviews_rating = 0;
/**
* Current product the reviews should be displayed for.
*
* @var WC_Product|null Product or null for all products.
*/
private $current_product_for_reviews;
/**
* Constructor.
*
* @param array|string $args Array or string of arguments.
*/
public function __construct( $args = [] ) {
parent::__construct(
wp_parse_args(
$args,
[
'plural' => 'product-reviews',
'singular' => 'product-review',
]
)
);
$this->current_user_can_moderate_reviews = current_user_can( Reviews::get_capability( 'moderate' ) );
}
/**
* Prepares reviews for display.
*
* @return void
*/
public function prepare_items() : void {
$this->set_review_status();
$this->set_review_type();
$this->current_reviews_rating = isset( $_REQUEST['review_rating'] ) ? absint( $_REQUEST['review_rating'] ) : 0;
$this->set_review_product();
$args = [
'number' => $this->get_per_page(),
'post_type' => 'product',
];
// Include the order & orderby arguments.
$args = wp_parse_args( $this->get_sort_arguments(), $args );
// Handle the review item types filter.
$args = wp_parse_args( $this->get_filter_type_arguments(), $args );
// Handle the reviews rating filter.
$args = wp_parse_args( $this->get_filter_rating_arguments(), $args );
// Handle the review product filter.
$args = wp_parse_args( $this->get_filter_product_arguments(), $args );
// Include the review status arguments.
$args = wp_parse_args( $this->get_status_arguments(), $args );
// Include the search argument.
$args = wp_parse_args( $this->get_search_arguments(), $args );
// Include the offset argument.
$args = wp_parse_args( $this->get_offset_arguments(), $args );
/**
* Provides an opportunity to alter the comment query arguments used within
* the product reviews admin list table.
*
* @since 7.0.0
*
* @param array $args Comment query args.
*/
$args = (array) apply_filters( 'woocommerce_product_reviews_list_table_prepare_items_args', $args );
$comments = get_comments( $args );
update_comment_cache( $comments );
$this->items = $comments;
$this->set_pagination_args(
[
'total_items' => get_comments( $this->get_total_comments_arguments( $args ) ),
'per_page' => $this->get_per_page(),
]
);
}
/**
* Returns the number of items to show per page.
*
* @return int Customized per-page value if available, or 20 as the default.
*/
protected function get_per_page() : int {
return $this->get_items_per_page( 'edit_comments_per_page' );
}
/**
* Sets the product to filter reviews by.
*
* @return void
*/
protected function set_review_product() : void {
$product_id = isset( $_REQUEST['product_id'] ) ? absint( $_REQUEST['product_id'] ) : null;
$product = $product_id ? wc_get_product( $product_id ) : null;
if ( $product instanceof WC_Product ) {
$this->current_product_for_reviews = $product;
}
}
/**
* Sets the `$comment_status` global based on the current request.
*
* @global string $comment_status
*
* @return void
*/
protected function set_review_status() : void {
global $comment_status;
$comment_status = sanitize_text_field( wp_unslash( $_REQUEST['comment_status'] ?? 'all' ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
if ( ! in_array( $comment_status, [ 'all', 'moderated', 'approved', 'spam', 'trash' ], true ) ) {
$comment_status = 'all'; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
}
}
/**
* Sets the `$comment_type` global based on the current request.
*
* @global string $comment_type
*
* @return void
*/
protected function set_review_type() : void {
global $comment_type;
$review_type = sanitize_text_field( wp_unslash( $_REQUEST['review_type'] ?? 'all' ) );
if ( 'all' !== $review_type && ! empty( $review_type ) ) {
$comment_type = $review_type; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
}
}
/**
* Builds the `orderby` and `order` arguments based on the current request.
*
* @return array
*/
protected function get_sort_arguments() : array {
$orderby = sanitize_text_field( wp_unslash( $_REQUEST['orderby'] ?? '' ) );
$order = sanitize_text_field( wp_unslash( $_REQUEST['order'] ?? '' ) );
$args = [];
if ( ! in_array( $orderby, $this->get_sortable_columns(), true ) ) {
$orderby = 'comment_date_gmt';
}
// If ordering by "rating", then we need to adjust to sort by meta value.
if ( 'rating' === $orderby ) {
$orderby = 'meta_value_num';
$args['meta_key'] = 'rating';
}
if ( ! in_array( strtolower( $order ), [ 'asc', 'desc' ], true ) ) {
$order = 'desc';
}
return wp_parse_args(
[
'orderby' => $orderby,
'order' => strtolower( $order ),
],
$args
);
}
/**
* Builds the `type` argument based on the current request.
*
* @return array
*/
protected function get_filter_type_arguments() : array {
$args = [];
$item_type = isset( $_REQUEST['review_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['review_type'] ) ) : 'all';
if ( 'all' === $item_type ) {
return $args;
}
$args['type'] = $item_type;
return $args;
}
/**
* Builds the `meta_query` arguments based on the current request.
*
* @return array
*/
protected function get_filter_rating_arguments() : array {
$args = [];
if ( empty( $this->current_reviews_rating ) ) {
return $args;
}
$args['meta_query'] = [
[
'key' => 'rating',
'value' => (int) $this->current_reviews_rating,
'compare' => '=',
'type' => 'NUMERIC',
],
];
return $args;
}
/**
* Gets the `post_id` argument based on the current request.
*
* @return array
*/
public function get_filter_product_arguments() : array {
$args = [];
if ( $this->current_product_for_reviews instanceof WC_Product ) {
$args['post_id'] = $this->current_product_for_reviews->get_id();
}
return $args;
}
/**
* Gets the `status` argument based on the current request.
*
* @return array
*/
protected function get_status_arguments() : array {
$args = [];
global $comment_status;
if ( ! empty( $comment_status ) && 'all' !== $comment_status && array_key_exists( $comment_status, $this->get_status_filters() ) ) {
$args['status'] = $this->convert_status_to_query_value( $comment_status );
}
return $args;
}
/**
* Gets the `search` argument based on the current request.
*
* @return array
*/
protected function get_search_arguments() : array {
$args = [];
if ( ! empty( $_REQUEST['s'] ) ) {
$args['search'] = sanitize_text_field( wp_unslash( $_REQUEST['s'] ) );
}
return $args;
}
/**
* Returns the `offset` argument based on the current request.
*
* @return array
*/
protected function get_offset_arguments() : array {
$args = [];
if ( isset( $_REQUEST['start'] ) ) {
$args['offset'] = absint( wp_unslash( $_REQUEST['start'] ) );
} else {
$args['offset'] = ( $this->get_pagenum() - 1 ) * $this->get_per_page();
}
return $args;
}
/**
* Returns the arguments used to count the total number of comments.
*
* @param array $default_query_args Query args for the main request.
* @return array
*/
protected function get_total_comments_arguments( array $default_query_args ) : array {
return wp_parse_args(
[
'count' => true,
'offset' => 0,
'number' => 0,
],
$default_query_args
);
}
/**
* Displays the product reviews HTML table.
*
* Reimplements {@see WP_Comment_::display()} but we change the ID to match the one output by {@see WP_Comments_List_Table::display()}.
* This will automatically handle additional CSS for consistency with the comments page.
*
* @return void
*/
public function display() : void {
$this->display_tablenav( 'top' );
$this->screen->render_screen_reader_content( 'heading_list' );
?>
print_column_headers(); ?>
display_rows_or_placeholder(); ?>
print_column_headers( false ); ?>
display_tablenav( 'bottom' );
}
/**
* Render a single row HTML.
*
* @global WP_Post $post
* @global WP_Comment $comment
*
* @param WP_Comment|mixed $item Review or reply being rendered.
* @return void
*/
public function single_row( $item ) : void {
global $post, $comment;
// Overrides the comment global for properly rendering rows.
$comment = $item; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$the_comment_class = (string) wp_get_comment_status( $comment->comment_ID );
$the_comment_class = implode( ' ', get_comment_class( $the_comment_class, $comment->comment_ID, $comment->comment_post_ID ) );
// Sets the post for the product in context.
$post = get_post( $comment->comment_post_ID ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$this->current_user_can_edit_review = current_user_can( 'edit_comment', $comment->comment_ID );
?>
 . ')
';
}
/**
* Get the JWT for the address service, a service should implement an A8C hosted API or some mechanism to get a JWT, this will be passed to frontend code to be used in the address autocomplete and maps.
*
* This method shouldn't implement any caching, it should only fetch the token or throw an exception, if you must handle caching, consider also overriding get_jwt.
*
* @return string The JWT for the address service.
*/
abstract public function get_address_service_jwt();
/**
* Get the telemetry status for the address service, this is meant to be overridden by the implementor to return true if the service has permission to send telemetry data.
*
* @return bool The telemetry status for the address service.
*/
public function can_telemetry() {
return false;
}
/**
* Loads up a JWT from cache or from the implementor side.
*
* @return void
*
* phpcs:ignore Squiz.Commenting.FunctionCommentThrowTag.Missing -- As we wrap the throw in a try/catch.
*/
public function load_jwt() {
// If the address autocomplete is disabled, we don't load the JWT.
if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) !== true ) {
return;
}
// If we already have a loaded, valid token, we return early.
if ( $this->jwt && is_string( $this->jwt ) && JsonWebToken::shallow_validate( $this->jwt ) ) {
return;
}
$cached_jwt = $this->get_cached_option( 'address_autocomplete_jwt' );
// If we have a cached, valid token, we load it to class and return early.
if ( $cached_jwt && is_string( $cached_jwt ) && JsonWebToken::shallow_validate( $cached_jwt ) ) {
$this->jwt = $cached_jwt;
return;
}
$retry_data = $this->get_cached_option( 'jwt_retry_data' );
if ( $retry_data && isset( $retry_data['try_after'] ) && $retry_data['try_after'] > time() ) {
return;
}
try {
$fresh_jwt = $this->get_address_service_jwt();
if ( $fresh_jwt && is_string( $fresh_jwt ) && JsonWebToken::shallow_validate( $fresh_jwt ) ) {
$this->set_jwt( $fresh_jwt );
// Clear retry data on success.
$this->delete_cached_option( 'jwt_retry_data' );
return;
} else {
throw new \Exception( 'Invalid JWT received from address service.' );
}
} catch ( \Exception $e ) {
$retry_data['attempts'] = isset( $retry_data['attempts'] ) ? $retry_data['attempts'] + 1 : 1;
wc_get_logger()->error(
sprintf(
'Failed loading JWT for %1$s address autocomplete service (attempt %2$d) with error %3$s.',
$this->name,
$retry_data['attempts'],
$e->getMessage()
),
'address-autocomplete'
);
$backoff_hours = pow( 2, $retry_data['attempts'] - 1 ); // 1, 2, 4, 8 hours.
$retry_data['try_after'] = time() + ( $backoff_hours * HOUR_IN_SECONDS );
$this->update_cached_option( 'jwt_retry_data', $retry_data, DAY_IN_SECONDS );
}
}
/**
* Gets the JWT for the address service.
*
* @return string The JWT for the address service.
*/
public function get_jwt() {
if ( null === $this->jwt ) {
$this->load_jwt();
}
return $this->jwt;
}
/**
* Sets the JWT for the address service.
*
* @param string $jwt The JWT for the address service.
*/
public function set_jwt( $jwt ) {
$this->jwt = $jwt;
if ( null !== $jwt ) {
$cache_duration = $this->get_jwt_cache_duration( $jwt );
// If the token is expired, we don't cache it and we fetch a new one.
if ( 0 === $cache_duration ) {
$this->jwt = null;
$this->load_jwt();
return;
}
$this->update_cached_option( 'address_autocomplete_jwt', $jwt, $cache_duration );
} else {
$this->delete_cached_option( 'address_autocomplete_jwt' );
}
}
/**
* Gets the cache duration for the JWT.
*
* @param string $jwt The JWT for the address service.
* @return int The cache duration for the JWT.
*/
public function get_jwt_cache_duration( $jwt ) {
$parts = JsonWebToken::get_parts( $jwt );
if ( property_exists( $parts->payload, 'exp' ) ) {
return max( $parts->payload->exp - time(), 0 );
}
}
/**
* Deletes the cached token if we disable the autocomplete service or fetches a new one if it's enabled.
*
* @param string $setting If the service is enabled or disabled.
* @return string the setting value.
*/
public function refresh_cache( $setting ) {
if ( wc_string_to_bool( $setting ) ) {
$this->load_jwt();
} else {
$this->set_jwt( null );
}
return $setting;
}
/**
* Gets the cached option.
*
* @param string $key The key of the option.
* @return mixed|null The cached option.
*/
private function get_cached_option( $key ) {
$data = get_option( $this->id . '_' . $key );
if ( is_array( $data ) && isset( $data['data'] ) ) {
if ( ! self::is_expired( $data ) ) {
return $data['data'];
}
$this->delete_cached_option( $key );
}
return null;
}
/**
* Updates the cached option.
*
* @param string $key The key of the option.
* @param mixed $value The value of the option.
* @param int $ttl The TTL of the option.
*/
private function update_cached_option( $key, $value, $ttl = DAY_IN_SECONDS ) {
$result = update_option(
$this->id . '_' . $key,
array(
'data' => $value,
'updated' => time(),
'ttl' => $ttl,
),
false
);
if ( false === $result ) {
wp_cache_delete( $this->id . '_' . $key, 'options' );
}
}
/**
* Deletes the cached option.
*
* @param string $key The key of the option.
*/
private function delete_cached_option( $key ) {
if ( delete_option( $this->id . '_' . $key ) ) {
wp_cache_delete( $this->id . '_' . $key, 'options' );
}
}
/**
* Checks if the cache value is expired.
*
* @param array $cache_contents The cache contents.
*
* @return boolean True if the contents are expired. False otherwise.
*/
private static function is_expired( $cache_contents ) {
if ( ! is_array( $cache_contents ) || ! isset( $cache_contents['updated'] ) || ! isset( $cache_contents['ttl'] ) ) {
// Treat bad/invalid cache contents as expired.
return true;
}
// Double-check that we have integers for `updated` and `ttl`.
if ( ! is_int( $cache_contents['updated'] ) || ! is_int( $cache_contents['ttl'] ) ) {
return true;
}
$expires = $cache_contents['updated'] + $cache_contents['ttl'];
$now = time();
return $expires < $now;
}
/**
* Return asset URL, copied from WC_Frontend_Scripts::get_asset_url.
*
* @param string $path Assets path.
* @return string
*/
public static function get_asset_url( $path ) {
/**
* Filters the asset URL.
*
* @since 3.2.0
*
* @param string $url The asset URL.
* @param string $path The asset path.
* @return string The filtered asset URL.
*/
return apply_filters( 'woocommerce_get_asset_url', plugins_url( $path, Constants::get_constant( 'WC_PLUGIN_FILE' ) ), $path );
}
/**
* Enqueues the checkout script, checks if it's already registered or not so we don't duplicate, and prints out the JWT to the page to be consumed.
*/
public function load_scripts() {
// If the address autocomplete setting is disabled, don't load the scripts.
if ( wc_string_to_bool( get_option( 'woocommerce_address_autocomplete_enabled', 'no' ) ) !== true ) {
return;
}
if ( ! is_checkout() ) {
return;
}
if ( ! $this->get_jwt() ) {
return;
}
$suffix = Constants::is_true( 'SCRIPT_DEBUG' ) ? '' : '.min';
$version = Constants::get_constant( 'WC_VERSION' );
if ( ! wp_script_is( 'a8c-address-autocomplete-service', 'registered' ) ) {
wp_register_script( 'a8c-address-autocomplete-service', self::get_asset_url( 'assets/js/frontend/a8c-address-autocomplete-service' . $suffix . '.js' ), array( 'wc-address-autocomplete' ), $version, array( 'strategy' => 'defer' ) );
}
if ( ! wp_script_is( 'a8c-address-autocomplete-service', 'enqueued' ) ) {
wp_enqueue_script( 'a8c-address-autocomplete-service' );
}
wp_add_inline_script(
'a8c-address-autocomplete-service',
sprintf(
'var a8cAddressAutocompleteServiceKeys = a8cAddressAutocompleteServiceKeys || {}; a8cAddressAutocompleteServiceKeys[ %1$s ] = { key: %2$s, canTelemetry: %3$s };',
wp_json_encode( $this->id, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( $this->get_jwt(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( false !== $this->can_telemetry() && (bool) $this->can_telemetry(), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
),
'before'
);
}
}
PK [1]* - AddressProvider/AddressProviderController.phpnu preferred_provider_option = get_option( 'woocommerce_address_autocomplete_provider', '' );
$this->providers = $this->get_registered_providers();
}
/**
* Get the registered providers.
*
* @return WC_Address_Provider[] array of WC_Address_Providers.
*/
public function get_providers(): array {
return $this->providers;
}
/**
* Get all registered providers.
*
* @return WC_Address_Provider[] array of WC_Address_Providers.
*/
private function get_registered_providers(): array {
/**
* Filter the registered address providers.
*
* @since 9.9.0
* @param array $providers Array of fully qualified class names (strings) or WC_Address_Provider instances.
* Class names will be instantiated automatically.
* Example: array( 'My_Provider_Class', new My_Other_Provider() )
*/
$provider_items = apply_filters( 'woocommerce_address_providers', array() );
// The filter returned nothing but an empty array, so we can skip the rest of the function.
if ( empty( $provider_items ) && is_array( $provider_items ) ) {
return array();
}
$logger = wc_get_logger();
if ( ! is_array( $provider_items ) ) {
$logger->error(
'Invalid return value for woocommerce_address_providers, expected an array of class names or instances.',
array(
'context' => 'address_provider_service',
)
);
return array();
}
$providers = array();
$seen_ids = array();
foreach ( $provider_items as $provider_item ) {
if ( is_string( $provider_item ) && class_exists( $provider_item ) ) {
$provider_item = new $provider_item();
}
// Providers need to be valid and extend WC_Address_Provider.
if ( ! is_a( $provider_item, WC_Address_Provider::class ) ) {
$logger->error(
sprintf(
'Invalid address provider item "%s", expected a string class name or WC_Address_Provider instance.',
is_object( $provider_item ) ? get_class( $provider_item ) : gettype( $provider_item )
),
array(
'context' => 'address_provider_service',
)
);
continue;
}
// Validate the instance has the necessary properties.
if ( empty( $provider_item->id ) || empty( $provider_item->name ) ) {
$logger->error(
'Invalid address provider instance, id or name property is missing or empty: ' . get_class( $provider_item ),
array(
'context' => 'address_provider_service',
)
);
continue;
}
// Check for duplicate IDs.
if ( isset( $seen_ids[ $provider_item->id ] ) ) {
$logger->error(
sprintf(
'Duplicate provider ID found. ID "%s" is used by both %s and %s.',
$provider_item->id,
$seen_ids[ $provider_item->id ],
get_class( $provider_item )
),
array(
'context' => 'address_provider_service',
)
);
continue;
}
// Track the ID and its provider class for error reporting.
$seen_ids[ $provider_item->id ] = get_class( $provider_item );
// Add the provider instance to the array after all checks are completed.
$providers[] = $provider_item;
}
if ( ! empty( $this->preferred_provider_option ) && ! empty( $providers ) ) {
// Look for the preferred provider in the array.
foreach ( $providers as $key => $provider ) {
if ( $provider->id === $this->preferred_provider_option ) {
// Found the preferred provider, move it to the beginning of the array.
$preferred_provider = $provider;
unset( $providers[ $key ] );
array_unshift( $providers, $preferred_provider );
break;
}
}
}
return $providers;
}
/**
* Check if a specific provider is registered and available.
*
* @param string $provider_id The provider ID to check.
* @return bool
*/
public function is_provider_available( string $provider_id ): bool {
foreach ( $this->providers as $provider ) {
if ( $provider->id === $provider_id ) {
return true;
}
}
return false;
}
/**
* Get the preferred provider; this is what was selected in the WooCommerce "preferred provider" setting *or* the
* first registered provider if no preference was set. If the provider selected in WC Settings is not registered
* anymore, it will fall back to the first registered provider. Any other case will return an empty string.
*
* @return string
*/
public function get_preferred_provider(): string {
if ( $this->is_provider_available( $this->preferred_provider_option ) ) {
return $this->preferred_provider_option;
}
// Get the first provider's ID.
return $this->providers[0]->id ?? '';
}
}
PK [1]lɭ Customers/SearchService.phpnu get_col(
$wpdb->prepare(
"SELECT DISTINCT customer_id FROM %i WHERE billing_email IN ($placeholders)",
OrdersTableDataStore::get_orders_table_name(),
...$emails
)
);
// phpcs:enable
if ( array() === $include_user_ids ) {
return array();
}
}
$users_query = new \WP_User_Query(
array(
'fields' => 'ID',
'include' => $include_user_ids,
'meta_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'key' => 'billing_email',
'value' => $emails,
'compare' => 'IN',
),
),
)
);
return array_map( 'intval', array_unique( $users_query->get_results() ) );
}
}
PK [1]ypr # Agentic/Enums/Specs/MessageType.phpnu namespace;
}
/**
* Register the routes for order statuses.
*/
public function register_routes() {
register_rest_route(
$this->get_rest_api_namespace(),
'/' . $this->rest_base,
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => '__return_true',
),
'schema' => array( $this, 'get_item_schema' ),
)
);
}
/**
* Get all order statuses.
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( WP_REST_Request $request ) {
$order_statuses = wc_get_order_statuses();
$formatted_statuses = array();
foreach ( $order_statuses as $status_slug => $status_name ) {
$slug = str_replace( 'wc-', '', $status_slug );
$formatted_statuses[] = array(
'slug' => $slug,
'name' => wc_get_order_status_name( $slug ),
);
}
if ( ! $formatted_statuses ) {
return new WP_Error( 'woocommerce_rest_not_found', __( 'Order statuses not found', 'woocommerce' ), array( 'status' => 404 ) );
}
return rest_ensure_response( $formatted_statuses );
}
/**
* Get the order status schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'order_status',
'type' => 'object',
'properties' => array(
'slug' => array(
'description' => __( 'Order status slug.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Order status name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
),
);
return $schema;
}
}
PK [1]9 Orders/CardIcons/jcb.svgnu
PK [1]D8n0 n0 Orders/CardIcons/mastercard.svgnu
PK [1]B Orders/CardIcons/diners.svgnu
PK [1]z:{ { Orders/CardIcons/unknown.svgnu PK [1]d Orders/CardIcons/visa.svgnu
PK [1]b} Orders/CardIcons/interac.svgnu PK [1]( ( Orders/CardIcons/amex.svgnu
PK [1] P P Orders/CardIcons/discover.svgnu
PK [1]1 K Orders/IppFunctions.phpnu get_status(), array( 'pending', 'on-hold', 'processing' ), true );
$has_payment_method = in_array( $order->get_payment_method(), array( WC_Gateway_COD::ID, 'woocommerce_payments', 'none' ), true );
$order_is_not_paid = null === $order->get_date_paid();
$order_is_not_refunded = empty( $order->get_refunds() );
$order_has_no_subscription_products = true;
foreach ( $order->get_items() as $item ) {
$product = $item->get_product();
if ( is_object( $product ) && $product->is_type( 'subscription' ) ) {
$order_has_no_subscription_products = false;
break;
}
}
return $has_status && $has_payment_method && $order_is_not_paid && $order_is_not_refunded && $order_has_no_subscription_products;
}
/**
* Returns if store is eligible to accept In-Person Payments.
*
* @return bool true if store is eligible, false otherwise
*/
public static function is_store_in_person_payment_eligible(): bool {
$is_store_usa_based = self::has_store_specified_country_currency( 'US', 'USD' );
$is_store_canada_based = self::has_store_specified_country_currency( 'CA', 'CAD' );
return $is_store_usa_based || $is_store_canada_based;
}
/**
* Checks if the store has specified country location and currency used.
*
* @param string $country country to compare store's country with.
* @param string $currency currency to compare store's currency with.
*
* @return bool true if specified country and currency match the store's ones. false otherwise
*/
public static function has_store_specified_country_currency( string $country, string $currency ): bool {
return ( WC()->countries->get_base_country() === $country && get_woocommerce_currency() === $currency );
}
}
PK [1]x x + Orders/OrderAttributionBlocksController.phpnu extend_schema = $extend_schema;
$this->features_controller = $features_controller;
$this->order_attribution_controller = $order_attribution_controller;
}
/**
* Register this class instance to the appropriate hooks.
*
* @return void
*/
public function register() {
add_action( 'init', array( $this, 'on_init' ) );
}
/**
* Hook into WordPress on init.
*/
public function on_init() {
// Bail if the feature is not enabled.
if ( ! $this->features_controller->feature_is_enabled( 'order_attribution' ) ) {
return;
}
$this->extend_api();
}
/**
* Extend the Store API.
*
* @return void
*/
private function extend_api() {
$this->extend_schema->register_endpoint_data(
array(
'endpoint' => CheckoutSchema::IDENTIFIER,
'namespace' => 'woocommerce/order-attribution',
'schema_callback' => $this->get_schema_callback(),
)
);
// Update order based on extended data.
add_action(
'woocommerce_store_api_checkout_update_order_from_request',
function ( $order, $request ) {
$extensions = $request->get_param( 'extensions' );
$params = $extensions['woocommerce/order-attribution'] ?? array();
if ( empty( $params ) ) {
return;
}
// Check if this order already has any attribution data to prevent duplicates attribution data.
if ( $this->order_attribution_controller->has_attribution( $order ) ) {
return;
}
/**
* Run an action to save order attribution data.
*
* @since 8.5.0
*
* @param WC_Order $order The order object.
* @param array $params Unprefixed order attribution data.
*/
do_action( 'woocommerce_order_save_attribution_data', $order, $params );
},
10,
2
);
}
/**
* Get the schema callback.
*
* @return callable
*/
private function get_schema_callback() {
return function() {
$schema = array();
$field_names = $this->order_attribution_controller->get_field_names();
$validate_callback = function( $value ) {
if ( ! is_string( $value ) && null !== $value ) {
return new WP_Error(
'api-error',
sprintf(
/* translators: %s is the property type */
esc_html__( 'Value of type %s was posted to the order attribution callback', 'woocommerce' ),
gettype( $value )
)
);
}
return true;
};
$sanitize_callback = function( $value ) {
return sanitize_text_field( $value );
};
foreach ( $field_names as $field_name ) {
$schema[ $field_name ] = array(
'description' => sprintf(
/* translators: %s is the field name */
__( 'Order attribution field: %s', 'woocommerce' ),
esc_html( $field_name )
),
'type' => array( 'string', 'null' ),
'context' => array(),
'arg_options' => array(
'validate_callback' => $validate_callback,
'sanitize_callback' => $sanitize_callback,
),
);
}
return $schema;
};
}
}
PK [1]
+ ! Orders/MobileMessagingHandler.phpnu diff( $now )->days <= self::OPEN_ORDER_INTERVAL_DAYS;
$has_jetpack = null !== $blog_id;
if ( IppFunctions::is_store_in_person_payment_eligible() && IppFunctions::is_order_in_person_payment_eligible( $order ) ) {
return self::accept_payment_message( $blog_id, $domain );
} else {
if ( $used_app_in_last_month && $has_jetpack ) {
return self::manage_order_message( $blog_id, $order->get_id(), $domain );
} else {
return self::no_app_message( $blog_id, $domain );
}
}
} catch ( Exception $e ) {
return null;
}
}
/**
* Returns the closest date of last usage of any mobile app platform.
*
* @return ?DateTime
*/
private static function get_closer_mobile_usage_date(): ?DateTime {
$mobile_usage = WC_Tracker::get_woocommerce_mobile_usage();
if ( ! $mobile_usage ) {
return null;
}
$last_ios_used = self::get_last_used_or_null( 'ios', $mobile_usage );
$last_android_used = self::get_last_used_or_null( 'android', $mobile_usage );
return max( $last_android_used, $last_ios_used );
}
/**
* Returns last used date of specified mobile app platform.
*
* @param string $platform mobile platform to check.
* @param array $mobile_usage mobile apps usage data.
*
* @return ?DateTime last used date of specified mobile app
*/
private static function get_last_used_or_null(
string $platform, array $mobile_usage
): ?DateTime {
try {
if ( array_key_exists( $platform, $mobile_usage ) ) {
return new DateTime( $mobile_usage[ $platform ]['last_used'] );
} else {
return null;
}
} catch ( Exception $e ) {
return null;
}
}
/**
* Prepares message with a deep link to mobile payment.
*
* @param ?int $blog_id blog id to deep link to.
* @param string $domain URL of the current site.
*
* @return string formatted message
*/
private static function accept_payment_message( ?int $blog_id, $domain ): string {
$deep_link_url = add_query_arg(
array_merge(
array(
'blog_id' => absint( $blog_id ),
),
self::prepare_utm_parameters( 'deeplinks_payments', $blog_id, $domain )
),
'https://woocommerce.com/mobile/payments'
);
return sprintf(
/* translators: 1: opening link tag 2: closing link tag. */
esc_html__(
'%1$sCollect payments easily%2$s from your customers anywhere with our mobile app.',
'woocommerce'
),
'',
''
);
}
/**
* Prepares message with a deep link to manage order details.
*
* @param int $blog_id blog id to deep link to.
* @param int $order_id order id to deep link to.
* @param string $domain URL of the current site.
*
* @return string formatted message
*/
private static function manage_order_message( int $blog_id, int $order_id, string $domain ): string {
$deep_link_url = add_query_arg(
array_merge(
array(
'blog_id' => absint( $blog_id ),
'order_id' => absint( $order_id ),
),
self::prepare_utm_parameters( 'deeplinks_orders_details', $blog_id, $domain )
),
'https://woocommerce.com/mobile/orders/details'
);
return sprintf(
/* translators: 1: opening link tag 2: closing link tag. */
esc_html__(
'%1$sManage the order%2$s with the app.',
'woocommerce'
),
'',
''
);
}
/**
* Prepares message with a deep link to learn more about mobile app.
*
* @param ?int $blog_id blog id used for tracking.
* @param string $domain URL of the current site.
*
* @return string formatted message
*/
private static function no_app_message( ?int $blog_id, string $domain ): string {
$deep_link_url = add_query_arg(
array_merge(
array(
'blog_id' => absint( $blog_id ),
),
self::prepare_utm_parameters( 'deeplinks_promote_app', $blog_id, $domain )
),
'https://woocommerce.com/mobile'
);
return sprintf(
/* translators: 1: opening link tag 2: closing link tag. */
esc_html__(
'Process your orders on the go. %1$sGet the app%2$s.',
'woocommerce'
),
'',
''
);
}
/**
* Prepares array of parameters used by WooCommerce.com for tracking.
*
* @param string $campaign name of the deep link campaign.
* @param int|null $blog_id blog id of the current site.
* @param string $domain URL of the current site.
*
* @return array
*/
private static function prepare_utm_parameters(
string $campaign,
?int $blog_id,
string $domain
): array {
return array(
'utm_campaign' => $campaign,
'utm_medium' => 'email',
'utm_source' => $domain,
'utm_term' => absint( $blog_id ),
);
}
}
PK [1]Uu35B 5B % Orders/OrderAttributionController.phpnu proxy = $proxy;
$this->feature_controller = $controller;
$this->consent = $consent;
$this->logger = $proxy->call_function( 'wc_get_logger' );
$this->set_fields_and_prefix();
}
/**
* Register this class instance to the appropriate hooks.
*
* @return void
*/
public function register() {
// Don't run during install.
if ( Constants::get_constant( 'WC_INSTALLING' ) ) {
return;
}
add_action( 'init', array( $this, 'on_init' ) );
}
/**
* Hook into WordPress on init.
*/
public function on_init() {
// Bail if the feature is not enabled.
if ( ! $this->feature_controller->feature_is_enabled( 'order_attribution' ) ) {
return;
}
// Reset the static flag at the start of each request to prevent issues in persistent PHP environments.
self::$is_stamp_html_called = false;
// Register WPConsentAPI integration.
$this->consent->register();
add_action(
'wp_enqueue_scripts',
function () {
$this->enqueue_scripts_and_styles();
}
);
add_action(
'admin_enqueue_scripts',
function () {
$this->enqueue_admin_scripts_and_styles();
}
);
/**
* Filter set of actions used to stamp the checkout order attribution HTML container element.
*
* @since 9.0.0
*
* @param array $stamp_checkout_html_actions The set of actions used to stamp the checkout order attribution HTML container element.
*/
$stamp_checkout_html_actions = apply_filters(
'wc_order_attribution_stamp_checkout_html_actions',
array(
'woocommerce_checkout_billing',
'woocommerce_after_checkout_billing_form',
'woocommerce_checkout_shipping',
'woocommerce_after_order_notes',
'woocommerce_checkout_after_customer_details',
)
);
foreach ( $stamp_checkout_html_actions as $action ) {
add_action( $action, array( $this, 'stamp_html_element' ) );
}
add_action( 'woocommerce_register_form', array( $this, 'stamp_html_element' ) );
// Update order based on submitted fields.
add_action(
'woocommerce_checkout_order_created',
function ( $order ) {
// Check if this order already has any attribution data to prevent duplicates attribution data.
if ( $this->has_attribution( $order ) ) {
return;
}
// Nonce check is handled by WooCommerce before woocommerce_checkout_order_created hook.
// phpcs:ignore WordPress.Security.NonceVerification
$params = $this->get_unprefixed_field_values( $_POST );
/**
* Run an action to save order attribution data.
*
* @since 8.5.0
*
* @param WC_Order $order The order object.
* @param array $params Unprefixed order attribution data.
*/
do_action( 'woocommerce_order_save_attribution_data', $order, $params );
}
);
add_action(
'woocommerce_order_save_attribution_data',
function ( $order, $data ) {
$source_data = $this->get_source_values( $data );
$this->send_order_tracks( $source_data, $order );
$this->set_order_source_data( $source_data, $order );
},
10,
2
);
add_action(
'user_register',
function ( $customer_id ) {
try {
$customer = new WC_Customer( $customer_id );
$this->set_customer_source_data( $customer );
} catch ( Exception $e ) {
$this->log( $e->getMessage(), __METHOD__, WC_Log_Levels::ERROR );
}
}
);
// Add origin data to the order table.
add_action(
'admin_init',
function () {
$this->register_order_origin_column();
}
);
add_action(
'woocommerce_new_order',
function ( $order_id, $order ) {
$this->maybe_set_admin_source( $order );
},
2,
10
);
}
/**
* If the order is created in the admin, set the source type and origin to admin/Web admin.
* Only execute this if the order is created in the admin interface (or via ajax in the admin interface).
*
* @param WC_Order $order The recently created order object.
*
* @since 8.5.0
*/
private function maybe_set_admin_source( WC_Order $order ) {
// For ajax requests, bail if the referer is not an admin page.
$http_referer = esc_url_raw( wp_unslash( $_SERVER['HTTP_REFERER'] ?? '' ) );
$referer_is_admin = 0 === strpos( $http_referer, get_admin_url() );
if ( ! $referer_is_admin && wp_doing_ajax() ) {
return;
}
// If not admin interface page, bail.
if ( ! is_admin() ) {
return;
}
$order->add_meta_data( $this->get_meta_prefixed_field_name( 'source_type' ), 'admin' );
$order->save();
}
/**
* Get all of the field names.
*
* @return array
*/
public function get_field_names(): array {
return $this->field_names;
}
/**
* Get the prefix for the fields.
*
* @return string
*/
public function get_prefix(): string {
return $this->field_prefix;
}
/**
* Scripts & styles for custom source tracking and cart tracking.
*/
private function enqueue_scripts_and_styles() {
wp_enqueue_script(
'sourcebuster-js',
plugins_url( "assets/js/sourcebuster/sourcebuster{$this->get_script_suffix()}.js", WC_PLUGIN_FILE ),
array(),
Constants::get_constant( 'WC_VERSION' ),
true
);
wp_enqueue_script(
'wc-order-attribution',
plugins_url( "assets/js/frontend/order-attribution{$this->get_script_suffix()}.js", WC_PLUGIN_FILE ),
// Technically we do depend on 'wp-data', 'wc-blocks-checkout' for blocks checkout,
// but as implementing conditional dependency on the server-side would be too complex,
// we resolve this condition at the client-side.
array( 'sourcebuster-js' ),
Constants::get_constant( 'WC_VERSION' ),
true
);
/**
* Filter the lifetime of the cookie used for source tracking.
*
* @since 8.5.0
*
* @param float $lifetime The lifetime of the Sourcebuster cookies in months.
*
* The default value forces Sourcebuster into making the cookies valid for the current session only.
*/
$lifetime = (float) apply_filters( 'wc_order_attribution_cookie_lifetime_months', 0.00001 );
/**
* Filter the session length for source tracking.
*
* @since 8.5.0
*
* @param int $session_length The session length in minutes.
*/
$session_length = (int) apply_filters( 'wc_order_attribution_session_length_minutes', 30 );
/**
* Filter to enable base64 encoding for cookie values.
*
* @since 9.0.0
*
* @param bool $use_base64_cookies True to enable base64 encoding, default is false.
*/
$use_base64_cookies = apply_filters( 'wc_order_attribution_use_base64_cookies', false );
/**
* Filter to allow tracking.
*
* @since 8.5.0
*
* @param bool $allow_tracking True to allow tracking, false to disable.
*/
$allow_tracking = wc_bool_to_string( apply_filters( 'wc_order_attribution_allow_tracking', true ) );
// Create Order Attribution JS namespace with parameters.
$namespace = array(
'params' => array(
'lifetime' => $lifetime,
'session' => $session_length,
'base64' => $use_base64_cookies,
'ajaxurl' => admin_url( 'admin-ajax.php' ),
'prefix' => $this->field_prefix,
'allowTracking' => 'yes' === $allow_tracking,
),
'fields' => $this->fields,
);
wp_localize_script( 'wc-order-attribution', 'wc_order_attribution', $namespace );
}
/**
* Enqueue the stylesheet for admin pages.
*
* @return void
*/
private function enqueue_admin_scripts_and_styles() {
$screen = get_current_screen();
if ( $screen->id !== $this->get_order_screen_id() ) {
return;
}
// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.NotInFooter
wp_enqueue_script(
'woocommerce-order-attribution-admin-js',
plugins_url( "assets/js/admin/order-attribution-admin{$this->get_script_suffix()}.js", WC_PLUGIN_FILE ),
array( 'jquery' ),
Constants::get_constant( 'WC_VERSION' )
);
}
/**
* Display the origin column in the orders table.
*
* @param int $order_id The order ID.
*
* @return void
*/
private function display_origin_column( $order_id ): void {
try {
// Ensure we've got a valid order.
$order = $this->get_hpos_order_object( $order_id );
$this->output_origin_column( $order );
} catch ( Exception $e ) {
return;
}
}
/**
* Output the translated origin label for the Origin column in the orders table.
*
* Default to "Unknown" if no origin is set.
*
* @param WC_Order $order The order object.
*
* @return void
*/
private function output_origin_column( WC_Order $order ) {
$source_type = $order->get_meta( $this->get_meta_prefixed_field_name( 'source_type' ) );
$source = $order->get_meta( $this->get_meta_prefixed_field_name( 'utm_source' ) );
$origin = $this->get_origin_label( $source_type, $source );
echo esc_html( $origin );
}
/**
* Handles the `->plugin_url() . '/assets/images/placeholder.webp){kind=small}
';
}
/**
* Force products in preview to be considered downloadable so core renders downloads section.
*
* @param bool $is_downloadable Current value.
* @return bool
*/
public function force_product_downloadable( $is_downloadable ) {
/**
* Filters whether the current request is an email preview.
*
* When true, products should be considered downloadable so the downloads
* section renders in applicable emails during preview.
*
* @since 9.6.0
*
* @param bool $is_email_preview Whether preview mode is active.
*/
if ( apply_filters( 'woocommerce_is_email_preview', false ) ) {
return true;
}
return $is_downloadable;
}
/**
* Provide a dummy product file so product->has_file() returns true in preview.
*
* @param array|null $file Current file array or null.
* @return array|null
*/
public function provide_dummy_product_file( $file ) {
/**
* Filters whether the current request is an email preview.
*
* When true, provide a dummy product file array so downloadable template parts
* can render during preview.
*
* @since 9.6.0
*
* @param bool $is_email_preview Whether preview mode is active.
*/
if ( apply_filters( 'woocommerce_is_email_preview', false ) ) {
return array(
'name' => __( 'Sample Download File.pdf', 'woocommerce' ),
'file' => 'sample-download.pdf',
);
}
return $file;
}
/**
* Get dummy downloadable items for email preview.
*
* @param array $downloads Existing downloads.
* @return array
*/
public function get_dummy_downloadable_items( $downloads ) {
$dummy_downloads = array(
array(
'product_name' => $this->get_dummy_downloadable_product()->get_name(),
'product_id' => $this->get_dummy_downloadable_product()->get_id(),
'download_url' => 'https://example.com/download',
'download_name' => __( 'Sample Download File.pdf', 'woocommerce' ),
'access_expires' => time() + ( 30 * DAY_IN_SECONDS ),
),
);
return array_merge( $downloads, $dummy_downloads );
}
/**
* Generate placeholder content for a specific email type, typically used in the email editor.
*
* Encapsulates the logic for setting the email type, generating raw content, applying styles,
* ensuring links open in new tabs, and handling errors based on WP_DEBUG.
*
* @param string $email_type_class_name The class name of the WC_Email type (e.g., 'WC_Email_Customer_Processing_Order').
* @return string The generated and styled HTML content.
* @throws \RuntimeException If content generation fails. If rendering fails.
*/
public function generate_placeholder_content( string $email_type_class_name ): string {
// Note: set_email_type can throw InvalidArgumentException.
$this->set_email_type( $email_type_class_name );
$woo_content_processor = wc_get_container()->get( WooContentProcessor::class );
$generate_content_closure = function () use ( $woo_content_processor ) {
// Note: If 'woocommerce_email_styles' filter was intentional and `prepare_css` isn't
// the intended callback, adjust accordingly. This assumes `prepare_css` applies styles
// needed for the Woo content block.
add_filter( 'woocommerce_email_styles', array( $woo_content_processor, 'prepare_css' ), 10, 2 );
$content = $woo_content_processor->get_woo_content( $this->get_email() );
$content = $this->get_email()->style_inline( $content );
$content = $this->ensure_links_open_in_new_tab( $content );
return $content;
};
$this->set_up_filters();
$message = '';
try {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
$message = $generate_content_closure();
} else {
// Use output buffering to prevent partial renders with PHP notices or warnings when WP_DEBUG is off.
ob_start();
try {
$message = $generate_content_closure();
} catch ( Throwable $e ) {
ob_end_clean();
// Let the caller handle the exception.
throw new \RuntimeException( esc_html__( 'There was an error rendering the email editor placeholder content.', 'woocommerce' ), 0, $e );
}
ob_end_clean();
}
} finally {
$this->clean_up_filters();
}
return $message;
}
/**
* Switch to the site locale. This is to ensure the email is displayed
* in the store's language, as the customer would see it, not the admin's language.
*/
private function switch_to_site_locale() {
if ( ! $this->locale_switched ) {
wc_switch_to_site_locale();
$this->locale_switched = true;
}
}
/**
* Restore the original locale.
*/
private function restore_locale() {
if ( $this->locale_switched ) {
wc_restore_locale();
$this->locale_switched = false;
}
}
}
PK [1]+ + Admin/Orders/PostsRedirectionController.phpnu page_controller = $page_controller;
if ( ! wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled() ) {
return;
}
add_action(
'admin_menu',
function () {
$this->maybe_update_menu_items();
},
9999
);
add_action(
'load-edit.php',
function() {
$this->maybe_redirect_to_orders_page();
}
);
add_action(
'load-post-new.php',
function() {
$this->maybe_redirect_to_new_order_page();
}
);
add_action(
'load-post.php',
function() {
$this->maybe_redirect_to_edit_order_page();
}
);
}
/**
* If needed, performs a redirection to the main orders page.
*
* @return void
*/
private function maybe_redirect_to_orders_page(): void {
$post_type = $_GET['post_type'] ?? ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( ! $post_type || ! in_array( $post_type, wc_get_order_types( 'admin-menu' ), true ) ) {
return;
}
// Respect query args, except for 'post_type'.
$query_args = wp_unslash( $_GET );
$action = $query_args['action'] ?? '';
$posts = $query_args['post'] ?? array();
unset( $query_args['post_type'], $query_args['post'], $query_args['_wpnonce'], $query_args['_wp_http_referer'], $query_args['action'] );
// Remap 'post_status' arg.
if ( isset( $query_args['post_status'] ) ) {
$query_args['status'] = $query_args['post_status'];
unset( $query_args['post_status'] );
}
$new_url = $this->page_controller->get_base_page_url( $post_type );
$new_url = add_query_arg( $query_args, $new_url );
// Handle bulk actions.
if ( $action && in_array( $action, array( 'trash', 'untrash', 'delete', 'mark_processing', 'mark_on-hold', 'mark_completed', 'mark_cancelled' ), true ) ) {
check_admin_referer( 'bulk-posts' );
$new_url = add_query_arg(
array(
'action' => $action,
'id' => $posts,
'_wp_http_referer' => $this->page_controller->get_orders_url(),
'_wpnonce' => wp_create_nonce( 'bulk-orders' ),
),
$new_url
);
}
wp_safe_redirect( $new_url, 301 );
exit;
}
/**
* If needed, performs a redirection to the new order page.
*
* @return void
*/
private function maybe_redirect_to_new_order_page(): void {
$post_type = $_GET['post_type'] ?? ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( ! $post_type || ! in_array( $post_type, wc_get_order_types( 'admin-menu' ), true ) ) {
return;
}
// Respect query args, except for 'post_type'.
$query_args = wp_unslash( $_GET );
unset( $query_args['post_type'] );
$new_url = $this->page_controller->get_new_page_url( $post_type );
$new_url = add_query_arg( $query_args, $new_url );
wp_safe_redirect( $new_url, 301 );
exit;
}
/**
* If needed, performs a redirection to the edit order page.
*
* @return void
*/
private function maybe_redirect_to_edit_order_page(): void {
$post_id = absint( $_GET['post'] ?? 0 );
if ( ! $post_id ) {
return;
}
$redirect_from_types = wc_get_order_types( 'admin-menu' );
$redirect_from_types[] = 'shop_order_placehold';
$post_type = get_post_type( $post_id );
$order_type = $post_type ? $post_type : OrderUtil::get_order_type( $post_id );
if ( ! in_array( $order_type, $redirect_from_types, true ) || ! isset( $_GET['action'] ) ) {
return;
}
// Respect query args, except for 'post'.
$query_args = wp_unslash( $_GET );
$action = $query_args['action'];
unset( $query_args['post'], $query_args['_wpnonce'], $query_args['_wp_http_referer'], $query_args['action'] );
$new_url = '';
switch ( $action ) {
case 'edit':
$new_url = $this->page_controller->get_edit_url( $post_id );
break;
case 'trash':
case 'untrash':
case 'delete':
// Re-generate nonce if validation passes.
check_admin_referer( $action . '-post_' . $post_id );
$new_url = add_query_arg(
array(
'action' => $action,
'order' => array( $post_id ),
'_wp_http_referer' => $this->page_controller->get_orders_url(),
'_wpnonce' => wp_create_nonce( 'bulk-orders' ),
),
$this->page_controller->get_orders_url()
);
break;
default:
break;
}
if ( ! $new_url ) {
return;
}
$new_url = add_query_arg( $query_args, $new_url );
wp_safe_redirect( $new_url, 301 );
exit;
}
/**
* Rewrites legacy post type menu items to point to the HPOS orders page when the main WooCommerce menu is not visible.
*
* @since 10.3.0
*/
private function maybe_update_menu_items(): void {
global $pagenow, $submenu;
// Do not conflict with CPT > HPOS redirection.
if ( 'edit.php' === $pagenow && in_array( $_GET['post_type'] ?? '', wc_get_order_types( 'admin-menu' ), true ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
return;
}
if ( \WC_Admin_Menus::can_view_woocommerce_menu_item() ) {
return;
}
$post_types = array_filter( array_map( 'get_post_type_object', wc_get_order_types( 'admin-menu' ) ) );
foreach ( $post_types as $post_type ) {
if ( ! current_user_can( $post_type->cap->edit_posts ) || ! isset( $submenu[ 'edit.php?post_type=' . $post_type->name ] ) ) {
continue;
}
$post_type_menu = &$submenu[ 'edit.php?post_type=' . $post_type->name ];
$menu_indexes = array_flip( array_map( fn( $x ) => $x[2], $post_type_menu ) );
// Rewrite URL for the legacy menu item.
$post_type_menu[ $menu_indexes[ 'edit.php?post_type=' . $post_type->name ] ][2] = $this->page_controller->get_base_page_url( $post_type->name );
// Hide the legacy "Add New" menu item.
unset( $post_type_menu[ $menu_indexes[ "post-new.php?post_type={$post_type->name}" ] ] );
}
}
}
PK [1]?[A [A Admin/Orders/PageController.phpnu current_action && ( ! isset( $this->order ) || ! $this->order ) ) {
wp_die( esc_html__( 'You attempted to edit an order that does not exist. Perhaps it was deleted?', 'woocommerce' ) );
}
if ( $this->order->get_type() !== $this->order_type ) {
wp_die( esc_html__( 'Order type mismatch.', 'woocommerce' ) );
}
if ( ! current_user_can( get_post_type_object( $this->order_type )->cap->edit_post, $this->order->get_id() ) && ! current_user_can( 'manage_woocommerce' ) ) {
wp_die( esc_html__( 'You do not have permission to edit this order.', 'woocommerce' ) );
}
if ( 'trash' === $this->order->get_status() ) {
wp_die( esc_html__( 'You cannot edit this item because it is in the Trash. Please restore it and try again.', 'woocommerce' ) );
}
}
/**
* Verify that user has permission to create order.
*
* @return void
*/
private function verify_create_permission() {
if ( ! current_user_can( get_post_type_object( $this->order_type )->cap->publish_posts ) && ! current_user_can( 'manage_woocommerce' ) ) {
wp_die( esc_html__( 'You don\'t have permission to create a new order.', 'woocommerce' ) );
}
if ( isset( $this->order ) ) {
$this->verify_edit_permission();
}
}
/**
* Claims the lock for the order being edited/created (unless it belongs to someone else).
* Also handles the 'claim-lock' action which allows taking over the order forcefully.
*
* @return void
*/
private function handle_edit_lock() {
if ( ! $this->order ) {
return;
}
$edit_lock = wc_get_container()->get( EditLock::class );
$locked = $edit_lock->is_locked_by_another_user( $this->order );
// Take over order?
if ( ! empty( $_GET['claim-lock'] ) && wp_verify_nonce( $_GET['_wpnonce'] ?? '', 'claim-lock-' . $this->order->get_id() ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.ValidatedSanitizedInput.MissingUnslash
$edit_lock->lock( $this->order );
wp_safe_redirect( $this->get_edit_url( $this->order->get_id() ) );
exit;
}
if ( ! $locked ) {
$edit_lock->lock( $this->order );
}
add_action(
'admin_footer',
function() use ( $edit_lock ) {
$edit_lock->render_dialog( $this->order );
}
);
}
/**
* Sets up the page controller, including registering the menu item.
*
* @return void
*/
public function setup(): void {
global $plugin_page, $pagenow;
$this->redirection_controller = new PostsRedirectionController( $this );
// Register menu.
if ( 'admin_menu' === current_action() ) {
$this->register_menu();
} else {
add_action( 'admin_menu', 'register_menu', 9 );
}
// Not on an Orders page.
if ( empty( $plugin_page ) || 'admin.php' !== $pagenow || 0 !== strpos( $plugin_page, 'wc-orders' ) ) {
return;
}
$this->set_order_type();
$this->set_action();
$page_suffix = ( 'shop_order' === $this->order_type ? '' : '--' . $this->order_type );
$page_name = ( \WC_Admin_Menus::can_view_woocommerce_menu_item() ? 'woocommerce_page_wc-orders' : 'admin_page_wc-orders' ) . $page_suffix;
add_action( "load-{$page_name}", array( $this, 'handle_load_page_action' ) );
add_action( 'admin_title', array( $this, 'set_page_title' ) );
}
/**
* Perform initialization for the current action.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function handle_load_page_action() {
$screen = get_current_screen();
$screen->post_type = $this->order_type;
if ( method_exists( $this, 'setup_action_' . $this->current_action ) ) {
$this->{"setup_action_{$this->current_action}"}();
}
}
/**
* Set the document title for Orders screens to match what it would be with the shop_order CPT.
*
* @param string $admin_title The admin screen title before it's filtered.
*
* @return string The filtered admin title.
*
* @internal For exclusive usage of WooCommerce core, backwards compatibility not guaranteed.
*/
public function set_page_title( $admin_title ) {
if ( ! $this->is_order_screen( $this->order_type ) ) {
return $admin_title;
}
$wp_order_type = get_post_type_object( $this->order_type );
$labels = get_post_type_labels( $wp_order_type );
if ( $this->is_order_screen( $this->order_type, 'list' ) ) {
$admin_title = sprintf(
// translators: 1: The label for an order type 2: The name of the website.
esc_html__( '%1$s ‹ %2$s — WordPress', 'woocommerce' ),
esc_html( $labels->name ),
esc_html( get_bloginfo( 'name' ) )
);
} elseif ( $this->is_order_screen( $this->order_type, 'edit' ) ) {
$admin_title = sprintf(
// translators: 1: The label for an order type 2: The title of the order 3: The name of the website.
esc_html__( '%1$s #%2$s ‹ %3$s — WordPress', 'woocommerce' ),
esc_html( $labels->edit_item ),
absint( $this->order->get_id() ),
esc_html( get_bloginfo( 'name' ) )
);
} elseif ( $this->is_order_screen( $this->order_type, 'new' ) ) {
$admin_title = sprintf(
// translators: 1: The label for an order type 2: The name of the website.
esc_html__( '%1$s ‹ %2$s — WordPress', 'woocommerce' ),
esc_html( $labels->add_new_item ),
esc_html( get_bloginfo( 'name' ) )
);
}
return $admin_title;
}
/**
* Determines the order type for the current screen.
*
* @return void
*/
private function set_order_type() {
global $plugin_page;
$this->order_type = str_replace( array( 'wc-orders--', 'wc-orders' ), '', $plugin_page );
$this->order_type = empty( $this->order_type ) ? 'shop_order' : $this->order_type;
$wc_order_type = wc_get_order_type( $this->order_type );
$wp_order_type = get_post_type_object( $this->order_type );
if ( ! $wc_order_type || ! $wp_order_type || ! $wp_order_type->show_ui || ! current_user_can( $wp_order_type->cap->edit_posts ) ) {
wp_die();
}
}
/**
* Sets the current action based on querystring arguments. Defaults to 'list_orders'.
*
* @return void
*/
private function set_action(): void {
switch ( isset( $_GET['action'] ) ? sanitize_text_field( wp_unslash( $_GET['action'] ) ) : '' ) {
case 'edit':
$this->current_action = 'edit_order';
break;
case 'new':
$this->current_action = 'new_order';
break;
default:
$this->current_action = 'list_orders';
break;
}
}
/**
* Registers the "Orders" menu.
*
* @return void
*/
public function register_menu(): void {
$order_types = wc_get_order_types( 'admin-menu' );
foreach ( $order_types as $order_type ) {
$post_type = get_post_type_object( $order_type );
add_submenu_page(
\WC_Admin_Menus::can_view_woocommerce_menu_item() ? 'woocommerce' : 'admin.php',
$post_type->labels->name,
$post_type->labels->menu_name,
$post_type->cap->edit_posts,
'wc-orders' . ( 'shop_order' === $order_type ? '' : '--' . $order_type ),
array( $this, 'output' )
);
}
// In some cases (such as if the authoritative order store was changed earlier in the current request) we
// need an extra step to remove the menu entry for the menu post type.
add_action(
'admin_init',
function() use ( $order_types ) {
foreach ( $order_types as $order_type ) {
remove_submenu_page( 'woocommerce', 'edit.php?post_type=' . $order_type );
}
}
);
}
/**
* Outputs content for the current orders screen.
*
* @return void
*/
public function output(): void {
switch ( $this->current_action ) {
case 'edit_order':
case 'new_order':
$this->order_edit_form->display();
break;
case 'list_orders':
default:
$this->orders_table->prepare_items();
$this->orders_table->display();
break;
}
}
/**
* Handles initialization of the orders list table.
*
* @return void
*/
private function setup_action_list_orders(): void {
$this->orders_table = wc_get_container()->get( ListTable::class );
$this->orders_table->setup(
array(
'order_type' => $this->order_type,
)
);
if ( $this->orders_table->current_action() ) {
$this->orders_table->handle_bulk_actions();
}
$this->strip_http_referer();
}
/**
* Perform a redirect to remove the `_wp_http_referer` and `_wpnonce` strings if present in the URL (see also
* wp-admin/edit.php where a similar process takes place), otherwise the size of this field builds to an
* unmanageable length over time.
*/
private function strip_http_referer(): void {
$current_url = esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) );
$stripped_url = remove_query_arg( array( '_wp_http_referer', '_wpnonce' ), $current_url );
if ( $stripped_url !== $current_url ) {
wp_safe_redirect( $stripped_url );
exit;
}
}
/**
* Prepares the order edit form for creating or editing an order.
*
* @see \Automattic\WooCommerce\Internal\Admin\Orders\Edit.
* @since 8.1.0
*/
private function prepare_order_edit_form(): void {
if ( ! $this->order || ! in_array( $this->current_action, array( 'new_order', 'edit_order' ), true ) ) {
return;
}
$this->order_edit_form = $this->order_edit_form ?? new Edit();
$this->order_edit_form->setup( $this->order );
$this->order_edit_form->set_current_action( $this->current_action );
}
/**
* Handles initialization of the orders edit form.
*
* @return void
*/
private function setup_action_edit_order(): void {
global $theorder;
$this->order = wc_get_order( absint( isset( $_GET['id'] ) ? $_GET['id'] : 0 ) );
$this->verify_edit_permission();
$this->handle_edit_lock();
$theorder = $this->order;
$this->prepare_order_edit_form();
}
/**
* Handles initialization of the orders edit form with a new order.
*
* @return void
*/
private function setup_action_new_order(): void {
global $theorder;
$this->verify_create_permission();
$order_class_name = wc_get_order_type( $this->order_type )['class_name'];
if ( ! $order_class_name || ! class_exists( $order_class_name ) ) {
wp_die();
}
$this->order = new $order_class_name();
$this->order->set_object_read( false );
$this->order->set_status( 'auto-draft' );
$this->order->set_created_via( 'admin' );
$this->order->save();
$this->handle_edit_lock();
// Schedule auto-draft cleanup. We re-use the WP event here on purpose.
if ( ! wp_next_scheduled( 'wp_scheduled_auto_draft_delete' ) ) {
wp_schedule_event( time(), 'daily', 'wp_scheduled_auto_draft_delete' );
}
$theorder = $this->order;
$this->prepare_order_edit_form();
}
/**
* Returns the current order type.
*
* @return string
*/
public function get_order_type() {
return $this->order_type;
}
/**
* Helper method to generate a link to the main orders screen.
*
* @return string Orders screen URL.
*/
public function get_orders_url(): string {
return wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled() ?
admin_url( 'admin.php?page=wc-orders' ) :
admin_url( 'edit.php?post_type=shop_order' );
}
/**
* Helper method to generate edit link for an order.
*
* @param int $order_id Order ID.
*
* @return string Edit link.
*/
public function get_edit_url( int $order_id ) : string {
if ( ! wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled() ) {
return admin_url( 'post.php?post=' . absint( $order_id ) ) . '&action=edit';
}
$order = wc_get_order( $order_id );
// Confirm we could obtain the order object (since it's possible it will not exist, due to a sync issue, or may
// have been deleted in a separate concurrent request).
if ( false === $order ) {
wc_get_logger()->debug(
sprintf(
/* translators: %d order ID. */
__( 'Attempted to determine the edit URL for order %d, however the order does not exist.', 'woocommerce' ),
$order_id
)
);
$order_type = 'shop_order';
} else {
$order_type = $order->get_type();
}
try {
$base_url = $this->get_base_page_url( $order_type );
} catch ( \Exception $e ) {
return '';
}
return add_query_arg(
array(
'action' => 'edit',
'id' => absint( $order_id ),
),
$base_url
);
}
/**
* Helper method to generate a link for creating order.
*
* @param string $order_type The order type. Defaults to 'shop_order'.
* @return string
*/
public function get_new_page_url( $order_type = 'shop_order' ) : string {
$url = wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled() ?
add_query_arg( 'action', 'new', $this->get_base_page_url( $order_type ) ) :
admin_url( 'post-new.php?post_type=' . $order_type );
return $url;
}
/**
* Helper method to generate a link to the main screen for a custom order type.
*
* @param string $order_type The order type.
*
* @return string
*
* @throws \Exception When an invalid order type is passed.
*/
public function get_base_page_url( $order_type ): string {
$order_types_with_ui = wc_get_order_types( 'admin-menu' );
if ( ! in_array( $order_type, $order_types_with_ui, true ) ) {
// translators: %s is a custom order type.
throw new \Exception( sprintf( __( 'Invalid order type: %s.', 'woocommerce' ), esc_html( $order_type ) ) );
}
return admin_url( 'admin.php?page=wc-orders' . ( 'shop_order' === $order_type ? '' : '--' . $order_type ) );
}
/**
* Helper method to check if the current admin screen is related to orders.
*
* @param string $type Optional. The order type to check for. Default shop_order.
* @param string $action Optional. The purpose of the screen to check for. 'list', 'edit', or 'new'.
* Leave empty to check for any order screen.
*
* @return bool
*/
public function is_order_screen( $type = 'shop_order', $action = '' ) : bool {
if ( ! did_action( 'current_screen' ) ) {
wc_doing_it_wrong(
__METHOD__,
sprintf(
// translators: %s is the name of a function.
esc_html__( '%s must be called after the current_screen action.', 'woocommerce' ),
esc_html( __METHOD__ )
),
'7.9.0'
);
return false;
}
$valid_types = wc_get_order_types( 'view-order' );
if ( ! in_array( $type, $valid_types, true ) ) {
wc_doing_it_wrong(
__METHOD__,
sprintf(
// translators: %s is the name of an order type.
esc_html__( '%s is not a valid order type.', 'woocommerce' ),
esc_html( $type )
),
'7.9.0'
);
return false;
}
if ( wc_get_container()->get( CustomOrdersTableController::class )->custom_orders_table_usage_is_enabled() ) {
if ( $action ) {
switch ( $action ) {
case 'edit':
$is_action = 'edit_order' === $this->current_action;
break;
case 'list':
$is_action = 'list_orders' === $this->current_action;
break;
case 'new':
$is_action = 'new_order' === $this->current_action;
break;
default:
$is_action = false;
break;
}
}
$type_match = $type === $this->order_type;
$action_match = ! $action || $is_action;
} else {
$screen = get_current_screen();
if ( $action ) {
switch ( $action ) {
case 'edit':
$screen_match = 'post' === $screen->base && filter_input( INPUT_GET, 'post', FILTER_VALIDATE_INT );
break;
case 'list':
$screen_match = 'edit' === $screen->base;
break;
case 'new':
$screen_match = 'post' === $screen->base && 'add' === $screen->action;
break;
default:
$screen_match = false;
break;
}
}
$type_match = $type === $screen->post_type;
$action_match = ! $action || $screen_match;
}
return $type_match && $action_match;
}
}
PK [1]PF Admin/Orders/ListTable.phpnu 'order',
'plural' => 'orders',
'ajax' => false,
)
);
}
/**
* Init method, invoked by DI container.
*
* @internal This method is not intended to be used directly (except for testing).
* @param PageController $page_controller Page controller instance for this request.
*/
final public function init( PageController $page_controller ) {
$this->page_controller = $page_controller;
}
/**
* Performs setup work required before rendering the table.
*
* @param array $args Args to initialize this list table.
*
* @return void
*/
public function setup( $args = array() ): void {
$this->order_type = $args['order_type'] ?? 'shop_order';
$this->wp_post_type = get_post_type_object( $this->order_type );
add_action( 'admin_notices', array( $this, 'bulk_action_notices' ) );
add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 );
add_filter( 'set_screen_option_edit_' . $this->order_type . '_per_page', array( $this, 'set_items_per_page' ), 10, 3 );
add_filter( 'default_hidden_columns', array( $this, 'default_hidden_columns' ), 10, 2 );
add_action( 'admin_footer', array( $this, 'enqueue_scripts' ) );
add_action( 'woocommerce_order_list_table_restrict_manage_orders', array( $this, 'created_via_filter' ) );
add_action( 'woocommerce_order_list_table_restrict_manage_orders', array( $this, 'customers_filter' ) );
$this->items_per_page();
set_screen_options();
add_action( 'manage_' . wc_get_page_screen_id( $this->order_type ) . '_custom_column', array( $this, 'render_column' ), 10, 2 );
}
/**
* Generates content for a single row of the table.
*
* @since 7.8.0
*
* @param \WC_Order $order The current order.
*/
public function single_row( $order ) {
/**
* Filters the list of CSS class names for a given order row in the orders list table.
*
* @since 7.8.0
*
* @param string[] $classes An array of CSS class names.
* @param \WC_Order $order The order object.
*/
$css_classes = apply_filters(
'woocommerce_' . $this->order_type . '_list_table_order_css_classes',
array(
'order-' . $order->get_id(),
'type-' . $order->get_type(),
'status-' . $order->get_status(),
),
$order
);
$css_classes = array_unique( array_map( 'trim', $css_classes ) );
// Is locked?
$edit_lock = wc_get_container()->get( EditLock::class );
if ( $edit_lock->is_locked_by_another_user( $order ) ) {
$css_classes[] = 'wp-locked';
}
echo '