Make a backup of your database before running this. It won't break your database, but we can't improve this unless we have broken databases that it doesn't quite do the job for.

There are times in Drupal 7 when the registry gets hopelessly hosed and you need to rebuild the registry (a list of PHP classes and the files they go with). Sometimes, though, you can't do this regular cache-clear activity because some class is required when the system is trying to bootstrap.

The drush version now also fixes Drupal 6 sites where modules have been moved around or removed and the system table is broken.

When would you need Registry Rebuild?

You might get something like:

PHP Fatal error: Class 'EntityAPIControllerExportable' not found in ...sites/all/modules/rules/includes/ on line 11

If this happens when you're trying to run update.php, and happens when you're trying to clear your cache, well, you have some trouble. That's what Registry Rebuild is for.

It also may happen that you've moved some module that Drupal requires to bootstrap, and you get a horrible error. Registry Rebuild will also rebuild the system table to get the modules in the right place so you can bootstrap.

When would you *not* need Registry Rebuild?

If you can access any page, or install a module, or run update.php, you almost certainly don't need Registry Rebuild.

Drush usage is preferred and best maintained. You probably *can* use registry_rebuild without drush. See below.

How To Use Registry Rebuild With Drush

This is the preferred technique, and it should work with multisite installs.

  1. You can just drush @none dl registry_rebuild-7.x and drush will download it into your .drush folder. (Alternately, you can obtain the package another way and copy the folder into .drush yourself.)
  2. Make a backup of your database.
  3. Clear Drush own cache with drush cc drush
  4. On a multisite install, either use correct drush alias, or cd into the site you're rebuilding, as in cd sites/mymultisite
  5. Run drush rr or drush @sitename rr for soft rebuild (default), or:
  6. To force aggressive rebuild from scratch run drush @sitename rr --fire-bazooka

How To Use Registry Rebuild Without Drush

This isn't a module, but it's just packaged as a module download to make it so
it's easy to find and people can download it as a package.

  1. Make a backup of your database using any technique you like. drush sql-dump >dump.sql or mysqldump -uuser -ppassword dbname >dump.sql or use phpMyAdmin or whatever. I know of no way that this procedure can harm your database, but on the other hand if it doesn't work, you can get me the database and I can improve the module to deal with your situation.
  2. Make a directory for the php file, probably sites/all/modules/registry_rebuild (or for a multisite, sites/mymultisite/modules/registry_rebuild.
  3. *If* your modules are not in sites/all/modules, you will probably have to edit registry_rebuild.php to set DRUPAL_ROOT to what it should be.
  4. Copy the registry_rebuild.php from the package into that directory.
  5. You don't need to enable it. If you were able to enable it it means you didn't actually need it.
  6. Either run it from the command line:
       cd sites/all/modules/registry_rebuild
       php registry_rebuild.php

    point your web browser to
    Changing "" to your own site's base URL of course.

  7. You should see something like this:
    DRUPAL_ROOT is /home/rfay/workspace/commerce.
    There were 631 files in the registry before and 508 files now.
    If you don't see any crazy fatal errors, your registry has been rebuilt. You will probably want to flush your caches now.
  8. Hopefully you'll now be able to go about your affairs in peace, updating, clearing cache, etc.

This package comes with no guarantee explicit or implicit.

There's no reason it should do any harm to your install. But there can be lots of things wrong with a system, and the registry problem is not the fix for everything.

For multisite installations: Use the drush version and use it from sites/yourbrokensite. It should work fine.

Supporting organizations: 
Drush command, bug fixes
development, releases maintenance

Project information