WP2Static Documentation

The integration test suite validates WP2Static's behavior using a real web server and database environment. The system spins up the following services:

• Web Servers: NGINX running on localhost:7000, localhost:7001, and localhost:7002.
• Database: MariaDB using the socket at mariadb/data/mysql.sock.
• PHP: PHP-FPM using the socket at php/fpm.sock.

Test Scenarios/Environments:

• Standard WordPress: Accessible at localhost:7000.
• Bedrock: Accessible at localhost:7001.
• WordPress with Basic Auth: Accessible at localhost:7002.

To set up the integration test environment, you must have Nix and direnv installed on your system.

1. Restart your shell.
2. Navigate to the integration tests directory.
3. Run direnv allow to trigger Nix to install the required dependencies.

Optimization options:

• Use nix-direnv for faster dependency loading.
• Use envrc.el if you are using Emacs for faster direnv integration.

WP2Static uses Composer scripts to manage its test suites. You can run linting, static analysis, unit tests, and integration tests using the following commands.

Note: Running coverage requires XDebug to be installed.

You can install WP2Static using several methods depending on your workflow:

• From source code: Clone the repository and run Composer to install dependencies.
• Via Composer: Add it to your project using the standard Composer require command.
• Installer Zip: Download a pre-built installer zip from the official website.
• Custom Build: Compile your own installer zip from the source code.

When instantiating SitemapParser, you can provide configuration options to control its behavior, specifically regarding HTTP requests and parsing strictness.

Constructor Signature

public function __construct( $user_agent = self::DEFAULT_USER_AGENT, array $config = [] )

Configuration Keys

• guzzle: An associative array used to pass configuration to the underlying `WP2StaticGuzzleHttp

` client. This is primarily used to set HTTP headers.

• guzzle['headers']['User-Agent']: Overrides the default User-Agent if not already set.
• strict: A boolean flag. If set to true, the parser will only attempt to parse line-separated text strings if they are valid XML sitemaps. If false (default), it may treat lines as individual URLs.

Note: The parser uses WP2StaticGuzzleHttp for requests and sets 'verify' => false by default for SSL verification.

Once the environment is set up via Nix and direnv, you can execute the test suite using the following command:

nix-shell --run "clojure -X:test"

After running the parser, you can extract the discovered data using the following methods:

• getSitemaps(): Returns an associative array of discovered sitemaps. The keys are the sitemap URLs, and the values are arrays containing metadata like loc and lastmod.
• getURLs(): Returns an associative array of all discovered URLs. The keys are the URL strings, and the values are arrays containing metadata such as loc, lastmod, changefreq, and priority.

You can modify or extend the core site information (paths and URLs) used by WP2Static by applying a filter to wp2static_siteinfo. This is useful if you need to override default paths for content, uploads, themes, or plugins during the plugin execution.

The filter provides an associative array containing keys for both paths and URLs. Note that paths are automatically standardized to use forward slashes (/) when retrieved via getPath().

Use the SiteInfo class to verify if the current WordPress environment meets the requirements for static generation:

• SiteInfo::isUploadsWritable(): bool: Checks if the uploads_path exists and is writable.
• SiteInfo::permallinksAreCompatible(): bool: Checks if the current WordPress permalink structure is compatible (specifically checking if it ends with a trailing slash).
• SiteInfo::hasCURLSupport(): bool: Checks if the curl PHP extension is loaded.