Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/10up/wp-hammer
ARCHIVED: Please see https://github.com/10up/wp-scrubber as replacement.
https://github.com/10up/wp-hammer
hammer wordpress wp-ha
Last synced: about 1 month ago
JSON representation
ARCHIVED: Please see https://github.com/10up/wp-scrubber as replacement.
- Host: GitHub
- URL: https://github.com/10up/wp-hammer
- Owner: 10up
- License: mit
- Archived: true
- Created: 2016-03-04T20:03:42.000Z (almost 9 years ago)
- Default Branch: trunk
- Last Pushed: 2024-01-24T19:09:11.000Z (11 months ago)
- Last Synced: 2024-06-26T12:40:11.093Z (6 months ago)
- Topics: hammer, wordpress, wp-ha
- Language: PHP
- Homepage:
- Size: 83 KB
- Stars: 152
- Watchers: 111
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-wp-developer-tools - WP Hammer - This plugin adds a wp-cli ha command to clean your environment and prepare it for staging / development by removing Personally Identi.fiable Information. (WordPress Plugins)
README
# WP Hammer
> ``wp ha`` is a multi-tool. You can use it to clean your environment of personally identifiable information and extra content (posts and users) that are not necessary.
> [!CAUTION]
> WP Hammer has been archived and [WordPress Scrubber](https://github.com/10up/wp-scrubber) should be used as its replacement.
[](#support-level)  [](https://github.com/10up/wp-hammer/blob/trunk/LICENSE.md)
> [!WARNING]
> All changes are final and modify your site DB. Make sure you take a backup of your database __BEFORE__ you play around with the tool ``wp db export``
## Before You Begin
Make a copy of your database.
## About
This tool will help you work on a client's site without having to worry about any of their user's personal information (emails, post content etc) being hosted on your dev environment.
## Installation
Make sure you have [wp-cli](http://wp-cli.org/) installed and in your $PATH. Following that, run this command in your terminal:
`wp package install ivankruchkoff/wp-hammer`
## Usage
With ``wp ha`` you can:
### Clean up user emails.
``wp ha -f users.user_email='[email protected]'``
### Clean up user passwords.
To auto generate passwords:
``wp ha -f users.user_pass=auto``
To set all passwords to password:
``wp ha -f users.user_pass=password``
### Replace posts with dummy posts.
``wp ha -f posts.post_content=markov,posts.post_title=random``
### Remove extra users.
`` wp ha -l users=10``
### Remove extra Posts.
`` wp ha -l posts=100``
Or you can chain tasks together like in the following example, which we'll break down in parts as the syntax is fairly powerful
`wp ha -f posts.post_author=auto,users.user_pass=auto,users.user_email='[email protected]',posts.post_title=ipsum,posts.post_content=markov -l users=10,posts=100.post_date`
``wp ha``
How you invoke the command
### Format
`
wp ha -f posts.post_author=auto users.user_pass=__user_email__UMINtHeroJEreAGleC users.user_email='[email protected]' posts.post_title=ipsum posts.post_content=markov
`
``posts.post_author`` is set to a random user ID (from those that will remain after we've performed any adjustments to the users)
`users.user_pass` is set to the user email followed by UMINtHeroJEreAGleC
`users.user_email='[email protected]' - __ID__` is replaced by the user ID
`posts.post_title=ipsum` replaces all post_titles with auto-generated lorem ipsum
`posts.post_content=markov` replaces all post_content with randomly generated content, using markov chains for the specified post_content
### Limits
`
-l users=10 posts=page.100.post_date,post.50.post_content.length`
users=10 only the first 10 users remain
`posts=page.100.postdate,post.50.post_content.length `
We keep the following posts:
`post type = page, 100 posts sorted by postdate, descending
post type = post, 50 posts with the longest post_content
`
### Another example
`
wp db import production.sql &&
wp ha posts.post_author=auto,users.user_pass=XGRwPjb7uFD5de23,users.user_email='[email protected]',posts.post_title=ipsum,posts.post_content=markov -l users=10 &&
wp db export staging.sql
`
## Support Level
**Archived:** This project is no longer maintained by 10up. We are no longer responding to Issues or Pull Requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!
## Credits
Created by Ivan Kruchkoff ([@ivankk](https://profiles.wordpress.org/ivankk)), at [10up.com](http://10up.com).
## Like what you see?
