README.txt

Same filename in this branch
  1. 11.x sites/README.txt
  2. 11.x composer/Template/README.txt
  3. 11.x composer/Metapackage/README.txt
  4. 11.x composer/Plugin/VendorHardening/README.txt
  5. 11.x profiles/README.txt
  6. 11.x themes/README.txt
  7. 11.x core/profiles/demo_umami/themes/umami/README.txt
  8. 11.x core/profiles/demo_umami/themes/umami/images/classy/README.txt
  9. 11.x core/profiles/demo_umami/themes/umami/css/classy/README.txt
  10. 11.x core/profiles/demo_umami/themes/umami/js/classy/README.txt
  11. 11.x core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  12. 11.x core/themes/stable9/README.txt
  13. 11.x core/themes/claro/images/classy/README.txt
  14. 11.x core/themes/claro/css/classy/README.txt
  15. 11.x core/themes/claro/js/classy/README.txt
  16. 11.x core/themes/claro/templates/classy/README.txt
  17. 11.x core/themes/stark/README.txt
  18. 11.x core/modules/sdc/README.txt
  19. 11.x core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  20. 11.x core/modules/system/tests/src/Functional/Update/README.txt
  21. 11.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  22. 11.x core/tests/fixtures/files/README.txt
  23. 11.x core/assets/scaffold/README.txt
  24. 11.x core/assets/vendor/tabbable/README.txt
  25. 11.x core/lib/Drupal/Core/README.txt
  26. 11.x core/lib/Drupal/Component/Render/README.txt
  27. 11.x core/lib/Drupal/Component/Assertion/README.txt
  28. 11.x core/lib/Drupal/Component/Discovery/README.txt
  29. 11.x core/lib/Drupal/Component/FileSecurity/README.txt
  30. 11.x core/lib/Drupal/Component/FileCache/README.txt
  31. 11.x core/lib/Drupal/Component/Utility/README.txt
  32. 11.x core/lib/Drupal/Component/README.txt
  33. 11.x core/lib/Drupal/Component/Graph/README.txt
  34. 11.x core/lib/Drupal/Component/DependencyInjection/README.txt
  35. 11.x core/lib/Drupal/Component/FrontMatter/README.txt
  36. 11.x core/lib/Drupal/Component/Version/README.txt
  37. 11.x core/lib/Drupal/Component/Serialization/README.txt
  38. 11.x core/lib/Drupal/Component/ClassFinder/README.txt
  39. 11.x core/lib/Drupal/Component/ProxyBuilder/README.txt
  40. 11.x core/lib/Drupal/Component/EventDispatcher/README.txt
  41. 11.x core/lib/Drupal/Component/Diff/README.txt
  42. 11.x core/lib/Drupal/Component/FileSystem/README.txt
  43. 11.x core/lib/Drupal/Component/Gettext/README.txt
  44. 11.x core/lib/Drupal/Component/PhpStorage/README.txt
  45. 11.x core/lib/Drupal/Component/Datetime/README.txt
  46. 11.x core/lib/Drupal/Component/Transliteration/README.txt
  47. 11.x core/lib/Drupal/Component/Annotation/README.txt
  48. 11.x core/lib/Drupal/Component/HttpFoundation/README.txt
  49. 11.x core/lib/Drupal/Component/Uuid/README.txt
  50. 11.x core/lib/Drupal/Component/Plugin/README.txt
  51. 11.x core/lib/README.txt
