README

WordPress Link Checker is a command line tool that checks for broken links on a WordPress website.

Example

wp-check https://example.com

or via Docker:

docker compose run --rm wp-check https://example.com

Usage

wp-check <url> \
    [--user-agent=<user-agent>] \
    [--request-timeout=<positive-integer>] \
    [--response-status=<success|error>] ... \
    [--output-format=<text|csv|json>] \
    [--scan-elements=<links|images>] ... \
    [--exclude-type=<post-type>] ... \
    [--exclude-post=<post-link>] ...

Parameters

The <url> argument is the URL of the WordPress website to check for broken links.

NOTE: URL can include the authentication credentials in the form: https://user:password@example.com.

• --user-agent - parameter is used to set a custom user agent for the requests.
• --request-timeout - parameter is used to set a custom timeout for the requests in seconds (default: 5).
• --response-status - parameter is used to filter results by response status (options: success, error | default: error)
• --output-format - parameter is used to set the output format (options: text, csv, json | default: text).
• --scan-elements - parameter is used to specify which elements to scan (options: links, images | default: links).
• --exclude-type - parameter is used to exclude post types by slug from the check.
• --exclude-post - parameter is used to exclude posts by URL from the check.
• --verbose|-v - parameter is used to enable verbose output, which includes progress information about scanning pages and checking links.

Requirements

• PHP >=8.3

or:

• Docker

License

MIT