@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,1350 +1,1350 @@
1
- # Settings Page Plugin Example
2
-
3
- ## Overview
4
-
5
- This example demonstrates a complete **Settings Page Plugin** with admin menu, settings registration, sections, fields, validation, sanitization, and proper security implementation.
6
-
7
- **Complexity**: Medium
8
- **File Count**: 5-10 files
9
- **Team Size**: 1-2 developers
10
- **Use Case**: Plugin configuration, site settings, feature toggles, API integrations
11
-
12
- ---
13
-
14
- ## Complete Plugin: "Site Settings Manager"
15
-
16
- A comprehensive settings management plugin demonstrating WordPress Settings API, custom admin pages, field types, validation, and security best practices.
17
-
18
- ---
19
-
20
- ## Directory Structure
21
-
22
- ```
23
- site-settings-manager/
24
- ├── site-settings-manager.php # Main plugin file
25
- ├── uninstall.php # Uninstall cleanup
26
- ├── readme.txt # WordPress.org readme
27
- ├── includes/
28
- │ ├── class-settings-page.php # Settings page class
29
- │ ├── class-settings-fields.php # Field rendering
30
- │ └── class-settings-validator.php # Validation logic
31
- ├── admin/
32
- │ ├── css/
33
- │ │ └── admin.css # Admin styles
34
- │ ├── js/
35
- │ │ └── admin.js # Admin scripts
36
- │ └── views/
37
- │ ├── settings-page.php # Main settings view
38
- │ └── settings-sidebar.php # Sidebar view
39
- └── assets/
40
- └── images/
41
- └── icon.png # Plugin icon
42
- ```
43
-
44
- ---
45
-
46
- ## Main Plugin File
47
-
48
- ### File: `site-settings-manager.php`
49
-
50
- ```php
51
- <?php
52
- /**
53
- * Plugin Name: Site Settings Manager
54
- * Plugin URI: https://example.com/site-settings-manager
55
- * Description: Complete settings management with validation, sanitization, and security
56
- * Version: 1.0.0
57
- * Author: Your Name
58
- * Author URI: https://example.com
59
- * License: GPL-2.0+
60
- * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
61
- * Text Domain: site-settings-manager
62
- * Domain Path: /languages
63
- *
64
- * @package Site_Settings_Manager
65
- */
66
-
67
- // Exit if accessed directly
68
- if (!defined('ABSPATH')) {
69
- exit;
70
- }
71
-
72
- // Define plugin constants
73
- define('SSM_VERSION', '1.0.0');
74
- define('SSM_PLUGIN_DIR', plugin_dir_path(__FILE__));
75
- define('SSM_PLUGIN_URL', plugin_dir_url(__FILE__));
76
- define('SSM_PLUGIN_FILE', __FILE__);
77
-
78
- /**
79
- * Autoloader
80
- */
81
- spl_autoload_register(function ($class) {
82
- $prefix = 'SSM_';
83
-
84
- if (strpos($class, $prefix) !== 0) {
85
- return;
86
- }
87
-
88
- $class_name = str_replace($prefix, '', $class);
89
- $class_file = 'class-' . str_replace('_', '-', strtolower($class_name)) . '.php';
90
-
91
- $file = SSM_PLUGIN_DIR . 'includes/' . $class_file;
92
- if (file_exists($file)) {
93
- require $file;
94
- }
95
- });
96
-
97
- /**
98
- * Activation hook
99
- */
100
- register_activation_hook(__FILE__, function() {
101
- // Set default options
102
- $defaults = array(
103
- 'ssm_site_title' => get_bloginfo('name'),
104
- 'ssm_site_description' => get_bloginfo('description'),
105
- 'ssm_enable_feature' => false,
106
- 'ssm_api_key' => '',
107
- 'ssm_items_per_page' => 10,
108
- 'ssm_theme_color' => '#0073aa',
109
- );
110
-
111
- foreach ($defaults as $key => $value) {
112
- if (get_option($key) === false) {
113
- add_option($key, $value);
114
- }
115
- }
116
- });
117
-
118
- /**
119
- * Deactivation hook
120
- */
121
- register_deactivation_hook(__FILE__, function() {
122
- // Cleanup if needed
123
- });
124
-
125
- /**
126
- * Initialize the plugin
127
- */
128
- function run_site_settings_manager() {
129
- // Initialize settings page
130
- if (is_admin()) {
131
- SSM_Settings_Page::init();
132
- }
133
-
134
- // Load text domain
135
- add_action('plugins_loaded', 'ssm_load_textdomain');
136
-
137
- // Enqueue admin assets
138
- add_action('admin_enqueue_scripts', 'ssm_enqueue_admin_assets');
139
- }
140
- add_action('plugins_loaded', 'run_site_settings_manager');
141
-
142
- /**
143
- * Load plugin text domain
144
- */
145
- function ssm_load_textdomain() {
146
- load_plugin_textdomain(
147
- 'site-settings-manager',
148
- false,
149
- dirname(plugin_basename(SSM_PLUGIN_FILE)) . '/languages/'
150
- );
151
- }
152
-
153
- /**
154
- * Enqueue admin assets
155
- */
156
- function ssm_enqueue_admin_assets($hook) {
157
- // Only load on our settings page
158
- if ('settings_page_site-settings-manager' !== $hook) {
159
- return;
160
- }
161
-
162
- wp_enqueue_style(
163
- 'ssm-admin',
164
- SSM_PLUGIN_URL . 'admin/css/admin.css',
165
- array(),
166
- SSM_VERSION
167
- );
168
-
169
- wp_enqueue_script(
170
- 'ssm-admin',
171
- SSM_PLUGIN_URL . 'admin/js/admin.js',
172
- array('jquery', 'wp-color-picker'),
173
- SSM_VERSION,
174
- true
175
- );
176
-
177
- // Enqueue color picker
178
- wp_enqueue_style('wp-color-picker');
179
- }
180
- ```
181
-
182
- ---
183
-
184
- ## Settings Page Class
185
-
186
- ### File: `includes/class-settings-page.php`
187
-
188
- ```php
189
- <?php
190
- /**
191
- * Settings page class
192
- *
193
- * @package Site_Settings_Manager
194
- */
195
-
196
- class SSM_Settings_Page {
197
- /**
198
- * Settings page slug
199
- */
200
- const PAGE_SLUG = 'site-settings-manager';
201
-
202
- /**
203
- * Option group
204
- */
205
- const OPTION_GROUP = 'ssm_settings_group';
206
-
207
- /**
208
- * Initialize
209
- */
210
- public static function init() {
211
- add_action('admin_menu', array(__CLASS__, 'add_admin_menu'));
212
- add_action('admin_init', array(__CLASS__, 'register_settings'));
213
- }
214
-
215
- /**
216
- * Add admin menu
217
- */
218
- public static function add_admin_menu() {
219
- add_options_page(
220
- __('Site Settings Manager', 'site-settings-manager'),
221
- __('Site Settings', 'site-settings-manager'),
222
- 'manage_options',
223
- self::PAGE_SLUG,
224
- array(__CLASS__, 'render_settings_page')
225
- );
226
- }
227
-
228
- /**
229
- * Register settings
230
- */
231
- public static function register_settings() {
232
- // Register settings
233
- register_setting(
234
- self::OPTION_GROUP,
235
- 'ssm_site_title',
236
- array(
237
- 'type' => 'string',
238
- 'sanitize_callback' => 'sanitize_text_field',
239
- 'default' => '',
240
- )
241
- );
242
-
243
- register_setting(
244
- self::OPTION_GROUP,
245
- 'ssm_site_description',
246
- array(
247
- 'type' => 'string',
248
- 'sanitize_callback' => 'sanitize_textarea_field',
249
- 'default' => '',
250
- )
251
- );
252
-
253
- register_setting(
254
- self::OPTION_GROUP,
255
- 'ssm_enable_feature',
256
- array(
257
- 'type' => 'boolean',
258
- 'sanitize_callback' => array(__CLASS__, 'sanitize_checkbox'),
259
- 'default' => false,
260
- )
261
- );
262
-
263
- register_setting(
264
- self::OPTION_GROUP,
265
- 'ssm_api_key',
266
- array(
267
- 'type' => 'string',
268
- 'sanitize_callback' => array(__CLASS__, 'sanitize_api_key'),
269
- 'default' => '',
270
- )
271
- );
272
-
273
- register_setting(
274
- self::OPTION_GROUP,
275
- 'ssm_items_per_page',
276
- array(
277
- 'type' => 'integer',
278
- 'sanitize_callback' => array(__CLASS__, 'sanitize_items_per_page'),
279
- 'default' => 10,
280
- )
281
- );
282
-
283
- register_setting(
284
- self::OPTION_GROUP,
285
- 'ssm_theme_color',
286
- array(
287
- 'type' => 'string',
288
- 'sanitize_callback' => 'sanitize_hex_color',
289
- 'default' => '#0073aa',
290
- )
291
- );
292
-
293
- register_setting(
294
- self::OPTION_GROUP,
295
- 'ssm_email_notifications',
296
- array(
297
- 'type' => 'string',
298
- 'sanitize_callback' => array(__CLASS__, 'sanitize_email_list'),
299
- 'default' => '',
300
- )
301
- );
302
-
303
- // Add settings sections
304
- add_settings_section(
305
- 'ssm_general_section',
306
- __('General Settings', 'site-settings-manager'),
307
- array(__CLASS__, 'render_general_section'),
308
- self::PAGE_SLUG
309
- );
310
-
311
- add_settings_section(
312
- 'ssm_api_section',
313
- __('API Settings', 'site-settings-manager'),
314
- array(__CLASS__, 'render_api_section'),
315
- self::PAGE_SLUG
316
- );
317
-
318
- add_settings_section(
319
- 'ssm_display_section',
320
- __('Display Settings', 'site-settings-manager'),
321
- array(__CLASS__, 'render_display_section'),
322
- self::PAGE_SLUG
323
- );
324
-
325
- // Add settings fields - General Section
326
- add_settings_field(
327
- 'ssm_site_title',
328
- __('Site Title', 'site-settings-manager'),
329
- array('SSM_Settings_Fields', 'render_text_field'),
330
- self::PAGE_SLUG,
331
- 'ssm_general_section',
332
- array(
333
- 'label_for' => 'ssm_site_title',
334
- 'option_name' => 'ssm_site_title',
335
- 'description' => __('Enter your site title', 'site-settings-manager'),
336
- )
337
- );
338
-
339
- add_settings_field(
340
- 'ssm_site_description',
341
- __('Site Description', 'site-settings-manager'),
342
- array('SSM_Settings_Fields', 'render_textarea_field'),
343
- self::PAGE_SLUG,
344
- 'ssm_general_section',
345
- array(
346
- 'label_for' => 'ssm_site_description',
347
- 'option_name' => 'ssm_site_description',
348
- 'description' => __('Enter your site description', 'site-settings-manager'),
349
- 'rows' => 4,
350
- )
351
- );
352
-
353
- add_settings_field(
354
- 'ssm_enable_feature',
355
- __('Enable Feature', 'site-settings-manager'),
356
- array('SSM_Settings_Fields', 'render_checkbox_field'),
357
- self::PAGE_SLUG,
358
- 'ssm_general_section',
359
- array(
360
- 'label_for' => 'ssm_enable_feature',
361
- 'option_name' => 'ssm_enable_feature',
362
- 'description' => __('Enable this feature', 'site-settings-manager'),
363
- )
364
- );
365
-
366
- // Add settings fields - API Section
367
- add_settings_field(
368
- 'ssm_api_key',
369
- __('API Key', 'site-settings-manager'),
370
- array('SSM_Settings_Fields', 'render_password_field'),
371
- self::PAGE_SLUG,
372
- 'ssm_api_section',
373
- array(
374
- 'label_for' => 'ssm_api_key',
375
- 'option_name' => 'ssm_api_key',
376
- 'description' => __('Enter your API key', 'site-settings-manager'),
377
- )
378
- );
379
-
380
- add_settings_field(
381
- 'ssm_email_notifications',
382
- __('Email Notifications', 'site-settings-manager'),
383
- array('SSM_Settings_Fields', 'render_text_field'),
384
- self::PAGE_SLUG,
385
- 'ssm_api_section',
386
- array(
387
- 'label_for' => 'ssm_email_notifications',
388
- 'option_name' => 'ssm_email_notifications',
389
- 'description' => __('Comma-separated email addresses', 'site-settings-manager'),
390
- )
391
- );
392
-
393
- // Add settings fields - Display Section
394
- add_settings_field(
395
- 'ssm_items_per_page',
396
- __('Items Per Page', 'site-settings-manager'),
397
- array('SSM_Settings_Fields', 'render_number_field'),
398
- self::PAGE_SLUG,
399
- 'ssm_display_section',
400
- array(
401
- 'label_for' => 'ssm_items_per_page',
402
- 'option_name' => 'ssm_items_per_page',
403
- 'description' => __('Number of items to display per page', 'site-settings-manager'),
404
- 'min' => 1,
405
- 'max' => 100,
406
- )
407
- );
408
-
409
- add_settings_field(
410
- 'ssm_theme_color',
411
- __('Theme Color', 'site-settings-manager'),
412
- array('SSM_Settings_Fields', 'render_color_field'),
413
- self::PAGE_SLUG,
414
- 'ssm_display_section',
415
- array(
416
- 'label_for' => 'ssm_theme_color',
417
- 'option_name' => 'ssm_theme_color',
418
- 'description' => __('Choose your theme color', 'site-settings-manager'),
419
- )
420
- );
421
- }
422
-
423
- /**
424
- * Render general section
425
- */
426
- public static function render_general_section() {
427
- echo '<p>' . esc_html__('Configure general site settings.', 'site-settings-manager') . '</p>';
428
- }
429
-
430
- /**
431
- * Render API section
432
- */
433
- public static function render_api_section() {
434
- echo '<p>' . esc_html__('Configure API and integration settings.', 'site-settings-manager') . '</p>';
435
- }
436
-
437
- /**
438
- * Render display section
439
- */
440
- public static function render_display_section() {
441
- echo '<p>' . esc_html__('Configure display and appearance settings.', 'site-settings-manager') . '</p>';
442
- }
443
-
444
- /**
445
- * Sanitize checkbox
446
- */
447
- public static function sanitize_checkbox($value) {
448
- return $value ? true : false;
449
- }
450
-
451
- /**
452
- * Sanitize API key
453
- */
454
- public static function sanitize_api_key($value) {
455
- $value = sanitize_text_field($value);
456
-
457
- // Validate API key format (example: alphanumeric, 32 characters)
458
- if (!empty($value) && !preg_match('/^[a-zA-Z0-9]{32}$/', $value)) {
459
- add_settings_error(
460
- 'ssm_api_key',
461
- 'invalid_api_key',
462
- __('API key must be 32 alphanumeric characters.', 'site-settings-manager'),
463
- 'error'
464
- );
465
- return get_option('ssm_api_key'); // Return old value
466
- }
467
-
468
- return $value;
469
- }
470
-
471
- /**
472
- * Sanitize items per page
473
- */
474
- public static function sanitize_items_per_page($value) {
475
- $value = intval($value);
476
-
477
- if ($value < 1 || $value > 100) {
478
- add_settings_error(
479
- 'ssm_items_per_page',
480
- 'invalid_items_per_page',
481
- __('Items per page must be between 1 and 100.', 'site-settings-manager'),
482
- 'error'
483
- );
484
- return get_option('ssm_items_per_page'); // Return old value
485
- }
486
-
487
- return $value;
488
- }
489
-
490
- /**
491
- * Sanitize email list
492
- */
493
- public static function sanitize_email_list($value) {
494
- $emails = array_map('trim', explode(',', $value));
495
- $valid_emails = array();
496
-
497
- foreach ($emails as $email) {
498
- if (is_email($email)) {
499
- $valid_emails[] = $email;
500
- }
501
- }
502
-
503
- if (count($emails) !== count($valid_emails)) {
504
- add_settings_error(
505
- 'ssm_email_notifications',
506
- 'invalid_emails',
507
- __('Some email addresses are invalid and were removed.', 'site-settings-manager'),
508
- 'warning'
509
- );
510
- }
511
-
512
- return implode(', ', $valid_emails);
513
- }
514
-
515
- /**
516
- * Render settings page
517
- */
518
- public static function render_settings_page() {
519
- // Check user capabilities
520
- if (!current_user_can('manage_options')) {
521
- wp_die(__('You do not have sufficient permissions to access this page.', 'site-settings-manager'));
522
- }
523
-
524
- // Include the view
525
- include SSM_PLUGIN_DIR . 'admin/views/settings-page.php';
526
- }
527
- }
528
- ```
529
-
530
- ---
531
-
532
- ## Settings Fields Class
533
-
534
- ### File: `includes/class-settings-fields.php`
535
-
536
- ```php
537
- <?php
538
- /**
539
- * Settings fields rendering
540
- *
541
- * @package Site_Settings_Manager
542
- */
543
-
544
- class SSM_Settings_Fields {
545
- /**
546
- * Render text field
547
- */
548
- public static function render_text_field($args) {
549
- $option_name = $args['option_name'];
550
- $value = get_option($option_name, '');
551
- $description = isset($args['description']) ? $args['description'] : '';
552
-
553
- printf(
554
- '<input type="text" id="%s" name="%s" value="%s" class="regular-text">',
555
- esc_attr($args['label_for']),
556
- esc_attr($option_name),
557
- esc_attr($value)
558
- );
559
-
560
- if ($description) {
561
- printf('<p class="description">%s</p>', esc_html($description));
562
- }
563
- }
564
-
565
- /**
566
- * Render textarea field
567
- */
568
- public static function render_textarea_field($args) {
569
- $option_name = $args['option_name'];
570
- $value = get_option($option_name, '');
571
- $description = isset($args['description']) ? $args['description'] : '';
572
- $rows = isset($args['rows']) ? intval($args['rows']) : 5;
573
-
574
- printf(
575
- '<textarea id="%s" name="%s" rows="%d" class="large-text">%s</textarea>',
576
- esc_attr($args['label_for']),
577
- esc_attr($option_name),
578
- $rows,
579
- esc_textarea($value)
580
- );
581
-
582
- if ($description) {
583
- printf('<p class="description">%s</p>', esc_html($description));
584
- }
585
- }
586
-
587
- /**
588
- * Render checkbox field
589
- */
590
- public static function render_checkbox_field($args) {
591
- $option_name = $args['option_name'];
592
- $value = get_option($option_name, false);
593
- $description = isset($args['description']) ? $args['description'] : '';
594
-
595
- printf(
596
- '<label><input type="checkbox" id="%s" name="%s" value="1" %s> %s</label>',
597
- esc_attr($args['label_for']),
598
- esc_attr($option_name),
599
- checked($value, true, false),
600
- esc_html($description)
601
- );
602
- }
603
-
604
- /**
605
- * Render password field
606
- */
607
- public static function render_password_field($args) {
608
- $option_name = $args['option_name'];
609
- $value = get_option($option_name, '');
610
- $description = isset($args['description']) ? $args['description'] : '';
611
-
612
- printf(
613
- '<input type="password" id="%s" name="%s" value="%s" class="regular-text">',
614
- esc_attr($args['label_for']),
615
- esc_attr($option_name),
616
- esc_attr($value)
617
- );
618
-
619
- if ($description) {
620
- printf('<p class="description">%s</p>', esc_html($description));
621
- }
622
- }
623
-
624
- /**
625
- * Render number field
626
- */
627
- public static function render_number_field($args) {
628
- $option_name = $args['option_name'];
629
- $value = get_option($option_name, '');
630
- $description = isset($args['description']) ? $args['description'] : '';
631
- $min = isset($args['min']) ? intval($args['min']) : '';
632
- $max = isset($args['max']) ? intval($args['max']) : '';
633
-
634
- printf(
635
- '<input type="number" id="%s" name="%s" value="%s" min="%s" max="%s" class="small-text">',
636
- esc_attr($args['label_for']),
637
- esc_attr($option_name),
638
- esc_attr($value),
639
- esc_attr($min),
640
- esc_attr($max)
641
- );
642
-
643
- if ($description) {
644
- printf('<p class="description">%s</p>', esc_html($description));
645
- }
646
- }
647
-
648
- /**
649
- * Render color field
650
- */
651
- public static function render_color_field($args) {
652
- $option_name = $args['option_name'];
653
- $value = get_option($option_name, '#0073aa');
654
- $description = isset($args['description']) ? $args['description'] : '';
655
-
656
- printf(
657
- '<input type="text" id="%s" name="%s" value="%s" class="ssm-color-picker">',
658
- esc_attr($args['label_for']),
659
- esc_attr($option_name),
660
- esc_attr($value)
661
- );
662
-
663
- if ($description) {
664
- printf('<p class="description">%s</p>', esc_html($description));
665
- }
666
- }
667
-
668
- /**
669
- * Render select field
670
- */
671
- public static function render_select_field($args) {
672
- $option_name = $args['option_name'];
673
- $value = get_option($option_name, '');
674
- $description = isset($args['description']) ? $args['description'] : '';
675
- $options = isset($args['options']) ? $args['options'] : array();
676
-
677
- printf('<select id="%s" name="%s">', esc_attr($args['label_for']), esc_attr($option_name));
678
-
679
- foreach ($options as $option_value => $option_label) {
680
- printf(
681
- '<option value="%s" %s>%s</option>',
682
- esc_attr($option_value),
683
- selected($value, $option_value, false),
684
- esc_html($option_label)
685
- );
686
- }
687
-
688
- echo '</select>';
689
-
690
- if ($description) {
691
- printf('<p class="description">%s</p>', esc_html($description));
692
- }
693
- }
694
-
695
- /**
696
- * Render radio field
697
- */
698
- public static function render_radio_field($args) {
699
- $option_name = $args['option_name'];
700
- $value = get_option($option_name, '');
701
- $description = isset($args['description']) ? $args['description'] : '';
702
- $options = isset($args['options']) ? $args['options'] : array();
703
-
704
- foreach ($options as $option_value => $option_label) {
705
- printf(
706
- '<label><input type="radio" name="%s" value="%s" %s> %s</label><br>',
707
- esc_attr($option_name),
708
- esc_attr($option_value),
709
- checked($value, $option_value, false),
710
- esc_html($option_label)
711
- );
712
- }
713
-
714
- if ($description) {
715
- printf('<p class="description">%s</p>', esc_html($description));
716
- }
717
- }
718
- }
719
- ```
720
-
721
- ---
722
-
723
- ## View Files
724
-
725
- ### File: `admin/views/settings-page.php`
726
-
727
- ```php
728
- <?php
729
- /**
730
- * Settings page view
731
- *
732
- * @package Site_Settings_Manager
733
- */
734
-
735
- // Exit if accessed directly
736
- if (!defined('ABSPATH')) {
737
- exit;
738
- }
739
- ?>
740
-
741
- <div class="wrap ssm-settings-wrap">
742
- <h1><?php echo esc_html(get_admin_page_title()); ?></h1>
743
-
744
- <?php settings_errors(); ?>
745
-
746
- <div class="ssm-settings-container">
747
- <div class="ssm-settings-main">
748
- <form method="post" action="options.php">
749
- <?php
750
- settings_fields(SSM_Settings_Page::OPTION_GROUP);
751
- do_settings_sections(SSM_Settings_Page::PAGE_SLUG);
752
- submit_button(__('Save Settings', 'site-settings-manager'));
753
- ?>
754
- </form>
755
- </div>
756
-
757
- <div class="ssm-settings-sidebar">
758
- <?php include SSM_PLUGIN_DIR . 'admin/views/settings-sidebar.php'; ?>
759
- </div>
760
- </div>
761
- </div>
762
- ```
763
-
764
- ### File: `admin/views/settings-sidebar.php`
765
-
766
- ```php
767
- <?php
768
- /**
769
- * Settings sidebar view
770
- *
771
- * @package Site_Settings_Manager
772
- */
773
-
774
- // Exit if accessed directly
775
- if (!defined('ABSPATH')) {
776
- exit;
777
- }
778
- ?>
779
-
780
- <div class="ssm-sidebar-box">
781
- <h3><?php _e('About This Plugin', 'site-settings-manager'); ?></h3>
782
- <p><?php _e('Site Settings Manager provides a comprehensive settings interface for your WordPress site.', 'site-settings-manager'); ?></p>
783
- </div>
784
-
785
- <div class="ssm-sidebar-box">
786
- <h3><?php _e('Documentation', 'site-settings-manager'); ?></h3>
787
- <ul>
788
- <li><a href="#" target="_blank"><?php _e('Getting Started', 'site-settings-manager'); ?></a></li>
789
- <li><a href="#" target="_blank"><?php _e('API Documentation', 'site-settings-manager'); ?></a></li>
790
- <li><a href="#" target="_blank"><?php _e('Support Forum', 'site-settings-manager'); ?></a></li>
791
- </ul>
792
- </div>
793
-
794
- <div class="ssm-sidebar-box">
795
- <h3><?php _e('System Info', 'site-settings-manager'); ?></h3>
796
- <table class="ssm-info-table">
797
- <tr>
798
- <td><?php _e('Plugin Version:', 'site-settings-manager'); ?></td>
799
- <td><?php echo esc_html(SSM_VERSION); ?></td>
800
- </tr>
801
- <tr>
802
- <td><?php _e('WordPress Version:', 'site-settings-manager'); ?></td>
803
- <td><?php echo esc_html(get_bloginfo('version')); ?></td>
804
- </tr>
805
- <tr>
806
- <td><?php _e('PHP Version:', 'site-settings-manager'); ?></td>
807
- <td><?php echo esc_html(PHP_VERSION); ?></td>
808
- </tr>
809
- </table>
810
- </div>
811
-
812
- <div class="ssm-sidebar-box ssm-support-box">
813
- <h3><?php _e('Need Help?', 'site-settings-manager'); ?></h3>
814
- <p><?php _e('If you need assistance, please visit our support forum.', 'site-settings-manager'); ?></p>
815
- <a href="#" class="button button-primary" target="_blank">
816
- <?php _e('Get Support', 'site-settings-manager'); ?>
817
- </a>
818
- </div>
819
- ```
820
-
821
- ---
822
-
823
- ## Assets
824
-
825
- ### File: `admin/css/admin.css`
826
-
827
- ```css
828
- /* Settings Page Layout */
829
- .ssm-settings-wrap {
830
- margin: 20px 20px 0 0;
831
- }
832
-
833
- .ssm-settings-container {
834
- display: flex;
835
- gap: 30px;
836
- margin-top: 20px;
837
- }
838
-
839
- .ssm-settings-main {
840
- flex: 1;
841
- background: #fff;
842
- padding: 20px;
843
- border: 1px solid #ccd0d4;
844
- box-shadow: 0 1px 1px rgba(0, 0, 0, 0.04);
845
- }
846
-
847
- .ssm-settings-sidebar {
848
- width: 300px;
849
- flex-shrink: 0;
850
- }
851
-
852
- @media (max-width: 1024px) {
853
- .ssm-settings-container {
854
- flex-direction: column;
855
- }
856
-
857
- .ssm-settings-sidebar {
858
- width: 100%;
859
- }
860
- }
861
-
862
- /* Settings Sections */
863
- .ssm-settings-main h2 {
864
- margin-top: 0;
865
- padding-bottom: 10px;
866
- border-bottom: 1px solid #e0e0e0;
867
- }
868
-
869
- .ssm-settings-main .form-table {
870
- margin-top: 20px;
871
- }
872
-
873
- .ssm-settings-main .form-table th {
874
- padding: 15px 10px 15px 0;
875
- width: 200px;
876
- }
877
-
878
- .ssm-settings-main .form-table td {
879
- padding: 15px 10px;
880
- }
881
-
882
- /* Sidebar Boxes */
883
- .ssm-sidebar-box {
884
- background: #fff;
885
- padding: 20px;
886
- margin-bottom: 20px;
887
- border: 1px solid #ccd0d4;
888
- box-shadow: 0 1px 1px rgba(0, 0, 0, 0.04);
889
- }
890
-
891
- .ssm-sidebar-box h3 {
892
- margin-top: 0;
893
- margin-bottom: 15px;
894
- font-size: 14px;
895
- font-weight: 600;
896
- }
897
-
898
- .ssm-sidebar-box p {
899
- margin: 0 0 15px;
900
- font-size: 13px;
901
- line-height: 1.6;
902
- }
903
-
904
- .ssm-sidebar-box ul {
905
- margin: 0;
906
- padding: 0;
907
- list-style: none;
908
- }
909
-
910
- .ssm-sidebar-box ul li {
911
- margin-bottom: 8px;
912
- }
913
-
914
- .ssm-sidebar-box ul li a {
915
- text-decoration: none;
916
- font-size: 13px;
917
- }
918
-
919
- .ssm-sidebar-box ul li a:hover {
920
- text-decoration: underline;
921
- }
922
-
923
- /* Info Table */
924
- .ssm-info-table {
925
- width: 100%;
926
- font-size: 13px;
927
- }
928
-
929
- .ssm-info-table tr {
930
- border-bottom: 1px solid #f0f0f0;
931
- }
932
-
933
- .ssm-info-table tr:last-child {
934
- border-bottom: none;
935
- }
936
-
937
- .ssm-info-table td {
938
- padding: 8px 0;
939
- }
940
-
941
- .ssm-info-table td:first-child {
942
- font-weight: 600;
943
- width: 50%;
944
- }
945
-
946
- /* Support Box */
947
- .ssm-support-box {
948
- background: #f7f7f7;
949
- border-left: 4px solid #0073aa;
950
- }
951
-
952
- .ssm-support-box .button {
953
- width: 100%;
954
- text-align: center;
955
- margin-top: 10px;
956
- }
957
-
958
- /* Color Picker */
959
- .ssm-color-picker {
960
- max-width: 100px;
961
- }
962
-
963
- /* Success/Error Messages */
964
- .ssm-settings-wrap .notice {
965
- margin: 20px 0;
966
- }
967
- ```
968
-
969
- ### File: `admin/js/admin.js`
970
-
971
- ```javascript
972
- (function($) {
973
- 'use strict';
974
-
975
- $(document).ready(function() {
976
- // Initialize color picker
977
- if (typeof $.fn.wpColorPicker !== 'undefined') {
978
- $('.ssm-color-picker').wpColorPicker();
979
- }
980
-
981
- // Form validation
982
- $('form').on('submit', function(e) {
983
- var isValid = true;
984
-
985
- // Validate API key if present
986
- var apiKey = $('#ssm_api_key').val();
987
- if (apiKey && !/^[a-zA-Z0-9]{32}$/.test(apiKey)) {
988
- alert('API key must be 32 alphanumeric characters.');
989
- isValid = false;
990
- }
991
-
992
- // Validate items per page
993
- var itemsPerPage = parseInt($('#ssm_items_per_page').val());
994
- if (itemsPerPage < 1 || itemsPerPage > 100) {
995
- alert('Items per page must be between 1 and 100.');
996
- isValid = false;
997
- }
998
-
999
- if (!isValid) {
1000
- e.preventDefault();
1001
- }
1002
- });
1003
-
1004
- // Show/hide conditional fields
1005
- $('#ssm_enable_feature').on('change', function() {
1006
- if ($(this).is(':checked')) {
1007
- $('.conditional-field').slideDown();
1008
- } else {
1009
- $('.conditional-field').slideUp();
1010
- }
1011
- }).trigger('change');
1012
- });
1013
-
1014
- })(jQuery);
1015
- ```
1016
-
1017
- ---
1018
-
1019
- ## Uninstall
1020
-
1021
- ### File: `uninstall.php`
1022
-
1023
- ```php
1024
- <?php
1025
- /**
1026
- * Uninstall script
1027
- *
1028
- * @package Site_Settings_Manager
1029
- */
1030
-
1031
- // Exit if accessed directly or not uninstalling
1032
- if (!defined('WP_UNINSTALL_PLUGIN')) {
1033
- exit;
1034
- }
1035
-
1036
- // Delete all plugin options
1037
- $options = array(
1038
- 'ssm_site_title',
1039
- 'ssm_site_description',
1040
- 'ssm_enable_feature',
1041
- 'ssm_api_key',
1042
- 'ssm_items_per_page',
1043
- 'ssm_theme_color',
1044
- 'ssm_email_notifications',
1045
- );
1046
-
1047
- foreach ($options as $option) {
1048
- delete_option($option);
1049
- }
1050
-
1051
- // Clear any cached data
1052
- wp_cache_flush();
1053
- ```
1054
-
1055
- ---
1056
-
1057
- ## Usage Examples
1058
-
1059
- ### Accessing Settings in Your Code
1060
-
1061
- ```php
1062
- <?php
1063
- // Get individual settings
1064
- $site_title = get_option('ssm_site_title', '');
1065
- $enable_feature = get_option('ssm_enable_feature', false);
1066
- $items_per_page = get_option('ssm_items_per_page', 10);
1067
- $theme_color = get_option('ssm_theme_color', '#0073aa');
1068
-
1069
- // Use settings
1070
- if ($enable_feature) {
1071
- // Feature is enabled
1072
- echo '<h1>' . esc_html($site_title) . '</h1>';
1073
- }
1074
-
1075
- // Use in queries
1076
- $args = array(
1077
- 'posts_per_page' => $items_per_page,
1078
- );
1079
- $query = new WP_Query($args);
1080
- ?>
1081
- ```
1082
-
1083
- ### Programmatically Update Settings
1084
-
1085
- ```php
1086
- <?php
1087
- // Update settings
1088
- update_option('ssm_site_title', 'New Site Title');
1089
- update_option('ssm_enable_feature', true);
1090
- update_option('ssm_items_per_page', 20);
1091
-
1092
- // Get and modify
1093
- $emails = get_option('ssm_email_notifications', '');
1094
- $email_array = array_map('trim', explode(',', $emails));
1095
- $email_array[] = 'new@example.com';
1096
- update_option('ssm_email_notifications', implode(', ', $email_array));
1097
- ?>
1098
- ```
1099
-
1100
- ### Add Custom Validation
1101
-
1102
- ```php
1103
- <?php
1104
- // Add to class-settings-page.php
1105
- public static function sanitize_custom_field($value) {
1106
- $value = sanitize_text_field($value);
1107
-
1108
- // Custom validation logic
1109
- if (strlen($value) < 5) {
1110
- add_settings_error(
1111
- 'ssm_custom_field',
1112
- 'too_short',
1113
- __('Value must be at least 5 characters.', 'site-settings-manager'),
1114
- 'error'
1115
- );
1116
- return get_option('ssm_custom_field');
1117
- }
1118
-
1119
- return $value;
1120
- }
1121
- ?>
1122
- ```
1123
-
1124
- ### Add New Settings Section
1125
-
1126
- ```php
1127
- <?php
1128
- // In register_settings() method
1129
- add_settings_section(
1130
- 'ssm_custom_section',
1131
- __('Custom Settings', 'site-settings-manager'),
1132
- array(__CLASS__, 'render_custom_section'),
1133
- self::PAGE_SLUG
1134
- );
1135
-
1136
- add_settings_field(
1137
- 'ssm_custom_field',
1138
- __('Custom Field', 'site-settings-manager'),
1139
- array('SSM_Settings_Fields', 'render_text_field'),
1140
- self::PAGE_SLUG,
1141
- 'ssm_custom_section',
1142
- array(
1143
- 'label_for' => 'ssm_custom_field',
1144
- 'option_name' => 'ssm_custom_field',
1145
- 'description' => __('Enter custom value', 'site-settings-manager'),
1146
- )
1147
- );
1148
- ?>
1149
- ```
1150
-
1151
- ---
1152
-
1153
- ## Key Features
1154
-
1155
- ### 1. Settings API Integration
1156
- - **Proper registration** with `register_setting()`
1157
- - **Sections and fields** with `add_settings_section()` and `add_settings_field()`
1158
- - **Automatic form handling** with `settings_fields()` and `do_settings_sections()`
1159
- - **Built-in validation** and error handling
1160
-
1161
- ### 2. Field Types
1162
- - **Text field**: Single-line text input
1163
- - **Textarea field**: Multi-line text input
1164
- - **Checkbox field**: Boolean toggle
1165
- - **Password field**: Masked input
1166
- - **Number field**: Numeric input with min/max
1167
- - **Color field**: Color picker integration
1168
- - **Select field**: Dropdown selection
1169
- - **Radio field**: Radio button group
1170
-
1171
- ### 3. Validation & Sanitization
1172
- - **Built-in sanitization**: `sanitize_text_field()`, `sanitize_textarea_field()`, `sanitize_hex_color()`
1173
- - **Custom validation**: API key format, email list, numeric ranges
1174
- - **Error messages**: `add_settings_error()` for user feedback
1175
- - **Fallback values**: Return old value on validation failure
1176
-
1177
- ### 4. Security
1178
- - **Capability checks**: `current_user_can('manage_options')`
1179
- - **Nonce verification**: Automatic with Settings API
1180
- - **Input sanitization**: All inputs sanitized
1181
- - **Output escaping**: All outputs escaped
1182
-
1183
- ### 5. User Experience
1184
- - **Clean layout**: Two-column design with sidebar
1185
- - **Helpful descriptions**: Field-level help text
1186
- - **System information**: Plugin and environment details
1187
- - **Color picker**: WordPress color picker integration
1188
- - **Responsive design**: Mobile-friendly layout
1189
-
1190
- ---
1191
-
1192
- ## Best Practices Demonstrated
1193
-
1194
- ### Security
1195
- ✅ Capability checks (`current_user_can('manage_options')`)
1196
- ✅ Automatic nonce verification (Settings API)
1197
- ✅ Input sanitization (all fields)
1198
- ✅ Output escaping (`esc_html`, `esc_attr`, `esc_url`)
1199
- ✅ Validation with error messages
1200
-
1201
- ### WordPress Standards
1202
- ✅ Settings API usage
1203
- ✅ Internationalization (`__()`, `_e()`)
1204
- ✅ Proper hook usage (`admin_menu`, `admin_init`)
1205
- ✅ Autoloader for class files
1206
- ✅ Proper file organization
1207
- ✅ WordPress coding standards
1208
-
1209
- ### User Experience
1210
- ✅ Clear section organization
1211
- ✅ Helpful field descriptions
1212
- ✅ Validation feedback
1213
- ✅ Sidebar with documentation
1214
- ✅ Responsive layout
1215
- ✅ Color picker integration
1216
-
1217
- ### Code Quality
1218
- ✅ Separation of concerns (page, fields, validation)
1219
- ✅ Reusable field rendering methods
1220
- ✅ Consistent naming conventions
1221
- ✅ Proper documentation
1222
- ✅ Clean uninstall process
1223
-
1224
- ---
1225
-
1226
- ## Customization
1227
-
1228
- ### Add New Field Type
1229
-
1230
- ```php
1231
- <?php
1232
- // In class-settings-fields.php
1233
- public static function render_custom_field($args) {
1234
- $option_name = $args['option_name'];
1235
- $value = get_option($option_name, '');
1236
- $description = isset($args['description']) ? $args['description'] : '';
1237
-
1238
- // Custom field HTML
1239
- printf(
1240
- '<input type="text" id="%s" name="%s" value="%s" class="custom-field">',
1241
- esc_attr($args['label_for']),
1242
- esc_attr($option_name),
1243
- esc_attr($value)
1244
- );
1245
-
1246
- if ($description) {
1247
- printf('<p class="description">%s</p>', esc_html($description));
1248
- }
1249
- }
1250
- ?>
1251
- ```
1252
-
1253
- ### Add Tabs to Settings Page
1254
-
1255
- ```php
1256
- <?php
1257
- // Add to settings-page.php view
1258
- <h2 class="nav-tab-wrapper">
1259
- <a href="?page=site-settings-manager&tab=general" class="nav-tab <?php echo $active_tab == 'general' ? 'nav-tab-active' : ''; ?>">
1260
- <?php _e('General', 'site-settings-manager'); ?>
1261
- </a>
1262
- <a href="?page=site-settings-manager&tab=advanced" class="nav-tab <?php echo $active_tab == 'advanced' ? 'nav-tab-active' : ''; ?>">
1263
- <?php _e('Advanced', 'site-settings-manager'); ?>
1264
- </a>
1265
- </h2>
1266
- ?>
1267
- ```
1268
-
1269
- ### Export/Import Settings
1270
-
1271
- ```php
1272
- <?php
1273
- // Export settings
1274
- function ssm_export_settings() {
1275
- $settings = array(
1276
- 'ssm_site_title' => get_option('ssm_site_title'),
1277
- 'ssm_site_description' => get_option('ssm_site_description'),
1278
- // ... other settings
1279
- );
1280
-
1281
- return json_encode($settings);
1282
- }
1283
-
1284
- // Import settings
1285
- function ssm_import_settings($json) {
1286
- $settings = json_decode($json, true);
1287
-
1288
- if ($settings) {
1289
- foreach ($settings as $key => $value) {
1290
- update_option($key, $value);
1291
- }
1292
- }
1293
- }
1294
- ?>
1295
- ```
1296
-
1297
- ---
1298
-
1299
- ## Testing Checklist
1300
-
1301
- - [ ] Access settings page (Settings > Site Settings)
1302
- - [ ] Save settings with valid values
1303
- - [ ] Test validation errors (invalid API key, out-of-range numbers)
1304
- - [ ] Test email list validation
1305
- - [ ] Test color picker functionality
1306
- - [ ] Test checkbox toggle
1307
- - [ ] Verify settings persist after save
1308
- - [ ] Test responsive layout on mobile
1309
- - [ ] Verify capability checks (non-admin users)
1310
- - [ ] Test uninstall cleanup
1311
- - [ ] Check for PHP/JavaScript errors
1312
- - [ ] Verify internationalization strings
1313
-
1314
- ---
1315
-
1316
- ## Comparison with Other Patterns
1317
-
1318
- | Feature | This Plugin | Simple Settings | Advanced Settings | Framework-Based |
1319
- |---------|-------------|-----------------|-------------------|-----------------|
1320
- | **Complexity** | Medium | Low | High | Very High |
1321
- | **File Count** | 5-10 | 1-2 | 10-20 | 20+ |
1322
- | **Settings API** | ✅ Full | ✅ Basic | ✅ Full | ✅ Custom |
1323
- | **Validation** | ✅ Advanced | ❌ | ✅ Advanced | ✅ Advanced |
1324
- | **Field Types** | ✅ 7 types | ✅ 2-3 types | ✅ 10+ types | ✅ Unlimited |
1325
- | **Layout** | ✅ Custom | ❌ Basic | ✅ Tabbed | ✅ Advanced |
1326
- | **Security** | ✅ Full | ✅ Basic | ✅ Full | ✅ Full |
1327
- | **Best For** | Most plugins | Simple config | Complex plugins | Large systems |
1328
-
1329
- ---
1330
-
1331
- ## Summary
1332
-
1333
- This example demonstrates a **complete settings page plugin** with:
1334
-
1335
- - ✅ WordPress Settings API integration
1336
- - ✅ Multiple field types (text, textarea, checkbox, password, number, color, select, radio)
1337
- - ✅ Advanced validation and sanitization
1338
- - ✅ Custom admin page with sidebar
1339
- - ✅ Proper security (capability checks, sanitization, escaping)
1340
- - ✅ Error handling and user feedback
1341
- - ✅ Responsive design
1342
- - ✅ Color picker integration
1343
- - ✅ Clean uninstall process
1344
- - ✅ Internationalization support
1345
- - ✅ Reusable field rendering methods
1346
-
1347
- **Perfect for**: Plugin configuration, site settings, feature toggles, API integrations, or any plugin requiring user-configurable options.
1348
-
1349
- **Character Count**: ~24,500 characters
1350
-
1
+ # Settings Page Plugin Example
2
+
3
+ ## Overview
4
+
5
+ This example demonstrates a complete **Settings Page Plugin** with admin menu, settings registration, sections, fields, validation, sanitization, and proper security implementation.
6
+
7
+ **Complexity**: Medium
8
+ **File Count**: 5-10 files
9
+ **Team Size**: 1-2 developers
10
+ **Use Case**: Plugin configuration, site settings, feature toggles, API integrations
11
+
12
+ ---
13
+
14
+ ## Complete Plugin: "Site Settings Manager"
15
+
16
+ A comprehensive settings management plugin demonstrating WordPress Settings API, custom admin pages, field types, validation, and security best practices.
17
+
18
+ ---
19
+
20
+ ## Directory Structure
21
+
22
+ ```
23
+ site-settings-manager/
24
+ ├── site-settings-manager.php # Main plugin file
25
+ ├── uninstall.php # Uninstall cleanup
26
+ ├── readme.txt # WordPress.org readme
27
+ ├── includes/
28
+ │ ├── class-settings-page.php # Settings page class
29
+ │ ├── class-settings-fields.php # Field rendering
30
+ │ └── class-settings-validator.php # Validation logic
31
+ ├── admin/
32
+ │ ├── css/
33
+ │ │ └── admin.css # Admin styles
34
+ │ ├── js/
35
+ │ │ └── admin.js # Admin scripts
36
+ │ └── views/
37
+ │ ├── settings-page.php # Main settings view
38
+ │ └── settings-sidebar.php # Sidebar view
39
+ └── assets/
40
+ └── images/
41
+ └── icon.png # Plugin icon
42
+ ```
43
+
44
+ ---
45
+
46
+ ## Main Plugin File
47
+
48
+ ### File: `site-settings-manager.php`
49
+
50
+ ```php
51
+ <?php
52
+ /**
53
+ * Plugin Name: Site Settings Manager
54
+ * Plugin URI: https://example.com/site-settings-manager
55
+ * Description: Complete settings management with validation, sanitization, and security
56
+ * Version: 1.0.0
57
+ * Author: Your Name
58
+ * Author URI: https://example.com
59
+ * License: GPL-2.0+
60
+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
61
+ * Text Domain: site-settings-manager
62
+ * Domain Path: /languages
63
+ *
64
+ * @package Site_Settings_Manager
65
+ */
66
+
67
+ // Exit if accessed directly
68
+ if (!defined('ABSPATH')) {
69
+ exit;
70
+ }
71
+
72
+ // Define plugin constants
73
+ define('SSM_VERSION', '1.0.0');
74
+ define('SSM_PLUGIN_DIR', plugin_dir_path(__FILE__));
75
+ define('SSM_PLUGIN_URL', plugin_dir_url(__FILE__));
76
+ define('SSM_PLUGIN_FILE', __FILE__);
77
+
78
+ /**
79
+ * Autoloader
80
+ */
81
+ spl_autoload_register(function ($class) {
82
+ $prefix = 'SSM_';
83
+
84
+ if (strpos($class, $prefix) !== 0) {
85
+ return;
86
+ }
87
+
88
+ $class_name = str_replace($prefix, '', $class);
89
+ $class_file = 'class-' . str_replace('_', '-', strtolower($class_name)) . '.php';
90
+
91
+ $file = SSM_PLUGIN_DIR . 'includes/' . $class_file;
92
+ if (file_exists($file)) {
93
+ require $file;
94
+ }
95
+ });
96
+
97
+ /**
98
+ * Activation hook
99
+ */
100
+ register_activation_hook(__FILE__, function() {
101
+ // Set default options
102
+ $defaults = array(
103
+ 'ssm_site_title' => get_bloginfo('name'),
104
+ 'ssm_site_description' => get_bloginfo('description'),
105
+ 'ssm_enable_feature' => false,
106
+ 'ssm_api_key' => '',
107
+ 'ssm_items_per_page' => 10,
108
+ 'ssm_theme_color' => '#0073aa',
109
+ );
110
+
111
+ foreach ($defaults as $key => $value) {
112
+ if (get_option($key) === false) {
113
+ add_option($key, $value);
114
+ }
115
+ }
116
+ });
117
+
118
+ /**
119
+ * Deactivation hook
120
+ */
121
+ register_deactivation_hook(__FILE__, function() {
122
+ // Cleanup if needed
123
+ });
124
+
125
+ /**
126
+ * Initialize the plugin
127
+ */
128
+ function run_site_settings_manager() {
129
+ // Initialize settings page
130
+ if (is_admin()) {
131
+ SSM_Settings_Page::init();
132
+ }
133
+
134
+ // Load text domain
135
+ add_action('plugins_loaded', 'ssm_load_textdomain');
136
+
137
+ // Enqueue admin assets
138
+ add_action('admin_enqueue_scripts', 'ssm_enqueue_admin_assets');
139
+ }
140
+ add_action('plugins_loaded', 'run_site_settings_manager');
141
+
142
+ /**
143
+ * Load plugin text domain
144
+ */
145
+ function ssm_load_textdomain() {
146
+ load_plugin_textdomain(
147
+ 'site-settings-manager',
148
+ false,
149
+ dirname(plugin_basename(SSM_PLUGIN_FILE)) . '/languages/'
150
+ );
151
+ }
152
+
153
+ /**
154
+ * Enqueue admin assets
155
+ */
156
+ function ssm_enqueue_admin_assets($hook) {
157
+ // Only load on our settings page
158
+ if ('settings_page_site-settings-manager' !== $hook) {
159
+ return;
160
+ }
161
+
162
+ wp_enqueue_style(
163
+ 'ssm-admin',
164
+ SSM_PLUGIN_URL . 'admin/css/admin.css',
165
+ array(),
166
+ SSM_VERSION
167
+ );
168
+
169
+ wp_enqueue_script(
170
+ 'ssm-admin',
171
+ SSM_PLUGIN_URL . 'admin/js/admin.js',
172
+ array('jquery', 'wp-color-picker'),
173
+ SSM_VERSION,
174
+ true
175
+ );
176
+
177
+ // Enqueue color picker
178
+ wp_enqueue_style('wp-color-picker');
179
+ }
180
+ ```
181
+
182
+ ---
183
+
184
+ ## Settings Page Class
185
+
186
+ ### File: `includes/class-settings-page.php`
187
+
188
+ ```php
189
+ <?php
190
+ /**
191
+ * Settings page class
192
+ *
193
+ * @package Site_Settings_Manager
194
+ */
195
+
196
+ class SSM_Settings_Page {
197
+ /**
198
+ * Settings page slug
199
+ */
200
+ const PAGE_SLUG = 'site-settings-manager';
201
+
202
+ /**
203
+ * Option group
204
+ */
205
+ const OPTION_GROUP = 'ssm_settings_group';
206
+
207
+ /**
208
+ * Initialize
209
+ */
210
+ public static function init() {
211
+ add_action('admin_menu', array(__CLASS__, 'add_admin_menu'));
212
+ add_action('admin_init', array(__CLASS__, 'register_settings'));
213
+ }
214
+
215
+ /**
216
+ * Add admin menu
217
+ */
218
+ public static function add_admin_menu() {
219
+ add_options_page(
220
+ __('Site Settings Manager', 'site-settings-manager'),
221
+ __('Site Settings', 'site-settings-manager'),
222
+ 'manage_options',
223
+ self::PAGE_SLUG,
224
+ array(__CLASS__, 'render_settings_page')
225
+ );
226
+ }
227
+
228
+ /**
229
+ * Register settings
230
+ */
231
+ public static function register_settings() {
232
+ // Register settings
233
+ register_setting(
234
+ self::OPTION_GROUP,
235
+ 'ssm_site_title',
236
+ array(
237
+ 'type' => 'string',
238
+ 'sanitize_callback' => 'sanitize_text_field',
239
+ 'default' => '',
240
+ )
241
+ );
242
+
243
+ register_setting(
244
+ self::OPTION_GROUP,
245
+ 'ssm_site_description',
246
+ array(
247
+ 'type' => 'string',
248
+ 'sanitize_callback' => 'sanitize_textarea_field',
249
+ 'default' => '',
250
+ )
251
+ );
252
+
253
+ register_setting(
254
+ self::OPTION_GROUP,
255
+ 'ssm_enable_feature',
256
+ array(
257
+ 'type' => 'boolean',
258
+ 'sanitize_callback' => array(__CLASS__, 'sanitize_checkbox'),
259
+ 'default' => false,
260
+ )
261
+ );
262
+
263
+ register_setting(
264
+ self::OPTION_GROUP,
265
+ 'ssm_api_key',
266
+ array(
267
+ 'type' => 'string',
268
+ 'sanitize_callback' => array(__CLASS__, 'sanitize_api_key'),
269
+ 'default' => '',
270
+ )
271
+ );
272
+
273
+ register_setting(
274
+ self::OPTION_GROUP,
275
+ 'ssm_items_per_page',
276
+ array(
277
+ 'type' => 'integer',
278
+ 'sanitize_callback' => array(__CLASS__, 'sanitize_items_per_page'),
279
+ 'default' => 10,
280
+ )
281
+ );
282
+
283
+ register_setting(
284
+ self::OPTION_GROUP,
285
+ 'ssm_theme_color',
286
+ array(
287
+ 'type' => 'string',
288
+ 'sanitize_callback' => 'sanitize_hex_color',
289
+ 'default' => '#0073aa',
290
+ )
291
+ );
292
+
293
+ register_setting(
294
+ self::OPTION_GROUP,
295
+ 'ssm_email_notifications',
296
+ array(
297
+ 'type' => 'string',
298
+ 'sanitize_callback' => array(__CLASS__, 'sanitize_email_list'),
299
+ 'default' => '',
300
+ )
301
+ );
302
+
303
+ // Add settings sections
304
+ add_settings_section(
305
+ 'ssm_general_section',
306
+ __('General Settings', 'site-settings-manager'),
307
+ array(__CLASS__, 'render_general_section'),
308
+ self::PAGE_SLUG
309
+ );
310
+
311
+ add_settings_section(
312
+ 'ssm_api_section',
313
+ __('API Settings', 'site-settings-manager'),
314
+ array(__CLASS__, 'render_api_section'),
315
+ self::PAGE_SLUG
316
+ );
317
+
318
+ add_settings_section(
319
+ 'ssm_display_section',
320
+ __('Display Settings', 'site-settings-manager'),
321
+ array(__CLASS__, 'render_display_section'),
322
+ self::PAGE_SLUG
323
+ );
324
+
325
+ // Add settings fields - General Section
326
+ add_settings_field(
327
+ 'ssm_site_title',
328
+ __('Site Title', 'site-settings-manager'),
329
+ array('SSM_Settings_Fields', 'render_text_field'),
330
+ self::PAGE_SLUG,
331
+ 'ssm_general_section',
332
+ array(
333
+ 'label_for' => 'ssm_site_title',
334
+ 'option_name' => 'ssm_site_title',
335
+ 'description' => __('Enter your site title', 'site-settings-manager'),
336
+ )
337
+ );
338
+
339
+ add_settings_field(
340
+ 'ssm_site_description',
341
+ __('Site Description', 'site-settings-manager'),
342
+ array('SSM_Settings_Fields', 'render_textarea_field'),
343
+ self::PAGE_SLUG,
344
+ 'ssm_general_section',
345
+ array(
346
+ 'label_for' => 'ssm_site_description',
347
+ 'option_name' => 'ssm_site_description',
348
+ 'description' => __('Enter your site description', 'site-settings-manager'),
349
+ 'rows' => 4,
350
+ )
351
+ );
352
+
353
+ add_settings_field(
354
+ 'ssm_enable_feature',
355
+ __('Enable Feature', 'site-settings-manager'),
356
+ array('SSM_Settings_Fields', 'render_checkbox_field'),
357
+ self::PAGE_SLUG,
358
+ 'ssm_general_section',
359
+ array(
360
+ 'label_for' => 'ssm_enable_feature',
361
+ 'option_name' => 'ssm_enable_feature',
362
+ 'description' => __('Enable this feature', 'site-settings-manager'),
363
+ )
364
+ );
365
+
366
+ // Add settings fields - API Section
367
+ add_settings_field(
368
+ 'ssm_api_key',
369
+ __('API Key', 'site-settings-manager'),
370
+ array('SSM_Settings_Fields', 'render_password_field'),
371
+ self::PAGE_SLUG,
372
+ 'ssm_api_section',
373
+ array(
374
+ 'label_for' => 'ssm_api_key',
375
+ 'option_name' => 'ssm_api_key',
376
+ 'description' => __('Enter your API key', 'site-settings-manager'),
377
+ )
378
+ );
379
+
380
+ add_settings_field(
381
+ 'ssm_email_notifications',
382
+ __('Email Notifications', 'site-settings-manager'),
383
+ array('SSM_Settings_Fields', 'render_text_field'),
384
+ self::PAGE_SLUG,
385
+ 'ssm_api_section',
386
+ array(
387
+ 'label_for' => 'ssm_email_notifications',
388
+ 'option_name' => 'ssm_email_notifications',
389
+ 'description' => __('Comma-separated email addresses', 'site-settings-manager'),
390
+ )
391
+ );
392
+
393
+ // Add settings fields - Display Section
394
+ add_settings_field(
395
+ 'ssm_items_per_page',
396
+ __('Items Per Page', 'site-settings-manager'),
397
+ array('SSM_Settings_Fields', 'render_number_field'),
398
+ self::PAGE_SLUG,
399
+ 'ssm_display_section',
400
+ array(
401
+ 'label_for' => 'ssm_items_per_page',
402
+ 'option_name' => 'ssm_items_per_page',
403
+ 'description' => __('Number of items to display per page', 'site-settings-manager'),
404
+ 'min' => 1,
405
+ 'max' => 100,
406
+ )
407
+ );
408
+
409
+ add_settings_field(
410
+ 'ssm_theme_color',
411
+ __('Theme Color', 'site-settings-manager'),
412
+ array('SSM_Settings_Fields', 'render_color_field'),
413
+ self::PAGE_SLUG,
414
+ 'ssm_display_section',
415
+ array(
416
+ 'label_for' => 'ssm_theme_color',
417
+ 'option_name' => 'ssm_theme_color',
418
+ 'description' => __('Choose your theme color', 'site-settings-manager'),
419
+ )
420
+ );
421
+ }
422
+
423
+ /**
424
+ * Render general section
425
+ */
426
+ public static function render_general_section() {
427
+ echo '<p>' . esc_html__('Configure general site settings.', 'site-settings-manager') . '</p>';
428
+ }
429
+
430
+ /**
431
+ * Render API section
432
+ */
433
+ public static function render_api_section() {
434
+ echo '<p>' . esc_html__('Configure API and integration settings.', 'site-settings-manager') . '</p>';
435
+ }
436
+
437
+ /**
438
+ * Render display section
439
+ */
440
+ public static function render_display_section() {
441
+ echo '<p>' . esc_html__('Configure display and appearance settings.', 'site-settings-manager') . '</p>';
442
+ }
443
+
444
+ /**
445
+ * Sanitize checkbox
446
+ */
447
+ public static function sanitize_checkbox($value) {
448
+ return $value ? true : false;
449
+ }
450
+
451
+ /**
452
+ * Sanitize API key
453
+ */
454
+ public static function sanitize_api_key($value) {
455
+ $value = sanitize_text_field($value);
456
+
457
+ // Validate API key format (example: alphanumeric, 32 characters)
458
+ if (!empty($value) && !preg_match('/^[a-zA-Z0-9]{32}$/', $value)) {
459
+ add_settings_error(
460
+ 'ssm_api_key',
461
+ 'invalid_api_key',
462
+ __('API key must be 32 alphanumeric characters.', 'site-settings-manager'),
463
+ 'error'
464
+ );
465
+ return get_option('ssm_api_key'); // Return old value
466
+ }
467
+
468
+ return $value;
469
+ }
470
+
471
+ /**
472
+ * Sanitize items per page
473
+ */
474
+ public static function sanitize_items_per_page($value) {
475
+ $value = intval($value);
476
+
477
+ if ($value < 1 || $value > 100) {
478
+ add_settings_error(
479
+ 'ssm_items_per_page',
480
+ 'invalid_items_per_page',
481
+ __('Items per page must be between 1 and 100.', 'site-settings-manager'),
482
+ 'error'
483
+ );
484
+ return get_option('ssm_items_per_page'); // Return old value
485
+ }
486
+
487
+ return $value;
488
+ }
489
+
490
+ /**
491
+ * Sanitize email list
492
+ */
493
+ public static function sanitize_email_list($value) {
494
+ $emails = array_map('trim', explode(',', $value));
495
+ $valid_emails = array();
496
+
497
+ foreach ($emails as $email) {
498
+ if (is_email($email)) {
499
+ $valid_emails[] = $email;
500
+ }
501
+ }
502
+
503
+ if (count($emails) !== count($valid_emails)) {
504
+ add_settings_error(
505
+ 'ssm_email_notifications',
506
+ 'invalid_emails',
507
+ __('Some email addresses are invalid and were removed.', 'site-settings-manager'),
508
+ 'warning'
509
+ );
510
+ }
511
+
512
+ return implode(', ', $valid_emails);
513
+ }
514
+
515
+ /**
516
+ * Render settings page
517
+ */
518
+ public static function render_settings_page() {
519
+ // Check user capabilities
520
+ if (!current_user_can('manage_options')) {
521
+ wp_die(__('You do not have sufficient permissions to access this page.', 'site-settings-manager'));
522
+ }
523
+
524
+ // Include the view
525
+ include SSM_PLUGIN_DIR . 'admin/views/settings-page.php';
526
+ }
527
+ }
528
+ ```
529
+
530
+ ---
531
+
532
+ ## Settings Fields Class
533
+
534
+ ### File: `includes/class-settings-fields.php`
535
+
536
+ ```php
537
+ <?php
538
+ /**
539
+ * Settings fields rendering
540
+ *
541
+ * @package Site_Settings_Manager
542
+ */
543
+
544
+ class SSM_Settings_Fields {
545
+ /**
546
+ * Render text field
547
+ */
548
+ public static function render_text_field($args) {
549
+ $option_name = $args['option_name'];
550
+ $value = get_option($option_name, '');
551
+ $description = isset($args['description']) ? $args['description'] : '';
552
+
553
+ printf(
554
+ '<input type="text" id="%s" name="%s" value="%s" class="regular-text">',
555
+ esc_attr($args['label_for']),
556
+ esc_attr($option_name),
557
+ esc_attr($value)
558
+ );
559
+
560
+ if ($description) {
561
+ printf('<p class="description">%s</p>', esc_html($description));
562
+ }
563
+ }
564
+
565
+ /**
566
+ * Render textarea field
567
+ */
568
+ public static function render_textarea_field($args) {
569
+ $option_name = $args['option_name'];
570
+ $value = get_option($option_name, '');
571
+ $description = isset($args['description']) ? $args['description'] : '';
572
+ $rows = isset($args['rows']) ? intval($args['rows']) : 5;
573
+
574
+ printf(
575
+ '<textarea id="%s" name="%s" rows="%d" class="large-text">%s</textarea>',
576
+ esc_attr($args['label_for']),
577
+ esc_attr($option_name),
578
+ $rows,
579
+ esc_textarea($value)
580
+ );
581
+
582
+ if ($description) {
583
+ printf('<p class="description">%s</p>', esc_html($description));
584
+ }
585
+ }
586
+
587
+ /**
588
+ * Render checkbox field
589
+ */
590
+ public static function render_checkbox_field($args) {
591
+ $option_name = $args['option_name'];
592
+ $value = get_option($option_name, false);
593
+ $description = isset($args['description']) ? $args['description'] : '';
594
+
595
+ printf(
596
+ '<label><input type="checkbox" id="%s" name="%s" value="1" %s> %s</label>',
597
+ esc_attr($args['label_for']),
598
+ esc_attr($option_name),
599
+ checked($value, true, false),
600
+ esc_html($description)
601
+ );
602
+ }
603
+
604
+ /**
605
+ * Render password field
606
+ */
607
+ public static function render_password_field($args) {
608
+ $option_name = $args['option_name'];
609
+ $value = get_option($option_name, '');
610
+ $description = isset($args['description']) ? $args['description'] : '';
611
+
612
+ printf(
613
+ '<input type="password" id="%s" name="%s" value="%s" class="regular-text">',
614
+ esc_attr($args['label_for']),
615
+ esc_attr($option_name),
616
+ esc_attr($value)
617
+ );
618
+
619
+ if ($description) {
620
+ printf('<p class="description">%s</p>', esc_html($description));
621
+ }
622
+ }
623
+
624
+ /**
625
+ * Render number field
626
+ */
627
+ public static function render_number_field($args) {
628
+ $option_name = $args['option_name'];
629
+ $value = get_option($option_name, '');
630
+ $description = isset($args['description']) ? $args['description'] : '';
631
+ $min = isset($args['min']) ? intval($args['min']) : '';
632
+ $max = isset($args['max']) ? intval($args['max']) : '';
633
+
634
+ printf(
635
+ '<input type="number" id="%s" name="%s" value="%s" min="%s" max="%s" class="small-text">',
636
+ esc_attr($args['label_for']),
637
+ esc_attr($option_name),
638
+ esc_attr($value),
639
+ esc_attr($min),
640
+ esc_attr($max)
641
+ );
642
+
643
+ if ($description) {
644
+ printf('<p class="description">%s</p>', esc_html($description));
645
+ }
646
+ }
647
+
648
+ /**
649
+ * Render color field
650
+ */
651
+ public static function render_color_field($args) {
652
+ $option_name = $args['option_name'];
653
+ $value = get_option($option_name, '#0073aa');
654
+ $description = isset($args['description']) ? $args['description'] : '';
655
+
656
+ printf(
657
+ '<input type="text" id="%s" name="%s" value="%s" class="ssm-color-picker">',
658
+ esc_attr($args['label_for']),
659
+ esc_attr($option_name),
660
+ esc_attr($value)
661
+ );
662
+
663
+ if ($description) {
664
+ printf('<p class="description">%s</p>', esc_html($description));
665
+ }
666
+ }
667
+
668
+ /**
669
+ * Render select field
670
+ */
671
+ public static function render_select_field($args) {
672
+ $option_name = $args['option_name'];
673
+ $value = get_option($option_name, '');
674
+ $description = isset($args['description']) ? $args['description'] : '';
675
+ $options = isset($args['options']) ? $args['options'] : array();
676
+
677
+ printf('<select id="%s" name="%s">', esc_attr($args['label_for']), esc_attr($option_name));
678
+
679
+ foreach ($options as $option_value => $option_label) {
680
+ printf(
681
+ '<option value="%s" %s>%s</option>',
682
+ esc_attr($option_value),
683
+ selected($value, $option_value, false),
684
+ esc_html($option_label)
685
+ );
686
+ }
687
+
688
+ echo '</select>';
689
+
690
+ if ($description) {
691
+ printf('<p class="description">%s</p>', esc_html($description));
692
+ }
693
+ }
694
+
695
+ /**
696
+ * Render radio field
697
+ */
698
+ public static function render_radio_field($args) {
699
+ $option_name = $args['option_name'];
700
+ $value = get_option($option_name, '');
701
+ $description = isset($args['description']) ? $args['description'] : '';
702
+ $options = isset($args['options']) ? $args['options'] : array();
703
+
704
+ foreach ($options as $option_value => $option_label) {
705
+ printf(
706
+ '<label><input type="radio" name="%s" value="%s" %s> %s</label><br>',
707
+ esc_attr($option_name),
708
+ esc_attr($option_value),
709
+ checked($value, $option_value, false),
710
+ esc_html($option_label)
711
+ );
712
+ }
713
+
714
+ if ($description) {
715
+ printf('<p class="description">%s</p>', esc_html($description));
716
+ }
717
+ }
718
+ }
719
+ ```
720
+
721
+ ---
722
+
723
+ ## View Files
724
+
725
+ ### File: `admin/views/settings-page.php`
726
+
727
+ ```php
728
+ <?php
729
+ /**
730
+ * Settings page view
731
+ *
732
+ * @package Site_Settings_Manager
733
+ */
734
+
735
+ // Exit if accessed directly
736
+ if (!defined('ABSPATH')) {
737
+ exit;
738
+ }
739
+ ?>
740
+
741
+ <div class="wrap ssm-settings-wrap">
742
+ <h1><?php echo esc_html(get_admin_page_title()); ?></h1>
743
+
744
+ <?php settings_errors(); ?>
745
+
746
+ <div class="ssm-settings-container">
747
+ <div class="ssm-settings-main">
748
+ <form method="post" action="options.php">
749
+ <?php
750
+ settings_fields(SSM_Settings_Page::OPTION_GROUP);
751
+ do_settings_sections(SSM_Settings_Page::PAGE_SLUG);
752
+ submit_button(__('Save Settings', 'site-settings-manager'));
753
+ ?>
754
+ </form>
755
+ </div>
756
+
757
+ <div class="ssm-settings-sidebar">
758
+ <?php include SSM_PLUGIN_DIR . 'admin/views/settings-sidebar.php'; ?>
759
+ </div>
760
+ </div>
761
+ </div>
762
+ ```
763
+
764
+ ### File: `admin/views/settings-sidebar.php`
765
+
766
+ ```php
767
+ <?php
768
+ /**
769
+ * Settings sidebar view
770
+ *
771
+ * @package Site_Settings_Manager
772
+ */
773
+
774
+ // Exit if accessed directly
775
+ if (!defined('ABSPATH')) {
776
+ exit;
777
+ }
778
+ ?>
779
+
780
+ <div class="ssm-sidebar-box">
781
+ <h3><?php _e('About This Plugin', 'site-settings-manager'); ?></h3>
782
+ <p><?php _e('Site Settings Manager provides a comprehensive settings interface for your WordPress site.', 'site-settings-manager'); ?></p>
783
+ </div>
784
+
785
+ <div class="ssm-sidebar-box">
786
+ <h3><?php _e('Documentation', 'site-settings-manager'); ?></h3>
787
+ <ul>
788
+ <li><a href="#" target="_blank"><?php _e('Getting Started', 'site-settings-manager'); ?></a></li>
789
+ <li><a href="#" target="_blank"><?php _e('API Documentation', 'site-settings-manager'); ?></a></li>
790
+ <li><a href="#" target="_blank"><?php _e('Support Forum', 'site-settings-manager'); ?></a></li>
791
+ </ul>
792
+ </div>
793
+
794
+ <div class="ssm-sidebar-box">
795
+ <h3><?php _e('System Info', 'site-settings-manager'); ?></h3>
796
+ <table class="ssm-info-table">
797
+ <tr>
798
+ <td><?php _e('Plugin Version:', 'site-settings-manager'); ?></td>
799
+ <td><?php echo esc_html(SSM_VERSION); ?></td>
800
+ </tr>
801
+ <tr>
802
+ <td><?php _e('WordPress Version:', 'site-settings-manager'); ?></td>
803
+ <td><?php echo esc_html(get_bloginfo('version')); ?></td>
804
+ </tr>
805
+ <tr>
806
+ <td><?php _e('PHP Version:', 'site-settings-manager'); ?></td>
807
+ <td><?php echo esc_html(PHP_VERSION); ?></td>
808
+ </tr>
809
+ </table>
810
+ </div>
811
+
812
+ <div class="ssm-sidebar-box ssm-support-box">
813
+ <h3><?php _e('Need Help?', 'site-settings-manager'); ?></h3>
814
+ <p><?php _e('If you need assistance, please visit our support forum.', 'site-settings-manager'); ?></p>
815
+ <a href="#" class="button button-primary" target="_blank">
816
+ <?php _e('Get Support', 'site-settings-manager'); ?>
817
+ </a>
818
+ </div>
819
+ ```
820
+
821
+ ---
822
+
823
+ ## Assets
824
+
825
+ ### File: `admin/css/admin.css`
826
+
827
+ ```css
828
+ /* Settings Page Layout */
829
+ .ssm-settings-wrap {
830
+ margin: 20px 20px 0 0;
831
+ }
832
+
833
+ .ssm-settings-container {
834
+ display: flex;
835
+ gap: 30px;
836
+ margin-top: 20px;
837
+ }
838
+
839
+ .ssm-settings-main {
840
+ flex: 1;
841
+ background: #fff;
842
+ padding: 20px;
843
+ border: 1px solid #ccd0d4;
844
+ box-shadow: 0 1px 1px rgba(0, 0, 0, 0.04);
845
+ }
846
+
847
+ .ssm-settings-sidebar {
848
+ width: 300px;
849
+ flex-shrink: 0;
850
+ }
851
+
852
+ @media (max-width: 1024px) {
853
+ .ssm-settings-container {
854
+ flex-direction: column;
855
+ }
856
+
857
+ .ssm-settings-sidebar {
858
+ width: 100%;
859
+ }
860
+ }
861
+
862
+ /* Settings Sections */
863
+ .ssm-settings-main h2 {
864
+ margin-top: 0;
865
+ padding-bottom: 10px;
866
+ border-bottom: 1px solid #e0e0e0;
867
+ }
868
+
869
+ .ssm-settings-main .form-table {
870
+ margin-top: 20px;
871
+ }
872
+
873
+ .ssm-settings-main .form-table th {
874
+ padding: 15px 10px 15px 0;
875
+ width: 200px;
876
+ }
877
+
878
+ .ssm-settings-main .form-table td {
879
+ padding: 15px 10px;
880
+ }
881
+
882
+ /* Sidebar Boxes */
883
+ .ssm-sidebar-box {
884
+ background: #fff;
885
+ padding: 20px;
886
+ margin-bottom: 20px;
887
+ border: 1px solid #ccd0d4;
888
+ box-shadow: 0 1px 1px rgba(0, 0, 0, 0.04);
889
+ }
890
+
891
+ .ssm-sidebar-box h3 {
892
+ margin-top: 0;
893
+ margin-bottom: 15px;
894
+ font-size: 14px;
895
+ font-weight: 600;
896
+ }
897
+
898
+ .ssm-sidebar-box p {
899
+ margin: 0 0 15px;
900
+ font-size: 13px;
901
+ line-height: 1.6;
902
+ }
903
+
904
+ .ssm-sidebar-box ul {
905
+ margin: 0;
906
+ padding: 0;
907
+ list-style: none;
908
+ }
909
+
910
+ .ssm-sidebar-box ul li {
911
+ margin-bottom: 8px;
912
+ }
913
+
914
+ .ssm-sidebar-box ul li a {
915
+ text-decoration: none;
916
+ font-size: 13px;
917
+ }
918
+
919
+ .ssm-sidebar-box ul li a:hover {
920
+ text-decoration: underline;
921
+ }
922
+
923
+ /* Info Table */
924
+ .ssm-info-table {
925
+ width: 100%;
926
+ font-size: 13px;
927
+ }
928
+
929
+ .ssm-info-table tr {
930
+ border-bottom: 1px solid #f0f0f0;
931
+ }
932
+
933
+ .ssm-info-table tr:last-child {
934
+ border-bottom: none;
935
+ }
936
+
937
+ .ssm-info-table td {
938
+ padding: 8px 0;
939
+ }
940
+
941
+ .ssm-info-table td:first-child {
942
+ font-weight: 600;
943
+ width: 50%;
944
+ }
945
+
946
+ /* Support Box */
947
+ .ssm-support-box {
948
+ background: #f7f7f7;
949
+ border-left: 4px solid #0073aa;
950
+ }
951
+
952
+ .ssm-support-box .button {
953
+ width: 100%;
954
+ text-align: center;
955
+ margin-top: 10px;
956
+ }
957
+
958
+ /* Color Picker */
959
+ .ssm-color-picker {
960
+ max-width: 100px;
961
+ }
962
+
963
+ /* Success/Error Messages */
964
+ .ssm-settings-wrap .notice {
965
+ margin: 20px 0;
966
+ }
967
+ ```
968
+
969
+ ### File: `admin/js/admin.js`
970
+
971
+ ```javascript
972
+ (function($) {
973
+ 'use strict';
974
+
975
+ $(document).ready(function() {
976
+ // Initialize color picker
977
+ if (typeof $.fn.wpColorPicker !== 'undefined') {
978
+ $('.ssm-color-picker').wpColorPicker();
979
+ }
980
+
981
+ // Form validation
982
+ $('form').on('submit', function(e) {
983
+ var isValid = true;
984
+
985
+ // Validate API key if present
986
+ var apiKey = $('#ssm_api_key').val();
987
+ if (apiKey && !/^[a-zA-Z0-9]{32}$/.test(apiKey)) {
988
+ alert('API key must be 32 alphanumeric characters.');
989
+ isValid = false;
990
+ }
991
+
992
+ // Validate items per page
993
+ var itemsPerPage = parseInt($('#ssm_items_per_page').val());
994
+ if (itemsPerPage < 1 || itemsPerPage > 100) {
995
+ alert('Items per page must be between 1 and 100.');
996
+ isValid = false;
997
+ }
998
+
999
+ if (!isValid) {
1000
+ e.preventDefault();
1001
+ }
1002
+ });
1003
+
1004
+ // Show/hide conditional fields
1005
+ $('#ssm_enable_feature').on('change', function() {
1006
+ if ($(this).is(':checked')) {
1007
+ $('.conditional-field').slideDown();
1008
+ } else {
1009
+ $('.conditional-field').slideUp();
1010
+ }
1011
+ }).trigger('change');
1012
+ });
1013
+
1014
+ })(jQuery);
1015
+ ```
1016
+
1017
+ ---
1018
+
1019
+ ## Uninstall
1020
+
1021
+ ### File: `uninstall.php`
1022
+
1023
+ ```php
1024
+ <?php
1025
+ /**
1026
+ * Uninstall script
1027
+ *
1028
+ * @package Site_Settings_Manager
1029
+ */
1030
+
1031
+ // Exit if accessed directly or not uninstalling
1032
+ if (!defined('WP_UNINSTALL_PLUGIN')) {
1033
+ exit;
1034
+ }
1035
+
1036
+ // Delete all plugin options
1037
+ $options = array(
1038
+ 'ssm_site_title',
1039
+ 'ssm_site_description',
1040
+ 'ssm_enable_feature',
1041
+ 'ssm_api_key',
1042
+ 'ssm_items_per_page',
1043
+ 'ssm_theme_color',
1044
+ 'ssm_email_notifications',
1045
+ );
1046
+
1047
+ foreach ($options as $option) {
1048
+ delete_option($option);
1049
+ }
1050
+
1051
+ // Clear any cached data
1052
+ wp_cache_flush();
1053
+ ```
1054
+
1055
+ ---
1056
+
1057
+ ## Usage Examples
1058
+
1059
+ ### Accessing Settings in Your Code
1060
+
1061
+ ```php
1062
+ <?php
1063
+ // Get individual settings
1064
+ $site_title = get_option('ssm_site_title', '');
1065
+ $enable_feature = get_option('ssm_enable_feature', false);
1066
+ $items_per_page = get_option('ssm_items_per_page', 10);
1067
+ $theme_color = get_option('ssm_theme_color', '#0073aa');
1068
+
1069
+ // Use settings
1070
+ if ($enable_feature) {
1071
+ // Feature is enabled
1072
+ echo '<h1>' . esc_html($site_title) . '</h1>';
1073
+ }
1074
+
1075
+ // Use in queries
1076
+ $args = array(
1077
+ 'posts_per_page' => $items_per_page,
1078
+ );
1079
+ $query = new WP_Query($args);
1080
+ ?>
1081
+ ```
1082
+
1083
+ ### Programmatically Update Settings
1084
+
1085
+ ```php
1086
+ <?php
1087
+ // Update settings
1088
+ update_option('ssm_site_title', 'New Site Title');
1089
+ update_option('ssm_enable_feature', true);
1090
+ update_option('ssm_items_per_page', 20);
1091
+
1092
+ // Get and modify
1093
+ $emails = get_option('ssm_email_notifications', '');
1094
+ $email_array = array_map('trim', explode(',', $emails));
1095
+ $email_array[] = 'new@example.com';
1096
+ update_option('ssm_email_notifications', implode(', ', $email_array));
1097
+ ?>
1098
+ ```
1099
+
1100
+ ### Add Custom Validation
1101
+
1102
+ ```php
1103
+ <?php
1104
+ // Add to class-settings-page.php
1105
+ public static function sanitize_custom_field($value) {
1106
+ $value = sanitize_text_field($value);
1107
+
1108
+ // Custom validation logic
1109
+ if (strlen($value) < 5) {
1110
+ add_settings_error(
1111
+ 'ssm_custom_field',
1112
+ 'too_short',
1113
+ __('Value must be at least 5 characters.', 'site-settings-manager'),
1114
+ 'error'
1115
+ );
1116
+ return get_option('ssm_custom_field');
1117
+ }
1118
+
1119
+ return $value;
1120
+ }
1121
+ ?>
1122
+ ```
1123
+
1124
+ ### Add New Settings Section
1125
+
1126
+ ```php
1127
+ <?php
1128
+ // In register_settings() method
1129
+ add_settings_section(
1130
+ 'ssm_custom_section',
1131
+ __('Custom Settings', 'site-settings-manager'),
1132
+ array(__CLASS__, 'render_custom_section'),
1133
+ self::PAGE_SLUG
1134
+ );
1135
+
1136
+ add_settings_field(
1137
+ 'ssm_custom_field',
1138
+ __('Custom Field', 'site-settings-manager'),
1139
+ array('SSM_Settings_Fields', 'render_text_field'),
1140
+ self::PAGE_SLUG,
1141
+ 'ssm_custom_section',
1142
+ array(
1143
+ 'label_for' => 'ssm_custom_field',
1144
+ 'option_name' => 'ssm_custom_field',
1145
+ 'description' => __('Enter custom value', 'site-settings-manager'),
1146
+ )
1147
+ );
1148
+ ?>
1149
+ ```
1150
+
1151
+ ---
1152
+
1153
+ ## Key Features
1154
+
1155
+ ### 1. Settings API Integration
1156
+ - **Proper registration** with `register_setting()`
1157
+ - **Sections and fields** with `add_settings_section()` and `add_settings_field()`
1158
+ - **Automatic form handling** with `settings_fields()` and `do_settings_sections()`
1159
+ - **Built-in validation** and error handling
1160
+
1161
+ ### 2. Field Types
1162
+ - **Text field**: Single-line text input
1163
+ - **Textarea field**: Multi-line text input
1164
+ - **Checkbox field**: Boolean toggle
1165
+ - **Password field**: Masked input
1166
+ - **Number field**: Numeric input with min/max
1167
+ - **Color field**: Color picker integration
1168
+ - **Select field**: Dropdown selection
1169
+ - **Radio field**: Radio button group
1170
+
1171
+ ### 3. Validation & Sanitization
1172
+ - **Built-in sanitization**: `sanitize_text_field()`, `sanitize_textarea_field()`, `sanitize_hex_color()`
1173
+ - **Custom validation**: API key format, email list, numeric ranges
1174
+ - **Error messages**: `add_settings_error()` for user feedback
1175
+ - **Fallback values**: Return old value on validation failure
1176
+
1177
+ ### 4. Security
1178
+ - **Capability checks**: `current_user_can('manage_options')`
1179
+ - **Nonce verification**: Automatic with Settings API
1180
+ - **Input sanitization**: All inputs sanitized
1181
+ - **Output escaping**: All outputs escaped
1182
+
1183
+ ### 5. User Experience
1184
+ - **Clean layout**: Two-column design with sidebar
1185
+ - **Helpful descriptions**: Field-level help text
1186
+ - **System information**: Plugin and environment details
1187
+ - **Color picker**: WordPress color picker integration
1188
+ - **Responsive design**: Mobile-friendly layout
1189
+
1190
+ ---
1191
+
1192
+ ## Best Practices Demonstrated
1193
+
1194
+ ### Security
1195
+ ✅ Capability checks (`current_user_can('manage_options')`)
1196
+ ✅ Automatic nonce verification (Settings API)
1197
+ ✅ Input sanitization (all fields)
1198
+ ✅ Output escaping (`esc_html`, `esc_attr`, `esc_url`)
1199
+ ✅ Validation with error messages
1200
+
1201
+ ### WordPress Standards
1202
+ ✅ Settings API usage
1203
+ ✅ Internationalization (`__()`, `_e()`)
1204
+ ✅ Proper hook usage (`admin_menu`, `admin_init`)
1205
+ ✅ Autoloader for class files
1206
+ ✅ Proper file organization
1207
+ ✅ WordPress coding standards
1208
+
1209
+ ### User Experience
1210
+ ✅ Clear section organization
1211
+ ✅ Helpful field descriptions
1212
+ ✅ Validation feedback
1213
+ ✅ Sidebar with documentation
1214
+ ✅ Responsive layout
1215
+ ✅ Color picker integration
1216
+
1217
+ ### Code Quality
1218
+ ✅ Separation of concerns (page, fields, validation)
1219
+ ✅ Reusable field rendering methods
1220
+ ✅ Consistent naming conventions
1221
+ ✅ Proper documentation
1222
+ ✅ Clean uninstall process
1223
+
1224
+ ---
1225
+
1226
+ ## Customization
1227
+
1228
+ ### Add New Field Type
1229
+
1230
+ ```php
1231
+ <?php
1232
+ // In class-settings-fields.php
1233
+ public static function render_custom_field($args) {
1234
+ $option_name = $args['option_name'];
1235
+ $value = get_option($option_name, '');
1236
+ $description = isset($args['description']) ? $args['description'] : '';
1237
+
1238
+ // Custom field HTML
1239
+ printf(
1240
+ '<input type="text" id="%s" name="%s" value="%s" class="custom-field">',
1241
+ esc_attr($args['label_for']),
1242
+ esc_attr($option_name),
1243
+ esc_attr($value)
1244
+ );
1245
+
1246
+ if ($description) {
1247
+ printf('<p class="description">%s</p>', esc_html($description));
1248
+ }
1249
+ }
1250
+ ?>
1251
+ ```
1252
+
1253
+ ### Add Tabs to Settings Page
1254
+
1255
+ ```php
1256
+ <?php
1257
+ // Add to settings-page.php view
1258
+ <h2 class="nav-tab-wrapper">
1259
+ <a href="?page=site-settings-manager&tab=general" class="nav-tab <?php echo $active_tab == 'general' ? 'nav-tab-active' : ''; ?>">
1260
+ <?php _e('General', 'site-settings-manager'); ?>
1261
+ </a>
1262
+ <a href="?page=site-settings-manager&tab=advanced" class="nav-tab <?php echo $active_tab == 'advanced' ? 'nav-tab-active' : ''; ?>">
1263
+ <?php _e('Advanced', 'site-settings-manager'); ?>
1264
+ </a>
1265
+ </h2>
1266
+ ?>
1267
+ ```
1268
+
1269
+ ### Export/Import Settings
1270
+
1271
+ ```php
1272
+ <?php
1273
+ // Export settings
1274
+ function ssm_export_settings() {
1275
+ $settings = array(
1276
+ 'ssm_site_title' => get_option('ssm_site_title'),
1277
+ 'ssm_site_description' => get_option('ssm_site_description'),
1278
+ // ... other settings
1279
+ );
1280
+
1281
+ return json_encode($settings);
1282
+ }
1283
+
1284
+ // Import settings
1285
+ function ssm_import_settings($json) {
1286
+ $settings = json_decode($json, true);
1287
+
1288
+ if ($settings) {
1289
+ foreach ($settings as $key => $value) {
1290
+ update_option($key, $value);
1291
+ }
1292
+ }
1293
+ }
1294
+ ?>
1295
+ ```
1296
+
1297
+ ---
1298
+
1299
+ ## Testing Checklist
1300
+
1301
+ - [ ] Access settings page (Settings > Site Settings)
1302
+ - [ ] Save settings with valid values
1303
+ - [ ] Test validation errors (invalid API key, out-of-range numbers)
1304
+ - [ ] Test email list validation
1305
+ - [ ] Test color picker functionality
1306
+ - [ ] Test checkbox toggle
1307
+ - [ ] Verify settings persist after save
1308
+ - [ ] Test responsive layout on mobile
1309
+ - [ ] Verify capability checks (non-admin users)
1310
+ - [ ] Test uninstall cleanup
1311
+ - [ ] Check for PHP/JavaScript errors
1312
+ - [ ] Verify internationalization strings
1313
+
1314
+ ---
1315
+
1316
+ ## Comparison with Other Patterns
1317
+
1318
+ | Feature | This Plugin | Simple Settings | Advanced Settings | Framework-Based |
1319
+ |---------|-------------|-----------------|-------------------|-----------------|
1320
+ | **Complexity** | Medium | Low | High | Very High |
1321
+ | **File Count** | 5-10 | 1-2 | 10-20 | 20+ |
1322
+ | **Settings API** | ✅ Full | ✅ Basic | ✅ Full | ✅ Custom |
1323
+ | **Validation** | ✅ Advanced | ❌ | ✅ Advanced | ✅ Advanced |
1324
+ | **Field Types** | ✅ 7 types | ✅ 2-3 types | ✅ 10+ types | ✅ Unlimited |
1325
+ | **Layout** | ✅ Custom | ❌ Basic | ✅ Tabbed | ✅ Advanced |
1326
+ | **Security** | ✅ Full | ✅ Basic | ✅ Full | ✅ Full |
1327
+ | **Best For** | Most plugins | Simple config | Complex plugins | Large systems |
1328
+
1329
+ ---
1330
+
1331
+ ## Summary
1332
+
1333
+ This example demonstrates a **complete settings page plugin** with:
1334
+
1335
+ - ✅ WordPress Settings API integration
1336
+ - ✅ Multiple field types (text, textarea, checkbox, password, number, color, select, radio)
1337
+ - ✅ Advanced validation and sanitization
1338
+ - ✅ Custom admin page with sidebar
1339
+ - ✅ Proper security (capability checks, sanitization, escaping)
1340
+ - ✅ Error handling and user feedback
1341
+ - ✅ Responsive design
1342
+ - ✅ Color picker integration
1343
+ - ✅ Clean uninstall process
1344
+ - ✅ Internationalization support
1345
+ - ✅ Reusable field rendering methods
1346
+
1347
+ **Perfect for**: Plugin configuration, site settings, feature toggles, API integrations, or any plugin requiring user-configurable options.
1348
+
1349
+ **Character Count**: ~24,500 characters
1350
+