@mytechtoday/augment-extensions 0.5.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 (523) 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 +113 -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 +15 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +576 -23
  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/config-system.d.ts +111 -0
  476. package/cli/dist/utils/config-system.d.ts.map +1 -0
  477. package/cli/dist/utils/config-system.js +239 -0
  478. package/cli/dist/utils/config-system.js.map +1 -0
  479. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  480. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  481. package/cli/dist/utils/extractCommandHelp.js +250 -0
  482. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  483. package/cli/dist/utils/hook-system.d.ts +84 -0
  484. package/cli/dist/utils/hook-system.d.ts.map +1 -0
  485. package/cli/dist/utils/hook-system.js +151 -0
  486. package/cli/dist/utils/hook-system.js.map +1 -0
  487. package/cli/dist/utils/inspection-cache.d.ts +56 -0
  488. package/cli/dist/utils/inspection-cache.d.ts.map +1 -0
  489. package/cli/dist/utils/inspection-cache.js +166 -0
  490. package/cli/dist/utils/inspection-cache.js.map +1 -0
  491. package/cli/dist/utils/inspection-handlers.d.ts +75 -0
  492. package/cli/dist/utils/inspection-handlers.d.ts.map +1 -0
  493. package/cli/dist/utils/inspection-handlers.js +171 -0
  494. package/cli/dist/utils/inspection-handlers.js.map +1 -0
  495. package/cli/dist/utils/install-rules.js +55 -55
  496. package/cli/dist/utils/mcp-integration.js +44 -44
  497. package/cli/dist/utils/module-system.d.ts +1 -0
  498. package/cli/dist/utils/module-system.d.ts.map +1 -1
  499. package/cli/dist/utils/module-system.js +8 -3
  500. package/cli/dist/utils/module-system.js.map +1 -1
  501. package/cli/dist/utils/plugin-system.d.ts +133 -0
  502. package/cli/dist/utils/plugin-system.d.ts.map +1 -0
  503. package/cli/dist/utils/plugin-system.js +210 -0
  504. package/cli/dist/utils/plugin-system.js.map +1 -0
  505. package/cli/dist/utils/progress.d.ts +67 -0
  506. package/cli/dist/utils/progress.d.ts.map +1 -0
  507. package/cli/dist/utils/progress.js +146 -0
  508. package/cli/dist/utils/progress.js.map +1 -0
  509. package/cli/dist/utils/rule-install-hooks.js +8 -8
  510. package/cli/dist/utils/stream-reader.d.ts +34 -0
  511. package/cli/dist/utils/stream-reader.d.ts.map +1 -0
  512. package/cli/dist/utils/stream-reader.js +147 -0
  513. package/cli/dist/utils/stream-reader.js.map +1 -0
  514. package/cli/dist/utils/vscode-editor.d.ts +45 -0
  515. package/cli/dist/utils/vscode-editor.d.ts.map +1 -0
  516. package/cli/dist/utils/vscode-editor.js +171 -0
  517. package/cli/dist/utils/vscode-editor.js.map +1 -0
  518. package/cli/dist/utils/vscode-links.d.ts +49 -0
  519. package/cli/dist/utils/vscode-links.d.ts.map +1 -0
  520. package/cli/dist/utils/vscode-links.js +167 -0
  521. package/cli/dist/utils/vscode-links.js.map +1 -0
  522. package/modules.md +667 -630
  523. package/package.json +85 -85
