Documentation
ScraperBlock
Developer Reference

Developer Reference

Constants

ConstantValueDescription
SCRAPERBLOCK_VERSION1.0.0Plugin version
SCRAPERBLOCK_PLUGIN_FILE__FILE__Plugin main file path
SCRAPERBLOCK_PLUGIN_DIRplugin_dir_path()Plugin directory
SCRAPERBLOCK_PLUGIN_URLplugin_dir_url()Plugin URL

Filters

FilterArgumentsDescription
scraperblock_bot_blocklist$bots (array)Modify the full list of blocked user-agent strings
scraperblock_is_blocked$blocked (bool), $user_agent (string)Override block decision for a specific UA
scraperblock_rate_limit_threshold$limit (int), $ip (string)Override the rate limit for a specific IP
scraperblock_robots_txt_entries$entries (array)Modify robots.txt directives before output
scraperblock_meta_tags$tags (array)Modify meta AI tags before output

Actions

ActionArgumentsDescription
scraperblock_bot_blocked$user_agent (string), $ip (string), $reason (string)Fires when a request is blocked
scraperblock_rate_limit_hit$ip (string), $count (int)Fires when rate limit is exceeded

Options

Option KeyTypeDefaultDescription
scraperblock_settings[protection_enabled]string yes/noyesMaster toggle
scraperblock_settings[enable_robots_blocking]string yes/noyesrobots.txt directives
scraperblock_settings[enable_htaccess_blocking]string yes/nonohtaccess rules
scraperblock_settings[enable_meta_noai]string yes/noyesMeta noai tags
scraperblock_settings[enable_per_page_control]string yes/noyesPer-page editor box
scraperblock_settings[enable_rate_limit]string yes/noyesRate limiting
scraperblock_settings[requests_per_minute]int60Rate limit threshold