class Detector::Php::Wordpress

Defined in:

detector/detectors/php/wordpress.cr

Constant Summary

WP_CORE_FILES = ["wp-config.php", "wp-load.php", "wp-settings.php", "wp-blog-header.php", "wp-cron.php"]

WordPress core bootstrap files. Their presence is unambiguous.

WP_SOURCE_MARKERS = ["register_rest_route", "WP_REST_Server", "WP_REST_Controller", "add_shortcode", "register_activation_hook", "register_deactivation_hook", "wp_enqueue_script", "wp_enqueue_style", "add_menu_page", "add_submenu_page", "get_template_directory", "wp_insert_post", "wp_get_current_user"]

Strong, WordPress-specific source markers. A generic PHP file that merely calls add_action is not enough — we require a marker that is effectively unique to WordPress core/plugin/theme code so we do not light up on every PHP project.

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?

Constructor methods inherited from class Detector

new(options : Hash(String, YAML::Any)) new

Instance Method Detail

def applicable?(filename : String) : Bool #
Description copied from class Detector

Cheap filename-only filter the detector pass uses to skip #detect on files the detector cannot possibly match. The default true preserves prior behavior (every detector runs on every file). Override with the same predicate the body of #detect starts with — e.g., filename.ends_with?(".py") for a Python framework detector — so the detector loop avoids the #detect dispatch on files outside the detector's language.

On large codebases (saleor's 4255 .py files) this lifts ~100 virtual #detect calls per file out of the hot loop because most detectors' inner first-line is exactly this kind of cheap filename check.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def set_name #

[View source]