Home

Welcome to the wp-malware-scanner Wiki!

Welcome to the wp-malware-scanner wiki! This space serves as the central hub for all documentation related to the WP Malware Scanner project ([GitHub Docs]1, [GitHub]2). Designed for long-form content beyond the README, the wiki allows you to share detailed guides, architectural diagrams, and core principles of the tool ([GitHub Docs]3). The structure follows GitHub’s recommended best practices—providing initial context, logical ordering by importance, and concise paragraphs for readability ([GitHub Docs]4, [GitHub Docs]5).

What You’ll Find Here

• Project Overview: A clear outline of the scanner’s goals, components, and design philosophy ([GitHub]2)
• Installation & Quick Start: Step-by-step instructions to clone the repo, install dependencies, configure your environment, and run your first scan ([GitHub]2)
• Feature Reference: Detailed explanations of scanning modes, custom patterns, CLI flags (e.g., --exclude, --extensions, --virustotal), and the integrated email phishing detector ([GitHub]2)
• Roadmap & Changelog: Track upcoming enhancements, scheduled integrations like Aikido.dev, PDF/JSON reports, auto-clean research, and view historical release notes ([GitHub Docs]3, [GitHub Docs]6)
• Contribution Guidelines: Learn how to propose changes, submit pull requests, write unit tests, and adhere to the project’s style guides ([GitHub Docs]3)

How to Contribute

Since GitHub wikis are themselves Git repositories, every edit is versioned and auditable—view the history or revert changes at any time ([GitHub Docs]6). By default, repository collaborators can edit this wiki, but you’re welcome to suggest improvements via issues or by forking and submitting a pull request against the wiki repository ([GitHub Docs]6).

---

What is WP Malware Scanner?

WP Malware Scanner is a lightweight PHP-based security tool that inspects WordPress installations for common malicious code patterns such as <script>, eval(), base64_decode(), and document.write() ([GitHub]2, [GitHub Docs]5). It supports both web-based and command-line execution modes, offers custom regex pattern configuration, and integrates optionally with the VirusTotal API for external threat analysis ([GitHub]2). A companion Python-based phishing detector enables you to analyze email sender, recipient, subject, and body content through the same frontend interface ([GitHub]2).

How to Navigate This Wiki

Use the sidebar on the right to jump between pages; each page focuses on one topic for clarity and ease of discovery ([GitHub Docs]3). If you prefer working locally, clone the wiki repository with:

git clone https://github.com/Kvnbbg/wp-malware-scanner.wiki.git

make your edits, and push them back to GitHub ([GitHub Docs]6).