Extension hooks

Use these hooks when you are adding a reusable integration or changing one of Staatic’s extension points. If you only need a conditional crawl or URL rewrite decision, start with URL processing hooks instead.

Add crawl URL providers

staatic_crawl_url_providers

Filters the collection of crawl URL providers used to produce the initial crawl queue.

Use a provider when URLs need to be discovered from custom data, external APIs, plugin records, or another source that does not fit the Additional URLs setting.

Arguments:

Example:

use Staatic\Crawler\CrawlUrlProvider\AdditionalUrlCrawlUrlProvider;
use Staatic\Crawler\CrawlUrlProvider\AdditionalUrlCrawlUrlProvider\AdditionalUrl;
use Staatic\Crawler\CrawlUrlProvider\CrawlUrlProviderCollection;
use Staatic\WordPress\Publication\Publication;

add_filter( 'staatic_crawl_url_providers', function ( CrawlUrlProviderCollection $providers, Publication $publication ) {
    $providers->addProvider( new AdditionalUrlCrawlUrlProvider(
        [ new AdditionalUrl( 'https://www.example.com/special-page/' ) ],
        $publication->build()->entryUrl()
    ) );

    return $providers;
}, 10, 2 );

Add transformers

staatic_transformers

Filters the list of result transformers used while publication results are processed.

Transformers operate during result processing. Use them for systematic changes to generated resources, not for one-off URL decisions that can be handled by staatic_should_transform_url.

Arguments:

Example shape:

add_filter( 'staatic_transformers', function ( array $transformers, $publication ) {
    // $transformers[] = new MyCustomTransformer();
    return $transformers;
}, 10, 2 );

Add post-processors

staatic_post_processors

Filters the list of post-processors that run after crawling has finished.

Post-processors are a good fit for final build changes such as generated config files, redirects, duplicate cleanup, or deployment-target-specific files.

Arguments:

Example shape:

add_filter( 'staatic_post_processors', function ( array $postProcessors, $publication ) {
    // $postProcessors[] = new MyCustomPostProcessor();
    return $postProcessors;
}, 10, 2 );

Register deployment methods

Custom deployment methods usually need three pieces:

For the complete workflow, including settings, validation, strategy lifecycle, preview support, and no-deploy methods, see Custom deployment methods.

Preview support can be enabled with staatic_deployment_strategy_supports_preview.

staatic_deployment_methods

Arguments:

Example:

add_filter( 'staatic_deployment_methods', function ( array $deploymentMethods ) {
    $deploymentMethods['custom'] = 'Custom';
    return $deploymentMethods;
} );

staatic_deployment_strategy

Arguments:

Return false only when deployment tasks are intentionally inactive. Otherwise return an object implementing Staatic\Framework\DeployStrategy\DeployStrategyInterface for the selected deployment method.

Example shape:

use Staatic\WordPress\Publication\Publication;

add_filter( 'staatic_deployment_strategy', function ( $deployStrategy, Publication $publication ) {
    if ( get_option( 'staatic_deployment_method' ) !== 'custom' ) {
        return $deployStrategy;
    }

    // return new MyCustomDeployStrategy( $publication );
    return $deployStrategy;
}, 10, 2 );

staatic_deployment_strategy_validate

Arguments:

Example:

add_filter( 'staatic_deployment_strategy_validate', function ( array $errors, $publication ) {
    if ( get_option( 'staatic_deployment_method' ) === 'custom' && ! get_option( 'staatic_custom_token' ) ) {
        $errors[] = 'Custom deployment token is missing.';
    }

    return $errors;
}, 10, 2 );

staatic_deployment_strategy_supports_preview

Arguments:

Register settings

staatic_settings

Filters the registered settings grouped by setting group name.

Arguments:

Example shape:

add_filter( 'staatic_settings', function ( array $settings ) {
    // $settings['staatic-deployment'][] = new MyCustomSetting();
    return $settings;
} );

staatic_setting_groups

Filters the registered settings groups.

Arguments:

Deployment-specific helpers

These hooks are most useful when extending or tuning built-in deployment targets.

Other extension hooks

Example debug toggle:

add_filter( 'staatic_debug', '__return_true' );