Zend OPcache Configuration Directives

Configuration Directives Summary

Directive

Type

Modification Scope

Description

opcache.enable

boolean

PHP_INI_SYSTEM

OPcache On/Off switch. When set to Off, code is not optimized.

opcache.use_cwd

boolean

PHP_INI_SYSTEM

If set to On, use the current directory as a part of the script key

opcache.validate_timestamps

boolean

PHP_INI_ALL

If enabled, the OPcache checks the file timestamps and updates the cache accordingly.

opcache.revalidate_freq

integer

PHP_INI_ALL

How often to check file timestamps for changes to the shared memory storage allocation.

opcache.revalidate_path

boolean

PHP_INI_ALL

Enables or disables file search in include_path optimization

opcache.inherited_hack

boolean

PHP_INI_SYSTEM

Enable this hack as a workaround for "can't redeclare class" errors

opcache.dups_fix

boolean

PHP_INI_ALL

Enable this hack as a workaround for "duplicate definition" errors

opcache.log_verbosity_level

integer

PHP_INI_SYSTEM

The verbosity of the OPcache log

opcache.memory_consumption

integer

PHP_INI_SYSTEM

The OPcache shared memory storage size. The amount of memory for storing precompiled PHP code in Mbytes.

opcache.max_accelerated_files

integer

PHP_INI_SYSTEM

The maximum number of keys (scripts) in the OPcache hash table

opcache.max_wasted_percentage

integer

PHP_INI_SYSTEM

The maximum percentage of "wasted" memory until a restart is scheduled

opcache.consistency_checks

integer

PHP_INI_ALL

Check the cache checksum each N requests

opcache.force_restart_timeout

integer

PHP_INI_SYSTEM

How long to wait (in seconds) for a scheduled restart to begin if the cache is not being accessed

opcache.blacklist_filename

string

PHP_INI_SYSTEM

The location of the OPcache blacklist file

opcache.save_comments

boolean

PHP_INI_SYSTEM

If disabled, all PHPDoc comments are dropped from the code to reduce the size of the optimized code.

opcache.fast_shutdown

boolean

PHP_INI_SYSTEM

If enabled, a fast shutdown sequence is used for the accelerated code

opcache.optimization_level

integer

PHP_INI_SYSTEM

A bitmask, where each bit enables or disables the appropriate OPcache passes

opcache.enable_slow_optimizations

boolean

PHP_INI_SYSTEM

Enables or disables the optimization passes that may take significant time, based on an internal runtime calculation

opcache.enable_cli

boolean

PHP_INI_SYSTEM

Enables the opcode cache for the CLI version of PHP. This is mostly useful for testing and debugging.

opcache.error_log

string

PHP_INI_SYSTEM

The error log for OPcache errors.

opcache.file_update_protection

integer

PHP_INI_SYSTEM

Prevents caching files that are less than this number of seconds old.

opcache.load_comments

boolean

PHP_INI_SYSTEM

If disabled, documentation comments won't be loaded from the opcode cache even if they exist.

opcache.max_file_size

boolean

PHP_INI_SYSTEM

The maximum file size that will be cached, in bytes.

opcache.protect_memory

boolean

PHP_INI_SYSTEM

Protects shared memory from unexpected writes while executing scripts.

opcache.restrict_api

boolean

PHP_INI_SYSTEM

Use OPcache API only from path starting the specified string

External Configuration File: OPcache blacklist file

The OPcache blacklist file is a text file that holds the names of files that should not be accelerated. The file format is to add each filename to a new line. The filename may be a full path or just a file prefix (i.e., /var/www/x blacklists all the files and directories in /var/www that start with 'x'). Files are usually triggered by one of the following three reasons:

1) Directories that contain auto generated code, like Smarty or ZFW cache.

2) Code that does not work well when accelerated, due to some delayed compile time evaluation.

3) Code that triggers an OPcache bug.

Configuration Directive Details

opcache.enable

OPcache On/Off switch. When set to Off, code is not optimized.

Type: boolean

Default Value: 1

Available since version 4.0

opcache.use_cwd

When this directive is enabled, the OPcache appends the current working directory to the script key, thus elminating possible collisions between files with the same name (basename). Disablingthe directive improves performance, but may break existing applications.

Type: boolean

Default Value: 1

Available since version 4.0

opcache.validate_timestamps

When disabled, you must reset the OPcache manually or restart the webserver for changes to the filesystem to take effect.<br> The frequancy of the check is controlled by the directive "opcache.revalidate_freq"

Type: boolean

Default Value: 1

Available since version 4.0

opcache.revalidate_freq

How often to check file timestamps for changes to the shared memory storage allocation.

Type: integer

Units: seconds

Default Value: 2

Available since version 4.0

opcache.revalidate_path

