>wc_version . $this->package->get_path() ); } /** * Initialize and load cached script data from the transient cache. * * @return array */ private function get_cached_script_data() { if ( $this->disable_cache ) { return []; } $transient_value = json_decode( (string) get_transient( $this->script_data_transient_key ), true ); if ( json_last_error() !== JSON_ERROR_NONE || empty( $transient_value ) || empty( $transient_value['script_data'] ) || empty( $transient_value['version'] ) || $transient_value['version'] !== $this->wc_version || empty( $transient_value['hash'] ) || $transient_value['hash'] !== $this->script_data_hash ) { return []; } return (array) ( $transient_value['script_data'] ?? [] ); } /** * Store all cached script data in the transient cache. */ public function update_script_data_cache() { if ( is_null( $this->script_data ) || $this->disable_cache ) { return; } set_transient( $this->script_data_transient_key, wp_json_encode( array( 'script_data' => $this->script_data, 'version' => $this->wc_version, 'hash' => $this->script_data_hash, ) ), DAY_IN_SECONDS * 30 ); } /** * Get src, version and dependencies given a script relative src. * * @param string $relative_src Relative src to the script. * @param array $dependencies Optional. An array of registered script handles this script depends on. Default empty array. * * @return array src, version and dependencies of the script. */ public function get_script_data( $relative_src, $dependencies = [] ) { if ( ! $relative_src ) { return array( 'src' => '', 'version' => '1', 'dependencies' => $dependencies, ); } if ( is_null( $this->script_data ) ) { $this->script_data = $this->get_cached_script_data(); } if ( empty( $this->script_data[ $relative_src ] ) ) { $asset_path = $this->package->get_path( str_replace( '.js', '.asset.php', $relative_src ) ); // The following require is safe because we are checking if the file exists and it is not a user input. // nosemgrep audit.php.lang.security.file.inclusion-arg. $asset = file_exists( $asset_path ) ? require $asset_path : []; $this->script_data[ $relative_src ] = array( 'src' => $this->get_asset_url( $relative_src ), 'version' => ! empty( $asset['version'] ) ? $asset['version'] : $this->get_file_version( $relative_src ), 'dependencies' => ! empty( $asset['dependencies'] ) ? $asset['dependencies'] : [], ); } // Return asset details as well as the requested dependencies array. return [ 'src' => $this->script_data[ $relative_src ]['src'], 'version' => $this->script_data[ $relative_src ]['version'], 'dependencies' => array_merge( $this->script_data[ $relative_src ]['dependencies'], $dependencies ), ]; } /** * Registers a script according to `wp_register_script`, adding the correct prefix, and additionally loading translations. * * When creating script assets, the following rules should be followed: * 1. All asset handles should have a `wc-` prefix. * 2. If the asset handle is for a Block (in editor context) use the `-block` suffix. * 3. If the asset handle is for a Block (in frontend context) use the `-block-frontend` suffix. * 4. If the asset is for any other script being consumed or enqueued by the blocks plugin, use the `wc-blocks-` prefix. * * @since 2.5.0 * @throws Exception If the registered script has a dependency on itself. * * @param string $handle Unique name of the script. * @param string $relative_src Relative url for the script to the path from plugin root. * @param array $dependencies Optional. An array of registered script handles this script depends on. Default empty array. * @param bool $has_i18n Optional. Whether to add a script translation call to this file. Default: true. */ public function register_script( $handle, $relative_src, $dependencies = [], $has_i18n = true ) { $script_data = $this->get_script_data( $relative_src, $dependencies ); if ( in_array( $handle, $script_data['dependencies'], true ) ) { if ( $this->package->feature()->is_development_environment() ) { $dependencies = array_diff( $script_data['dependencies'], [ $handle ] ); add_action( 'admin_notices', function() use ( $handle ) { echo '
'; /* translators: %s file handle name. */ printf( esc_html__( 'Script with handle %s had a dependency on itself which has been removed. This is an indicator that your JS code has a circular dependency that can cause bugs.', 'woocommerce' ), esc_html( $handle ) ); echo '