Same filename and directory in other branches
  1. 7.x sites/README.txt
  2. 7.x sites/all/themes/README.txt
  3. 7.x sites/all/modules/README.txt
  4. 7.x sites/all/libraries/README.txt
  5. 7.x profiles/README.txt
  6. 7.x profiles/standard/translations/README.txt
  7. 7.x profiles/minimal/translations/README.txt
  8. 7.x README.txt
  9. 7.x themes/README.txt
  10. 7.x themes/stark/README.txt
  11. 7.x modules/README.txt
  12. 7.x modules/simpletest/files/README.txt
  13. 9 sites/README.txt
  14. 9 composer/Template/README.txt
  15. 9 composer/Metapackage/README.txt
  16. 9 composer/Plugin/VendorHardening/README.txt
  17. 9 profiles/README.txt
  18. 9 themes/README.txt
  19. 9 modules/README.txt
  20. 9 core/profiles/demo_umami/themes/umami/README.txt
  21. 9 core/profiles/demo_umami/themes/umami/images/classy/README.txt
  22. 9 core/profiles/demo_umami/themes/umami/css/classy/README.txt
  23. 9 core/profiles/demo_umami/themes/umami/js/classy/README.txt
  24. 9 core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  25. 9 core/themes/stable9/README.txt
  26. 9 core/themes/stable9/images/README.txt
  27. 9 core/themes/seven/README.txt
  28. 9 core/themes/seven/images/classy/README.txt
  29. 9 core/themes/seven/css/classy/README.txt
  30. 9 core/themes/seven/js/classy/README.txt
  31. 9 core/themes/seven/templates/classy/README.txt
  32. 9 core/themes/claro/images/classy/README.txt
  33. 9 core/themes/claro/css/classy/README.txt
  34. 9 core/themes/claro/js/classy/README.txt
  35. 9 core/themes/claro/templates/classy/README.txt
  36. 9 core/themes/stark/README.txt
  37. 9 core/themes/bartik/README.txt
  38. 9 core/themes/bartik/images/classy/README.txt
  39. 9 core/themes/bartik/css/classy/README.txt
  40. 9 core/themes/bartik/js/classy/README.txt
  41. 9 core/themes/bartik/templates/classy/README.txt
  42. 9 core/themes/stable/README.txt
  43. 9 core/themes/classy/README.txt
  44. 9 core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  45. 9 core/modules/system/tests/src/Functional/Update/README.txt
  46. 9 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  47. 9 core/tests/fixtures/files/README.txt
  48. 9 core/assets/scaffold/README.txt
  49. 9 core/assets/vendor/tabbable/README.txt
  50. 9 core/lib/Drupal/Core/README.txt
  51. 9 core/lib/Drupal/Component/Render/README.txt
  52. 9 core/lib/Drupal/Component/Assertion/README.txt
  53. 9 core/lib/Drupal/Component/Discovery/README.txt
  54. 9 core/lib/Drupal/Component/FileSecurity/README.txt
  55. 9 core/lib/Drupal/Component/FileCache/README.txt
  56. 9 core/lib/Drupal/Component/Utility/README.txt
  57. 9 core/lib/Drupal/Component/README.txt
  58. 9 core/lib/Drupal/Component/Graph/README.txt
  59. 9 core/lib/Drupal/Component/DependencyInjection/README.txt
  60. 9 core/lib/Drupal/Component/FrontMatter/README.txt
  61. 9 core/lib/Drupal/Component/Version/README.txt
  62. 9 core/lib/Drupal/Component/Serialization/README.txt
  63. 9 core/lib/Drupal/Component/ClassFinder/README.txt
  64. 9 core/lib/Drupal/Component/ProxyBuilder/README.txt
  65. 9 core/lib/Drupal/Component/EventDispatcher/README.txt
  66. 9 core/lib/Drupal/Component/Diff/README.txt
  67. 9 core/lib/Drupal/Component/FileSystem/README.txt
  68. 9 core/lib/Drupal/Component/Gettext/README.txt
  69. 9 core/lib/Drupal/Component/Bridge/README.txt
  70. 9 core/lib/Drupal/Component/PhpStorage/README.txt
  71. 9 core/lib/Drupal/Component/Datetime/README.txt
  72. 9 core/lib/Drupal/Component/Transliteration/README.txt
  73. 9 core/lib/Drupal/Component/Annotation/README.txt
  74. 9 core/lib/Drupal/Component/HttpFoundation/README.txt
  75. 9 core/lib/Drupal/Component/Uuid/README.txt
  76. 9 core/lib/Drupal/Component/Plugin/README.txt
  77. 9 core/lib/README.txt
  78. 8.9.x sites/README.txt
  79. 8.9.x composer/Template/README.txt
  80. 8.9.x composer/Metapackage/README.txt
  81. 8.9.x composer/Plugin/VendorHardening/README.txt
  82. 8.9.x profiles/README.txt
  83. 8.9.x README.txt
  84. 8.9.x themes/README.txt
  85. 8.9.x modules/README.txt
  86. 8.9.x core/profiles/demo_umami/themes/umami/README.txt
  87. 8.9.x core/profiles/demo_umami/themes/umami/images/classy/README.txt
  88. 8.9.x core/profiles/demo_umami/themes/umami/css/classy/README.txt
  89. 8.9.x core/profiles/demo_umami/themes/umami/js/classy/README.txt
  90. 8.9.x core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  91. 8.9.x core/themes/seven/README.txt
  92. 8.9.x core/themes/seven/images/classy/README.txt
  93. 8.9.x core/themes/seven/css/classy/README.txt
  94. 8.9.x core/themes/seven/js/classy/README.txt
  95. 8.9.x core/themes/seven/templates/classy/README.txt
  96. 8.9.x core/themes/claro/images/classy/README.txt
  97. 8.9.x core/themes/claro/css/classy/README.txt
  98. 8.9.x core/themes/claro/js/classy/README.txt
  99. 8.9.x core/themes/claro/templates/classy/README.txt
  100. 8.9.x core/themes/stark/README.txt
  101. 8.9.x core/themes/bartik/README.txt
  102. 8.9.x core/themes/bartik/images/classy/README.txt
  103. 8.9.x core/themes/bartik/css/classy/README.txt
  104. 8.9.x core/themes/bartik/js/classy/README.txt
  105. 8.9.x core/themes/bartik/templates/classy/README.txt
  106. 8.9.x core/themes/stable/README.txt
  107. 8.9.x core/themes/classy/README.txt
  108. 8.9.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  109. 8.9.x core/tests/fixtures/files/README.txt
  110. 8.9.x core/assets/scaffold/README.txt
  111. 8.9.x core/lib/Drupal/Core/README.txt
  112. 8.9.x core/lib/Drupal/Component/Render/README.txt
  113. 8.9.x core/lib/Drupal/Component/Assertion/README.txt
  114. 8.9.x core/lib/Drupal/Component/Discovery/README.txt
  115. 8.9.x core/lib/Drupal/Component/FileSecurity/README.txt
  116. 8.9.x core/lib/Drupal/Component/FileCache/README.txt
  117. 8.9.x core/lib/Drupal/Component/Utility/README.txt
  118. 8.9.x core/lib/Drupal/Component/README.txt
  119. 8.9.x core/lib/Drupal/Component/Graph/README.txt
  120. 8.9.x core/lib/Drupal/Component/DependencyInjection/README.txt
  121. 8.9.x core/lib/Drupal/Component/Version/README.txt
  122. 8.9.x core/lib/Drupal/Component/Serialization/README.txt
  123. 8.9.x core/lib/Drupal/Component/ClassFinder/README.txt
  124. 8.9.x core/lib/Drupal/Component/ProxyBuilder/README.txt
  125. 8.9.x core/lib/Drupal/Component/EventDispatcher/README.txt
  126. 8.9.x core/lib/Drupal/Component/Diff/README.txt
  127. 8.9.x core/lib/Drupal/Component/FileSystem/README.txt
  128. 8.9.x core/lib/Drupal/Component/Gettext/README.txt
  129. 8.9.x core/lib/Drupal/Component/Bridge/README.txt
  130. 8.9.x core/lib/Drupal/Component/PhpStorage/README.txt
  131. 8.9.x core/lib/Drupal/Component/Datetime/README.txt
  132. 8.9.x core/lib/Drupal/Component/Transliteration/README.txt
  133. 8.9.x core/lib/Drupal/Component/Annotation/README.txt
  134. 8.9.x core/lib/Drupal/Component/HttpFoundation/README.txt
  135. 8.9.x core/lib/Drupal/Component/Uuid/README.txt
  136. 8.9.x core/lib/Drupal/Component/Plugin/README.txt
  137. 8.9.x core/lib/README.txt
  138. 10 sites/README.txt
  139. 10 composer/Template/README.txt
  140. 10 composer/Metapackage/README.txt
  141. 10 composer/Plugin/VendorHardening/README.txt
  142. 10 profiles/README.txt
  143. 10 themes/README.txt
  144. 10 modules/README.txt
  145. 10 core/profiles/demo_umami/themes/umami/README.txt
  146. 10 core/profiles/demo_umami/themes/umami/images/classy/README.txt
  147. 10 core/profiles/demo_umami/themes/umami/css/classy/README.txt
  148. 10 core/profiles/demo_umami/themes/umami/js/classy/README.txt
  149. 10 core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  150. 10 core/themes/stable9/README.txt
  151. 10 core/themes/claro/images/classy/README.txt
  152. 10 core/themes/claro/css/classy/README.txt
  153. 10 core/themes/claro/js/classy/README.txt
  154. 10 core/themes/claro/templates/classy/README.txt
  155. 10 core/themes/stark/README.txt
  156. 10 core/modules/sdc/README.txt
  157. 10 core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  158. 10 core/modules/system/tests/src/Functional/Update/README.txt
  159. 10 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  160. 10 core/tests/fixtures/files/README.txt
  161. 10 core/assets/scaffold/README.txt
  162. 10 core/assets/vendor/tabbable/README.txt
  163. 10 core/lib/Drupal/Core/README.txt
  164. 10 core/lib/Drupal/Component/Render/README.txt
  165. 10 core/lib/Drupal/Component/Assertion/README.txt
  166. 10 core/lib/Drupal/Component/Discovery/README.txt
  167. 10 core/lib/Drupal/Component/FileSecurity/README.txt
  168. 10 core/lib/Drupal/Component/FileCache/README.txt
  169. 10 core/lib/Drupal/Component/Utility/README.txt
  170. 10 core/lib/Drupal/Component/README.txt
  171. 10 core/lib/Drupal/Component/Graph/README.txt
  172. 10 core/lib/Drupal/Component/DependencyInjection/README.txt
  173. 10 core/lib/Drupal/Component/FrontMatter/README.txt
  174. 10 core/lib/Drupal/Component/Version/README.txt
  175. 10 core/lib/Drupal/Component/Serialization/README.txt
  176. 10 core/lib/Drupal/Component/ClassFinder/README.txt
  177. 10 core/lib/Drupal/Component/ProxyBuilder/README.txt
  178. 10 core/lib/Drupal/Component/EventDispatcher/README.txt
  179. 10 core/lib/Drupal/Component/Diff/README.txt
  180. 10 core/lib/Drupal/Component/FileSystem/README.txt
  181. 10 core/lib/Drupal/Component/Gettext/README.txt
  182. 10 core/lib/Drupal/Component/PhpStorage/README.txt
  183. 10 core/lib/Drupal/Component/Datetime/README.txt
  184. 10 core/lib/Drupal/Component/Transliteration/README.txt
  185. 10 core/lib/Drupal/Component/Annotation/README.txt
  186. 10 core/lib/Drupal/Component/HttpFoundation/README.txt
  187. 10 core/lib/Drupal/Component/Uuid/README.txt
  188. 10 core/lib/Drupal/Component/Plugin/README.txt
  189. 10 core/lib/README.txt
