Skip to content

Update README.md #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xxsimoxx merged 1 commit into from
Jan 27, 2026
Merged

Update README.md #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 65 additions & 102 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,132 +2,95 @@

![](assets/banner-772x250.png)

This is a plugin for WordPress that switches your installation to
[ClassicPress](https://www.classicpress.net).
This is a plugin for WordPress that switches your installation to [ClassicPress](https://www.classicpress.net).

Version 1.5 of this plugin also added a switcher tool for ClassicPress
that can be used to install other versions, test nightly builds and even revert your
site to WordPress.
Version 1.5 of this plugin also added a switcher tool for ClassicPress that can be used to install other versions, test nightly builds and even revert your site to WordPress.

## The CMS for Creators

ClassicPress takes your website to the next level with the same features and
functionality that you enjoyed with WordPress, but with more attention to the
most common needs of a business website.
ClassicPress takes your website to the next level with the same features and functionality that you enjoyed with WordPress, but with more attention to the most common needs of a business website.

**PLEASE NOTE:** ClassicPress is stable software, but it is important to take a
backup before switching a live production site to ClassicPress. Please also
ensure any known conflicting plugins are **deactivated** (see list
[here](https://docs.classicpress.net/installing-classicpress/#plugin-conflicts)).
**PLEASE NOTE:** ClassicPress is stable software, but it is important to take a backup before switching a live production site to ClassicPress.

## What version of WordPress does the plugin work with?

You can always see the latest supported version by going to [Get ClassicPress](https://www.classicpress.net/get-classicpress/#switch-to-classicpress).

## Installation

To **install a fresh version of ClassicPress on a new site**, you do not need
this plugin. See our
[installation instructions](https://docs.classicpress.net/installing-classicpress/)
instead.

To **install ClassicPress on a current WordPress site** (switch a current
WordPress site to ClassicPress):

1. Back up the current site files and database. You can do a manual backup in
your hosting panel and export the database, or you can use a backup plugin.
2. Download this plugin from the
[Releases page](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/releases)
here on GitHub.
3. Install the downloaded zip file from within the WordPress dashboard
("Plugins" -> "Add New" -> "Upload Plugin").
To **install a fresh version of ClassicPress on a new site**, you do not need this plugin.
See our [installation instructions](https://docs.classicpress.net/installing-classicpress/) instead.

To **install ClassicPress on a current WordPress site** (switch a current WordPress site to ClassicPress):

1. Back up the current site files and database. You can do a manual backup in your hosting panel and export the database, or you can use a backup plugin.
2. Download the latest version of the ClassicPress migration plugin from the [ClassicPress Plugin Directory](https://directory.classicpress.net/plugins/switch-to-classicpress/).
3. Install the downloaded zip file from within the WordPress dashboard ("Plugins" -> "Add New" -> "Upload Plugin").
4. Activate this plugin ("Switch to ClassicPress") after it is installed.
5. Go to the ClassicPress Migration plugin by clicking the **Switch** link in
this plugin's table row, or at **Tools -> Switch to ClassicPress**.
6. If all the checks pass, press the **Switch this site to ClassicPress now!**
button. If not, you'll probably need to upgrade WordPress or PHP.
7. The migration process may take a few minutes depending on your hosting
provider, so go grab some water or a beverage of your choice 🙂
8. When the process is finished, you should see the ClassicPress About screen.
At this point it is safe to delete the “Switch to ClassicPress” plugin.
9. You may be prompted to upgrade ClassicPress immediately after switching from
WordPress. This is normal, and it is safe to upgrade.

If something is wrong, please let us know in
[our support forum](https://forums.classicpress.net/c/support/migration-plugin).
5. Go to the settings of the ClassicPress migration plugin at "Tools" -> "Switch to ClassicPress".
6. To proceed with the switch it is necessary that all pre-flight checks succeed, with a green or yellow check mark. A yellow check mark requires your attention, so read this information carefully.
7. Press the **Switch this site to ClassicPress now!** button.
8. The migration process may take a few minutes depending on your hosting provider, so go grab some water or a beverage of your choice 🙂
9. When the process is finished, you should see the ClassicPress About screen.
10. To complete the migration process you must visit the Updates page and press the **Re-Install Now** button.
11. You may be prompted to upgrade ClassicPress immediately after switching from WordPress. This is normal, and it is safe to upgrade.

At this point it is safe to delete the “Switch to ClassicPress” plugin.

If something is wrong, please let us know in [our support forum](https://forums.classicpress.net/c/support/migration-plugin).

## Frequently Asked Questions

### Will my current plugins and themes work in ClassicPress?

Plugins that require Blocks might not work well in ClassicPress, you should test
any plugins you plan to use and verify they work correctly.
If you see something unusual it may be a bug with
ClassicPress, and you can get help on
[our support forum](https://forums.classicpress.net/c/support/)
or
[GitHub](https://github.com/ClassicPress).
Plugins that require Blocks might not work well in ClassicPress, you should test any plugins you plan to use and verify they work correctly.
If you see something unusual it may be a bug with ClassicPress, and you can get help on [our support forum](https://forums.classicpress.net/c/support/) or [GitHub](https://github.com/ClassicPress).

### How can I use this plugin with an unsupported version of WordPress?

This plugin currently supports migrating from WordPress versions starting at
`4.9.0`.
This plugin currently supports migrating from WordPress versions starting at `4.9.0`.

We update the plugin as quickly as possible when a new version of WordPress
comes out, but we do need to test each new version for compatibility with the
plugin first.

If you would like to migrate from a different version of WordPress **at your
own risk**, you can use the following code in your current theme's
`functions.php` file or a mu-plugin to enable the migration:
We update the plugin as quickly as possible when a new version of WordPress comes out, but we do need to test each new version for compatibility with the plugin first.

If you would like to migrate from a different version of WordPress **at your own risk**, you can use the following code in your current theme's `functions.php` file or a mu-plugin to enable the migration:
`add_filter( 'classicpress_ignore_wp_version', '__return_true' );`

With each new WordPress release, it's very helpful for us to have multiple
reports of whether the migration plugin works with the new version. You can
use the filter above to test the migration process, and you can tell us about
the results of your testing
[on GitHub](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues)
or
[on the support subforum for the migration plugin](https://forums.classicpress.net/c/support/migration-plugin).
With each new WordPress release, it's very helpful for us to have multiple reports of whether the migration plugin works with the new version.
You can use the filter above to test the migration process, and you can tell us about the results of your testing [on GitHub](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues) or [on the support subforum for the migration plugin](https://forums.classicpress.net/c/support/migration-plugin).

### I need help with something else, what should I do?

Like all of ClassicPress, our support is a volunteer effort by the community.
If you need help with something, please let us know in
[our support forum](https://forums.classicpress.net/c/support/)
or
[Zulip chat](https://classicpress.zulipchat.com/register/).
If you need help with something, please let us know in [our support forum](https://forums.classicpress.net/c/support/) or [Zulip chat](https://classicpress.zulipchat.com/register/).

## Screenshots

The plugin's admin page with information and the controls to start the migration:
![](assets/screenshot-1.png)
The plugin's admin page with information and the controls to start the migration:

![Screenshot-1](https://github.com/user-attachments/assets/d27844d7-7629-4e17-91d2-f68761c137a0)

<br>

The plugin's admin page with an error that is blocking the migration:
![](assets/screenshot-2.png)
The plugin's migration progress page:

![Screenshot-2](https://github.com/user-attachments/assets/429b2248-1e0d-4ce0-97e7-5ed95af6b00a)

<br>

The plugin's migration progress page:
![](assets/screenshot-3.png)

The About ClassicPress screen that appears at the end of the migration: <br>
![](assets/screenshot-4.png)
The About ClassicPress screen that appears at the end of the migration:

![Screenshot-3](https://github.com/user-attachments/assets/f55504a1-a8eb-4bad-9214-9d2e7d24a523)

## Changelog

### 0.1.0

The initial public release of this plugin. Switches to an early ClassicPress
alpha release.
- The initial public release of this plugin. Switches to an early ClassicPress alpha release.

### 0.2.0

Switches to ClassicPress `1.0.0-beta1` with working auto-updates. Also
supports migrating multisite WordPress installations to ClassicPress.
- Switches to ClassicPress `1.0.0-beta1` with working auto-updates.
- Also supports migrating multisite WordPress installations to ClassicPress.

### 0.3.0

Expand Down Expand Up @@ -158,42 +121,31 @@ supports migrating multisite WordPress installations to ClassicPress.

- Support migrating from WP up to 5.1.0.
- Switch to ClassicPress `1.0.0` by default.
- Add an advanced feature that allows switching to any version of WordPress or
ClassicPress.
- Add an advanced feature that allows switching to any version of WordPress or ClassicPress.

### 1.0.1

- Load the supported WordPress version and the target ClassicPress version from
a remote API endpoint, so that a new release of the migration plugin is not
required with every new WordPress or ClassicPress release.
- Load the supported WordPress version and the target ClassicPress version from a remote API endpoint, so that a new release of the migration plugin is not required with every new WordPress or ClassicPress release.

### 1.1.0

- Change pre-existing `composer.json` from an error to a warning
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/61))
- Minor fix for disorganized/jumbled output in some cases
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/59#issuecomment-495459514))
- Change pre-existing `composer.json` from an error to a warning ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/61))
- Minor fix for disorganized/jumbled output in some cases ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/59#issuecomment-495459514))

### 1.2.0

- Add translation files and translate the plugin into Russian
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/60))
- Fix an issue with incorrect upgrade notices appearing immediately after a
custom migration
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/62))
- Fix an issue with stale WordPress news items appearing in the dashboard after
migrating to ClassicPress
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/67))

- Add translation files and translate the plugin into Russian ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/60))
- Fix an issue with incorrect upgrade notices appearing immediately after a custom migration ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/62))
- Fix an issue with stale WordPress news items appearing in the dashboard after migrating to ClassicPress ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/issues/67))

### 1.3.0

- Add Plugin and Theme check sections
([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/74))

- Add Plugin and Theme check sections ([details](https://github.com/ClassicPress/ClassicPress-Migration-Plugin/pull/74))

### 1.3.1

- Remove stray files from release

### 1.4.0

- Direct blocking issues to ClassicPress Forum (#82)
Expand Down Expand Up @@ -232,3 +184,14 @@ supports migrating multisite WordPress installations to ClassicPress.
- Change Core File check to show any modified files on the page rather than in the console
- Display override function info for unsupported WP versions when applicable
- Correct links and update wording as needed

### 1.6.0

- Fix "modified files" warning when locale is not en_US
- Update to Plugin and Theme Warnings
- Add override for WP version check in "General setting"
- Fixed Functions in admin-page.php
- Adding more support for translation
- Translation related fixes
- Validate custom migration URL
- Regenerate POT file