wp-cli / wp-cli/search-replace-command

Better communicate failure to search-replace JSON-serialized URLs

Open
#45 12 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

command:search-replace good-first-issue scope:documentation
Dominant language
Gherkin
Stars
61
Forks
47
Avg merge
8m
Merged PRs (30d)
1

Description

From Post Status Slack:

javorszky [5 hours ago] Gravity forms confirmation: goes to https://livesite.com/confirmation-page
I'm on dev. Dev is https://site.test
`wp search-replace https://livesites.com https://site.text`
It does not turn gravity form's form confirmation setting
javorszky [5 hours ago] because the setting is stored in the `rg_form_meta` table in the `confirmations` column as `json`, so the url will look like
javorszky [5 hours ago] `https:\/\/livesite.com\/confirmation-page`

We should better communicate this scenario in our documentation. In fact, it may be time for a dedicated document on search-replacing URLs in the database. Or even, create a dedicated wp search-replace url command, because replacing URLs is such a common use case.

cc @javorszky

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing search-replace documentation and review how it explains URLs stored in JSON-serialized database values. Use the provided Gravity Forms example to document the limitation and URL-replacement guidance; done means the relevant scenario and expected behavior are clearly explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
cli, database, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.