Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:preload

Warm the page caches of a site: request its section pages, then follow its links, and report the broken ones (dry run unless --apply).

Download as PDF

Address: https://doc.exponential.earth/learninminutes/exphelp/viewer/examples/commands/preload.md

On this page

exp:preload

Warm the page caches of a site: request its section pages, then follow its links, and report the broken ones (dry run unless --apply).

Script bin/php/preload.php, code in kernel/private/classes/commands/preload.php. Run it from the installation root, as the user the web server runs as:

./console exp:preload --help
php bin/php/preload.php --help

Help text

Exponential cache preloader

Requests the section pages of a site, then follows its links, so the caches are warm
before a visitor arrives, and reports the broken links with the pages that link to them.
The site is the one of --siteaccess (or --target). One preload runs at a time; the run is
listed in Setup > Preload.
Without --apply nothing is requested: the script prints the address, the starting pages and
the limits. --dry-run means the same as no flag; --apply together with --dry-run is a usage
error (exit 2).

Usage: php bin/php/preload.php --siteaccess=<name> [--max-pages=<n>] [--max-depth=<n>] [--images] [--apply]

Example: php bin/php/preload.php --siteaccess=site
         php bin/php/preload.php --siteaccess=site --apply

Options

OptionValueHelp
--applyrequest the pages (the default is a dry run that prints the plan and requests nothing)
--dry-run
--targetrequiredthe siteaccess whose site is preloaded (default: the one of --siteaccess)
--max-pagesrequiredmost pages to request (default
--max-depthrequired
--images

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).


Generated by ./console exp:help:examples from bin/php/preload.php, kernel/private/classes/commands/preload.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x