Modules extend your site functionality beyond Drupal core.

WHAT TO PLACE IN THIS DIRECTORY?
--------------------------------

Placing downloaded and custom modules in this directory separates downloaded and
custom modules from Drupal core's modules. This allows Drupal core to be updated
without overwriting these files.

DOWNLOAD ADDITIONAL MODULES
---------------------------

Contributed modules from the Drupal community may be downloaded at
https://www.drupal.org/project/project_module.

ORGANIZING MODULES IN THIS DIRECTORY
------------------------------------

You may create subdirectories in this directory, to organize your added modules,
without breaking the site. Some common subdirectories include "contrib" for
contributed modules, and "custom" for custom modules. Note that if you move a
module to a subdirectory after it has been enabled, you may need to clear the
Drupal cache so it can be found.

There are number of directories that are ignored when looking for modules. These
are 'src', 'lib', 'vendor', 'assets', 'css', 'files', 'images', 'js', 'misc',
'templates', 'includes', 'fixtures' and 'Drupal'.

MULTISITE CONFIGURATION
-----------------------

In multisite configurations, modules found in this directory are available to
all sites. You may also put modules in the sites/all/modules directory, and the
versions in sites/all/modules will take precedence over versions of the same
module that are here. Alternatively, the sites/your_site_name/modules directory
pattern may be used to restrict modules to a specific site instance.

MORE INFORMATION
----------------

Refer to the “Developing for Drupal” section of the README.md in the Drupal
root directory for further information on extending Drupal with custom modules.

File

modules/README.txt

View source
  1. Modules extend your site functionality beyond Drupal core.
  2. WHAT TO PLACE IN THIS DIRECTORY?
  3. --------------------------------
  4. Placing downloaded and custom modules in this directory separates downloaded and
  5. custom modules from Drupal core's modules. This allows Drupal core to be updated
  6. without overwriting these files.
  7. DOWNLOAD ADDITIONAL MODULES
  8. ---------------------------
  9. Contributed modules from the Drupal community may be downloaded at
  10. https://www.drupal.org/project/project_module.
  11. ORGANIZING MODULES IN THIS DIRECTORY
  12. ------------------------------------
  13. You may create subdirectories in this directory, to organize your added modules,
  14. without breaking the site. Some common subdirectories include "contrib" for
  15. contributed modules, and "custom" for custom modules. Note that if you move a
  16. module to a subdirectory after it has been enabled, you may need to clear the
  17. Drupal cache so it can be found.
  18. There are number of directories that are ignored when looking for modules. These
  19. are 'src', 'lib', 'vendor', 'assets', 'css', 'files', 'images', 'js', 'misc',
  20. 'templates', 'includes', 'fixtures' and 'Drupal'.
  21. MULTISITE CONFIGURATION
  22. -----------------------
  23. In multisite configurations, modules found in this directory are available to
  24. all sites. You may also put modules in the sites/all/modules directory, and the
  25. versions in sites/all/modules will take precedence over versions of the same
  26. module that are here. Alternatively, the sites/your_site_name/modules directory
  27. pattern may be used to restrict modules to a specific site instance.
  28. MORE INFORMATION
  29. ----------------
  30. Refer to the “Developing for Drupal” section of the README.md in the Drupal
  31. root directory for further information on extending Drupal with custom modules.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.