@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,949 +1,949 @@
1
- # WooCommerce Integration for WordPress Plugins
2
-
3
- ## Overview
4
-
5
- This document provides comprehensive guidelines for creating WordPress plugins that integrate with WooCommerce, the most popular eCommerce platform for WordPress.
6
-
7
- ## Plugin Detection
8
-
9
- ### Check if WooCommerce is Active
10
-
11
- Always verify WooCommerce is installed and active before using WooCommerce functions:
12
-
13
- ```php
14
- <?php
15
- /**
16
- * Check if WooCommerce is active
17
- */
18
- function my_plugin_is_woocommerce_active() {
19
- return in_array(
20
- 'woocommerce/woocommerce.php',
21
- apply_filters( 'active_plugins', get_option( 'active_plugins' ) )
22
- );
23
- }
24
-
25
- /**
26
- * Initialize plugin only if WooCommerce is active
27
- */
28
- function my_plugin_init() {
29
- if ( ! my_plugin_is_woocommerce_active() ) {
30
- add_action( 'admin_notices', 'my_plugin_woocommerce_missing_notice' );
31
- return;
32
- }
33
-
34
- // Initialize plugin functionality
35
- My_Plugin::instance();
36
- }
37
- add_action( 'plugins_loaded', 'my_plugin_init' );
38
-
39
- /**
40
- * Display admin notice if WooCommerce is not active
41
- */
42
- function my_plugin_woocommerce_missing_notice() {
43
- ?>
44
- <div class="notice notice-error">
45
- <p><?php esc_html_e( 'My Plugin requires WooCommerce to be installed and active.', 'my-plugin' ); ?></p>
46
- </div>
47
- <?php
48
- }
49
- ```
50
-
51
- ### Declare WooCommerce Compatibility
52
-
53
- ```php
54
- <?php
55
- /**
56
- * Declare HPOS (High-Performance Order Storage) compatibility
57
- */
58
- add_action( 'before_woocommerce_init', function() {
59
- if ( class_exists( \Automattic\WooCommerce\Utilities\FeaturesUtil::class ) ) {
60
- \Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility(
61
- 'custom_order_tables',
62
- __FILE__,
63
- true
64
- );
65
- }
66
- } );
67
-
68
- /**
69
- * Declare compatibility with WooCommerce features
70
- */
71
- add_action( 'before_woocommerce_init', function() {
72
- if ( class_exists( \Automattic\WooCommerce\Utilities\FeaturesUtil::class ) ) {
73
- \Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility(
74
- 'cart_checkout_blocks',
75
- __FILE__,
76
- true
77
- );
78
- }
79
- } );
80
- ```
81
-
82
- ---
83
-
84
- ## Product Extensions
85
-
86
- ### Add Custom Product Fields
87
-
88
- ```php
89
- <?php
90
- /**
91
- * Add custom field to product general tab
92
- */
93
- function my_plugin_add_custom_product_field() {
94
- woocommerce_wp_text_input( array(
95
- 'id' => '_custom_product_field',
96
- 'label' => __( 'Custom Field', 'my-plugin' ),
97
- 'placeholder' => __( 'Enter value', 'my-plugin' ),
98
- 'desc_tip' => true,
99
- 'description' => __( 'This is a custom field.', 'my-plugin' ),
100
- ) );
101
- }
102
- add_action( 'woocommerce_product_options_general_product_data', 'my_plugin_add_custom_product_field' );
103
-
104
- /**
105
- * Save custom product field
106
- */
107
- function my_plugin_save_custom_product_field( $post_id ) {
108
- $custom_field = isset( $_POST['_custom_product_field'] )
109
- ? sanitize_text_field( $_POST['_custom_product_field'] )
110
- : '';
111
-
112
- update_post_meta( $post_id, '_custom_product_field', $custom_field );
113
- }
114
- add_action( 'woocommerce_process_product_meta', 'my_plugin_save_custom_product_field' );
115
-
116
- /**
117
- * Display custom field on product page
118
- */
119
- function my_plugin_display_custom_product_field() {
120
- global $product;
121
-
122
- $custom_field = $product->get_meta( '_custom_product_field' );
123
-
124
- if ( $custom_field ) {
125
- echo '<div class="custom-product-field">';
126
- echo '<strong>' . esc_html__( 'Custom Field:', 'my-plugin' ) . '</strong> ';
127
- echo esc_html( $custom_field );
128
- echo '</div>';
129
- }
130
- }
131
- add_action( 'woocommerce_single_product_summary', 'my_plugin_display_custom_product_field', 25 );
132
- ```
133
-
134
- ### Add Custom Product Tab
135
-
136
- ```php
137
- <?php
138
- /**
139
- * Add custom product tab
140
- */
141
- function my_plugin_add_custom_product_tab( $tabs ) {
142
- $tabs['custom_tab'] = array(
143
- 'title' => __( 'Custom Tab', 'my-plugin' ),
144
- 'priority' => 50,
145
- 'callback' => 'my_plugin_custom_product_tab_content',
146
- );
147
-
148
- return $tabs;
149
- }
150
- add_filter( 'woocommerce_product_tabs', 'my_plugin_add_custom_product_tab' );
151
-
152
- /**
153
- * Custom product tab content
154
- */
155
- function my_plugin_custom_product_tab_content() {
156
- global $product;
157
-
158
- ?>
159
- <h2><?php esc_html_e( 'Custom Tab', 'my-plugin' ); ?></h2>
160
- <p><?php esc_html_e( 'Custom tab content goes here.', 'my-plugin' ); ?></p>
161
- <?php
162
- }
163
- ```
164
-
165
- ---
166
-
167
- ## Cart & Checkout Extensions
168
-
169
- ### Add Custom Cart Item Data
170
-
171
- ```php
172
- <?php
173
- /**
174
- * Add custom data to cart item
175
- */
176
- function my_plugin_add_cart_item_data( $cart_item_data, $product_id, $variation_id ) {
177
- if ( isset( $_POST['custom_field'] ) ) {
178
- $cart_item_data['custom_field'] = sanitize_text_field( $_POST['custom_field'] );
179
- }
180
-
181
- return $cart_item_data;
182
- }
183
- add_filter( 'woocommerce_add_cart_item_data', 'my_plugin_add_cart_item_data', 10, 3 );
184
-
185
- /**
186
- * Display custom cart item data
187
- */
188
- function my_plugin_display_cart_item_data( $item_data, $cart_item ) {
189
- if ( isset( $cart_item['custom_field'] ) ) {
190
- $item_data[] = array(
191
- 'key' => __( 'Custom Field', 'my-plugin' ),
192
- 'value' => wc_clean( $cart_item['custom_field'] ),
193
- );
194
- }
195
-
196
- return $item_data;
197
- }
198
- add_filter( 'woocommerce_get_item_data', 'my_plugin_display_cart_item_data', 10, 2 );
199
-
200
- /**
201
- * Save custom cart item data to order
202
- */
203
- function my_plugin_save_order_item_meta( $item, $cart_item_key, $values, $order ) {
204
- if ( isset( $values['custom_field'] ) ) {
205
- $item->add_meta_data( '_custom_field', $values['custom_field'] );
206
- }
207
- }
208
- add_action( 'woocommerce_checkout_create_order_line_item', 'my_plugin_save_order_item_meta', 10, 4 );
209
- ```
210
-
211
- ### Add Custom Checkout Field
212
-
213
- ```php
214
- <?php
215
- /**
216
- * Add custom checkout field
217
- */
218
- function my_plugin_add_checkout_field( $fields ) {
219
- $fields['billing']['billing_custom_field'] = array(
220
- 'type' => 'text',
221
- 'label' => __( 'Custom Field', 'my-plugin' ),
222
- 'placeholder' => __( 'Enter value', 'my-plugin' ),
223
- 'required' => false,
224
- 'class' => array( 'form-row-wide' ),
225
- 'clear' => true,
226
- 'priority' => 100,
227
- );
228
-
229
- return $fields;
230
- }
231
- add_filter( 'woocommerce_checkout_fields', 'my_plugin_add_checkout_field' );
232
-
233
- /**
234
- * Validate custom checkout field
235
- */
236
- function my_plugin_validate_checkout_field() {
237
- if ( isset( $_POST['billing_custom_field'] ) && empty( $_POST['billing_custom_field'] ) ) {
238
- wc_add_notice(
239
- __( 'Please enter a value for Custom Field.', 'my-plugin' ),
240
- 'error'
241
- );
242
- }
243
- }
244
- add_action( 'woocommerce_checkout_process', 'my_plugin_validate_checkout_field' );
245
-
246
- /**
247
- * Save custom checkout field to order
248
- */
249
- function my_plugin_save_checkout_field( $order_id ) {
250
- if ( isset( $_POST['billing_custom_field'] ) ) {
251
- update_post_meta(
252
- $order_id,
253
- '_billing_custom_field',
254
- sanitize_text_field( $_POST['billing_custom_field'] )
255
- );
256
- }
257
- }
258
- add_action( 'woocommerce_checkout_update_order_meta', 'my_plugin_save_checkout_field' );
259
-
260
- /**
261
- * Display custom field in order admin
262
- */
263
- function my_plugin_display_order_custom_field( $order ) {
264
- $custom_field = $order->get_meta( '_billing_custom_field' );
265
-
266
- if ( $custom_field ) {
267
- echo '<p><strong>' . esc_html__( 'Custom Field:', 'my-plugin' ) . '</strong> ' . esc_html( $custom_field ) . '</p>';
268
- }
269
- }
270
- add_action( 'woocommerce_admin_order_data_after_billing_address', 'my_plugin_display_order_custom_field' );
271
- ```
272
-
273
- ---
274
-
275
- ## Order Extensions
276
-
277
- ### Add Custom Order Status
278
-
279
- ```php
280
- <?php
281
- /**
282
- * Register custom order status
283
- */
284
- function my_plugin_register_custom_order_status() {
285
- register_post_status( 'wc-custom-status', array(
286
- 'label' => __( 'Custom Status', 'my-plugin' ),
287
- 'public' => true,
288
- 'exclude_from_search' => false,
289
- 'show_in_admin_all_list' => true,
290
- 'show_in_admin_status_list' => true,
291
- 'label_count' => _n_noop(
292
- 'Custom Status <span class="count">(%s)</span>',
293
- 'Custom Status <span class="count">(%s)</span>',
294
- 'my-plugin'
295
- ),
296
- ) );
297
- }
298
- add_action( 'init', 'my_plugin_register_custom_order_status' );
299
-
300
- /**
301
- * Add custom status to order statuses
302
- */
303
- function my_plugin_add_custom_order_status( $order_statuses ) {
304
- $order_statuses['wc-custom-status'] = __( 'Custom Status', 'my-plugin' );
305
- return $order_statuses;
306
- }
307
- add_filter( 'wc_order_statuses', 'my_plugin_add_custom_order_status' );
308
- ```
309
-
310
- ### Hook into Order Events
311
-
312
- ```php
313
- <?php
314
- /**
315
- * Action when order is created
316
- */
317
- function my_plugin_order_created( $order_id, $order ) {
318
- // Custom logic when order is created
319
- error_log( 'Order created: ' . $order_id );
320
- }
321
- add_action( 'woocommerce_new_order', 'my_plugin_order_created', 10, 2 );
322
-
323
- /**
324
- * Action when order status changes
325
- */
326
- function my_plugin_order_status_changed( $order_id, $old_status, $new_status, $order ) {
327
- // Custom logic when order status changes
328
- if ( 'processing' === $new_status ) {
329
- // Do something when order is processing
330
- }
331
- }
332
- add_action( 'woocommerce_order_status_changed', 'my_plugin_order_status_changed', 10, 4 );
333
-
334
- /**
335
- * Action when order is completed
336
- */
337
- function my_plugin_order_completed( $order_id ) {
338
- $order = wc_get_order( $order_id );
339
-
340
- // Custom logic when order is completed
341
- // e.g., send to external API, update inventory, etc.
342
- }
343
- add_action( 'woocommerce_order_status_completed', 'my_plugin_order_completed' );
344
- ```
345
-
346
- ---
347
-
348
- ## Payment Gateway Integration
349
-
350
- ### Create Custom Payment Gateway
351
-
352
- ```php
353
- <?php
354
- /**
355
- * Custom Payment Gateway Class
356
- */
357
- class My_Plugin_Payment_Gateway extends WC_Payment_Gateway {
358
-
359
- /**
360
- * Constructor
361
- */
362
- public function __construct() {
363
- $this->id = 'my_custom_gateway';
364
- $this->icon = '';
365
- $this->has_fields = true;
366
- $this->method_title = __( 'Custom Gateway', 'my-plugin' );
367
- $this->method_description = __( 'Custom payment gateway description.', 'my-plugin' );
368
-
369
- // Load settings
370
- $this->init_form_fields();
371
- $this->init_settings();
372
-
373
- // Get settings
374
- $this->title = $this->get_option( 'title' );
375
- $this->description = $this->get_option( 'description' );
376
- $this->enabled = $this->get_option( 'enabled' );
377
-
378
- // Actions
379
- add_action(
380
- 'woocommerce_update_options_payment_gateways_' . $this->id,
381
- array( $this, 'process_admin_options' )
382
- );
383
- }
384
-
385
- /**
386
- * Initialize gateway settings form fields
387
- */
388
- public function init_form_fields() {
389
- $this->form_fields = array(
390
- 'enabled' => array(
391
- 'title' => __( 'Enable/Disable', 'my-plugin' ),
392
- 'type' => 'checkbox',
393
- 'label' => __( 'Enable Custom Gateway', 'my-plugin' ),
394
- 'default' => 'no',
395
- ),
396
- 'title' => array(
397
- 'title' => __( 'Title', 'my-plugin' ),
398
- 'type' => 'text',
399
- 'description' => __( 'Payment method title shown to customers.', 'my-plugin' ),
400
- 'default' => __( 'Custom Payment', 'my-plugin' ),
401
- 'desc_tip' => true,
402
- ),
403
- 'description' => array(
404
- 'title' => __( 'Description', 'my-plugin' ),
405
- 'type' => 'textarea',
406
- 'description' => __( 'Payment method description shown to customers.', 'my-plugin' ),
407
- 'default' => __( 'Pay with custom gateway.', 'my-plugin' ),
408
- 'desc_tip' => true,
409
- ),
410
- );
411
- }
412
-
413
- /**
414
- * Payment fields on checkout
415
- */
416
- public function payment_fields() {
417
- if ( $this->description ) {
418
- echo wpautop( wp_kses_post( $this->description ) );
419
- }
420
-
421
- // Add custom payment fields here
422
- ?>
423
- <fieldset>
424
- <p class="form-row form-row-wide">
425
- <label for="custom-field"><?php esc_html_e( 'Custom Field', 'my-plugin' ); ?></label>
426
- <input type="text" id="custom-field" name="custom_field" />
427
- </p>
428
- </fieldset>
429
- <?php
430
- }
431
-
432
- /**
433
- * Validate payment fields
434
- */
435
- public function validate_fields() {
436
- if ( empty( $_POST['custom_field'] ) ) {
437
- wc_add_notice(
438
- __( 'Custom field is required.', 'my-plugin' ),
439
- 'error'
440
- );
441
- return false;
442
- }
443
-
444
- return true;
445
- }
446
-
447
- /**
448
- * Process payment
449
- */
450
- public function process_payment( $order_id ) {
451
- $order = wc_get_order( $order_id );
452
-
453
- // Process payment with external gateway
454
- // ...
455
-
456
- // Mark order as processing or completed
457
- $order->payment_complete();
458
-
459
- // Add order note
460
- $order->add_order_note(
461
- __( 'Payment completed via Custom Gateway.', 'my-plugin' )
462
- );
463
-
464
- // Reduce stock levels
465
- wc_reduce_stock_levels( $order_id );
466
-
467
- // Remove cart
468
- WC()->cart->empty_cart();
469
-
470
- // Return success
471
- return array(
472
- 'result' => 'success',
473
- 'redirect' => $this->get_return_url( $order ),
474
- );
475
- }
476
- }
477
-
478
- /**
479
- * Add custom payment gateway to WooCommerce
480
- */
481
- function my_plugin_add_payment_gateway( $gateways ) {
482
- $gateways[] = 'My_Plugin_Payment_Gateway';
483
- return $gateways;
484
- }
485
- add_filter( 'woocommerce_payment_gateways', 'my_plugin_add_payment_gateway' );
486
- ```
487
-
488
- ---
489
-
490
- ## Email Extensions
491
-
492
- ### Add Custom Email
493
-
494
- ```php
495
- <?php
496
- /**
497
- * Custom Email Class
498
- */
499
- class My_Plugin_Custom_Email extends WC_Email {
500
-
501
- /**
502
- * Constructor
503
- */
504
- public function __construct() {
505
- $this->id = 'my_custom_email';
506
- $this->title = __( 'Custom Email', 'my-plugin' );
507
- $this->description = __( 'Custom email sent to customers.', 'my-plugin' );
508
- $this->template_html = 'emails/custom-email.php';
509
- $this->template_plain = 'emails/plain/custom-email.php';
510
- $this->template_base = plugin_dir_path( __FILE__ ) . 'templates/';
511
-
512
- // Triggers
513
- add_action( 'my_plugin_custom_action', array( $this, 'trigger' ), 10, 2 );
514
-
515
- // Call parent constructor
516
- parent::__construct();
517
- }
518
-
519
- /**
520
- * Trigger email
521
- */
522
- public function trigger( $order_id, $custom_data = null ) {
523
- $this->setup_locale();
524
-
525
- if ( $order_id ) {
526
- $this->object = wc_get_order( $order_id );
527
- $this->recipient = $this->object->get_billing_email();
528
- }
529
-
530
- if ( $this->is_enabled() && $this->get_recipient() ) {
531
- $this->send(
532
- $this->get_recipient(),
533
- $this->get_subject(),
534
- $this->get_content(),
535
- $this->get_headers(),
536
- $this->get_attachments()
537
- );
538
- }
539
-
540
- $this->restore_locale();
541
- }
542
-
543
- /**
544
- * Get email content (HTML)
545
- */
546
- public function get_content_html() {
547
- return wc_get_template_html(
548
- $this->template_html,
549
- array(
550
- 'order' => $this->object,
551
- 'email_heading' => $this->get_heading(),
552
- 'sent_to_admin' => false,
553
- 'plain_text' => false,
554
- 'email' => $this,
555
- ),
556
- '',
557
- $this->template_base
558
- );
559
- }
560
-
561
- /**
562
- * Get email content (plain text)
563
- */
564
- public function get_content_plain() {
565
- return wc_get_template_html(
566
- $this->template_plain,
567
- array(
568
- 'order' => $this->object,
569
- 'email_heading' => $this->get_heading(),
570
- 'sent_to_admin' => false,
571
- 'plain_text' => true,
572
- 'email' => $this,
573
- ),
574
- '',
575
- $this->template_base
576
- );
577
- }
578
- }
579
-
580
- /**
581
- * Add custom email to WooCommerce
582
- */
583
- function my_plugin_add_custom_email( $emails ) {
584
- $emails['My_Plugin_Custom_Email'] = new My_Plugin_Custom_Email();
585
- return $emails;
586
- }
587
- add_filter( 'woocommerce_email_classes', 'my_plugin_add_custom_email' );
588
- ```
589
-
590
- ---
591
-
592
- ## REST API Extensions
593
-
594
- ### Add Custom REST API Endpoint
595
-
596
- ```php
597
- <?php
598
- /**
599
- * Register custom REST API endpoint
600
- */
601
- function my_plugin_register_rest_route() {
602
- register_rest_route( 'my-plugin/v1', '/products/(?P<id>\d+)/custom', array(
603
- 'methods' => 'GET',
604
- 'callback' => 'my_plugin_get_product_custom_data',
605
- 'permission_callback' => function() {
606
- return current_user_can( 'edit_posts' );
607
- },
608
- 'args' => array(
609
- 'id' => array(
610
- 'validate_callback' => function( $param ) {
611
- return is_numeric( $param );
612
- },
613
- ),
614
- ),
615
- ) );
616
- }
617
- add_action( 'rest_api_init', 'my_plugin_register_rest_route' );
618
-
619
- /**
620
- * Get product custom data via REST API
621
- */
622
- function my_plugin_get_product_custom_data( $request ) {
623
- $product_id = $request['id'];
624
- $product = wc_get_product( $product_id );
625
-
626
- if ( ! $product ) {
627
- return new WP_Error( 'invalid_product', __( 'Invalid product ID.', 'my-plugin' ), array( 'status' => 404 ) );
628
- }
629
-
630
- return rest_ensure_response( array(
631
- 'id' => $product->get_id(),
632
- 'name' => $product->get_name(),
633
- 'custom_field' => $product->get_meta( '_custom_product_field' ),
634
- ) );
635
- }
636
- ```
637
-
638
- ---
639
-
640
- ## Admin Extensions
641
-
642
- ### Add Custom Admin Column
643
-
644
- ```php
645
- <?php
646
- /**
647
- * Add custom column to products admin
648
- */
649
- function my_plugin_add_product_column( $columns ) {
650
- $columns['custom_field'] = __( 'Custom Field', 'my-plugin' );
651
- return $columns;
652
- }
653
- add_filter( 'manage_edit-product_columns', 'my_plugin_add_product_column' );
654
-
655
- /**
656
- * Populate custom column
657
- */
658
- function my_plugin_populate_product_column( $column, $post_id ) {
659
- if ( 'custom_field' === $column ) {
660
- $product = wc_get_product( $post_id );
661
- $custom_field = $product->get_meta( '_custom_product_field' );
662
- echo esc_html( $custom_field );
663
- }
664
- }
665
- add_action( 'manage_product_posts_custom_column', 'my_plugin_populate_product_column', 10, 2 );
666
-
667
- /**
668
- * Make custom column sortable
669
- */
670
- function my_plugin_sortable_product_column( $columns ) {
671
- $columns['custom_field'] = 'custom_field';
672
- return $columns;
673
- }
674
- add_filter( 'manage_edit-product_sortable_columns', 'my_plugin_sortable_product_column' );
675
- ```
676
-
677
- ### Add Settings Tab to WooCommerce Settings
678
-
679
- ```php
680
- <?php
681
- /**
682
- * Add custom settings tab
683
- */
684
- function my_plugin_add_settings_tab( $settings_tabs ) {
685
- $settings_tabs['my_plugin'] = __( 'My Plugin', 'my-plugin' );
686
- return $settings_tabs;
687
- }
688
- add_filter( 'woocommerce_settings_tabs_array', 'my_plugin_add_settings_tab', 50 );
689
-
690
- /**
691
- * Settings tab content
692
- */
693
- function my_plugin_settings_tab_content() {
694
- woocommerce_admin_fields( my_plugin_get_settings() );
695
- }
696
- add_action( 'woocommerce_settings_tabs_my_plugin', 'my_plugin_settings_tab_content' );
697
-
698
- /**
699
- * Save settings
700
- */
701
- function my_plugin_save_settings() {
702
- woocommerce_update_options( my_plugin_get_settings() );
703
- }
704
- add_action( 'woocommerce_update_options_my_plugin', 'my_plugin_save_settings' );
705
-
706
- /**
707
- * Get settings array
708
- */
709
- function my_plugin_get_settings() {
710
- return array(
711
- array(
712
- 'title' => __( 'My Plugin Settings', 'my-plugin' ),
713
- 'type' => 'title',
714
- 'id' => 'my_plugin_settings',
715
- ),
716
- array(
717
- 'title' => __( 'Enable Feature', 'my-plugin' ),
718
- 'desc' => __( 'Enable custom feature', 'my-plugin' ),
719
- 'id' => 'my_plugin_enable_feature',
720
- 'default' => 'yes',
721
- 'type' => 'checkbox',
722
- ),
723
- array(
724
- 'title' => __( 'Custom Option', 'my-plugin' ),
725
- 'desc' => __( 'Enter custom value', 'my-plugin' ),
726
- 'id' => 'my_plugin_custom_option',
727
- 'default' => '',
728
- 'type' => 'text',
729
- 'desc_tip' => true,
730
- ),
731
- array(
732
- 'type' => 'sectionend',
733
- 'id' => 'my_plugin_settings',
734
- ),
735
- );
736
- }
737
- ```
738
-
739
- ---
740
-
741
- ## Best Practices
742
-
743
- ### DO
744
-
745
- ✅ **Check WooCommerce is active** before using WooCommerce functions
746
- ✅ **Declare HPOS compatibility** for modern WooCommerce versions
747
- ✅ **Use WooCommerce hooks and filters** instead of modifying core files
748
- ✅ **Sanitize all input** from forms and requests
749
- ✅ **Escape all output** to prevent XSS attacks
750
- ✅ **Use WooCommerce functions** (`wc_get_product()`, `wc_get_order()`, etc.)
751
- ✅ **Follow WooCommerce coding standards**
752
- ✅ **Test with latest WooCommerce version**
753
- ✅ **Use translation functions** for all user-facing text
754
- ✅ **Add proper error handling** for API calls and external services
755
- ✅ **Document custom hooks** for other developers
756
-
757
- ### DON'T
758
-
759
- ❌ **Don't modify WooCommerce core files** - use hooks and filters
760
- ❌ **Don't assume WooCommerce is active** - always check first
761
- ❌ **Don't use deprecated WooCommerce functions** - check documentation
762
- ❌ **Don't access database directly** - use WooCommerce CRUD classes
763
- ❌ **Don't ignore HPOS compatibility** - declare it explicitly
764
- ❌ **Don't hardcode text** - use translation functions
765
- ❌ **Don't skip nonce verification** on form submissions
766
- ❌ **Don't forget capability checks** for admin functions
767
- ❌ **Don't use global `$post`** - use WooCommerce objects
768
- ❌ **Don't break backward compatibility** without version checks
769
-
770
- ---
771
-
772
- ## Security Considerations
773
-
774
- ### Nonce Verification
775
-
776
- ```php
777
- <?php
778
- /**
779
- * Process custom form with nonce verification
780
- */
781
- function my_plugin_process_custom_form() {
782
- // Verify nonce
783
- if ( ! isset( $_POST['my_plugin_nonce'] ) ||
784
- ! wp_verify_nonce( $_POST['my_plugin_nonce'], 'my_plugin_action' ) ) {
785
- wp_die( __( 'Security check failed.', 'my-plugin' ) );
786
- }
787
-
788
- // Process form
789
- $custom_field = sanitize_text_field( $_POST['custom_field'] );
790
- // ...
791
- }
792
- ```
793
-
794
- ### Capability Checks
795
-
796
- ```php
797
- <?php
798
- /**
799
- * Admin action with capability check
800
- */
801
- function my_plugin_admin_action() {
802
- // Check user capabilities
803
- if ( ! current_user_can( 'manage_woocommerce' ) ) {
804
- wp_die( __( 'You do not have permission to perform this action.', 'my-plugin' ) );
805
- }
806
-
807
- // Perform admin action
808
- // ...
809
- }
810
- ```
811
-
812
- ### Data Sanitization
813
-
814
- ```php
815
- <?php
816
- // Text input
817
- $text = sanitize_text_field( $_POST['text_field'] );
818
-
819
- // Email
820
- $email = sanitize_email( $_POST['email_field'] );
821
-
822
- // URL
823
- $url = esc_url_raw( $_POST['url_field'] );
824
-
825
- // Integer
826
- $number = absint( $_POST['number_field'] );
827
-
828
- // Array
829
- $array = array_map( 'sanitize_text_field', $_POST['array_field'] );
830
- ```
831
-
832
- ---
833
-
834
- ## Performance Optimization
835
-
836
- ### Cache Product Data
837
-
838
- ```php
839
- <?php
840
- /**
841
- * Get product data with caching
842
- */
843
- function my_plugin_get_product_data( $product_id ) {
844
- $cache_key = 'my_plugin_product_' . $product_id;
845
- $data = wp_cache_get( $cache_key );
846
-
847
- if ( false === $data ) {
848
- $product = wc_get_product( $product_id );
849
-
850
- $data = array(
851
- 'id' => $product->get_id(),
852
- 'name' => $product->get_name(),
853
- 'price' => $product->get_price(),
854
- );
855
-
856
- wp_cache_set( $cache_key, $data, '', HOUR_IN_SECONDS );
857
- }
858
-
859
- return $data;
860
- }
861
- ```
862
-
863
- ### Optimize Database Queries
864
-
865
- ```php
866
- <?php
867
- /**
868
- * Get products efficiently
869
- */
870
- function my_plugin_get_products() {
871
- $args = array(
872
- 'limit' => 10,
873
- 'status' => 'publish',
874
- 'return' => 'ids', // Return only IDs for better performance
875
- );
876
-
877
- $products = wc_get_products( $args );
878
-
879
- return $products;
880
- }
881
- ```
882
-
883
- ---
884
-
885
- ## Testing
886
-
887
- ### Unit Test Example
888
-
889
- ```php
890
- <?php
891
- /**
892
- * Test custom product field
893
- */
894
- class Test_Custom_Product_Field extends WP_UnitTestCase {
895
-
896
- public function test_save_custom_product_field() {
897
- $product = WC_Helper_Product::create_simple_product();
898
-
899
- update_post_meta( $product->get_id(), '_custom_product_field', 'test value' );
900
-
901
- $saved_value = get_post_meta( $product->get_id(), '_custom_product_field', true );
902
-
903
- $this->assertEquals( 'test value', $saved_value );
904
- }
905
- }
906
- ```
907
-
908
- ---
909
-
910
- ## Common Hooks Reference
911
-
912
- ### Product Hooks
913
-
914
- - `woocommerce_product_options_general_product_data` - Add fields to product general tab
915
- - `woocommerce_process_product_meta` - Save product meta data
916
- - `woocommerce_single_product_summary` - Add content to product page
917
- - `woocommerce_product_tabs` - Add/modify product tabs
918
-
919
- ### Cart Hooks
920
-
921
- - `woocommerce_add_cart_item_data` - Add custom cart item data
922
- - `woocommerce_get_item_data` - Display cart item data
923
- - `woocommerce_before_calculate_totals` - Modify cart totals
924
-
925
- ### Checkout Hooks
926
-
927
- - `woocommerce_checkout_fields` - Add/modify checkout fields
928
- - `woocommerce_checkout_process` - Validate checkout fields
929
- - `woocommerce_checkout_update_order_meta` - Save checkout field data
930
-
931
- ### Order Hooks
932
-
933
- - `woocommerce_new_order` - Order created
934
- - `woocommerce_order_status_changed` - Order status changed
935
- - `woocommerce_order_status_completed` - Order completed
936
- - `woocommerce_checkout_create_order_line_item` - Save order item meta
937
-
938
- ---
939
-
940
- ## Resources
941
-
942
- - [WooCommerce Developer Documentation](https://woocommerce.com/document/create-a-plugin/)
943
- - [WooCommerce Code Reference](https://woocommerce.github.io/code-reference/)
944
- - [WooCommerce REST API](https://woocommerce.github.io/woocommerce-rest-api-docs/)
945
- - [WooCommerce GitHub](https://github.com/woocommerce/woocommerce)
946
- ```
947
- ```
948
-
949
-
1
+ # WooCommerce Integration for WordPress Plugins
2
+
3
+ ## Overview
4
+
5
+ This document provides comprehensive guidelines for creating WordPress plugins that integrate with WooCommerce, the most popular eCommerce platform for WordPress.
6
+
7
+ ## Plugin Detection
8
+
9
+ ### Check if WooCommerce is Active
10
+
11
+ Always verify WooCommerce is installed and active before using WooCommerce functions:
12
+
13
+ ```php
14
+ <?php
15
+ /**
16
+ * Check if WooCommerce is active
17
+ */
18
+ function my_plugin_is_woocommerce_active() {
19
+ return in_array(
20
+ 'woocommerce/woocommerce.php',
21
+ apply_filters( 'active_plugins', get_option( 'active_plugins' ) )
22
+ );
23
+ }
24
+
25
+ /**
26
+ * Initialize plugin only if WooCommerce is active
27
+ */
28
+ function my_plugin_init() {
29
+ if ( ! my_plugin_is_woocommerce_active() ) {
30
+ add_action( 'admin_notices', 'my_plugin_woocommerce_missing_notice' );
31
+ return;
32
+ }
33
+
34
+ // Initialize plugin functionality
35
+ My_Plugin::instance();
36
+ }
37
+ add_action( 'plugins_loaded', 'my_plugin_init' );
38
+
39
+ /**
40
+ * Display admin notice if WooCommerce is not active
41
+ */
42
+ function my_plugin_woocommerce_missing_notice() {
43
+ ?>
44
+ <div class="notice notice-error">
45
+ <p><?php esc_html_e( 'My Plugin requires WooCommerce to be installed and active.', 'my-plugin' ); ?></p>
46
+ </div>
47
+ <?php
48
+ }
49
+ ```
50
+
51
+ ### Declare WooCommerce Compatibility
52
+
53
+ ```php
54
+ <?php
55
+ /**
56
+ * Declare HPOS (High-Performance Order Storage) compatibility
57
+ */
58
+ add_action( 'before_woocommerce_init', function() {
59
+ if ( class_exists( \Automattic\WooCommerce\Utilities\FeaturesUtil::class ) ) {
60
+ \Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility(
61
+ 'custom_order_tables',
62
+ __FILE__,
63
+ true
64
+ );
65
+ }
66
+ } );
67
+
68
+ /**
69
+ * Declare compatibility with WooCommerce features
70
+ */
71
+ add_action( 'before_woocommerce_init', function() {
72
+ if ( class_exists( \Automattic\WooCommerce\Utilities\FeaturesUtil::class ) ) {
73
+ \Automattic\WooCommerce\Utilities\FeaturesUtil::declare_compatibility(
74
+ 'cart_checkout_blocks',
75
+ __FILE__,
76
+ true
77
+ );
78
+ }
79
+ } );
80
+ ```
81
+
82
+ ---
83
+
84
+ ## Product Extensions
85
+
86
+ ### Add Custom Product Fields
87
+
88
+ ```php
89
+ <?php
90
+ /**
91
+ * Add custom field to product general tab
92
+ */
93
+ function my_plugin_add_custom_product_field() {
94
+ woocommerce_wp_text_input( array(
95
+ 'id' => '_custom_product_field',
96
+ 'label' => __( 'Custom Field', 'my-plugin' ),
97
+ 'placeholder' => __( 'Enter value', 'my-plugin' ),
98
+ 'desc_tip' => true,
99
+ 'description' => __( 'This is a custom field.', 'my-plugin' ),
100
+ ) );
101
+ }
102
+ add_action( 'woocommerce_product_options_general_product_data', 'my_plugin_add_custom_product_field' );
103
+
104
+ /**
105
+ * Save custom product field
106
+ */
107
+ function my_plugin_save_custom_product_field( $post_id ) {
108
+ $custom_field = isset( $_POST['_custom_product_field'] )
109
+ ? sanitize_text_field( $_POST['_custom_product_field'] )
110
+ : '';
111
+
112
+ update_post_meta( $post_id, '_custom_product_field', $custom_field );
113
+ }
114
+ add_action( 'woocommerce_process_product_meta', 'my_plugin_save_custom_product_field' );
115
+
116
+ /**
117
+ * Display custom field on product page
118
+ */
119
+ function my_plugin_display_custom_product_field() {
120
+ global $product;
121
+
122
+ $custom_field = $product->get_meta( '_custom_product_field' );
123
+
124
+ if ( $custom_field ) {
125
+ echo '<div class="custom-product-field">';
126
+ echo '<strong>' . esc_html__( 'Custom Field:', 'my-plugin' ) . '</strong> ';
127
+ echo esc_html( $custom_field );
128
+ echo '</div>';
129
+ }
130
+ }
131
+ add_action( 'woocommerce_single_product_summary', 'my_plugin_display_custom_product_field', 25 );
132
+ ```
133
+
134
+ ### Add Custom Product Tab
135
+
136
+ ```php
137
+ <?php
138
+ /**
139
+ * Add custom product tab
140
+ */
141
+ function my_plugin_add_custom_product_tab( $tabs ) {
142
+ $tabs['custom_tab'] = array(
143
+ 'title' => __( 'Custom Tab', 'my-plugin' ),
144
+ 'priority' => 50,
145
+ 'callback' => 'my_plugin_custom_product_tab_content',
146
+ );
147
+
148
+ return $tabs;
149
+ }
150
+ add_filter( 'woocommerce_product_tabs', 'my_plugin_add_custom_product_tab' );
151
+
152
+ /**
153
+ * Custom product tab content
154
+ */
155
+ function my_plugin_custom_product_tab_content() {
156
+ global $product;
157
+
158
+ ?>
159
+ <h2><?php esc_html_e( 'Custom Tab', 'my-plugin' ); ?></h2>
160
+ <p><?php esc_html_e( 'Custom tab content goes here.', 'my-plugin' ); ?></p>
161
+ <?php
162
+ }
163
+ ```
164
+
165
+ ---
166
+
167
+ ## Cart & Checkout Extensions
168
+
169
+ ### Add Custom Cart Item Data
170
+
171
+ ```php
172
+ <?php
173
+ /**
174
+ * Add custom data to cart item
175
+ */
176
+ function my_plugin_add_cart_item_data( $cart_item_data, $product_id, $variation_id ) {
177
+ if ( isset( $_POST['custom_field'] ) ) {
178
+ $cart_item_data['custom_field'] = sanitize_text_field( $_POST['custom_field'] );
179
+ }
180
+
181
+ return $cart_item_data;
182
+ }
183
+ add_filter( 'woocommerce_add_cart_item_data', 'my_plugin_add_cart_item_data', 10, 3 );
184
+
185
+ /**
186
+ * Display custom cart item data
187
+ */
188
+ function my_plugin_display_cart_item_data( $item_data, $cart_item ) {
189
+ if ( isset( $cart_item['custom_field'] ) ) {
190
+ $item_data[] = array(
191
+ 'key' => __( 'Custom Field', 'my-plugin' ),
192
+ 'value' => wc_clean( $cart_item['custom_field'] ),
193
+ );
194
+ }
195
+
196
+ return $item_data;
197
+ }
198
+ add_filter( 'woocommerce_get_item_data', 'my_plugin_display_cart_item_data', 10, 2 );
199
+
200
+ /**
201
+ * Save custom cart item data to order
202
+ */
203
+ function my_plugin_save_order_item_meta( $item, $cart_item_key, $values, $order ) {
204
+ if ( isset( $values['custom_field'] ) ) {
205
+ $item->add_meta_data( '_custom_field', $values['custom_field'] );
206
+ }
207
+ }
208
+ add_action( 'woocommerce_checkout_create_order_line_item', 'my_plugin_save_order_item_meta', 10, 4 );
209
+ ```
210
+
211
+ ### Add Custom Checkout Field
212
+
213
+ ```php
214
+ <?php
215
+ /**
216
+ * Add custom checkout field
217
+ */
218
+ function my_plugin_add_checkout_field( $fields ) {
219
+ $fields['billing']['billing_custom_field'] = array(
220
+ 'type' => 'text',
221
+ 'label' => __( 'Custom Field', 'my-plugin' ),
222
+ 'placeholder' => __( 'Enter value', 'my-plugin' ),
223
+ 'required' => false,
224
+ 'class' => array( 'form-row-wide' ),
225
+ 'clear' => true,
226
+ 'priority' => 100,
227
+ );
228
+
229
+ return $fields;
230
+ }
231
+ add_filter( 'woocommerce_checkout_fields', 'my_plugin_add_checkout_field' );
232
+
233
+ /**
234
+ * Validate custom checkout field
235
+ */
236
+ function my_plugin_validate_checkout_field() {
237
+ if ( isset( $_POST['billing_custom_field'] ) && empty( $_POST['billing_custom_field'] ) ) {
238
+ wc_add_notice(
239
+ __( 'Please enter a value for Custom Field.', 'my-plugin' ),
240
+ 'error'
241
+ );
242
+ }
243
+ }
244
+ add_action( 'woocommerce_checkout_process', 'my_plugin_validate_checkout_field' );
245
+
246
+ /**
247
+ * Save custom checkout field to order
248
+ */
249
+ function my_plugin_save_checkout_field( $order_id ) {
250
+ if ( isset( $_POST['billing_custom_field'] ) ) {
251
+ update_post_meta(
252
+ $order_id,
253
+ '_billing_custom_field',
254
+ sanitize_text_field( $_POST['billing_custom_field'] )
255
+ );
256
+ }
257
+ }
258
+ add_action( 'woocommerce_checkout_update_order_meta', 'my_plugin_save_checkout_field' );
259
+
260
+ /**
261
+ * Display custom field in order admin
262
+ */
263
+ function my_plugin_display_order_custom_field( $order ) {
264
+ $custom_field = $order->get_meta( '_billing_custom_field' );
265
+
266
+ if ( $custom_field ) {
267
+ echo '<p><strong>' . esc_html__( 'Custom Field:', 'my-plugin' ) . '</strong> ' . esc_html( $custom_field ) . '</p>';
268
+ }
269
+ }
270
+ add_action( 'woocommerce_admin_order_data_after_billing_address', 'my_plugin_display_order_custom_field' );
271
+ ```
272
+
273
+ ---
274
+
275
+ ## Order Extensions
276
+
277
+ ### Add Custom Order Status
278
+
279
+ ```php
280
+ <?php
281
+ /**
282
+ * Register custom order status
283
+ */
284
+ function my_plugin_register_custom_order_status() {
285
+ register_post_status( 'wc-custom-status', array(
286
+ 'label' => __( 'Custom Status', 'my-plugin' ),
287
+ 'public' => true,
288
+ 'exclude_from_search' => false,
289
+ 'show_in_admin_all_list' => true,
290
+ 'show_in_admin_status_list' => true,
291
+ 'label_count' => _n_noop(
292
+ 'Custom Status <span class="count">(%s)</span>',
293
+ 'Custom Status <span class="count">(%s)</span>',
294
+ 'my-plugin'
295
+ ),
296
+ ) );
297
+ }
298
+ add_action( 'init', 'my_plugin_register_custom_order_status' );
299
+
300
+ /**
301
+ * Add custom status to order statuses
302
+ */
303
+ function my_plugin_add_custom_order_status( $order_statuses ) {
304
+ $order_statuses['wc-custom-status'] = __( 'Custom Status', 'my-plugin' );
305
+ return $order_statuses;
306
+ }
307
+ add_filter( 'wc_order_statuses', 'my_plugin_add_custom_order_status' );
308
+ ```
309
+
310
+ ### Hook into Order Events
311
+
312
+ ```php
313
+ <?php
314
+ /**
315
+ * Action when order is created
316
+ */
317
+ function my_plugin_order_created( $order_id, $order ) {
318
+ // Custom logic when order is created
319
+ error_log( 'Order created: ' . $order_id );
320
+ }
321
+ add_action( 'woocommerce_new_order', 'my_plugin_order_created', 10, 2 );
322
+
323
+ /**
324
+ * Action when order status changes
325
+ */
326
+ function my_plugin_order_status_changed( $order_id, $old_status, $new_status, $order ) {
327
+ // Custom logic when order status changes
328
+ if ( 'processing' === $new_status ) {
329
+ // Do something when order is processing
330
+ }
331
+ }
332
+ add_action( 'woocommerce_order_status_changed', 'my_plugin_order_status_changed', 10, 4 );
333
+
334
+ /**
335
+ * Action when order is completed
336
+ */
337
+ function my_plugin_order_completed( $order_id ) {
338
+ $order = wc_get_order( $order_id );
339
+
340
+ // Custom logic when order is completed
341
+ // e.g., send to external API, update inventory, etc.
342
+ }
343
+ add_action( 'woocommerce_order_status_completed', 'my_plugin_order_completed' );
344
+ ```
345
+
346
+ ---
347
+
348
+ ## Payment Gateway Integration
349
+
350
+ ### Create Custom Payment Gateway
351
+
352
+ ```php
353
+ <?php
354
+ /**
355
+ * Custom Payment Gateway Class
356
+ */
357
+ class My_Plugin_Payment_Gateway extends WC_Payment_Gateway {
358
+
359
+ /**
360
+ * Constructor
361
+ */
362
+ public function __construct() {
363
+ $this->id = 'my_custom_gateway';
364
+ $this->icon = '';
365
+ $this->has_fields = true;
366
+ $this->method_title = __( 'Custom Gateway', 'my-plugin' );
367
+ $this->method_description = __( 'Custom payment gateway description.', 'my-plugin' );
368
+
369
+ // Load settings
370
+ $this->init_form_fields();
371
+ $this->init_settings();
372
+
373
+ // Get settings
374
+ $this->title = $this->get_option( 'title' );
375
+ $this->description = $this->get_option( 'description' );
376
+ $this->enabled = $this->get_option( 'enabled' );
377
+
378
+ // Actions
379
+ add_action(
380
+ 'woocommerce_update_options_payment_gateways_' . $this->id,
381
+ array( $this, 'process_admin_options' )
382
+ );
383
+ }
384
+
385
+ /**
386
+ * Initialize gateway settings form fields
387
+ */
388
+ public function init_form_fields() {
389
+ $this->form_fields = array(
390
+ 'enabled' => array(
391
+ 'title' => __( 'Enable/Disable', 'my-plugin' ),
392
+ 'type' => 'checkbox',
393
+ 'label' => __( 'Enable Custom Gateway', 'my-plugin' ),
394
+ 'default' => 'no',
395
+ ),
396
+ 'title' => array(
397
+ 'title' => __( 'Title', 'my-plugin' ),
398
+ 'type' => 'text',
399
+ 'description' => __( 'Payment method title shown to customers.', 'my-plugin' ),
400
+ 'default' => __( 'Custom Payment', 'my-plugin' ),
401
+ 'desc_tip' => true,
402
+ ),
403
+ 'description' => array(
404
+ 'title' => __( 'Description', 'my-plugin' ),
405
+ 'type' => 'textarea',
406
+ 'description' => __( 'Payment method description shown to customers.', 'my-plugin' ),
407
+ 'default' => __( 'Pay with custom gateway.', 'my-plugin' ),
408
+ 'desc_tip' => true,
409
+ ),
410
+ );
411
+ }
412
+
413
+ /**
414
+ * Payment fields on checkout
415
+ */
416
+ public function payment_fields() {
417
+ if ( $this->description ) {
418
+ echo wpautop( wp_kses_post( $this->description ) );
419
+ }
420
+
421
+ // Add custom payment fields here
422
+ ?>
423
+ <fieldset>
424
+ <p class="form-row form-row-wide">
425
+ <label for="custom-field"><?php esc_html_e( 'Custom Field', 'my-plugin' ); ?></label>
426
+ <input type="text" id="custom-field" name="custom_field" />
427
+ </p>
428
+ </fieldset>
429
+ <?php
430
+ }
431
+
432
+ /**
433
+ * Validate payment fields
434
+ */
435
+ public function validate_fields() {
436
+ if ( empty( $_POST['custom_field'] ) ) {
437
+ wc_add_notice(
438
+ __( 'Custom field is required.', 'my-plugin' ),
439
+ 'error'
440
+ );
441
+ return false;
442
+ }
443
+
444
+ return true;
445
+ }
446
+
447
+ /**
448
+ * Process payment
449
+ */
450
+ public function process_payment( $order_id ) {
451
+ $order = wc_get_order( $order_id );
452
+
453
+ // Process payment with external gateway
454
+ // ...
455
+
456
+ // Mark order as processing or completed
457
+ $order->payment_complete();
458
+
459
+ // Add order note
460
+ $order->add_order_note(
461
+ __( 'Payment completed via Custom Gateway.', 'my-plugin' )
462
+ );
463
+
464
+ // Reduce stock levels
465
+ wc_reduce_stock_levels( $order_id );
466
+
467
+ // Remove cart
468
+ WC()->cart->empty_cart();
469
+
470
+ // Return success
471
+ return array(
472
+ 'result' => 'success',
473
+ 'redirect' => $this->get_return_url( $order ),
474
+ );
475
+ }
476
+ }
477
+
478
+ /**
479
+ * Add custom payment gateway to WooCommerce
480
+ */
481
+ function my_plugin_add_payment_gateway( $gateways ) {
482
+ $gateways[] = 'My_Plugin_Payment_Gateway';
483
+ return $gateways;
484
+ }
485
+ add_filter( 'woocommerce_payment_gateways', 'my_plugin_add_payment_gateway' );
486
+ ```
487
+
488
+ ---
489
+
490
+ ## Email Extensions
491
+
492
+ ### Add Custom Email
493
+
494
+ ```php
495
+ <?php
496
+ /**
497
+ * Custom Email Class
498
+ */
499
+ class My_Plugin_Custom_Email extends WC_Email {
500
+
501
+ /**
502
+ * Constructor
503
+ */
504
+ public function __construct() {
505
+ $this->id = 'my_custom_email';
506
+ $this->title = __( 'Custom Email', 'my-plugin' );
507
+ $this->description = __( 'Custom email sent to customers.', 'my-plugin' );
508
+ $this->template_html = 'emails/custom-email.php';
509
+ $this->template_plain = 'emails/plain/custom-email.php';
510
+ $this->template_base = plugin_dir_path( __FILE__ ) . 'templates/';
511
+
512
+ // Triggers
513
+ add_action( 'my_plugin_custom_action', array( $this, 'trigger' ), 10, 2 );
514
+
515
+ // Call parent constructor
516
+ parent::__construct();
517
+ }
518
+
519
+ /**
520
+ * Trigger email
521
+ */
522
+ public function trigger( $order_id, $custom_data = null ) {
523
+ $this->setup_locale();
524
+
525
+ if ( $order_id ) {
526
+ $this->object = wc_get_order( $order_id );
527
+ $this->recipient = $this->object->get_billing_email();
528
+ }
529
+
530
+ if ( $this->is_enabled() && $this->get_recipient() ) {
531
+ $this->send(
532
+ $this->get_recipient(),
533
+ $this->get_subject(),
534
+ $this->get_content(),
535
+ $this->get_headers(),
536
+ $this->get_attachments()
537
+ );
538
+ }
539
+
540
+ $this->restore_locale();
541
+ }
542
+
543
+ /**
544
+ * Get email content (HTML)
545
+ */
546
+ public function get_content_html() {
547
+ return wc_get_template_html(
548
+ $this->template_html,
549
+ array(
550
+ 'order' => $this->object,
551
+ 'email_heading' => $this->get_heading(),
552
+ 'sent_to_admin' => false,
553
+ 'plain_text' => false,
554
+ 'email' => $this,
555
+ ),
556
+ '',
557
+ $this->template_base
558
+ );
559
+ }
560
+
561
+ /**
562
+ * Get email content (plain text)
563
+ */
564
+ public function get_content_plain() {
565
+ return wc_get_template_html(
566
+ $this->template_plain,
567
+ array(
568
+ 'order' => $this->object,
569
+ 'email_heading' => $this->get_heading(),
570
+ 'sent_to_admin' => false,
571
+ 'plain_text' => true,
572
+ 'email' => $this,
573
+ ),
574
+ '',
575
+ $this->template_base
576
+ );
577
+ }
578
+ }
579
+
580
+ /**
581
+ * Add custom email to WooCommerce
582
+ */
583
+ function my_plugin_add_custom_email( $emails ) {
584
+ $emails['My_Plugin_Custom_Email'] = new My_Plugin_Custom_Email();
585
+ return $emails;
586
+ }
587
+ add_filter( 'woocommerce_email_classes', 'my_plugin_add_custom_email' );
588
+ ```
589
+
590
+ ---
591
+
592
+ ## REST API Extensions
593
+
594
+ ### Add Custom REST API Endpoint
595
+
596
+ ```php
597
+ <?php
598
+ /**
599
+ * Register custom REST API endpoint
600
+ */
601
+ function my_plugin_register_rest_route() {
602
+ register_rest_route( 'my-plugin/v1', '/products/(?P<id>\d+)/custom', array(
603
+ 'methods' => 'GET',
604
+ 'callback' => 'my_plugin_get_product_custom_data',
605
+ 'permission_callback' => function() {
606
+ return current_user_can( 'edit_posts' );
607
+ },
608
+ 'args' => array(
609
+ 'id' => array(
610
+ 'validate_callback' => function( $param ) {
611
+ return is_numeric( $param );
612
+ },
613
+ ),
614
+ ),
615
+ ) );
616
+ }
617
+ add_action( 'rest_api_init', 'my_plugin_register_rest_route' );
618
+
619
+ /**
620
+ * Get product custom data via REST API
621
+ */
622
+ function my_plugin_get_product_custom_data( $request ) {
623
+ $product_id = $request['id'];
624
+ $product = wc_get_product( $product_id );
625
+
626
+ if ( ! $product ) {
627
+ return new WP_Error( 'invalid_product', __( 'Invalid product ID.', 'my-plugin' ), array( 'status' => 404 ) );
628
+ }
629
+
630
+ return rest_ensure_response( array(
631
+ 'id' => $product->get_id(),
632
+ 'name' => $product->get_name(),
633
+ 'custom_field' => $product->get_meta( '_custom_product_field' ),
634
+ ) );
635
+ }
636
+ ```
637
+
638
+ ---
639
+
640
+ ## Admin Extensions
641
+
642
+ ### Add Custom Admin Column
643
+
644
+ ```php
645
+ <?php
646
+ /**
647
+ * Add custom column to products admin
648
+ */
649
+ function my_plugin_add_product_column( $columns ) {
650
+ $columns['custom_field'] = __( 'Custom Field', 'my-plugin' );
651
+ return $columns;
652
+ }
653
+ add_filter( 'manage_edit-product_columns', 'my_plugin_add_product_column' );
654
+
655
+ /**
656
+ * Populate custom column
657
+ */
658
+ function my_plugin_populate_product_column( $column, $post_id ) {
659
+ if ( 'custom_field' === $column ) {
660
+ $product = wc_get_product( $post_id );
661
+ $custom_field = $product->get_meta( '_custom_product_field' );
662
+ echo esc_html( $custom_field );
663
+ }
664
+ }
665
+ add_action( 'manage_product_posts_custom_column', 'my_plugin_populate_product_column', 10, 2 );
666
+
667
+ /**
668
+ * Make custom column sortable
669
+ */
670
+ function my_plugin_sortable_product_column( $columns ) {
671
+ $columns['custom_field'] = 'custom_field';
672
+ return $columns;
673
+ }
674
+ add_filter( 'manage_edit-product_sortable_columns', 'my_plugin_sortable_product_column' );
675
+ ```
676
+
677
+ ### Add Settings Tab to WooCommerce Settings
678
+
679
+ ```php
680
+ <?php
681
+ /**
682
+ * Add custom settings tab
683
+ */
684
+ function my_plugin_add_settings_tab( $settings_tabs ) {
685
+ $settings_tabs['my_plugin'] = __( 'My Plugin', 'my-plugin' );
686
+ return $settings_tabs;
687
+ }
688
+ add_filter( 'woocommerce_settings_tabs_array', 'my_plugin_add_settings_tab', 50 );
689
+
690
+ /**
691
+ * Settings tab content
692
+ */
693
+ function my_plugin_settings_tab_content() {
694
+ woocommerce_admin_fields( my_plugin_get_settings() );
695
+ }
696
+ add_action( 'woocommerce_settings_tabs_my_plugin', 'my_plugin_settings_tab_content' );
697
+
698
+ /**
699
+ * Save settings
700
+ */
701
+ function my_plugin_save_settings() {
702
+ woocommerce_update_options( my_plugin_get_settings() );
703
+ }
704
+ add_action( 'woocommerce_update_options_my_plugin', 'my_plugin_save_settings' );
705
+
706
+ /**
707
+ * Get settings array
708
+ */
709
+ function my_plugin_get_settings() {
710
+ return array(
711
+ array(
712
+ 'title' => __( 'My Plugin Settings', 'my-plugin' ),
713
+ 'type' => 'title',
714
+ 'id' => 'my_plugin_settings',
715
+ ),
716
+ array(
717
+ 'title' => __( 'Enable Feature', 'my-plugin' ),
718
+ 'desc' => __( 'Enable custom feature', 'my-plugin' ),
719
+ 'id' => 'my_plugin_enable_feature',
720
+ 'default' => 'yes',
721
+ 'type' => 'checkbox',
722
+ ),
723
+ array(
724
+ 'title' => __( 'Custom Option', 'my-plugin' ),
725
+ 'desc' => __( 'Enter custom value', 'my-plugin' ),
726
+ 'id' => 'my_plugin_custom_option',
727
+ 'default' => '',
728
+ 'type' => 'text',
729
+ 'desc_tip' => true,
730
+ ),
731
+ array(
732
+ 'type' => 'sectionend',
733
+ 'id' => 'my_plugin_settings',
734
+ ),
735
+ );
736
+ }
737
+ ```
738
+
739
+ ---
740
+
741
+ ## Best Practices
742
+
743
+ ### DO
744
+
745
+ ✅ **Check WooCommerce is active** before using WooCommerce functions
746
+ ✅ **Declare HPOS compatibility** for modern WooCommerce versions
747
+ ✅ **Use WooCommerce hooks and filters** instead of modifying core files
748
+ ✅ **Sanitize all input** from forms and requests
749
+ ✅ **Escape all output** to prevent XSS attacks
750
+ ✅ **Use WooCommerce functions** (`wc_get_product()`, `wc_get_order()`, etc.)
751
+ ✅ **Follow WooCommerce coding standards**
752
+ ✅ **Test with latest WooCommerce version**
753
+ ✅ **Use translation functions** for all user-facing text
754
+ ✅ **Add proper error handling** for API calls and external services
755
+ ✅ **Document custom hooks** for other developers
756
+
757
+ ### DON'T
758
+
759
+ ❌ **Don't modify WooCommerce core files** - use hooks and filters
760
+ ❌ **Don't assume WooCommerce is active** - always check first
761
+ ❌ **Don't use deprecated WooCommerce functions** - check documentation
762
+ ❌ **Don't access database directly** - use WooCommerce CRUD classes
763
+ ❌ **Don't ignore HPOS compatibility** - declare it explicitly
764
+ ❌ **Don't hardcode text** - use translation functions
765
+ ❌ **Don't skip nonce verification** on form submissions
766
+ ❌ **Don't forget capability checks** for admin functions
767
+ ❌ **Don't use global `$post`** - use WooCommerce objects
768
+ ❌ **Don't break backward compatibility** without version checks
769
+
770
+ ---
771
+
772
+ ## Security Considerations
773
+
774
+ ### Nonce Verification
775
+
776
+ ```php
777
+ <?php
778
+ /**
779
+ * Process custom form with nonce verification
780
+ */
781
+ function my_plugin_process_custom_form() {
782
+ // Verify nonce
783
+ if ( ! isset( $_POST['my_plugin_nonce'] ) ||
784
+ ! wp_verify_nonce( $_POST['my_plugin_nonce'], 'my_plugin_action' ) ) {
785
+ wp_die( __( 'Security check failed.', 'my-plugin' ) );
786
+ }
787
+
788
+ // Process form
789
+ $custom_field = sanitize_text_field( $_POST['custom_field'] );
790
+ // ...
791
+ }
792
+ ```
793
+
794
+ ### Capability Checks
795
+
796
+ ```php
797
+ <?php
798
+ /**
799
+ * Admin action with capability check
800
+ */
801
+ function my_plugin_admin_action() {
802
+ // Check user capabilities
803
+ if ( ! current_user_can( 'manage_woocommerce' ) ) {
804
+ wp_die( __( 'You do not have permission to perform this action.', 'my-plugin' ) );
805
+ }
806
+
807
+ // Perform admin action
808
+ // ...
809
+ }
810
+ ```
811
+
812
+ ### Data Sanitization
813
+
814
+ ```php
815
+ <?php
816
+ // Text input
817
+ $text = sanitize_text_field( $_POST['text_field'] );
818
+
819
+ // Email
820
+ $email = sanitize_email( $_POST['email_field'] );
821
+
822
+ // URL
823
+ $url = esc_url_raw( $_POST['url_field'] );
824
+
825
+ // Integer
826
+ $number = absint( $_POST['number_field'] );
827
+
828
+ // Array
829
+ $array = array_map( 'sanitize_text_field', $_POST['array_field'] );
830
+ ```
831
+
832
+ ---
833
+
834
+ ## Performance Optimization
835
+
836
+ ### Cache Product Data
837
+
838
+ ```php
839
+ <?php
840
+ /**
841
+ * Get product data with caching
842
+ */
843
+ function my_plugin_get_product_data( $product_id ) {
844
+ $cache_key = 'my_plugin_product_' . $product_id;
845
+ $data = wp_cache_get( $cache_key );
846
+
847
+ if ( false === $data ) {
848
+ $product = wc_get_product( $product_id );
849
+
850
+ $data = array(
851
+ 'id' => $product->get_id(),
852
+ 'name' => $product->get_name(),
853
+ 'price' => $product->get_price(),
854
+ );
855
+
856
+ wp_cache_set( $cache_key, $data, '', HOUR_IN_SECONDS );
857
+ }
858
+
859
+ return $data;
860
+ }
861
+ ```
862
+
863
+ ### Optimize Database Queries
864
+
865
+ ```php
866
+ <?php
867
+ /**
868
+ * Get products efficiently
869
+ */
870
+ function my_plugin_get_products() {
871
+ $args = array(
872
+ 'limit' => 10,
873
+ 'status' => 'publish',
874
+ 'return' => 'ids', // Return only IDs for better performance
875
+ );
876
+
877
+ $products = wc_get_products( $args );
878
+
879
+ return $products;
880
+ }
881
+ ```
882
+
883
+ ---
884
+
885
+ ## Testing
886
+
887
+ ### Unit Test Example
888
+
889
+ ```php
890
+ <?php
891
+ /**
892
+ * Test custom product field
893
+ */
894
+ class Test_Custom_Product_Field extends WP_UnitTestCase {
895
+
896
+ public function test_save_custom_product_field() {
897
+ $product = WC_Helper_Product::create_simple_product();
898
+
899
+ update_post_meta( $product->get_id(), '_custom_product_field', 'test value' );
900
+
901
+ $saved_value = get_post_meta( $product->get_id(), '_custom_product_field', true );
902
+
903
+ $this->assertEquals( 'test value', $saved_value );
904
+ }
905
+ }
906
+ ```
907
+
908
+ ---
909
+
910
+ ## Common Hooks Reference
911
+
912
+ ### Product Hooks
913
+
914
+ - `woocommerce_product_options_general_product_data` - Add fields to product general tab
915
+ - `woocommerce_process_product_meta` - Save product meta data
916
+ - `woocommerce_single_product_summary` - Add content to product page
917
+ - `woocommerce_product_tabs` - Add/modify product tabs
918
+
919
+ ### Cart Hooks
920
+
921
+ - `woocommerce_add_cart_item_data` - Add custom cart item data
922
+ - `woocommerce_get_item_data` - Display cart item data
923
+ - `woocommerce_before_calculate_totals` - Modify cart totals
924
+
925
+ ### Checkout Hooks
926
+
927
+ - `woocommerce_checkout_fields` - Add/modify checkout fields
928
+ - `woocommerce_checkout_process` - Validate checkout fields
929
+ - `woocommerce_checkout_update_order_meta` - Save checkout field data
930
+
931
+ ### Order Hooks
932
+
933
+ - `woocommerce_new_order` - Order created
934
+ - `woocommerce_order_status_changed` - Order status changed
935
+ - `woocommerce_order_status_completed` - Order completed
936
+ - `woocommerce_checkout_create_order_line_item` - Save order item meta
937
+
938
+ ---
939
+
940
+ ## Resources
941
+
942
+ - [WooCommerce Developer Documentation](https://woocommerce.com/document/create-a-plugin/)
943
+ - [WooCommerce Code Reference](https://woocommerce.github.io/code-reference/)
944
+ - [WooCommerce REST API](https://woocommerce.github.io/woocommerce-rest-api-docs/)
945
+ - [WooCommerce GitHub](https://github.com/woocommerce/woocommerce)
946
+ ```
947
+ ```
948
+
949
+