opcache_reset - PHP code example

OPcache and the PHP Function opcache_Reset

The OPcache extension implements various functionality to speed up PHP in a transparent manner. This includes opcode caching, an optimizer, and a just-in-time compiler. This article will focus on opcode caching.

The primary function of opcache is to cache compilation artifacts in shared memory, so that they are available the next time PHP needs to execute a script, eliminating the need to recompile the script. This improves performance drastically.

When a script is loaded, the compilation of the class is done as usual, except that it will only be cached if all its dependencies are also present. Inheritance is handled by opcache in a similar fashion as normal, and preloading supports complicated inheritance scenarios (including variance cycles).

On Unix-like systems opcache maintains a single fixed-size SHM segment, which is shared between all processes that make use of it. However, opcache doesn't necessarily guarantee that the address of internal functions/classes will be the same in each process, as the engine implementation may change the addresses used.

To work around this, opcache uses a file cache fallback that is enabled by default. This allows the cached artifacts to be used by all processes, but it has the disadvantage that it requires a write lock to be maintained.

To avoid the overhead of locking, opcache implements a simple API for invalidating an individual script from the opcode cache. The opcache_invalidate() function takes two arguments: the path of the script to be invalidated, and the optional argument force. The function will return TRUE if the script has been invalidated, or FALSE if there is no need to invalidate it. In some cases, it might be necessary to clear the opcode cache manually. For example, when deploying a new version of an application. In such a scenario, it is recommended to use the opcache_reset() function.

opcache_reset example

namespace Shopware\Recovery\Common;

class Utils
{
    /** * Clear opcode caches to make sure that the * updated files are used in the following requests. */
    public static function clearOpcodeCache()
    {
        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        if (\function_exists('apcu_clear_cache')) {
            apcu_clear_cache();
        }
    }

    /** * @param \Slim\Slim $app * * @return $this */

// Clear Shopware Proxies / Classmaps / Container         $this->clearDirectory($this->hookProxyDir);

        // Clear Annotation file cache         $this->clearDirectory($this->modelProxyDir);
    }

    public function clearOpCache()
    {
        if (\extension_loaded('Zend OPcache') && \ini_get('opcache.enable')) {
            opcache_reset();
        }
    }

    /** * Returns cache information * * @param Enlight_Controller_Request_Request|null $request * * @return array */
    public function getHttpCacheInfo($request = null)
    {

        if (!$fs->exists($htaccessFile)) {
            $fs->copy(\dirname(__DIR__) . '/Resources/install-template/htaccess', $htaccessFile);
        }

        $self = $_SERVER['SCRIPT_FILENAME'];
        \assert(\is_string($self));

        // Below this line call only php native functions as we deleted our own files already         unlink($self);

        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        exit;
    }
}

<?php declare(strict_types=1);

error_reporting(-1);

ignore_user_abort(true);

if (\function_exists('opcache_reset')) {
    opcache_reset();
}

if (function_exists('ini_set')) {
    @ini_set('display_errors', '1');
    @ini_set('display_startup_errors', '1');
    @ini_set('opcache.enable', '0');
    @ini_set('opcache.enable_cli', '0');
    @ini_set('max_execution_time', '300');
}

if (\PHP_VERSION_ID < 80100) {

return explode(\DIRECTORY_SEPARATOR, (string) $entry['name'])[0];
    }

    /** * Clear opcode caches to make sure that the * updated plugin files are used in the following requests. */
    private function clearOpcodeCache(): void
    {
        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        if (\function_exists('apcu_clear_cache')) {
            apcu_clear_cache();
        }
    }

    private function assertPrefix(string $filename, string $prefix): void
    {
        if (mb_strpos($filename, $prefix) !== 0) {
            throw new PluginExtractionException(

return $token;
    }

    /** * Clear opcode caches to make sure that the * updated plugin files are used in the following requests. */
    private function clearOpcodeCache()
    {
        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        if (\function_exists('apcu_clear_cache')) {
            apcu_clear_cache();
        }
    }

    /** * @param PluginStruct|LicenceStruct $plugin * * @throws RuntimeException * * @return PluginStruct */

return implode('/', [$segments[0], $segments[1]]);
    }

    /** * Clear opcode caches to make sure that the * updated plugin files are used in the following requests. */
    private function clearOpcodeCache()
    {
        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        if (\function_exists('apcu_clear_cache')) {
            apcu_clear_cache();
        }
    }

    /** * @param string $filename * @param string $prefix */

return explode('/', $entry['name'])[0];
    }

    /** * Clear opcode caches to make sure that the * updated plugin files are used in the following requests. */
    private function clearOpcodeCache(): void
    {
        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        if (\function_exists('apcu_clear_cache')) {
            apcu_clear_cache();
        }
    }

    private function assertPrefix(string $filename, string $prefix): void
    {
        if (strpos($filename, $prefix) !== 0) {
            throw new RuntimeException(sprintf('Detected invalid file/directory %s in the plugin zip: %s', $filename, $prefix));
        }

'--no-ansi',
            '--no-scripts',
            '-v',
            '--with-all-dependencies', // update all packages         ]);
    }

    #[Route('/update/_reset_config', name: 'update_reset_config', methods: ['POST'])]     public function resetConfig(Request $request): Response
    {
        if (\function_exists('opcache_reset')) {
            opcache_reset();
        }

        $shopwarePath = $this->recoveryManager->getShopwareLocation();

        $this->patchSymfonyFlex($shopwarePath);

        return $this->streamedCommandResponseGenerator->runJSON([
            $this->recoveryManager->getPhpBinary($request),
            '-dmemory_limit=1G',
            $this->recoveryManager->getBinary(),
            '-d',