An open API service indexing awesome lists of open source software.

https://github.com/prathushan/wp-site-inspector

A powerful admin-only tool that scans your active theme to list shortcodes, hooks, templates, APIs, post types, plugins used, and published content. Perfect for debugging and auditing complex or legacy WordPress projects.
https://github.com/prathushan/wp-site-inspector

code-mapping custom-post-types debugging developer-tools hook-inspector php plugin-development shortcode site-audit theme-audit theme-debugger theme-development wordpres-development wordpress wordpress-hooks wordpress-plugin wordpress-tools wp-cli

Last synced: 4 months ago
JSON representation

A powerful admin-only tool that scans your active theme to list shortcodes, hooks, templates, APIs, post types, plugins used, and published content. Perfect for debugging and auditing complex or legacy WordPress projects.

Awesome Lists containing this project

README

          

# πŸ› οΈ WP Site Inspector β€” Your WordPress Debug & Discovery Co-Pilot

**WP Site Inspector** is an open-source WordPress plugin for developers, freelancers, and agencies who need **instant insights** into what’s happening under the hood of any WordPress site.

Think of it as your site’s x-ray machine β€” mapping everything from shortcodes and hooks to REST APIs, templates, and logs.

> ⚑ No more digging through files. No more flying blind.

**πŸ‘‰ [⭐ Star us on GitHub](https://github.com/prathushan/WP-Site-Inspector)**
**🐞 [Report a Bug](https://github.com/prathushan/WP-Site-Inspector/issues)** Β· πŸ’‘ [Request a Feature](https://github.com/prathushan/WP-Site-Inspector/issues)

![Site Inspector Screenshot](./assets/site-inspector.png)

---

## ✨ Features

βœ… Scan active and parent themes β€” *no setup needed*
βœ… Instantly list shortcodes, hooks, templates, post types
βœ… View full file paths & line numbers
βœ… Detect REST API calls & CDN links
βœ… Display all published pages, posts & CPTs
βœ… Export results to `.xls`
βœ… Admin-only access with security best practices
βœ… Fatal error detection + email alerts
βœ… Built-in AI chatbot for log analysis *(BYOK)*
βœ… Multilingual UI: English, French, Spanish
βœ… One-click full site `.zip` backup

---

## πŸš€ Why Use It?

If you've ever said:

> β€œWhat’s even happening on this site?”
> β€œWhere is this shortcode defined?”
> β€œWhat template is this page using?”
> β€œWhich plugin is breaking the homepage?”

Then **WP Site Inspector** is made for you.

Perfect for debugging legacy projects, onboarding new ones, or simply understanding someone else’s codebase β€” this plugin gives you **superpowers**.

---

## πŸ” Use Cases

- 🧩 Auditing undocumented WP themes
- πŸ› οΈ Debugging custom features with clarity
- πŸ”„ Refactoring old code safely
- 🀝 Handoff-ready documentation
- πŸ“‹ Exporting a complete technical site map

**Ideal for:**
πŸ§‘β€πŸ’» Freelancers Β· πŸ§ͺ QA Engineers Β· 🏒 Agencies Β· πŸ’‘ WP Contributors Β· πŸ‘©β€πŸŽ“ Students

---

## πŸ€– Smarter Debugging with AI (NEW!)

Bring intelligence to your debug flow using **AI Code Assistant** and **Code AI** β€” both powered by your own API key (BYOK).

### πŸ” AI Code Assistant β€” Debug Smarter, Not Harder

![Ask AI Screenshot](./assets/Ask-AI.png)

Integrate with:

- πŸ”‘ OpenAI (ChatGPT)
- πŸ”‘ Anthropic (Claude)
- πŸ”‘ DeepSeek, Gemini, or OpenRouter-compatible models

Ask:

> β€œWhy did this error happen?”
> β€œWhich plugin triggered this warning?”
> β€œHow do I fix this deprecated function?”

🧠 It’s like **ChatGPT for your error logs** β€” secure, private, and built into WP.

---

### πŸ’» Code AI β€” Your AI Pair Programmer in WP

![Code AI Screenshot](./assets/Code-AI.png)

Directly inside your theme and plugin files β€” BYOK-powered.

- 🧩 Understand complex or legacy functions
- πŸ› οΈ Refactor outdated logic
- πŸ§ͺ Spot bugs and security issues
- ✍️ Generate WP-specific snippets
- πŸ” Evaluate logs inline

> Example queries:
> β€œWhat does this function do?”
> β€œRewrite this as a shortcode”
> β€œGenerate WP_Query for 5 products”

βš™οΈ Powered by **your choice of LLM** β€” no vendor lock-in.

![BYOK Illustration](./assets/byok.png)

---

## βœ… Unified BYOK Support

No subscriptions, no limits β€” just plug in your API key.

**Supported models:**

- OpenAI
- Anthropic
- DeepSeek
- OpenRouter

Your tools. Your rules.

---

## πŸ“€ One-Click xls Export

Export everything with a click β€” clean `.xls` format.

Great for:

- πŸ§ͺ QA teams
- 🧾 Client reports
- πŸ”§ Dev handoffs
- πŸ“ Project docs

---

## 🌍 Multilingual Ready

Currently supports:

- πŸ‡¬πŸ‡§ English
- πŸ‡«πŸ‡· French
- πŸ‡ͺπŸ‡Έ Spanish

UI adapts to your site’s language automatically β€” no setup needed.

---

## πŸ”„ One-Click Backup

Back up your entire site β€” files + DB β€” in one click.
Creates a downloadable `.zip`. No extra plugins needed.

---

## πŸ“¦ Coming Soon

- ⚑ AI-powered log auto-fix
- πŸ” Plugin folder scanner
- πŸ“ File/function filters
- πŸ§ͺ WP-CLI integration
- 🧠 AI-based fix suggestions
- πŸ—ƒοΈ Visual theme dependency map

---

## βš™οΈ How to Install

1. Download the `.zip` from GitHub
2. Go to `Plugins > Add New > Upload Plugin`
3. Upload and click **Install Now**, then **Activate**
4. Start inspecting via the WP Admin menu

---

## 🧠 Why We Built This

We created WP Site Inspector because:

- WordPress sites grow messy β€” fast
- Devs spend hours asking β€œWhat’s active and why?”
- Legacy code makes debugging painful

This plugin saves time, simplifies audits, and ensures smoother handoffs.
No fluff. No guesswork. Just answers.

---

## πŸ“ƒ License

Distributed under the MIT License.

---

## πŸ“¬ Contact

We’d love your feedback or contributions!

πŸ“§ Email: `prathusha.nammi@gmail.com`
πŸ› GitHub: [Open an issue](https://github.com/prathushan/WP-Site-Inspector/issues)

---

## πŸ™Œ Authors

**Made with ❀️ by [Prathusha](https://github.com/prathushan), [Prem](https://github.com/PremKumar-Softscripts), and [Vinay](https://github.com/v-i-nay)**

**Contributions welcome** πŸ‘‰ [Open a PR or feature request](https://github.com/prathushan/WP-Site-Inspector/issues)

---