https://github.com/ericrasch/wp-cli-sheet-automation
This repository provides a structured and repeatable system for automating WordPress cleanup tasks — including post deletions, permalink updates, and search-replace operations — using WP-CLI commands generated directly from a Google Sheet.
https://github.com/ericrasch/wp-cli-sheet-automation
Last synced: 11 days ago
JSON representation
This repository provides a structured and repeatable system for automating WordPress cleanup tasks — including post deletions, permalink updates, and search-replace operations — using WP-CLI commands generated directly from a Google Sheet.
- Host: GitHub
- URL: https://github.com/ericrasch/wp-cli-sheet-automation
- Owner: ericrasch
- Created: 2025-04-18T14:41:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-18T19:24:12.000Z (about 1 year ago)
- Last Synced: 2025-04-19T07:48:09.869Z (about 1 year ago)
- Language: JavaScript
- Size: 290 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WP-CLI + Google Sheets: Automating WordPress URL Cleanup
## Overview
This repository provides a structured and repeatable system for automating WordPress cleanup tasks — including post deletions, permalink updates, and search-replace operations — using WP-CLI commands generated directly from a Google Sheet.
Google Apps Scripts are included to:
- Generate categorized `.sh` shell scripts from the spreadsheet
- Sort and group commands by type (delete, update, replace)
- Log all output and failures
- Streamline cleanup for large WordPress datasets across multiple domains
---
## 🔧 Features
- **Grouped Command Execution**:
- STEP 1: `wp post delete`
- STEP 2: `wp post update` (permalink updates)
- STEP 3: `wp search-replace` (internal links)
- **Command Resilience**:
- All commands wrapped in `run_or_log_fail` for error tolerance
- Failures are logged to `failed.log`
- **Sorting by Specificity**:
- Commands can be sorted by URL length to prioritize deep paths first
---
## 📊 Google Sheet Structure
| Column | Header | Purpose |
|--------|---------------------------------------------|-------------------------------------------------------------------------|
| A | URL | Original full URL |
| B | Action | Type of action: `301`, `410`, or `Keep` |
| C | New URL | Destination URL for 301 redirects; `N/A` if 410 |
| D | url: ORIG | Original relative path |
| E | url: NEW | New relative path |
| F | post ID | WordPress post ID if known |
| G | STEP 1: Remove unwanted posts (301/410) | Generates `wp post delete` command if action = 410 |
| H | STEP 2: Change Post URL | (Optional) Updates post URL metadata |
| I | STEP 3: Search/Replace URL | Updates internal links across database |
| J | STEP 4: URL Length Sort | Calculates length of `url: ORIG` |
| K | STEP 5: Combined CLI Command | Combines Steps 1 + 3 with newlines |
## 🧮 Google Sheets Formulas
**STEP 1: Remove Unwanted Posts (Column Y)**
```excel
=IF(Q2=410, IF(ISNUMBER(W2), "wp post delete " & W2 & " --force --allow-root", "MISSING"), "")
```
**STEP 2: Change Post URL (Column Z)**
```excel
=IF(AND($W2<>"", $Q2<>410), "wp post update " & $W2 & " --meta_input='{"custom_permalink":"" & $V2 & ""}' --allow-root", "")
```
**STEP 3: Search/Replace URL (Column AA)**
```excel
=IF(AND($U2<>"", $Q2<>410), "wp search-replace '" & $U2 & "' '" & $V2 & "' --all-tables --skip-tables=wp_redirection* --report-changed-only --precise --allow-root", "")
```
---
## 📂 File Layout
```bash
wp-cli-sheet-automation/
├── .gitignore
├── README.md
├── LICENSE
├── scripts/
│ └── downloadShellScript.gs # Apps Script to generate the bash file
├── docs/
│ └── sheet-setup.md # Full column breakdown + Reusable formulas and logic
├── examples/
│ └── WP-CLI_Cleanup_Example_Public.xlsx
```
---
## 🚀 Getting Started
1. Clone or download the repository.
2. Open the `WP-CLI_Cleanup_Example_Public.xlsx` sheet in `/examples/`.
3. Adjust your own data and formulas as needed in the same format.
---
## ▶️ Usage
1. Open your working Google Sheet.
2. Add the script in `/scripts/downloadShellScript.gs` to **Apps Script Editor**.
3. Run `downloadShellScript()` to generate a `.sh` script in your Drive.
4. Download the file and run it in your WordPress CLI environment:
```bash
chmod +x wp_cli_batch_YYYYMMDD_HHMMSS.sh
./wp_cli_batch_YYYYMMDD_HHMMSS.sh
```
---
## 📥 Example Output
```bash
#!/bin/bash
timestamp=$(date +"%Y%m%d_%H%M%S")
logfile="wp_cli_log_$timestamp.log"
exec > >(tee -i "$logfile")
exec 2>&1
echo "=== Starting WP-CLI Batch Processing ==="
run_or_log_fail() {
"$@" || echo "❌ Failed: $*" >> failed.log
}
echo "=== STEP 1: Deleting Unwanted Posts ==="
run_or_log_fail wp post delete 1001 --force --allow-root
echo "=== STEP 2: Updating Custom Permalinks ==="
run_or_log_fail wp post update 1002 --meta_input='{"custom_permalink":"pages/about"}' --allow-root
echo "=== STEP 3: Running Search & Replace ==="
run_or_log_fail wp search-replace '/about-us' '/pages/about' --all-tables ...
```
---
## 🧠 Credits
**Author:** Eric Rasch
**GitHub:** [github.com/ericrasch](https://github.com/ericrasch)
---
## 📄 License
This project is licensed under the [MIT License](LICENSE).