dont-modify-core.rst 2.1 KB

  1. Don't Modify Core
  2. =================
  3. .. warning::
  4. Don't modify any non-config files that come with Elgg.
  5. Instead, create a :doc:`custom plugin<plugins>` and alter behavior through the rich Elgg plugin API.
  6. Here are the main reasons not to modify the core of Elgg, or of any other third party software that offers better extensibility routes through plugins.
  7. It makes it hard to get help
  8. ----------------------------
  9. When you don't share the same codebase as everyone else, it's impossible for others to know what is going on in your system and whether your changes are to blame. This can frustrate those who offer help because it can add considerable noise to the support process.
  10. It makes upgrading tricky and potentially disastrous
  11. ----------------------------------------------------
  12. You will certainly want or need to upgrade Elgg to take advantage of security patches, new features, new plugin APIs, new stability and performance improvements. If you've modified core files, then you must be very careful when upgrading that your changes are not overwritten and that they are compatible with the new Elgg code. If your changes are lost or incompatible, then the upgrade may remove features you've added or even completely break your site.
  13. This can also be a slippery slope. Lots of modifications can lead you to an upgrade process so complex that it's practically impossible. There are lots of sites stuck running old versions software due to taking this path.
  14. It may break plugins
  15. --------------------
  16. You may not realize until much later that your "quick fix" broke seemingly unrelated functionality that plugins depended on.
  17. Summary
  18. -------
  19. - Resist the temptation
  20. Editing existing files is quick and easy, but doing so heavily risks the maintainability, security, and stability of your site.
  21. - When receiving advice, consider if the person telling you to modify core will be around to rescue you if you run into trouble later!
  22. - Apply these principle to software in general.
  23. If you can avoid it, don't modify third party plugins either, for many of the same reasons: Plugin authors release new versions, too, and you will want those updates.