Steve Hanlon
6dd050ea1d
Wholesale rename to avoid clashes with generic 'site healthcheck' plugin names on a target site: - Plugin Name: 'Site Healthcheck' → 'ATT Site Healthcheck' - Main file: site-healthcheck.php → att-site-healthcheck.php - Plugin folder: site-healthcheck → att-site-healthcheck - Admin menu slug: site-healthcheck → att-site-healthcheck - Settings slug: site-healthcheck-settings → att-site-healthcheck-settings - PHP class prefix: WPH_ → ATT_HC_ - Function prefix: wph_ → att_hc_ - Option / transient: wph_* → att_hc_* - Action/filter: wph_* → att_hc_* - CSS class prefix: wph- → att-hc- - Constants: WPH_GITEA_* → ATT_HC_GITEA_* - Class file names: class-wph-*.php → class-att-hc-*.php - Dev folder: ~/dev/wp-healthcheck → ~/dev/att-site-healthcheck Existing in-progress sessions on installs that had the old wph_session option will not migrate — they were intended for dev use only and the user has confirmed this is OK for the rename window. Smoke-tested on testsite: classes load, 14 steps discovered, save/load round-trip works, admin page renders with new att-hc- CSS classes. Recovery plugin detection unchanged — that lives in wp-site-recovery and continues to be detected by Name + Author header.
62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# Site Healthcheck
|
|
|
|
Internal WordPress plugin that walks a technician through a structured healthcheck. Companion to [`wp-site-recovery`](../wp-site-recovery/), which it expects to be installed as step 0.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
ln -s ~/dev/wp-healthcheck /path/to/wp/wp-content/plugins/att-site-healthcheck
|
|
```
|
|
|
|
Then activate from *Plugins*. Settings appear under *Tools → Site Healthcheck*.
|
|
|
|
## Use
|
|
|
|
1. Open *Tools → Site Healthcheck*.
|
|
2. Confirm the recovery plugin status panel shows ✓ active.
|
|
3. Click **Start new healthcheck**.
|
|
4. Work through each step card. For each: choose a status (done / skipped / blocked / n/a) and add notes.
|
|
5. Click **Finish & generate report**.
|
|
6. Download the Markdown report or copy it to clipboard.
|
|
|
|
One in-progress session per site at a time. Reports are not stored in the database (the plugin is meant to be uninstalled at the end of each engagement) — download them.
|
|
|
|
## Adding, removing, reordering steps
|
|
|
|
Each step is a single file under `includes/steps/` named `<order>-<slug>.php`.
|
|
|
|
```php
|
|
<?php
|
|
// includes/steps/45-staging.php
|
|
return new class extends ATT_HC_Step {
|
|
public function id(): string { return 'staging'; }
|
|
public function title(): string { return 'Step 4.5 — Verify Staging Sync'; }
|
|
public function sub_items(): array {
|
|
return ['Re-deploy from production', 'Run smoke tests'];
|
|
}
|
|
};
|
|
```
|
|
|
|
- **Add:** drop a new file.
|
|
- **Remove:** delete the file.
|
|
- **Reorder:** rename the numeric prefix (steps are loaded in `natsort` order).
|
|
- **Conditionally drop on one install:** use the `att_hc_steps` filter to `unset` the step by id.
|
|
|
|
Stable string IDs (returned by `id()`) are what's stored in session data, so renaming a file does not break in-progress sessions as long as the id stays the same.
|
|
|
|
## Phase roadmap
|
|
|
|
Phase 1 (this) is a checklist + Markdown report. Phase 3 will add per-step automation — backup detection, env auto-collect, plugin update intelligence, PageSpeed Insights, SSL checks, etc. See beads epic `hc-5ix` for the full plan.
|
|
|
|
## Distribution
|
|
|
|
Internal/agency tool — not a WP.org plugin (decision `hc-5ix.26`). Distributed as a built ZIP. A self-hosted update channel is `hc-5ix.27` on the phase-3 backlog.
|
|
|
|
## Tracking
|
|
|
|
```sh
|
|
cd ~/dev/wp-healthcheck
|
|
bd list --label phase-1 # MVP work
|
|
bd list --label phase-3 # automation backlog
|
|
```
|