@@ -1,770 +1,770 @@
1
- # WordPress Plugin Activation, Deactivation, and Uninstall Hooks
2
-
3
- ## Overview
4
-
5
- This document covers the proper implementation of plugin lifecycle hooks: activation, deactivation, and uninstall. These hooks are critical for setting up plugin requirements, cleaning up data, and ensuring a smooth user experience.
6
-
7
- ---
8
-
9
- ## Activation Hook
10
-
11
- ### Purpose
12
-
13
- The activation hook runs **once** when the plugin is activated. Use it to:
14
-
15
- - Create custom database tables
16
- - Add default options
17
- - Set up capabilities/roles
18
- - Schedule cron events
19
- - Flush rewrite rules
20
- - Check system requirements
21
-
22
- ### Basic Implementation
23
-
24
- ```php
25
- <?php
26
- /**
27
- * Plugin Name: My Plugin
28
- */
29
-
30
- // Register activation hook
31
- register_activation_hook(__FILE__, 'my_plugin_activate');
32
-
33
- function my_plugin_activate() {
34
- // Activation code here
35
-
36
- // Example: Add default options
37
- add_option('my_plugin_version', '1.0.0');
38
- add_option('my_plugin_settings', array(
39
- 'enabled' => true,
40
- 'api_key' => ''
41
- ));
42
-
43
- // Flush rewrite rules
44
- flush_rewrite_rules();
45
- }
46
- ```
47
-
48
- ### Object-Oriented Implementation
49
-
50
- ```php
51
- <?php
52
- class My_Plugin_Activator {
53
- public static function activate() {
54
- self::create_tables();
55
- self::add_default_options();
56
- self::add_capabilities();
57
- self::schedule_cron();
58
-
59
- // Store activation timestamp
60
- update_option('my_plugin_activated_time', time());
61
- }
62
-
63
- private static function create_tables() {
64
- global $wpdb;
65
- $table_name = $wpdb->prefix . 'my_plugin_data';
66
- $charset_collate = $wpdb->get_charset_collate();
67
-
68
- $sql = "CREATE TABLE $table_name (
69
- id mediumint(9) NOT NULL AUTO_INCREMENT,
70
- name varchar(100) NOT NULL,
71
- data text NOT NULL,
72
- created_at datetime DEFAULT CURRENT_TIMESTAMP,
73
- PRIMARY KEY (id)
74
- ) $charset_collate;";
75
-
76
- require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
77
- dbDelta($sql);
78
- }
79
-
80
- private static function add_default_options() {
81
- $defaults = array(
82
- 'my_plugin_version' => '1.0.0',
83
- 'my_plugin_settings' => array(
84
- 'enabled' => true,
85
- 'items_per_page' => 10
86
- )
87
- );
88
-
89
- foreach ($defaults as $key => $value) {
90
- add_option($key, $value);
91
- }
92
- }
93
-
94
- private static function add_capabilities() {
95
- $role = get_role('administrator');
96
- if ($role) {
97
- $role->add_cap('manage_my_plugin');
98
- $role->add_cap('edit_my_plugin_items');
99
- }
100
- }
101
-
102
- private static function schedule_cron() {
103
- if (!wp_next_scheduled('my_plugin_daily_task')) {
104
- wp_schedule_event(time(), 'daily', 'my_plugin_daily_task');
105
- }
106
- }
107
- }
108
-
109
- // Register hook
110
- register_activation_hook(__FILE__, array('My_Plugin_Activator', 'activate'));
111
- ```
112
-
113
- ### System Requirements Check
114
-
115
- ```php
116
- <?php
117
- function my_plugin_activate() {
118
- // Check PHP version
119
- if (version_compare(PHP_VERSION, '7.4', '<')) {
120
- deactivate_plugins(plugin_basename(__FILE__));
121
- wp_die('This plugin requires PHP 7.4 or higher.');
122
- }
123
-
124
- // Check WordPress version
125
- global $wp_version;
126
- if (version_compare($wp_version, '5.8', '<')) {
127
- deactivate_plugins(plugin_basename(__FILE__));
128
- wp_die('This plugin requires WordPress 5.8 or higher.');
129
- }
130
-
131
- // Check for required plugins
132
- if (!is_plugin_active('woocommerce/woocommerce.php')) {
133
- deactivate_plugins(plugin_basename(__FILE__));
134
- wp_die('This plugin requires WooCommerce to be installed and activated.');
135
- }
136
-
137
- // Check for required PHP extensions
138
- if (!extension_loaded('curl')) {
139
- deactivate_plugins(plugin_basename(__FILE__));
140
- wp_die('This plugin requires the PHP cURL extension.');
141
- }
142
-
143
- // All checks passed - proceed with activation
144
- my_plugin_setup();
145
- }
146
- ```
147
-
148
- ### Multisite Activation
149
-
150
- ```php
151
- <?php
152
- function my_plugin_activate($network_wide) {
153
- if (is_multisite() && $network_wide) {
154
- // Network activation
155
- global $wpdb;
156
-
157
- // Get all blog IDs
158
- $blog_ids = $wpdb->get_col("SELECT blog_id FROM $wpdb->blogs");
159
-
160
- foreach ($blog_ids as $blog_id) {
161
- switch_to_blog($blog_id);
162
- my_plugin_activate_single_site();
163
- restore_current_blog();
164
- }
165
- } else {
166
- // Single site activation
167
- my_plugin_activate_single_site();
168
- }
169
- }
170
-
171
- function my_plugin_activate_single_site() {
172
- // Activation code for single site
173
- add_option('my_plugin_version', '1.0.0');
174
- }
175
-
176
- register_activation_hook(__FILE__, 'my_plugin_activate');
177
- ```
178
-
179
- ---
180
-
181
- ## Deactivation Hook
182
-
183
- ### Purpose
184
-
185
- The deactivation hook runs when the plugin is deactivated. Use it to:
186
-
187
- - Clear scheduled cron events
188
- - Flush rewrite rules
189
- - Clear transients/caches
190
- - **DO NOT** delete user data or options
191
-
192
- ### Basic Implementation
193
-
194
- ```php
195
- <?php
196
- register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
197
-
198
- function my_plugin_deactivate() {
199
- // Clear scheduled events
200
- $timestamp = wp_next_scheduled('my_plugin_daily_task');
201
- if ($timestamp) {
202
- wp_unschedule_event($timestamp, 'my_plugin_daily_task');
203
- }
204
-
205
- // Flush rewrite rules
206
- flush_rewrite_rules();
207
-
208
- // Clear transients
209
- delete_transient('my_plugin_cache');
210
- }
211
- ```
212
-
213
- ### Object-Oriented Implementation
214
-
215
- ```php
216
- <?php
217
- class My_Plugin_Deactivator {
218
- public static function deactivate() {
219
- self::clear_cron_jobs();
220
- self::flush_cache();
221
- self::flush_rewrite_rules();
222
-
223
- // Log deactivation
224
- update_option('my_plugin_deactivated_time', time());
225
- }
226
-
227
- private static function clear_cron_jobs() {
228
- $cron_hooks = array(
229
- 'my_plugin_daily_task',
230
- 'my_plugin_hourly_task',
231
- 'my_plugin_cleanup_task'
232
- );
233
-
234
- foreach ($cron_hooks as $hook) {
235
- $timestamp = wp_next_scheduled($hook);
236
- if ($timestamp) {
237
- wp_unschedule_event($timestamp, $hook);
238
- }
239
- }
240
- }
241
-
242
- private static function flush_cache() {
243
- // Delete transients
244
- delete_transient('my_plugin_cache');
245
- delete_transient('my_plugin_api_response');
246
-
247
- // Clear object cache
248
- wp_cache_flush();
249
- }
250
-
251
- private static function flush_rewrite_rules() {
252
- flush_rewrite_rules();
253
- }
254
- }
255
-
256
- register_deactivation_hook(__FILE__, array('My_Plugin_Deactivator', 'deactivate'));
257
- ```
258
-
259
- ### What NOT to Do on Deactivation
260
-
261
- ❌ **DO NOT** delete user data
262
- ❌ **DO NOT** delete options/settings
263
- ❌ **DO NOT** drop database tables
264
- ❌ **DO NOT** remove user capabilities
265
-
266
- **Reason**: Users may reactivate the plugin and expect their data to be intact.
267
-
268
- ---
269
-
270
- ## Uninstall Hook
271
-
272
- ### Purpose
273
-
274
- The uninstall hook runs when the plugin is **deleted** (not just deactivated). Use it to:
275
-
276
- - Delete all plugin options
277
- - Drop custom database tables
278
- - Remove custom capabilities
279
- - Delete uploaded files
280
- - Clean up everything
281
-
282
- ### Method 1: uninstall.php (Recommended)
283
-
284
- Create a file named `uninstall.php` in the plugin root:
285
-
286
- ```php
287
- <?php
288
- /**
289
- * Uninstall script
290
- *
291
- * Runs when plugin is deleted via WordPress admin
292
- */
293
-
294
- // Exit if accessed directly
295
- if (!defined('WP_UNINSTALL_PLUGIN')) {
296
- exit;
297
- }
298
-
299
- // Delete options
300
- delete_option('my_plugin_version');
301
- delete_option('my_plugin_settings');
302
- delete_option('my_plugin_activated_time');
303
- delete_option('my_plugin_deactivated_time');
304
-
305
- // Delete transients
306
- delete_transient('my_plugin_cache');
307
-
308
- // Drop custom tables
309
- global $wpdb;
310
- $table_name = $wpdb->prefix . 'my_plugin_data';
311
- $wpdb->query("DROP TABLE IF EXISTS $table_name");
312
-
313
- // Remove capabilities
314
- $role = get_role('administrator');
315
- if ($role) {
316
- $role->remove_cap('manage_my_plugin');
317
- $role->remove_cap('edit_my_plugin_items');
318
- }
319
-
320
- // Delete uploaded files
321
- $upload_dir = wp_upload_dir();
322
- $plugin_upload_dir = $upload_dir['basedir'] . '/my-plugin';
323
- if (is_dir($plugin_upload_dir)) {
324
- // Recursively delete directory
325
- array_map('unlink', glob("$plugin_upload_dir/*.*"));
326
- rmdir($plugin_upload_dir);
327
- }
328
-
329
- // Clear scheduled events (if any remain)
330
- wp_clear_scheduled_hook('my_plugin_daily_task');
331
- ```
332
-
333
- ### Method 2: register_uninstall_hook()
334
-
335
- ```php
336
- <?php
337
- /**
338
- * Plugin Name: My Plugin
339
- */
340
-
341
- // Register uninstall hook
342
- register_uninstall_hook(__FILE__, 'my_plugin_uninstall');
343
-
344
- function my_plugin_uninstall() {
345
- // Uninstall code here
346
- delete_option('my_plugin_version');
347
- delete_option('my_plugin_settings');
348
-
349
- global $wpdb;
350
- $table_name = $wpdb->prefix . 'my_plugin_data';
351
- $wpdb->query("DROP TABLE IF EXISTS $table_name");
352
- }
353
- ```
354
-
355
- ### Object-Oriented Uninstall (uninstall.php)
356
-
357
- ```php
358
- <?php
359
- if (!defined('WP_UNINSTALL_PLUGIN')) {
360
- exit;
361
- }
362
-
363
- // Load plugin classes
364
- require_once plugin_dir_path(__FILE__) . 'includes/class-uninstaller.php';
365
-
366
- // Run uninstall
367
- My_Plugin_Uninstaller::uninstall();
368
- ```
369
-
370
- **Uninstaller Class** (`includes/class-uninstaller.php`):
371
-
372
- ```php
373
- <?php
374
- class My_Plugin_Uninstaller {
375
- public static function uninstall() {
376
- self::delete_options();
377
- self::delete_transients();
378
- self::drop_tables();
379
- self::remove_capabilities();
380
- self::delete_files();
381
- self::clear_cron();
382
- }
383
-
384
- private static function delete_options() {
385
- $options = array(
386
- 'my_plugin_version',
387
- 'my_plugin_settings',
388
- 'my_plugin_activated_time',
389
- 'my_plugin_deactivated_time'
390
- );
391
-
392
- foreach ($options as $option) {
393
- delete_option($option);
394
- }
395
- }
396
-
397
- private static function delete_transients() {
398
- global $wpdb;
399
-
400
- // Delete all transients with plugin prefix
401
- $wpdb->query(
402
- "DELETE FROM $wpdb->options
403
- WHERE option_name LIKE '_transient_my_plugin_%'
404
- OR option_name LIKE '_transient_timeout_my_plugin_%'"
405
- );
406
- }
407
-
408
- private static function drop_tables() {
409
- global $wpdb;
410
-
411
- $tables = array(
412
- $wpdb->prefix . 'my_plugin_data',
413
- $wpdb->prefix . 'my_plugin_logs'
414
- );
415
-
416
- foreach ($tables as $table) {
417
- $wpdb->query("DROP TABLE IF EXISTS $table");
418
- }
419
- }
420
-
421
- private static function remove_capabilities() {
422
- $capabilities = array(
423
- 'manage_my_plugin',
424
- 'edit_my_plugin_items',
425
- 'delete_my_plugin_items'
426
- );
427
-
428
- $roles = array('administrator', 'editor');
429
-
430
- foreach ($roles as $role_name) {
431
- $role = get_role($role_name);
432
- if ($role) {
433
- foreach ($capabilities as $cap) {
434
- $role->remove_cap($cap);
435
- }
436
- }
437
- }
438
- }
439
-
440
- private static function delete_files() {
441
- $upload_dir = wp_upload_dir();
442
- $plugin_dir = $upload_dir['basedir'] . '/my-plugin';
443
-
444
- if (is_dir($plugin_dir)) {
445
- self::delete_directory($plugin_dir);
446
- }
447
- }
448
-
449
- private static function delete_directory($dir) {
450
- if (!is_dir($dir)) {
451
- return;
452
- }
453
-
454
- $files = array_diff(scandir($dir), array('.', '..'));
455
-
456
- foreach ($files as $file) {
457
- $path = $dir . '/' . $file;
458
- is_dir($path) ? self::delete_directory($path) : unlink($path);
459
- }
460
-
461
- rmdir($dir);
462
- }
463
-
464
- private static function clear_cron() {
465
- wp_clear_scheduled_hook('my_plugin_daily_task');
466
- wp_clear_scheduled_hook('my_plugin_hourly_task');
467
- }
468
- }
469
- ```
470
-
471
- ### Multisite Uninstall
472
-
473
- ```php
474
- <?php
475
- if (!defined('WP_UNINSTALL_PLUGIN')) {
476
- exit;
477
- }
478
-
479
- if (is_multisite()) {
480
- global $wpdb;
481
-
482
- // Get all blog IDs
483
- $blog_ids = $wpdb->get_col("SELECT blog_id FROM $wpdb->blogs");
484
-
485
- foreach ($blog_ids as $blog_id) {
486
- switch_to_blog($blog_id);
487
- my_plugin_uninstall_single_site();
488
- restore_current_blog();
489
- }
490
-
491
- // Delete network-wide options
492
- delete_site_option('my_plugin_network_settings');
493
- } else {
494
- my_plugin_uninstall_single_site();
495
- }
496
-
497
- function my_plugin_uninstall_single_site() {
498
- // Delete options
499
- delete_option('my_plugin_version');
500
- delete_option('my_plugin_settings');
501
-
502
- // Drop tables
503
- global $wpdb;
504
- $table_name = $wpdb->prefix . 'my_plugin_data';
505
- $wpdb->query("DROP TABLE IF EXISTS $table_name");
506
- }
507
- ```
508
-
509
- ---
510
-
511
- ## Database Table Management
512
-
513
- ### Creating Tables (Activation)
514
-
515
- ```php
516
- <?php
517
- function my_plugin_create_tables() {
518
- global $wpdb;
519
-
520
- $table_name = $wpdb->prefix . 'my_plugin_data';
521
- $charset_collate = $wpdb->get_charset_collate();
522
-
523
- $sql = "CREATE TABLE $table_name (
524
- id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
525
- user_id bigint(20) unsigned NOT NULL,
526
- title varchar(255) NOT NULL,
527
- content longtext NOT NULL,
528
- status varchar(20) DEFAULT 'draft',
529
- created_at datetime DEFAULT CURRENT_TIMESTAMP,
530
- updated_at datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
531
- PRIMARY KEY (id),
532
- KEY user_id (user_id),
533
- KEY status (status)
534
- ) $charset_collate;";
535
-
536
- require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
537
- dbDelta($sql);
538
-
539
- // Store database version
540
- add_option('my_plugin_db_version', '1.0');
541
- }
542
- ```
543
-
544
- ### Updating Tables (Version Check)
545
-
546
- ```php
547
- <?php
548
- function my_plugin_update_db_check() {
549
- $current_version = get_option('my_plugin_db_version', '0');
550
- $new_version = '1.1';
551
-
552
- if (version_compare($current_version, $new_version, '<')) {
553
- my_plugin_update_tables();
554
- update_option('my_plugin_db_version', $new_version);
555
- }
556
- }
557
- add_action('plugins_loaded', 'my_plugin_update_db_check');
558
-
559
- function my_plugin_update_tables() {
560
- global $wpdb;
561
-
562
- $table_name = $wpdb->prefix . 'my_plugin_data';
563
-
564
- // Add new column
565
- $wpdb->query("ALTER TABLE $table_name ADD COLUMN new_field varchar(100) DEFAULT NULL");
566
- }
567
- ```
568
-
569
- ---
570
-
571
- ## Best Practices
572
-
573
- ### Activation
574
-
575
- ✅ Check system requirements (PHP, WordPress, extensions)
576
- ✅ Create database tables using `dbDelta()`
577
- ✅ Add default options with `add_option()` (not `update_option()`)
578
- ✅ Flush rewrite rules if registering custom post types/taxonomies
579
- ✅ Schedule cron events
580
- ✅ Store activation timestamp
581
- ✅ Check for multisite and handle accordingly
582
-
583
- ### Deactivation
584
-
585
- ✅ Clear scheduled cron events
586
- ✅ Flush rewrite rules
587
- ✅ Clear transients and caches
588
- ❌ **DO NOT** delete user data
589
- ❌ **DO NOT** delete options
590
- ❌ **DO NOT** drop tables
591
-
592
- ### Uninstall
593
-
594
- ✅ Use `uninstall.php` (preferred) or `register_uninstall_hook()`
595
- ✅ Delete ALL plugin options
596
- ✅ Drop ALL custom tables
597
- ✅ Remove ALL capabilities
598
- ✅ Delete ALL uploaded files
599
- ✅ Clear ALL scheduled events
600
- ✅ Handle multisite properly
601
- ✅ Be thorough - leave no trace
602
-
603
- ---
604
-
605
- ## Common Patterns
606
-
607
- ### Version-Based Activation
608
-
609
- ```php
610
- <?php
611
- function my_plugin_activate() {
612
- $current_version = get_option('my_plugin_version', '0');
613
- $new_version = '2.0.0';
614
-
615
- if (version_compare($current_version, $new_version, '<')) {
616
- // Upgrade from older version
617
- my_plugin_upgrade($current_version, $new_version);
618
- } else {
619
- // Fresh install
620
- my_plugin_fresh_install();
621
- }
622
-
623
- update_option('my_plugin_version', $new_version);
624
- }
625
-
626
- function my_plugin_upgrade($from, $to) {
627
- // Migration logic
628
- if (version_compare($from, '1.5.0', '<')) {
629
- // Migrate from < 1.5.0
630
- }
631
-
632
- if (version_compare($from, '2.0.0', '<')) {
633
- // Migrate from < 2.0.0
634
- }
635
- }
636
-
637
- function my_plugin_fresh_install() {
638
- // Fresh installation logic
639
- my_plugin_create_tables();
640
- my_plugin_add_default_options();
641
- }
642
- ```
643
-
644
- ### Conditional Uninstall
645
-
646
- ```php
647
- <?php
648
- // uninstall.php
649
-
650
- if (!defined('WP_UNINSTALL_PLUGIN')) {
651
- exit;
652
- }
653
-
654
- // Check if user wants to keep data
655
- $keep_data = get_option('my_plugin_keep_data_on_uninstall', false);
656
-
657
- if (!$keep_data) {
658
- // Delete everything
659
- delete_option('my_plugin_version');
660
- delete_option('my_plugin_settings');
661
-
662
- global $wpdb;
663
- $wpdb->query("DROP TABLE IF EXISTS {$wpdb->prefix}my_plugin_data");
664
- } else {
665
- // Keep data, just mark as uninstalled
666
- update_option('my_plugin_uninstalled', true);
667
- }
668
- ```
669
-
670
- ---
671
-
672
- ## Security Considerations
673
-
674
- ### Activation
675
-
676
- ✅ Verify user capabilities before activation
677
- ✅ Validate system requirements
678
- ✅ Use nonces for AJAX activation
679
- ✅ Sanitize any user input during activation
680
-
681
- ### Uninstall
682
-
683
- ✅ Check `WP_UNINSTALL_PLUGIN` constant
684
- ✅ Verify user has permission to delete plugins
685
- ✅ Use `$wpdb->prepare()` for database queries
686
- ✅ Validate file paths before deletion
687
-
688
- ---
689
-
690
- ## Testing
691
-
692
- ### Test Activation
693
-
694
- ```php
695
- <?php
696
- // Test activation in different scenarios
697
- function test_my_plugin_activation() {
698
- // Test fresh install
699
- delete_option('my_plugin_version');
700
- my_plugin_activate();
701
- assert(get_option('my_plugin_version') === '1.0.0');
702
-
703
- // Test upgrade
704
- update_option('my_plugin_version', '0.9.0');
705
- my_plugin_activate();
706
- assert(get_option('my_plugin_version') === '1.0.0');
707
- }
708
- ```
709
-
710
- ### Test Uninstall
711
-
712
- ```php
713
- <?php
714
- // Test uninstall cleanup
715
- function test_my_plugin_uninstall() {
716
- // Activate plugin
717
- my_plugin_activate();
718
-
719
- // Verify data exists
720
- assert(get_option('my_plugin_version') !== false);
721
-
722
- // Uninstall
723
- require_once 'uninstall.php';
724
-
725
- // Verify cleanup
726
- assert(get_option('my_plugin_version') === false);
727
-
728
- global $wpdb;
729
- $table_exists = $wpdb->get_var(
730
- "SHOW TABLES LIKE '{$wpdb->prefix}my_plugin_data'"
731
- );
732
- assert($table_exists === null);
733
- }
734
- ```
735
-
736
- ---
737
-
738
- ## Troubleshooting
739
-
740
- ### Activation Errors
741
-
742
- **Problem**: Plugin activates but doesn't create tables
743
- **Solution**: Check `dbDelta()` syntax, ensure `upgrade.php` is included
744
-
745
- **Problem**: Activation fails silently
746
- **Solution**: Enable `WP_DEBUG` and check error logs
747
-
748
- **Problem**: Multisite activation doesn't work
749
- **Solution**: Check `$network_wide` parameter and use `switch_to_blog()`
750
-
751
- ### Uninstall Issues
752
-
753
- **Problem**: `uninstall.php` doesn't run
754
- **Solution**: Ensure file is in plugin root, check `WP_UNINSTALL_PLUGIN` constant
755
-
756
- **Problem**: Data not fully deleted
757
- **Solution**: Check for site-specific options in multisite, verify table names
758
-
759
- ---
760
-
761
- ## Summary
762
-
763
- | Hook | When | Purpose | Delete Data? |
764
- |------|------|---------|--------------|
765
- | Activation | Plugin activated | Setup, create tables, add options | No |
766
- | Deactivation | Plugin deactivated | Clear caches, unschedule cron | **NO** |
767
- | Uninstall | Plugin deleted | Complete cleanup | **YES** |
768
-
769
- **Golden Rule**: Only delete user data during uninstall, never during deactivation.
770
-
1
+ # WordPress Plugin Activation, Deactivation, and Uninstall Hooks
2
+
3
+ ## Overview
4
+
5
+ This document covers the proper implementation of plugin lifecycle hooks: activation, deactivation, and uninstall. These hooks are critical for setting up plugin requirements, cleaning up data, and ensuring a smooth user experience.
6
+
7
+ ---
8
+
9
+ ## Activation Hook
10
+
11
+ ### Purpose
12
+
13
+ The activation hook runs **once** when the plugin is activated. Use it to:
14
+
15
+ - Create custom database tables
16
+ - Add default options
17
+ - Set up capabilities/roles
18
+ - Schedule cron events
19
+ - Flush rewrite rules
20
+ - Check system requirements
21
+
22
+ ### Basic Implementation
23
+
24
+ ```php
25
+ <?php
26
+ /**
27
+ * Plugin Name: My Plugin
28
+ */
29
+
30
+ // Register activation hook
31
+ register_activation_hook(__FILE__, 'my_plugin_activate');
32
+
33
+ function my_plugin_activate() {
34
+ // Activation code here
35
+
36
+ // Example: Add default options
37
+ add_option('my_plugin_version', '1.0.0');
38
+ add_option('my_plugin_settings', array(
39
+ 'enabled' => true,
40
+ 'api_key' => ''
41
+ ));
42
+
43
+ // Flush rewrite rules
44
+ flush_rewrite_rules();
45
+ }
46
+ ```
47
+
48
+ ### Object-Oriented Implementation
49
+
50
+ ```php
51
+ <?php
52
+ class My_Plugin_Activator {
53
+ public static function activate() {
54
+ self::create_tables();
55
+ self::add_default_options();
56
+ self::add_capabilities();
57
+ self::schedule_cron();
58
+
59
+ // Store activation timestamp
60
+ update_option('my_plugin_activated_time', time());
61
+ }
62
+
63
+ private static function create_tables() {
64
+ global $wpdb;
65
+ $table_name = $wpdb->prefix . 'my_plugin_data';
66
+ $charset_collate = $wpdb->get_charset_collate();
67
+
68
+ $sql = "CREATE TABLE $table_name (
69
+ id mediumint(9) NOT NULL AUTO_INCREMENT,
70
+ name varchar(100) NOT NULL,
71
+ data text NOT NULL,
72
+ created_at datetime DEFAULT CURRENT_TIMESTAMP,
73
+ PRIMARY KEY (id)
74
+ ) $charset_collate;";
75
+
76
+ require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
77
+ dbDelta($sql);
78
+ }
79
+
80
+ private static function add_default_options() {
81
+ $defaults = array(
82
+ 'my_plugin_version' => '1.0.0',
83
+ 'my_plugin_settings' => array(
84
+ 'enabled' => true,
85
+ 'items_per_page' => 10
86
+ )
87
+ );
88
+
89
+ foreach ($defaults as $key => $value) {
90
+ add_option($key, $value);
91
+ }
92
+ }
93
+
94
+ private static function add_capabilities() {
95
+ $role = get_role('administrator');
96
+ if ($role) {
97
+ $role->add_cap('manage_my_plugin');
98
+ $role->add_cap('edit_my_plugin_items');
99
+ }
100
+ }
101
+
102
+ private static function schedule_cron() {
103
+ if (!wp_next_scheduled('my_plugin_daily_task')) {
104
+ wp_schedule_event(time(), 'daily', 'my_plugin_daily_task');
105
+ }
106
+ }
107
+ }
108
+
109
+ // Register hook
110
+ register_activation_hook(__FILE__, array('My_Plugin_Activator', 'activate'));
111
+ ```
112
+
113
+ ### System Requirements Check
114
+
115
+ ```php
116
+ <?php
117
+ function my_plugin_activate() {
118
+ // Check PHP version
119
+ if (version_compare(PHP_VERSION, '7.4', '<')) {
120
+ deactivate_plugins(plugin_basename(__FILE__));
121
+ wp_die('This plugin requires PHP 7.4 or higher.');
122
+ }
123
+
124
+ // Check WordPress version
125
+ global $wp_version;
126
+ if (version_compare($wp_version, '5.8', '<')) {
127
+ deactivate_plugins(plugin_basename(__FILE__));
128
+ wp_die('This plugin requires WordPress 5.8 or higher.');
129
+ }
130
+
131
+ // Check for required plugins
132
+ if (!is_plugin_active('woocommerce/woocommerce.php')) {
133
+ deactivate_plugins(plugin_basename(__FILE__));
134
+ wp_die('This plugin requires WooCommerce to be installed and activated.');
135
+ }
136
+
137
+ // Check for required PHP extensions
138
+ if (!extension_loaded('curl')) {
139
+ deactivate_plugins(plugin_basename(__FILE__));
140
+ wp_die('This plugin requires the PHP cURL extension.');
141
+ }
142
+
143
+ // All checks passed - proceed with activation
144
+ my_plugin_setup();
145
+ }
146
+ ```
147
+
148
+ ### Multisite Activation
149
+
150
+ ```php
151
+ <?php
152
+ function my_plugin_activate($network_wide) {
153
+ if (is_multisite() && $network_wide) {
154
+ // Network activation
155
+ global $wpdb;
156
+
157
+ // Get all blog IDs
158
+ $blog_ids = $wpdb->get_col("SELECT blog_id FROM $wpdb->blogs");
159
+
160
+ foreach ($blog_ids as $blog_id) {
161
+ switch_to_blog($blog_id);
162
+ my_plugin_activate_single_site();
163
+ restore_current_blog();
164
+ }
165
+ } else {
166
+ // Single site activation
167
+ my_plugin_activate_single_site();
168
+ }
169
+ }
170
+
171
+ function my_plugin_activate_single_site() {
172
+ // Activation code for single site
173
+ add_option('my_plugin_version', '1.0.0');
174
+ }
175
+
176
+ register_activation_hook(__FILE__, 'my_plugin_activate');
177
+ ```
178
+
179
+ ---
180
+
181
+ ## Deactivation Hook
182
+
183
+ ### Purpose
184
+
185
+ The deactivation hook runs when the plugin is deactivated. Use it to:
186
+
187
+ - Clear scheduled cron events
188
+ - Flush rewrite rules
189
+ - Clear transients/caches
190
+ - **DO NOT** delete user data or options
191
+
192
+ ### Basic Implementation
193
+
194
+ ```php
195
+ <?php
196
+ register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
197
+
198
+ function my_plugin_deactivate() {
199
+ // Clear scheduled events
200
+ $timestamp = wp_next_scheduled('my_plugin_daily_task');
201
+ if ($timestamp) {
202
+ wp_unschedule_event($timestamp, 'my_plugin_daily_task');
203
+ }
204
+
205
+ // Flush rewrite rules
206
+ flush_rewrite_rules();
207
+
208
+ // Clear transients
209
+ delete_transient('my_plugin_cache');
210
+ }
211
+ ```
212
+
213
+ ### Object-Oriented Implementation
214
+
215
+ ```php
216
+ <?php
217
+ class My_Plugin_Deactivator {
218
+ public static function deactivate() {
219
+ self::clear_cron_jobs();
220
+ self::flush_cache();
221
+ self::flush_rewrite_rules();
222
+
223
+ // Log deactivation
224
+ update_option('my_plugin_deactivated_time', time());
225
+ }
226
+
227
+ private static function clear_cron_jobs() {
228
+ $cron_hooks = array(
229
+ 'my_plugin_daily_task',
230
+ 'my_plugin_hourly_task',
231
+ 'my_plugin_cleanup_task'
232
+ );
233
+
234
+ foreach ($cron_hooks as $hook) {
235
+ $timestamp = wp_next_scheduled($hook);
236
+ if ($timestamp) {
237
+ wp_unschedule_event($timestamp, $hook);
238
+ }
239
+ }
240
+ }
241
+
242
+ private static function flush_cache() {
243
+ // Delete transients
244
+ delete_transient('my_plugin_cache');
245
+ delete_transient('my_plugin_api_response');
246
+
247
+ // Clear object cache
248
+ wp_cache_flush();
249
+ }
250
+
251
+ private static function flush_rewrite_rules() {
252
+ flush_rewrite_rules();
253
+ }
254
+ }
255
+
256
+ register_deactivation_hook(__FILE__, array('My_Plugin_Deactivator', 'deactivate'));
257
+ ```
258
+
259
+ ### What NOT to Do on Deactivation
260
+
261
+ ❌ **DO NOT** delete user data
262
+ ❌ **DO NOT** delete options/settings
263
+ ❌ **DO NOT** drop database tables
264
+ ❌ **DO NOT** remove user capabilities
265
+
266
+ **Reason**: Users may reactivate the plugin and expect their data to be intact.
267
+
268
+ ---
269
+
270
+ ## Uninstall Hook
271
+
272
+ ### Purpose
273
+
274
+ The uninstall hook runs when the plugin is **deleted** (not just deactivated). Use it to:
275
+
276
+ - Delete all plugin options
277
+ - Drop custom database tables
278
+ - Remove custom capabilities
279
+ - Delete uploaded files
280
+ - Clean up everything
281
+
282
+ ### Method 1: uninstall.php (Recommended)
283
+
284
+ Create a file named `uninstall.php` in the plugin root:
285
+
286
+ ```php
287
+ <?php
288
+ /**
289
+ * Uninstall script
290
+ *
291
+ * Runs when plugin is deleted via WordPress admin
292
+ */
293
+
294
+ // Exit if accessed directly
295
+ if (!defined('WP_UNINSTALL_PLUGIN')) {
296
+ exit;
297
+ }
298
+
299
+ // Delete options
300
+ delete_option('my_plugin_version');
301
+ delete_option('my_plugin_settings');
302
+ delete_option('my_plugin_activated_time');
303
+ delete_option('my_plugin_deactivated_time');
304
+
305
+ // Delete transients
306
+ delete_transient('my_plugin_cache');
307
+
308
+ // Drop custom tables
309
+ global $wpdb;
310
+ $table_name = $wpdb->prefix . 'my_plugin_data';
311
+ $wpdb->query("DROP TABLE IF EXISTS $table_name");
312
+
313
+ // Remove capabilities
314
+ $role = get_role('administrator');
315
+ if ($role) {
316
+ $role->remove_cap('manage_my_plugin');
317
+ $role->remove_cap('edit_my_plugin_items');
318
+ }
319
+
320
+ // Delete uploaded files
321
+ $upload_dir = wp_upload_dir();
322
+ $plugin_upload_dir = $upload_dir['basedir'] . '/my-plugin';
323
+ if (is_dir($plugin_upload_dir)) {
324
+ // Recursively delete directory
325
+ array_map('unlink', glob("$plugin_upload_dir/*.*"));
326
+ rmdir($plugin_upload_dir);
327
+ }
328
+
329
+ // Clear scheduled events (if any remain)
330
+ wp_clear_scheduled_hook('my_plugin_daily_task');
331
+ ```
332
+
333
+ ### Method 2: register_uninstall_hook()
334
+
335
+ ```php
336
+ <?php
337
+ /**
338
+ * Plugin Name: My Plugin
339
+ */
340
+
341
+ // Register uninstall hook
342
+ register_uninstall_hook(__FILE__, 'my_plugin_uninstall');
343
+
344
+ function my_plugin_uninstall() {
345
+ // Uninstall code here
346
+ delete_option('my_plugin_version');
347
+ delete_option('my_plugin_settings');
348
+
349
+ global $wpdb;
350
+ $table_name = $wpdb->prefix . 'my_plugin_data';
351
+ $wpdb->query("DROP TABLE IF EXISTS $table_name");
352
+ }
353
+ ```
354
+
355
+ ### Object-Oriented Uninstall (uninstall.php)
356
+
357
+ ```php
358
+ <?php
359
+ if (!defined('WP_UNINSTALL_PLUGIN')) {
360
+ exit;
361
+ }
362
+
363
+ // Load plugin classes
364
+ require_once plugin_dir_path(__FILE__) . 'includes/class-uninstaller.php';
365
+
366
+ // Run uninstall
367
+ My_Plugin_Uninstaller::uninstall();
368
+ ```
369
+
370
+ **Uninstaller Class** (`includes/class-uninstaller.php`):
371
+
372
+ ```php
373
+ <?php
374
+ class My_Plugin_Uninstaller {
375
+ public static function uninstall() {
376
+ self::delete_options();
377
+ self::delete_transients();
378
+ self::drop_tables();
379
+ self::remove_capabilities();
380
+ self::delete_files();
381
+ self::clear_cron();
382
+ }
383
+
384
+ private static function delete_options() {
385
+ $options = array(
386
+ 'my_plugin_version',
387
+ 'my_plugin_settings',
388
+ 'my_plugin_activated_time',
389
+ 'my_plugin_deactivated_time'
390
+ );
391
+
392
+ foreach ($options as $option) {
393
+ delete_option($option);
394
+ }
395
+ }
396
+
397
+ private static function delete_transients() {
398
+ global $wpdb;
399
+
400
+ // Delete all transients with plugin prefix
401
+ $wpdb->query(
402
+ "DELETE FROM $wpdb->options
403
+ WHERE option_name LIKE '_transient_my_plugin_%'
404
+ OR option_name LIKE '_transient_timeout_my_plugin_%'"
405
+ );
406
+ }
407
+
408
+ private static function drop_tables() {
409
+ global $wpdb;
410
+
411
+ $tables = array(
412
+ $wpdb->prefix . 'my_plugin_data',
413
+ $wpdb->prefix . 'my_plugin_logs'
414
+ );
415
+
416
+ foreach ($tables as $table) {
417
+ $wpdb->query("DROP TABLE IF EXISTS $table");
418
+ }
419
+ }
420
+
421
+ private static function remove_capabilities() {
422
+ $capabilities = array(
423
+ 'manage_my_plugin',
424
+ 'edit_my_plugin_items',
425
+ 'delete_my_plugin_items'
426
+ );
427
+
428
+ $roles = array('administrator', 'editor');
429
+
430
+ foreach ($roles as $role_name) {
431
+ $role = get_role($role_name);
432
+ if ($role) {
433
+ foreach ($capabilities as $cap) {
434
+ $role->remove_cap($cap);
435
+ }
436
+ }
437
+ }
438
+ }
439
+
440
+ private static function delete_files() {
441
+ $upload_dir = wp_upload_dir();
442
+ $plugin_dir = $upload_dir['basedir'] . '/my-plugin';
443
+
444
+ if (is_dir($plugin_dir)) {
445
+ self::delete_directory($plugin_dir);
446
+ }
447
+ }
448
+
449
+ private static function delete_directory($dir) {
450
+ if (!is_dir($dir)) {
451
+ return;
452
+ }
453
+
454
+ $files = array_diff(scandir($dir), array('.', '..'));
455
+
456
+ foreach ($files as $file) {
457
+ $path = $dir . '/' . $file;
458
+ is_dir($path) ? self::delete_directory($path) : unlink($path);
459
+ }
460
+
461
+ rmdir($dir);
462
+ }
463
+
464
+ private static function clear_cron() {
465
+ wp_clear_scheduled_hook('my_plugin_daily_task');
466
+ wp_clear_scheduled_hook('my_plugin_hourly_task');
467
+ }
468
+ }
469
+ ```
470
+
471
+ ### Multisite Uninstall
472
+
473
+ ```php
474
+ <?php
475
+ if (!defined('WP_UNINSTALL_PLUGIN')) {
476
+ exit;
477
+ }
478
+
479
+ if (is_multisite()) {
480
+ global $wpdb;
481
+
482
+ // Get all blog IDs
483
+ $blog_ids = $wpdb->get_col("SELECT blog_id FROM $wpdb->blogs");
484
+
485
+ foreach ($blog_ids as $blog_id) {
486
+ switch_to_blog($blog_id);
487
+ my_plugin_uninstall_single_site();
488
+ restore_current_blog();
489
+ }
490
+
491
+ // Delete network-wide options
492
+ delete_site_option('my_plugin_network_settings');
493
+ } else {
494
+ my_plugin_uninstall_single_site();
495
+ }
496
+
497
+ function my_plugin_uninstall_single_site() {
498
+ // Delete options
499
+ delete_option('my_plugin_version');
500
+ delete_option('my_plugin_settings');
501
+
502
+ // Drop tables
503
+ global $wpdb;
504
+ $table_name = $wpdb->prefix . 'my_plugin_data';
505
+ $wpdb->query("DROP TABLE IF EXISTS $table_name");
506
+ }
507
+ ```
508
+
509
+ ---
510
+
511
+ ## Database Table Management
512
+
513
+ ### Creating Tables (Activation)
514
+
515
+ ```php
516
+ <?php
517
+ function my_plugin_create_tables() {
518
+ global $wpdb;
519
+
520
+ $table_name = $wpdb->prefix . 'my_plugin_data';
521
+ $charset_collate = $wpdb->get_charset_collate();
522
+
523
+ $sql = "CREATE TABLE $table_name (
524
+ id bigint(20) unsigned NOT NULL AUTO_INCREMENT,
525
+ user_id bigint(20) unsigned NOT NULL,
526
+ title varchar(255) NOT NULL,
527
+ content longtext NOT NULL,
528
+ status varchar(20) DEFAULT 'draft',
529
+ created_at datetime DEFAULT CURRENT_TIMESTAMP,
530
+ updated_at datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
531
+ PRIMARY KEY (id),
532
+ KEY user_id (user_id),
533
+ KEY status (status)
534
+ ) $charset_collate;";
535
+
536
+ require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
537
+ dbDelta($sql);
538
+
539
+ // Store database version
540
+ add_option('my_plugin_db_version', '1.0');
541
+ }
542
+ ```
543
+
544
+ ### Updating Tables (Version Check)
545
+
546
+ ```php
547
+ <?php
548
+ function my_plugin_update_db_check() {
549
+ $current_version = get_option('my_plugin_db_version', '0');
550
+ $new_version = '1.1';
551
+
552
+ if (version_compare($current_version, $new_version, '<')) {
553
+ my_plugin_update_tables();
554
+ update_option('my_plugin_db_version', $new_version);
555
+ }
556
+ }
557
+ add_action('plugins_loaded', 'my_plugin_update_db_check');
558
+
559
+ function my_plugin_update_tables() {
560
+ global $wpdb;
561
+
562
+ $table_name = $wpdb->prefix . 'my_plugin_data';
563
+
564
+ // Add new column
565
+ $wpdb->query("ALTER TABLE $table_name ADD COLUMN new_field varchar(100) DEFAULT NULL");
566
+ }
567
+ ```
568
+
569
+ ---
570
+
571
+ ## Best Practices
572
+
573
+ ### Activation
574
+
575
+ ✅ Check system requirements (PHP, WordPress, extensions)
576
+ ✅ Create database tables using `dbDelta()`
577
+ ✅ Add default options with `add_option()` (not `update_option()`)
578
+ ✅ Flush rewrite rules if registering custom post types/taxonomies
579
+ ✅ Schedule cron events
580
+ ✅ Store activation timestamp
581
+ ✅ Check for multisite and handle accordingly
582
+
583
+ ### Deactivation
584
+
585
+ ✅ Clear scheduled cron events
586
+ ✅ Flush rewrite rules
587
+ ✅ Clear transients and caches
588
+ ❌ **DO NOT** delete user data
589
+ ❌ **DO NOT** delete options
590
+ ❌ **DO NOT** drop tables
591
+
592
+ ### Uninstall
593
+
594
+ ✅ Use `uninstall.php` (preferred) or `register_uninstall_hook()`
595
+ ✅ Delete ALL plugin options
596
+ ✅ Drop ALL custom tables
597
+ ✅ Remove ALL capabilities
598
+ ✅ Delete ALL uploaded files
599
+ ✅ Clear ALL scheduled events
600
+ ✅ Handle multisite properly
601
+ ✅ Be thorough - leave no trace
602
+
603
+ ---
604
+
605
+ ## Common Patterns
606
+
607
+ ### Version-Based Activation
608
+
609
+ ```php
610
+ <?php
611
+ function my_plugin_activate() {
612
+ $current_version = get_option('my_plugin_version', '0');
613
+ $new_version = '2.0.0';
614
+
615
+ if (version_compare($current_version, $new_version, '<')) {
616
+ // Upgrade from older version
617
+ my_plugin_upgrade($current_version, $new_version);
618
+ } else {
619
+ // Fresh install
620
+ my_plugin_fresh_install();
621
+ }
622
+
623
+ update_option('my_plugin_version', $new_version);
624
+ }
625
+
626
+ function my_plugin_upgrade($from, $to) {
627
+ // Migration logic
628
+ if (version_compare($from, '1.5.0', '<')) {
629
+ // Migrate from < 1.5.0
630
+ }
631
+
632
+ if (version_compare($from, '2.0.0', '<')) {
633
+ // Migrate from < 2.0.0
634
+ }
635
+ }
636
+
637
+ function my_plugin_fresh_install() {
638
+ // Fresh installation logic
639
+ my_plugin_create_tables();
640
+ my_plugin_add_default_options();
641
+ }
642
+ ```
643
+
644
+ ### Conditional Uninstall
645
+
646
+ ```php
647
+ <?php
648
+ // uninstall.php
649
+
650
+ if (!defined('WP_UNINSTALL_PLUGIN')) {
651
+ exit;
652
+ }
653
+
654
+ // Check if user wants to keep data
655
+ $keep_data = get_option('my_plugin_keep_data_on_uninstall', false);
656
+
657
+ if (!$keep_data) {
658
+ // Delete everything
659
+ delete_option('my_plugin_version');
660
+ delete_option('my_plugin_settings');
661
+
662
+ global $wpdb;
663
+ $wpdb->query("DROP TABLE IF EXISTS {$wpdb->prefix}my_plugin_data");
664
+ } else {
665
+ // Keep data, just mark as uninstalled
666
+ update_option('my_plugin_uninstalled', true);
667
+ }
668
+ ```
669
+
670
+ ---
671
+
672
+ ## Security Considerations
673
+
674
+ ### Activation
675
+
676
+ ✅ Verify user capabilities before activation
677
+ ✅ Validate system requirements
678
+ ✅ Use nonces for AJAX activation
679
+ ✅ Sanitize any user input during activation
680
+
681
+ ### Uninstall
682
+
683
+ ✅ Check `WP_UNINSTALL_PLUGIN` constant
684
+ ✅ Verify user has permission to delete plugins
685
+ ✅ Use `$wpdb->prepare()` for database queries
686
+ ✅ Validate file paths before deletion
687
+
688
+ ---
689
+
690
+ ## Testing
691
+
692
+ ### Test Activation
693
+
694
+ ```php
695
+ <?php
696
+ // Test activation in different scenarios
697
+ function test_my_plugin_activation() {
698
+ // Test fresh install
699
+ delete_option('my_plugin_version');
700
+ my_plugin_activate();
701
+ assert(get_option('my_plugin_version') === '1.0.0');
702
+
703
+ // Test upgrade
704
+ update_option('my_plugin_version', '0.9.0');
705
+ my_plugin_activate();
706
+ assert(get_option('my_plugin_version') === '1.0.0');
707
+ }
708
+ ```
709
+
710
+ ### Test Uninstall
711
+
712
+ ```php
713
+ <?php
714
+ // Test uninstall cleanup
715
+ function test_my_plugin_uninstall() {
716
+ // Activate plugin
717
+ my_plugin_activate();
718
+
719
+ // Verify data exists
720
+ assert(get_option('my_plugin_version') !== false);
721
+
722
+ // Uninstall
723
+ require_once 'uninstall.php';
724
+
725
+ // Verify cleanup
726
+ assert(get_option('my_plugin_version') === false);
727
+
728
+ global $wpdb;
729
+ $table_exists = $wpdb->get_var(
730
+ "SHOW TABLES LIKE '{$wpdb->prefix}my_plugin_data'"
731
+ );
732
+ assert($table_exists === null);
733
+ }
734
+ ```
735
+
736
+ ---
737
+
738
+ ## Troubleshooting
739
+
740
+ ### Activation Errors
741
+
742
+ **Problem**: Plugin activates but doesn't create tables
743
+ **Solution**: Check `dbDelta()` syntax, ensure `upgrade.php` is included
744
+
745
+ **Problem**: Activation fails silently
746
+ **Solution**: Enable `WP_DEBUG` and check error logs
747
+
748
+ **Problem**: Multisite activation doesn't work
749
+ **Solution**: Check `$network_wide` parameter and use `switch_to_blog()`
750
+
751
+ ### Uninstall Issues
752
+
753
+ **Problem**: `uninstall.php` doesn't run
754
+ **Solution**: Ensure file is in plugin root, check `WP_UNINSTALL_PLUGIN` constant
755
+
756
+ **Problem**: Data not fully deleted
757
+ **Solution**: Check for site-specific options in multisite, verify table names
758
+
759
+ ---
760
+
761
+ ## Summary
762
+
763
+ | Hook | When | Purpose | Delete Data? |
764
+ |------|------|---------|--------------|
765
+ | Activation | Plugin activated | Setup, create tables, add options | No |
766
+ | Deactivation | Plugin deactivated | Clear caches, unschedule cron | **NO** |
767
+ | Uninstall | Plugin deleted | Complete cleanup | **YES** |
768
+
769
+ **Golden Rule**: Only delete user data during uninstall, never during deactivation.
770
+