If the file search is disabled and a cached file is found that uses the same include_path, the file is not searched again. Thus, if a file with the same name appears somewhere else in include_path, it won't be found. Enable this directive if this optimization has an effect on your applications. The default for this directive is disabled, which means that optimization is active.

Type: boolean

Default Value: 0

Available since version 4.0

opcache.inherited_hack

The OPcache stores the places where DECLARE_CLASS opcodes use inheritance (These are the only opcodes that can be executed by PHP, but which may not be executed because the parent class is missing due to optimization). When the file is loaded, OPcache tries to bind the inherited classes by using the current environment. The problem with this scenario is that, while the DECLARE_CLASS opcode may not be needed for the current script, if the script requires that the opcode at least be defined, it may not run. The default for this directive is disabled, which means that optimization is active.

Type: boolean

Default Value: 1

Available since version 4.0

opcache.dups_fix

Enable this hack as a workaround for "duplicate definition" errors

Type: boolean

Default Value: 0

Available since version 4.0

opcache.log_verbosity_level

All OPcache errors go to the Web server log.<br> By default, only fatal errors (level 0) or errors (level 1) are logged. You can also enable warnings (level 2), info messages (level 3) or debug messesges (level 4).<br> For "debug" binaries, the default log verbosity level is 4, not 1.

Type: integer

Default Value: 1

Available since version 4.0

opcache.memory_consumption

The OPcache shared memory storage size. The amount of memory for storing precompiled PHP code in Mbytes.

Type: integer

Units: MBytes

Default Value: 64

Available since version 4.0

opcache.max_accelerated_files

The number is actually the the first one in the following set of prime numbers that is bigger than the one supplied: { 223, 463, 983, 1979, 3907, 7963, 16229, 32531, 65407, 130987 }. Only numbers between 200 and 100000 are allowed.

Type: integer

Default Value: 2000

Available since version 4.0

opcache.max_wasted_percentage

The maximum percentage of "wasted" memory until a restart is scheduled

Type: integer

Units: %

Default Value: 5

Available since version 4.0

opcache.consistency_checks

The default value of "0" means that the checks are disabled. Because calculating the checksum impairs performance, this directive should be enabled only as part of a debugging process.

Type: integer

Default Value: 0

Available since version 4.0

opcache.force_restart_timeout

The OPcache uses this directive to identify a situation where there may be a problem with a process. After this time period has passed, the OPcache assumes that something has happened and starts killing the processes that still hold the locks that are preventing a restart. If the log level is 3 or above, a "killed locker" error is recorded in the Apache logs when this happens.

Type: integer

Units: seconds

Default Value: 180

Available since version 4.0

opcache.blacklist_filename

For additional information, see "Extermal Configuration File", above

Type: string

Available since version 4.0

opcache.save_comments

If disabled, all PHPDoc comments are dropped from the code to reduce the size of the optimized code.

Type: boolean

Default Value: 1

Available since version 4.0

opcache.fast_shutdown

The fast shutdown sequence doesn't free each allocated block, but lets the Zend Engine Memory Manager do the work.

Type: boolean

Default Value: 0

Available since version 4.0

opcache.optimization_level

A bitmask, where each bit enables or disables the appropriate OPcache features (where 0 is disabled and 1 is enabled).

Type: integer

Default Value: 0xfffffbbf

Available since version 4.0

 

The following is a list of each bit represented in the value :

opcache.enable_slow_optimizations

Enables or disables the optimization passes that may take significant time, based on an internal runtime calculation

Type: boolean

Default Value: 1

Available since version 4.0

opcache.enable_cli

Enables the opcode cache for the CLI version of PHP. This is mostly useful for testing and debugging.

Type: boolean

Default Value: 1

Available since version 6.3

opcache.error_log

The error log for OPcache errors. An empty string is treated the same as stderr, and will result in logs being sent to standard error (which will be the Web server error log in most cases).

Type: string

Available since version 6.3

opcache.file_update_protection

Prevents caching files that are less than this number of seconds old. It protects from caching of incompletely updated files. In case all file updates on your site are atomic, you may increase performance setting it to 0.

Type: integer

Default Value: 2

Available since version 6.3

opcache.load_comments

If disabled, documentation comments won't be loaded from the opcode cache even if they exist. This can be used with opcache.save_comments to only load comments for applications that require them.

Type: boolean

Default Value: 1

Available since version 6.3

opcache.max_file_size

The maximum file size that will be cached, in bytes. If this is 0, all files will be cached.

Type: integer

Default Value: 0

Available since version 6.3

opcache.protect_memory

Protects shared memory from unexpected writes while executing scripts. This is useful for internal debugging only.

Type: boolean

Default Value: 0

Available since version 6.3

opcache.restrict_api

Allows calling OPcache API functions only from PHP scripts which path is started from specified string. The default means no restriction.

Type: string

Default Value: 1

Available since version 6.3