wp-cli/rewrite-command

Lists or flushes the site's rewrite rules, updates the permalink structure.

wp-cli/rewrite-command

Lists or flushes the site's rewrite rules, updates the permalink structure., _(*1)

, _(*2)

Quick links: Using | Installing | Contributing | Support, _(*3)

Using

This package implements the following commands:, _(*4)

wp rewrite

Lists or flushes the site's rewrite rules, updates the permalink structure., _(*5)

wp rewrite

See the WordPress Rewrite API and WP Rewrite class reference., _(*6)

EXAMPLES, _(*7)

# Flush rewrite rules
$ wp rewrite flush
Success: Rewrite rules flushed.

# Update permalink structure
$ wp rewrite structure '/%year%/%monthnum%/%postname%'
Success: Rewrite structure set.

# List rewrite rules
$ wp rewrite list --format=csv
match,query,source
^wp-json/?$,index.php?rest_route=/,other
^wp-json/(.*)?,index.php?rest_route=/$matches[1],other
category/(.+?)/feed/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category
category/(.+?)/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category
category/(.+?)/embed/?$,index.php?category_name=$matches[1]&embed=true,category

wp rewrite flush

Flushes rewrite rules., _(*8)

wp rewrite flush [--hard]

Resets WordPress' rewrite rules based on registered post types, etc., _(*9)

To regenerate a .htaccess file with WP-CLI, you'll need to add the mod_rewrite module to your wp-cli.yml or config.yml. For example:, _(*10)

apache_modules:
  - mod_rewrite

OPTIONS, _(*11)

[--hard]
    Perform a hard flush - update `.htaccess` rules as well as rewrite rules in database. Works only on single site installs.

EXAMPLES, _(*12)

$ wp rewrite flush
Success: Rewrite rules flushed.

wp rewrite list

Gets a list of the current rewrite rules., _(*13)

wp rewrite list [--match=<url>] [--source=<source>] [--fields=<fields>] [--format=<format>]

OPTIONS, _(*14)

[--match=<url>]
    Show rewrite rules matching a particular URL.

[--source=<source>]
    Show rewrite rules from a particular source.

[--fields=<fields>]
    Limit the output to specific fields. Defaults to match,query,source.

[--format=<format>]
    Render output in a particular format.
    ---
    default: table
    options:
      - table
      - csv
      - json
      - count
      - yaml
    ---

EXAMPLES, _(*15)

$ wp rewrite list --format=csv
match,query,source
^wp-json/?$,index.php?rest_route=/,other
^wp-json/(.*)?,index.php?rest_route=/$matches[1],other
category/(.+?)/feed/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category
category/(.+?)/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category
category/(.+?)/embed/?$,index.php?category_name=$matches[1]&embed=true,category

wp rewrite structure

Updates the permalink structure., _(*16)

wp rewrite structure <permastruct> [--category-base=<base>] [--tag-base=<base>] [--hard]

Sets the post permalink structure to the specified pattern., _(*17)

To regenerate a .htaccess file with WP-CLI, you'll need to add the mod_rewrite module to your WP-CLI config. For example:, _(*18)

apache_modules:
  - mod_rewrite

OPTIONS, _(*19)

<permastruct>
    The new permalink structure to apply.

[--category-base=<base>]
    Set the base for category permalinks, i.e. '/category/'.

[--tag-base=<base>]
    Set the base for tag permalinks, i.e. '/tag/'.

[--hard]
    Perform a hard flush - update `.htaccess` rules as well as rewrite rules in database.

EXAMPLES, _(*20)

$ wp rewrite structure '/%year%/%monthnum%/%postname%/'
Success: Rewrite structure set.

Installing

This package is included with WP-CLI itself, no additional installation necessary., _(*21)

To install the latest version of this package over what's included in WP-CLI, run:, _(*22)

wp package install git@github.com:wp-cli/rewrite-command.git

Contributing

We appreciate you taking the initiative to contribute to this project., _(*23)

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation., _(*24)

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines., _(*25)

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed., _(*26)

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version., _(*27)

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation., _(*28)

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project., _(*29)

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally., _(*30)

Support

GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support, _(*31)

This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase., _(*32)