Cache Options

This page lists all of the TubePress options that apply to server-side caching.

API Cache

Option name cacheCleaningFactor
Description Defines how often TubePress will perform a full flush of its API cache. If you enter x, the API cache will be flushed every 1/x cache writes. Enter 0 to disable all cache flushing.
Default value 20
Valid values Any non-negative integer
Example shortcode
[tubepress cacheCleaningFactor="0"]
Example in PHP
<?php TubePressPro::getHTML('cacheCleaningFactor="0"');
Option name cacheDirectory
Description The absolute filesystem path of a directory on your web server where TubePress can store the API cache contents. This directory must be writable by the PHP process owner. If this option is left empty, TubePress will attempt to find and use the system temporary directory.
Default value empty
Valid values An absolute filesystem path of a writeable (by the PHP process owner) directory on the web server, or empty.
Example shortcode
[tubepress cacheDirectory="/tmp/tubepress-cache"]
Example in PHP
<?php TubePressPro::getHTML('cacheDirectory="/tmp/tubepress-cache"');
Option name cacheEnabled
Description Enables or disables the TubePress API cache. You should always leave the cache enabled unless you are debugging.
Default value true
Valid values true or false
Example shortcode
[tubepress cacheEnabled="false"]
Example in PHP
<?php TubePressPro::getHTML('cacheEnabled="false"');
Option name cacheLifetimeSeconds
Description How long, in seconds, before an item in the TubePress API cache is considered to be stale.
Default value 21600 (six hours)
Valid values Any positive integer
Example shortcode
[tubepress cacheLifetimeSeconds="300"]
Example in PHP
<?php TubePressPro::getHTML('cacheLifetimeSeconds="300"');

HTML Cache

Option name htmlCacheCleaningFactor
Description Defines how often TubePress will perform a full flush of its HTML cache. If you enter x, the HTML cache will be flushed every 1/x cache writes. Enter 0 to disable all cache flushing.
Default value 100
Valid values Any non-negative integer
Example shortcode
[tubepress htmlCacheCleaningFactor="300"]
Example in PHP
<?php TubePressPro::getHTML('htmlCacheCleaningFactor="300"');
Option name htmlCacheCleaningKey
Description The name of the HTTP request parameter that, when set to true, can remotely flush the cache. For instance, if you enter foobar, then adding ?foobar=true to the end of a URL would remotely trigger a clear of the HTML cache.
Default value tubepress_clear_html_cache
Valid values Any string of word characters (alphanumerics, underscores, and hyphens)
Example shortcode
[tubepress htmlCacheCleaningKey="somekey"]
Example in PHP
<?php TubePressPro::getHTML('htmlCacheCleaningKey="somekey"');
Option name htmlCacheDirectory
Description The absolute filesystem path of a directory on your web server where TubePress can store the HTML cache contents. This directory must be writable by the PHP process owner. If this option is left empty, TubePress will attempt to find and use the system temporary directory.
Default value empty
Valid values An absolute filesystem path of a writeable (by the PHP process owner) directory on the web server, or empty.
Example shortcode
[tubepress htmlCacheDirectory="/tmp/tubepress-cache"]
Example in PHP
<?php TubePressPro::getHTML('htmlCacheDirectory="/tmp/tubepress-cache"');
Option name htmlCacheEnabled
Description Enables or disables the TubePress HTML cache. You should always leave the cache enabled unless you are debugging.
Default value true
Valid values true or false
Example shortcode
[tubepress htmlCacheEnabled="false"]
Example in PHP
<?php TubePressPro::getHTML('htmlCacheEnabled="false"');
Option name htmlCacheLifetimeSeconds
Description How long, in seconds, before an item in the TubePress HTML cache is considered to be stale.
Default value 21600 (six hours)
Valid values Any positive integer
Example shortcode
[tubepress htmlCacheLifetimeSeconds="300"]
Example in PHP
<?php TubePressPro::getHTML('htmlCacheLifetimeSeconds="300"');


Last Updated Apr 07, 2016 12:47PM PDT
c65861bf7a72e1a8878bdf73cabbbdbf@tubepress.desk-mail.com
http://assets2.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete