@mytechtoday/augment-extensions 0.7.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,693 +1,693 @@
1
- # WordPress Plugin Architecture Patterns
2
-
3
- ## Overview
4
-
5
- This document outlines 7 proven WordPress plugin architecture patterns, from simple procedural to enterprise-level. Choose the appropriate pattern based on plugin complexity, team size, and long-term maintenance needs.
6
-
7
- ---
8
-
9
- ## Pattern 1: Simple Procedural Plugin
10
-
11
- **Complexity**: Low
12
- **File Count**: 1-3 files
13
- **Team Size**: 1 developer
14
- **Use Case**: Single feature, utility functions, quick prototypes
15
-
16
- ### Structure
17
-
18
- ```
19
- my-plugin/
20
- ├── my-plugin.php # Main plugin file (all code)
21
- └── readme.txt # WordPress.org readme
22
- ```
23
-
24
- ### Implementation
25
-
26
- ```php
27
- <?php
28
- /**
29
- * Plugin Name: My Simple Plugin
30
- * Description: A simple plugin
31
- * Version: 1.0.0
32
- */
33
-
34
- // Exit if accessed directly
35
- if (!defined('ABSPATH')) {
36
- exit;
37
- }
38
-
39
- // Add action hooks
40
- add_action('init', 'my_plugin_init');
41
- add_filter('the_content', 'my_plugin_filter_content');
42
-
43
- function my_plugin_init() {
44
- // Initialization code
45
- }
46
-
47
- function my_plugin_filter_content($content) {
48
- // Filter content
49
- return $content;
50
- }
51
- ```
52
-
53
- ### When to Use
54
-
55
- ✅ Single feature plugins (e.g., disable comments, add custom CSS)
56
- ✅ Utility functions
57
- ✅ Quick prototypes
58
- ✅ Learning/tutorial plugins
59
-
60
- ### Pros & Cons
61
-
62
- **Pros**: Simple, fast to develop, easy to understand
63
- **Cons**: Hard to maintain as complexity grows, no separation of concerns
64
-
65
- ---
66
-
67
- ## Pattern 2: Organized Procedural Plugin
68
-
69
- **Complexity**: Medium
70
- **File Count**: 5-20 files
71
- **Team Size**: 1-2 developers
72
- **Use Case**: Medium-sized plugins, organized code, team collaboration
73
-
74
- ### Structure
75
-
76
- ```
77
- my-plugin/
78
- ├── my-plugin.php # Main plugin file (loader)
79
- ├── includes/
80
- │ ├── functions.php # Core functions
81
- │ ├── hooks.php # Hook callbacks
82
- │ └── shortcodes.php # Shortcode handlers
83
- ├── admin/
84
- │ ├── settings.php # Admin settings
85
- │ └── meta-boxes.php # Meta boxes
86
- ├── public/
87
- │ └── display.php # Frontend display
88
- ├── assets/
89
- │ ├── css/
90
- │ ├── js/
91
- │ └── images/
92
- ├── languages/
93
- ├── uninstall.php
94
- └── readme.txt
95
- ```
96
-
97
- ### Implementation
98
-
99
- **Main Plugin File** (`my-plugin.php`):
100
-
101
- ```php
102
- <?php
103
- /**
104
- * Plugin Name: My Organized Plugin
105
- * Description: An organized procedural plugin
106
- * Version: 1.0.0
107
- */
108
-
109
- if (!defined('ABSPATH')) {
110
- exit;
111
- }
112
-
113
- // Define constants
114
- define('MY_PLUGIN_VERSION', '1.0.0');
115
- define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
116
- define('MY_PLUGIN_URL', plugin_dir_url(__FILE__));
117
-
118
- // Load dependencies
119
- require_once MY_PLUGIN_PATH . 'includes/functions.php';
120
- require_once MY_PLUGIN_PATH . 'includes/hooks.php';
121
-
122
- // Admin functionality
123
- if (is_admin()) {
124
- require_once MY_PLUGIN_PATH . 'admin/settings.php';
125
- }
126
-
127
- // Public functionality
128
- if (!is_admin()) {
129
- require_once MY_PLUGIN_PATH . 'public/display.php';
130
- }
131
-
132
- // Activation/Deactivation
133
- register_activation_hook(__FILE__, 'my_plugin_activate');
134
- register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
135
- ```
136
-
137
- ### When to Use
138
-
139
- ✅ Multiple features
140
- ✅ Admin and frontend functionality
141
- ✅ Custom assets (CSS/JS)
142
- ✅ Team collaboration
143
-
144
- ### Pros & Cons
145
-
146
- **Pros**: Organized, easier to maintain, clear separation
147
- **Cons**: Still procedural, limited extensibility
148
-
149
- ---
150
-
151
- ## Pattern 3: Object-Oriented Plugin
152
-
153
- **Complexity**: Medium-High
154
- **File Count**: 10-50 files
155
- **Team Size**: 2-5 developers
156
- **Use Case**: Large plugins, maintainable code, extensibility
157
-
158
- ### Structure
159
-
160
- ```
161
- my-plugin/
162
- ├── my-plugin.php # Main plugin file (bootstrap)
163
- ├── includes/
164
- │ ├── class-plugin.php # Main plugin class
165
- │ ├── class-admin.php # Admin functionality
166
- │ ├── class-public.php # Public functionality
167
- │ ├── class-loader.php # Hook loader
168
- │ └── class-activator.php # Activation logic
169
- ├── admin/
170
- │ ├── class-settings.php # Settings page
171
- │ └── partials/ # Admin view templates
172
- ├── public/
173
- │ ├── class-shortcode.php # Shortcode handler
174
- │ └── partials/ # Public view templates
175
- ├── assets/
176
- ├── languages/
177
- ├── uninstall.php
178
- └── readme.txt
179
- ```
180
-
181
- ### Implementation
182
-
183
- **Main Plugin File** (`my-plugin.php`):
184
-
185
- ```php
186
- <?php
187
- /**
188
- * Plugin Name: My OOP Plugin
189
- * Description: An object-oriented plugin
190
- * Version: 1.0.0
191
- */
192
-
193
- if (!defined('ABSPATH')) {
194
- exit;
195
- }
196
-
197
- // Define constants
198
- define('MY_PLUGIN_VERSION', '1.0.0');
199
- define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
200
-
201
- // Autoloader
202
- spl_autoload_register(function ($class) {
203
- $prefix = 'My_Plugin_';
204
- $base_dir = MY_PLUGIN_PATH . 'includes/';
205
-
206
- $len = strlen($prefix);
207
- if (strncmp($prefix, $class, $len) !== 0) {
208
- return;
209
- }
210
-
211
- $relative_class = substr($class, $len);
212
- $file = $base_dir . 'class-' . str_replace('_', '-', strtolower($relative_class)) . '.php';
213
-
214
- if (file_exists($file)) {
215
- require $file;
216
- }
217
- });
218
-
219
- // Activation/Deactivation
220
- register_activation_hook(__FILE__, array('My_Plugin_Activator', 'activate'));
221
- register_deactivation_hook(__FILE__, array('My_Plugin_Deactivator', 'deactivate'));
222
-
223
- // Run the plugin
224
- function run_my_plugin() {
225
- $plugin = new My_Plugin();
226
- $plugin->run();
227
- }
228
- run_my_plugin();
229
- ```
230
-
231
- **Main Plugin Class** (`includes/class-plugin.php`):
232
-
233
- ```php
234
- <?php
235
- class My_Plugin {
236
- protected $loader;
237
- protected $plugin_name;
238
- protected $version;
239
-
240
- public function __construct() {
241
- $this->version = MY_PLUGIN_VERSION;
242
- $this->plugin_name = 'my-plugin';
243
-
244
- $this->load_dependencies();
245
- $this->define_admin_hooks();
246
- $this->define_public_hooks();
247
- }
248
-
249
- private function load_dependencies() {
250
- require_once MY_PLUGIN_PATH . 'includes/class-loader.php';
251
- require_once MY_PLUGIN_PATH . 'includes/class-admin.php';
252
- require_once MY_PLUGIN_PATH . 'includes/class-public.php';
253
-
254
- $this->loader = new My_Plugin_Loader();
255
- }
256
-
257
- private function define_admin_hooks() {
258
- $admin = new My_Plugin_Admin($this->plugin_name, $this->version);
259
- $this->loader->add_action('admin_menu', $admin, 'add_admin_menu');
260
- $this->loader->add_action('admin_enqueue_scripts', $admin, 'enqueue_styles');
261
- }
262
-
263
- private function define_public_hooks() {
264
- $public = new My_Plugin_Public($this->plugin_name, $this->version);
265
- $this->loader->add_action('wp_enqueue_scripts', $public, 'enqueue_styles');
266
- }
267
-
268
- public function run() {
269
- $this->loader->run();
270
- }
271
- }
272
- ```
273
-
274
- ### When to Use
275
-
276
- ✅ Complex functionality
277
- ✅ Need for extensibility
278
- ✅ Multiple developers
279
- ✅ Long-term maintenance
280
-
281
- ### Pros & Cons
282
-
283
- **Pros**: Maintainable, extensible, testable, clear structure
284
- **Cons**: More complex, steeper learning curve
285
-
286
- ---
287
-
288
- ## Pattern 4: WordPress Plugin Boilerplate (WPPB)
289
-
290
- **Complexity**: High
291
- **File Count**: 20-100 files
292
- **Team Size**: 3-10 developers
293
- **Use Case**: Professional plugins, standardized structure, large teams
294
-
295
- ### Structure
296
-
297
- ```
298
- plugin-name/
299
- ├── plugin-name.php
300
- ├── admin/
301
- │ ├── class-plugin-name-admin.php
302
- │ ├── css/
303
- │ ├── js/
304
- │ └── partials/
305
- ├── includes/
306
- │ ├── class-plugin-name.php
307
- │ ├── class-plugin-name-loader.php
308
- │ ├── class-plugin-name-i18n.php
309
- │ ├── class-plugin-name-activator.php
310
- │ └── class-plugin-name-deactivator.php
311
- ├── public/
312
- │ ├── class-plugin-name-public.php
313
- │ ├── css/
314
- │ ├── js/
315
- │ └── partials/
316
- ├── languages/
317
- ├── uninstall.php
318
- └── README.txt
319
- ```
320
-
321
- ### When to Use
322
-
323
- ✅ Professional/commercial plugins
324
- ✅ Standardized team workflow
325
- ✅ WordPress.org submission
326
- ✅ Long-term support
327
-
328
- ### Pros & Cons
329
-
330
- **Pros**: Industry standard, well-documented, proven structure
331
- **Cons**: Overkill for simple plugins, verbose
332
-
333
- ---
334
-
335
- ## Pattern 5: Namespace-Based Plugin
336
-
337
- **Complexity**: Medium-High
338
- **File Count**: 10-50 files
339
- **Team Size**: 2-5 developers
340
- **Use Case**: Modern PHP, PSR-4 autoloading, Composer dependencies
341
-
342
- ### Structure
343
-
344
- ```
345
- my-plugin/
346
- ├── my-plugin.php
347
- ├── src/
348
- │ ├── Plugin.php
349
- │ ├── Admin/
350
- │ │ ├── Settings.php
351
- │ │ └── MetaBoxes.php
352
- │ ├── Frontend/
353
- │ │ ├── Shortcodes.php
354
- │ │ └── Widgets.php
355
- │ └── Core/
356
- │ ├── Activator.php
357
- │ └── Deactivator.php
358
- ├── vendor/ # Composer dependencies
359
- ├── composer.json
360
- └── readme.txt
361
- ```
362
-
363
- ### Implementation
364
-
365
- **composer.json**:
366
-
367
- ```json
368
- {
369
- "name": "vendor/my-plugin",
370
- "autoload": {
371
- "psr-4": {
372
- "MyPlugin\\": "src/"
373
- }
374
- },
375
- "require": {
376
- "php": ">=7.4"
377
- }
378
- }
379
- ```
380
-
381
- **Main Plugin File** (`my-plugin.php`):
382
-
383
- ```php
384
- <?php
385
- /**
386
- * Plugin Name: My Namespace Plugin
387
- * Description: A modern namespace-based plugin
388
- * Version: 1.0.0
389
- * Requires PHP: 7.4
390
- */
391
-
392
- namespace MyPlugin;
393
-
394
- if (!defined('ABSPATH')) {
395
- exit;
396
- }
397
-
398
- // Composer autoloader
399
- require_once __DIR__ . '/vendor/autoload.php';
400
-
401
- // Define constants
402
- define('MY_PLUGIN_VERSION', '1.0.0');
403
- define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
404
-
405
- // Activation/Deactivation
406
- register_activation_hook(__FILE__, [Core\Activator::class, 'activate']);
407
- register_deactivation_hook(__FILE__, [Core\Deactivator::class, 'deactivate']);
408
-
409
- // Run plugin
410
- (new Plugin())->run();
411
- ```
412
-
413
- **Plugin Class** (`src/Plugin.php`):
414
-
415
- ```php
416
- <?php
417
- namespace MyPlugin;
418
-
419
- class Plugin {
420
- public function run() {
421
- add_action('init', [$this, 'init']);
422
-
423
- if (is_admin()) {
424
- new Admin\Settings();
425
- } else {
426
- new Frontend\Shortcodes();
427
- }
428
- }
429
-
430
- public function init() {
431
- // Initialization code
432
- }
433
- }
434
- ```
435
-
436
- ### When to Use
437
-
438
- ✅ Modern PHP (7.4+)
439
- ✅ Composer dependencies
440
- ✅ PSR-4 autoloading
441
- ✅ Third-party libraries
442
-
443
- ### Pros & Cons
444
-
445
- **Pros**: Modern, clean namespaces, Composer support
446
- **Cons**: Requires Composer, not beginner-friendly
447
-
448
- ---
449
-
450
- ## Pattern 6: Service Container Plugin
451
-
452
- **Complexity**: High
453
- **File Count**: 30-100 files
454
- **Team Size**: 5-15 developers
455
- **Use Case**: Enterprise plugins, dependency injection, testability
456
-
457
- ### Structure
458
-
459
- ```
460
- my-plugin/
461
- ├── my-plugin.php
462
- ├── src/
463
- │ ├── Container.php
464
- │ ├── ServiceProvider.php
465
- │ ├── Services/
466
- │ │ ├── DatabaseService.php
467
- │ │ ├── CacheService.php
468
- │ │ └── ApiService.php
469
- │ ├── Controllers/
470
- │ │ ├── AdminController.php
471
- │ │ └── FrontendController.php
472
- │ └── Models/
473
- │ └── Post.php
474
- ├── config/
475
- │ └── services.php
476
- ├── vendor/
477
- ├── composer.json
478
- └── readme.txt
479
- ```
480
-
481
- ### Implementation
482
-
483
- **Service Container** (`src/Container.php`):
484
-
485
- ```php
486
- <?php
487
- namespace MyPlugin;
488
-
489
- class Container {
490
- private $services = [];
491
-
492
- public function register($name, $resolver) {
493
- $this->services[$name] = $resolver;
494
- }
495
-
496
- public function resolve($name) {
497
- if (!isset($this->services[$name])) {
498
- throw new \Exception("Service {$name} not found");
499
- }
500
-
501
- $resolver = $this->services[$name];
502
- return $resolver($this);
503
- }
504
- }
505
- ```
506
-
507
- **Service Provider** (`src/ServiceProvider.php`):
508
-
509
- ```php
510
- <?php
511
- namespace MyPlugin;
512
-
513
- class ServiceProvider {
514
- public static function register(Container $container) {
515
- $container->register('database', function($c) {
516
- return new Services\DatabaseService();
517
- });
518
-
519
- $container->register('cache', function($c) {
520
- return new Services\CacheService();
521
- });
522
-
523
- $container->register('admin', function($c) {
524
- return new Controllers\AdminController(
525
- $c->resolve('database'),
526
- $c->resolve('cache')
527
- );
528
- });
529
- }
530
- }
531
- ```
532
-
533
- ### When to Use
534
-
535
- ✅ Enterprise-level plugins
536
- ✅ Complex dependencies
537
- ✅ High testability requirements
538
- ✅ Large development teams
539
-
540
- ### Pros & Cons
541
-
542
- **Pros**: Highly testable, dependency injection, scalable
543
- **Cons**: Complex, overkill for most plugins
544
-
545
- ---
546
-
547
- ## Pattern 7: Modular Plugin System
548
-
549
- **Complexity**: Very High
550
- **File Count**: 50-500 files
551
- **Team Size**: 10+ developers
552
- **Use Case**: Plugin frameworks, extensible platforms, add-on ecosystems
553
-
554
- ### Structure
555
-
556
- ```
557
- my-plugin/
558
- ├── my-plugin.php
559
- ├── src/
560
- │ ├── Core/
561
- │ │ ├── ModuleLoader.php
562
- │ │ ├── HookManager.php
563
- │ │ └── EventDispatcher.php
564
- │ ├── Modules/
565
- │ │ ├── Admin/
566
- │ │ ├── Frontend/
567
- │ │ ├── API/
568
- │ │ └── Database/
569
- │ └── Interfaces/
570
- │ └── ModuleInterface.php
571
- ├── modules/ # Third-party modules
572
- ├── config/
573
- ├── vendor/
574
- └── readme.txt
575
- ```
576
-
577
- ### Implementation
578
-
579
- **Module Interface** (`src/Interfaces/ModuleInterface.php`):
580
-
581
- ```php
582
- <?php
583
- namespace MyPlugin\Interfaces;
584
-
585
- interface ModuleInterface {
586
- public function register();
587
- public function boot();
588
- public function getName();
589
- }
590
- ```
591
-
592
- **Module Loader** (`src/Core/ModuleLoader.php`):
593
-
594
- ```php
595
- <?php
596
- namespace MyPlugin\Core;
597
-
598
- use MyPlugin\Interfaces\ModuleInterface;
599
-
600
- class ModuleLoader {
601
- private $modules = [];
602
-
603
- public function register(ModuleInterface $module) {
604
- $this->modules[$module->getName()] = $module;
605
- $module->register();
606
- }
607
-
608
- public function boot() {
609
- foreach ($this->modules as $module) {
610
- $module->boot();
611
- }
612
- }
613
- }
614
- ```
615
-
616
- ### When to Use
617
-
618
- ✅ Plugin frameworks (e.g., WooCommerce, BuddyPress)
619
- ✅ Extensible platforms
620
- ✅ Add-on ecosystems
621
- ✅ Very large teams
622
-
623
- ### Pros & Cons
624
-
625
- **Pros**: Extremely extensible, modular, scalable
626
- **Cons**: Very complex, requires significant architecture
627
-
628
- ---
629
-
630
- ## Choosing the Right Pattern
631
-
632
- ### Decision Matrix
633
-
634
- | Pattern | Complexity | Files | Team Size | Use Case |
635
- |---------|-----------|-------|-----------|----------|
636
- | Simple Procedural | Low | 1-3 | 1 | Single feature |
637
- | Organized Procedural | Medium | 5-20 | 1-2 | Multiple features |
638
- | Object-Oriented | Medium-High | 10-50 | 2-5 | Large plugins |
639
- | WPPB | High | 20-100 | 3-10 | Professional |
640
- | Namespace-Based | Medium-High | 10-50 | 2-5 | Modern PHP |
641
- | Service Container | High | 30-100 | 5-15 | Enterprise |
642
- | Modular System | Very High | 50-500 | 10+ | Frameworks |
643
-
644
- ### Recommendation Flow
645
-
646
- 1. **Single feature?** → Simple Procedural
647
- 2. **Multiple features, 1-2 devs?** → Organized Procedural
648
- 3. **Need extensibility?** → Object-Oriented
649
- 4. **Professional/commercial?** → WPPB
650
- 5. **Using Composer?** → Namespace-Based
651
- 6. **Enterprise-level?** → Service Container
652
- 7. **Building framework?** → Modular System
653
-
654
- ---
655
-
656
- ## Best Practices
657
-
658
- ### All Patterns
659
-
660
- ✅ Always check `ABSPATH` constant
661
- ✅ Use proper WordPress coding standards
662
- ✅ Sanitize input, escape output
663
- ✅ Use WordPress APIs (don't reinvent the wheel)
664
- ✅ Follow semantic versioning
665
-
666
- ### OOP Patterns
667
-
668
- ✅ Use dependency injection
669
- ✅ Follow SOLID principles
670
- ✅ Write unit tests
671
- ✅ Use interfaces for contracts
672
- ✅ Keep classes focused (single responsibility)
673
-
674
- ### Modern Patterns
675
-
676
- ✅ Use Composer for dependencies
677
- ✅ Follow PSR-4 autoloading
678
- ✅ Use namespaces
679
- ✅ Leverage modern PHP features
680
- ✅ Write PHPDoc blocks
681
-
682
- ---
683
-
684
- ## Anti-Patterns to Avoid
685
-
686
- ❌ Global variables (use constants or class properties)
687
- ❌ Direct database queries (use `$wpdb` or WP_Query)
688
- ❌ Hardcoded paths (use `plugin_dir_path()`)
689
- ❌ Mixing HTML and PHP logic
690
- ❌ Not using WordPress hooks
691
- ❌ Ignoring security (nonces, sanitization)
692
- ❌ Not following WordPress coding standards
693
-
1
+ # WordPress Plugin Architecture Patterns
2
+
3
+ ## Overview
4
+
5
+ This document outlines 7 proven WordPress plugin architecture patterns, from simple procedural to enterprise-level. Choose the appropriate pattern based on plugin complexity, team size, and long-term maintenance needs.
6
+
7
+ ---
8
+
9
+ ## Pattern 1: Simple Procedural Plugin
10
+
11
+ **Complexity**: Low
12
+ **File Count**: 1-3 files
13
+ **Team Size**: 1 developer
14
+ **Use Case**: Single feature, utility functions, quick prototypes
15
+
16
+ ### Structure
17
+
18
+ ```
19
+ my-plugin/
20
+ ├── my-plugin.php # Main plugin file (all code)
21
+ └── readme.txt # WordPress.org readme
22
+ ```
23
+
24
+ ### Implementation
25
+
26
+ ```php
27
+ <?php
28
+ /**
29
+ * Plugin Name: My Simple Plugin
30
+ * Description: A simple plugin
31
+ * Version: 1.0.0
32
+ */
33
+
34
+ // Exit if accessed directly
35
+ if (!defined('ABSPATH')) {
36
+ exit;
37
+ }
38
+
39
+ // Add action hooks
40
+ add_action('init', 'my_plugin_init');
41
+ add_filter('the_content', 'my_plugin_filter_content');
42
+
43
+ function my_plugin_init() {
44
+ // Initialization code
45
+ }
46
+
47
+ function my_plugin_filter_content($content) {
48
+ // Filter content
49
+ return $content;
50
+ }
51
+ ```
52
+
53
+ ### When to Use
54
+
55
+ ✅ Single feature plugins (e.g., disable comments, add custom CSS)
56
+ ✅ Utility functions
57
+ ✅ Quick prototypes
58
+ ✅ Learning/tutorial plugins
59
+
60
+ ### Pros & Cons
61
+
62
+ **Pros**: Simple, fast to develop, easy to understand
63
+ **Cons**: Hard to maintain as complexity grows, no separation of concerns
64
+
65
+ ---
66
+
67
+ ## Pattern 2: Organized Procedural Plugin
68
+
69
+ **Complexity**: Medium
70
+ **File Count**: 5-20 files
71
+ **Team Size**: 1-2 developers
72
+ **Use Case**: Medium-sized plugins, organized code, team collaboration
73
+
74
+ ### Structure
75
+
76
+ ```
77
+ my-plugin/
78
+ ├── my-plugin.php # Main plugin file (loader)
79
+ ├── includes/
80
+ │ ├── functions.php # Core functions
81
+ │ ├── hooks.php # Hook callbacks
82
+ │ └── shortcodes.php # Shortcode handlers
83
+ ├── admin/
84
+ │ ├── settings.php # Admin settings
85
+ │ └── meta-boxes.php # Meta boxes
86
+ ├── public/
87
+ │ └── display.php # Frontend display
88
+ ├── assets/
89
+ │ ├── css/
90
+ │ ├── js/
91
+ │ └── images/
92
+ ├── languages/
93
+ ├── uninstall.php
94
+ └── readme.txt
95
+ ```
96
+
97
+ ### Implementation
98
+
99
+ **Main Plugin File** (`my-plugin.php`):
100
+
101
+ ```php
102
+ <?php
103
+ /**
104
+ * Plugin Name: My Organized Plugin
105
+ * Description: An organized procedural plugin
106
+ * Version: 1.0.0
107
+ */
108
+
109
+ if (!defined('ABSPATH')) {
110
+ exit;
111
+ }
112
+
113
+ // Define constants
114
+ define('MY_PLUGIN_VERSION', '1.0.0');
115
+ define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
116
+ define('MY_PLUGIN_URL', plugin_dir_url(__FILE__));
117
+
118
+ // Load dependencies
119
+ require_once MY_PLUGIN_PATH . 'includes/functions.php';
120
+ require_once MY_PLUGIN_PATH . 'includes/hooks.php';
121
+
122
+ // Admin functionality
123
+ if (is_admin()) {
124
+ require_once MY_PLUGIN_PATH . 'admin/settings.php';
125
+ }
126
+
127
+ // Public functionality
128
+ if (!is_admin()) {
129
+ require_once MY_PLUGIN_PATH . 'public/display.php';
130
+ }
131
+
132
+ // Activation/Deactivation
133
+ register_activation_hook(__FILE__, 'my_plugin_activate');
134
+ register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
135
+ ```
136
+
137
+ ### When to Use
138
+
139
+ ✅ Multiple features
140
+ ✅ Admin and frontend functionality
141
+ ✅ Custom assets (CSS/JS)
142
+ ✅ Team collaboration
143
+
144
+ ### Pros & Cons
145
+
146
+ **Pros**: Organized, easier to maintain, clear separation
147
+ **Cons**: Still procedural, limited extensibility
148
+
149
+ ---
150
+
151
+ ## Pattern 3: Object-Oriented Plugin
152
+
153
+ **Complexity**: Medium-High
154
+ **File Count**: 10-50 files
155
+ **Team Size**: 2-5 developers
156
+ **Use Case**: Large plugins, maintainable code, extensibility
157
+
158
+ ### Structure
159
+
160
+ ```
161
+ my-plugin/
162
+ ├── my-plugin.php # Main plugin file (bootstrap)
163
+ ├── includes/
164
+ │ ├── class-plugin.php # Main plugin class
165
+ │ ├── class-admin.php # Admin functionality
166
+ │ ├── class-public.php # Public functionality
167
+ │ ├── class-loader.php # Hook loader
168
+ │ └── class-activator.php # Activation logic
169
+ ├── admin/
170
+ │ ├── class-settings.php # Settings page
171
+ │ └── partials/ # Admin view templates
172
+ ├── public/
173
+ │ ├── class-shortcode.php # Shortcode handler
174
+ │ └── partials/ # Public view templates
175
+ ├── assets/
176
+ ├── languages/
177
+ ├── uninstall.php
178
+ └── readme.txt
179
+ ```
180
+
181
+ ### Implementation
182
+
183
+ **Main Plugin File** (`my-plugin.php`):
184
+
185
+ ```php
186
+ <?php
187
+ /**
188
+ * Plugin Name: My OOP Plugin
189
+ * Description: An object-oriented plugin
190
+ * Version: 1.0.0
191
+ */
192
+
193
+ if (!defined('ABSPATH')) {
194
+ exit;
195
+ }
196
+
197
+ // Define constants
198
+ define('MY_PLUGIN_VERSION', '1.0.0');
199
+ define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
200
+
201
+ // Autoloader
202
+ spl_autoload_register(function ($class) {
203
+ $prefix = 'My_Plugin_';
204
+ $base_dir = MY_PLUGIN_PATH . 'includes/';
205
+
206
+ $len = strlen($prefix);
207
+ if (strncmp($prefix, $class, $len) !== 0) {
208
+ return;
209
+ }
210
+
211
+ $relative_class = substr($class, $len);
212
+ $file = $base_dir . 'class-' . str_replace('_', '-', strtolower($relative_class)) . '.php';
213
+
214
+ if (file_exists($file)) {
215
+ require $file;
216
+ }
217
+ });
218
+
219
+ // Activation/Deactivation
220
+ register_activation_hook(__FILE__, array('My_Plugin_Activator', 'activate'));
221
+ register_deactivation_hook(__FILE__, array('My_Plugin_Deactivator', 'deactivate'));
222
+
223
+ // Run the plugin
224
+ function run_my_plugin() {
225
+ $plugin = new My_Plugin();
226
+ $plugin->run();
227
+ }
228
+ run_my_plugin();
229
+ ```
230
+
231
+ **Main Plugin Class** (`includes/class-plugin.php`):
232
+
233
+ ```php
234
+ <?php
235
+ class My_Plugin {
236
+ protected $loader;
237
+ protected $plugin_name;
238
+ protected $version;
239
+
240
+ public function __construct() {
241
+ $this->version = MY_PLUGIN_VERSION;
242
+ $this->plugin_name = 'my-plugin';
243
+
244
+ $this->load_dependencies();
245
+ $this->define_admin_hooks();
246
+ $this->define_public_hooks();
247
+ }
248
+
249
+ private function load_dependencies() {
250
+ require_once MY_PLUGIN_PATH . 'includes/class-loader.php';
251
+ require_once MY_PLUGIN_PATH . 'includes/class-admin.php';
252
+ require_once MY_PLUGIN_PATH . 'includes/class-public.php';
253
+
254
+ $this->loader = new My_Plugin_Loader();
255
+ }
256
+
257
+ private function define_admin_hooks() {
258
+ $admin = new My_Plugin_Admin($this->plugin_name, $this->version);
259
+ $this->loader->add_action('admin_menu', $admin, 'add_admin_menu');
260
+ $this->loader->add_action('admin_enqueue_scripts', $admin, 'enqueue_styles');
261
+ }
262
+
263
+ private function define_public_hooks() {
264
+ $public = new My_Plugin_Public($this->plugin_name, $this->version);
265
+ $this->loader->add_action('wp_enqueue_scripts', $public, 'enqueue_styles');
266
+ }
267
+
268
+ public function run() {
269
+ $this->loader->run();
270
+ }
271
+ }
272
+ ```
273
+
274
+ ### When to Use
275
+
276
+ ✅ Complex functionality
277
+ ✅ Need for extensibility
278
+ ✅ Multiple developers
279
+ ✅ Long-term maintenance
280
+
281
+ ### Pros & Cons
282
+
283
+ **Pros**: Maintainable, extensible, testable, clear structure
284
+ **Cons**: More complex, steeper learning curve
285
+
286
+ ---
287
+
288
+ ## Pattern 4: WordPress Plugin Boilerplate (WPPB)
289
+
290
+ **Complexity**: High
291
+ **File Count**: 20-100 files
292
+ **Team Size**: 3-10 developers
293
+ **Use Case**: Professional plugins, standardized structure, large teams
294
+
295
+ ### Structure
296
+
297
+ ```
298
+ plugin-name/
299
+ ├── plugin-name.php
300
+ ├── admin/
301
+ │ ├── class-plugin-name-admin.php
302
+ │ ├── css/
303
+ │ ├── js/
304
+ │ └── partials/
305
+ ├── includes/
306
+ │ ├── class-plugin-name.php
307
+ │ ├── class-plugin-name-loader.php
308
+ │ ├── class-plugin-name-i18n.php
309
+ │ ├── class-plugin-name-activator.php
310
+ │ └── class-plugin-name-deactivator.php
311
+ ├── public/
312
+ │ ├── class-plugin-name-public.php
313
+ │ ├── css/
314
+ │ ├── js/
315
+ │ └── partials/
316
+ ├── languages/
317
+ ├── uninstall.php
318
+ └── README.txt
319
+ ```
320
+
321
+ ### When to Use
322
+
323
+ ✅ Professional/commercial plugins
324
+ ✅ Standardized team workflow
325
+ ✅ WordPress.org submission
326
+ ✅ Long-term support
327
+
328
+ ### Pros & Cons
329
+
330
+ **Pros**: Industry standard, well-documented, proven structure
331
+ **Cons**: Overkill for simple plugins, verbose
332
+
333
+ ---
334
+
335
+ ## Pattern 5: Namespace-Based Plugin
336
+
337
+ **Complexity**: Medium-High
338
+ **File Count**: 10-50 files
339
+ **Team Size**: 2-5 developers
340
+ **Use Case**: Modern PHP, PSR-4 autoloading, Composer dependencies
341
+
342
+ ### Structure
343
+
344
+ ```
345
+ my-plugin/
346
+ ├── my-plugin.php
347
+ ├── src/
348
+ │ ├── Plugin.php
349
+ │ ├── Admin/
350
+ │ │ ├── Settings.php
351
+ │ │ └── MetaBoxes.php
352
+ │ ├── Frontend/
353
+ │ │ ├── Shortcodes.php
354
+ │ │ └── Widgets.php
355
+ │ └── Core/
356
+ │ ├── Activator.php
357
+ │ └── Deactivator.php
358
+ ├── vendor/ # Composer dependencies
359
+ ├── composer.json
360
+ └── readme.txt
361
+ ```
362
+
363
+ ### Implementation
364
+
365
+ **composer.json**:
366
+
367
+ ```json
368
+ {
369
+ "name": "vendor/my-plugin",
370
+ "autoload": {
371
+ "psr-4": {
372
+ "MyPlugin\\": "src/"
373
+ }
374
+ },
375
+ "require": {
376
+ "php": ">=7.4"
377
+ }
378
+ }
379
+ ```
380
+
381
+ **Main Plugin File** (`my-plugin.php`):
382
+
383
+ ```php
384
+ <?php
385
+ /**
386
+ * Plugin Name: My Namespace Plugin
387
+ * Description: A modern namespace-based plugin
388
+ * Version: 1.0.0
389
+ * Requires PHP: 7.4
390
+ */
391
+
392
+ namespace MyPlugin;
393
+
394
+ if (!defined('ABSPATH')) {
395
+ exit;
396
+ }
397
+
398
+ // Composer autoloader
399
+ require_once __DIR__ . '/vendor/autoload.php';
400
+
401
+ // Define constants
402
+ define('MY_PLUGIN_VERSION', '1.0.0');
403
+ define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
404
+
405
+ // Activation/Deactivation
406
+ register_activation_hook(__FILE__, [Core\Activator::class, 'activate']);
407
+ register_deactivation_hook(__FILE__, [Core\Deactivator::class, 'deactivate']);
408
+
409
+ // Run plugin
410
+ (new Plugin())->run();
411
+ ```
412
+
413
+ **Plugin Class** (`src/Plugin.php`):
414
+
415
+ ```php
416
+ <?php
417
+ namespace MyPlugin;
418
+
419
+ class Plugin {
420
+ public function run() {
421
+ add_action('init', [$this, 'init']);
422
+
423
+ if (is_admin()) {
424
+ new Admin\Settings();
425
+ } else {
426
+ new Frontend\Shortcodes();
427
+ }
428
+ }
429
+
430
+ public function init() {
431
+ // Initialization code
432
+ }
433
+ }
434
+ ```
435
+
436
+ ### When to Use
437
+
438
+ ✅ Modern PHP (7.4+)
439
+ ✅ Composer dependencies
440
+ ✅ PSR-4 autoloading
441
+ ✅ Third-party libraries
442
+
443
+ ### Pros & Cons
444
+
445
+ **Pros**: Modern, clean namespaces, Composer support
446
+ **Cons**: Requires Composer, not beginner-friendly
447
+
448
+ ---
449
+
450
+ ## Pattern 6: Service Container Plugin
451
+
452
+ **Complexity**: High
453
+ **File Count**: 30-100 files
454
+ **Team Size**: 5-15 developers
455
+ **Use Case**: Enterprise plugins, dependency injection, testability
456
+
457
+ ### Structure
458
+
459
+ ```
460
+ my-plugin/
461
+ ├── my-plugin.php
462
+ ├── src/
463
+ │ ├── Container.php
464
+ │ ├── ServiceProvider.php
465
+ │ ├── Services/
466
+ │ │ ├── DatabaseService.php
467
+ │ │ ├── CacheService.php
468
+ │ │ └── ApiService.php
469
+ │ ├── Controllers/
470
+ │ │ ├── AdminController.php
471
+ │ │ └── FrontendController.php
472
+ │ └── Models/
473
+ │ └── Post.php
474
+ ├── config/
475
+ │ └── services.php
476
+ ├── vendor/
477
+ ├── composer.json
478
+ └── readme.txt
479
+ ```
480
+
481
+ ### Implementation
482
+
483
+ **Service Container** (`src/Container.php`):
484
+
485
+ ```php
486
+ <?php
487
+ namespace MyPlugin;
488
+
489
+ class Container {
490
+ private $services = [];
491
+
492
+ public function register($name, $resolver) {
493
+ $this->services[$name] = $resolver;
494
+ }
495
+
496
+ public function resolve($name) {
497
+ if (!isset($this->services[$name])) {
498
+ throw new \Exception("Service {$name} not found");
499
+ }
500
+
501
+ $resolver = $this->services[$name];
502
+ return $resolver($this);
503
+ }
504
+ }
505
+ ```
506
+
507
+ **Service Provider** (`src/ServiceProvider.php`):
508
+
509
+ ```php
510
+ <?php
511
+ namespace MyPlugin;
512
+
513
+ class ServiceProvider {
514
+ public static function register(Container $container) {
515
+ $container->register('database', function($c) {
516
+ return new Services\DatabaseService();
517
+ });
518
+
519
+ $container->register('cache', function($c) {
520
+ return new Services\CacheService();
521
+ });
522
+
523
+ $container->register('admin', function($c) {
524
+ return new Controllers\AdminController(
525
+ $c->resolve('database'),
526
+ $c->resolve('cache')
527
+ );
528
+ });
529
+ }
530
+ }
531
+ ```
532
+
533
+ ### When to Use
534
+
535
+ ✅ Enterprise-level plugins
536
+ ✅ Complex dependencies
537
+ ✅ High testability requirements
538
+ ✅ Large development teams
539
+
540
+ ### Pros & Cons
541
+
542
+ **Pros**: Highly testable, dependency injection, scalable
543
+ **Cons**: Complex, overkill for most plugins
544
+
545
+ ---
546
+
547
+ ## Pattern 7: Modular Plugin System
548
+
549
+ **Complexity**: Very High
550
+ **File Count**: 50-500 files
551
+ **Team Size**: 10+ developers
552
+ **Use Case**: Plugin frameworks, extensible platforms, add-on ecosystems
553
+
554
+ ### Structure
555
+
556
+ ```
557
+ my-plugin/
558
+ ├── my-plugin.php
559
+ ├── src/
560
+ │ ├── Core/
561
+ │ │ ├── ModuleLoader.php
562
+ │ │ ├── HookManager.php
563
+ │ │ └── EventDispatcher.php
564
+ │ ├── Modules/
565
+ │ │ ├── Admin/
566
+ │ │ ├── Frontend/
567
+ │ │ ├── API/
568
+ │ │ └── Database/
569
+ │ └── Interfaces/
570
+ │ └── ModuleInterface.php
571
+ ├── modules/ # Third-party modules
572
+ ├── config/
573
+ ├── vendor/
574
+ └── readme.txt
575
+ ```
576
+
577
+ ### Implementation
578
+
579
+ **Module Interface** (`src/Interfaces/ModuleInterface.php`):
580
+
581
+ ```php
582
+ <?php
583
+ namespace MyPlugin\Interfaces;
584
+
585
+ interface ModuleInterface {
586
+ public function register();
587
+ public function boot();
588
+ public function getName();
589
+ }
590
+ ```
591
+
592
+ **Module Loader** (`src/Core/ModuleLoader.php`):
593
+
594
+ ```php
595
+ <?php
596
+ namespace MyPlugin\Core;
597
+
598
+ use MyPlugin\Interfaces\ModuleInterface;
599
+
600
+ class ModuleLoader {
601
+ private $modules = [];
602
+
603
+ public function register(ModuleInterface $module) {
604
+ $this->modules[$module->getName()] = $module;
605
+ $module->register();
606
+ }
607
+
608
+ public function boot() {
609
+ foreach ($this->modules as $module) {
610
+ $module->boot();
611
+ }
612
+ }
613
+ }
614
+ ```
615
+
616
+ ### When to Use
617
+
618
+ ✅ Plugin frameworks (e.g., WooCommerce, BuddyPress)
619
+ ✅ Extensible platforms
620
+ ✅ Add-on ecosystems
621
+ ✅ Very large teams
622
+
623
+ ### Pros & Cons
624
+
625
+ **Pros**: Extremely extensible, modular, scalable
626
+ **Cons**: Very complex, requires significant architecture
627
+
628
+ ---
629
+
630
+ ## Choosing the Right Pattern
631
+
632
+ ### Decision Matrix
633
+
634
+ | Pattern | Complexity | Files | Team Size | Use Case |
635
+ |---------|-----------|-------|-----------|----------|
636
+ | Simple Procedural | Low | 1-3 | 1 | Single feature |
637
+ | Organized Procedural | Medium | 5-20 | 1-2 | Multiple features |
638
+ | Object-Oriented | Medium-High | 10-50 | 2-5 | Large plugins |
639
+ | WPPB | High | 20-100 | 3-10 | Professional |
640
+ | Namespace-Based | Medium-High | 10-50 | 2-5 | Modern PHP |
641
+ | Service Container | High | 30-100 | 5-15 | Enterprise |
642
+ | Modular System | Very High | 50-500 | 10+ | Frameworks |
643
+
644
+ ### Recommendation Flow
645
+
646
+ 1. **Single feature?** → Simple Procedural
647
+ 2. **Multiple features, 1-2 devs?** → Organized Procedural
648
+ 3. **Need extensibility?** → Object-Oriented
649
+ 4. **Professional/commercial?** → WPPB
650
+ 5. **Using Composer?** → Namespace-Based
651
+ 6. **Enterprise-level?** → Service Container
652
+ 7. **Building framework?** → Modular System
653
+
654
+ ---
655
+
656
+ ## Best Practices
657
+
658
+ ### All Patterns
659
+
660
+ ✅ Always check `ABSPATH` constant
661
+ ✅ Use proper WordPress coding standards
662
+ ✅ Sanitize input, escape output
663
+ ✅ Use WordPress APIs (don't reinvent the wheel)
664
+ ✅ Follow semantic versioning
665
+
666
+ ### OOP Patterns
667
+
668
+ ✅ Use dependency injection
669
+ ✅ Follow SOLID principles
670
+ ✅ Write unit tests
671
+ ✅ Use interfaces for contracts
672
+ ✅ Keep classes focused (single responsibility)
673
+
674
+ ### Modern Patterns
675
+
676
+ ✅ Use Composer for dependencies
677
+ ✅ Follow PSR-4 autoloading
678
+ ✅ Use namespaces
679
+ ✅ Leverage modern PHP features
680
+ ✅ Write PHPDoc blocks
681
+
682
+ ---
683
+
684
+ ## Anti-Patterns to Avoid
685
+
686
+ ❌ Global variables (use constants or class properties)
687
+ ❌ Direct database queries (use `$wpdb` or WP_Query)
688
+ ❌ Hardcoded paths (use `plugin_dir_path()`)
689
+ ❌ Mixing HTML and PHP logic
690
+ ❌ Not using WordPress hooks
691
+ ❌ Ignoring security (nonces, sanitization)
692
+ ❌ Not following WordPress coding standards
693
+