@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.
- package/AGENTS.md +265 -232
- package/README.md +956 -771
- package/augment-extensions/coding-standards/bash/README.md +196 -196
- package/augment-extensions/coding-standards/bash/module.json +163 -163
- package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
- package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
- package/augment-extensions/coding-standards/css/README.md +40 -40
- package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
- package/augment-extensions/coding-standards/css/module.json +44 -44
- package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
- package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
- package/augment-extensions/coding-standards/html/README.md +40 -40
- package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
- package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
- package/augment-extensions/coding-standards/html/module.json +44 -44
- package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
- package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
- package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
- package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
- package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
- package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
- package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
- package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
- package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
- package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
- package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
- package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
- package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
- package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
- package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
- package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
- package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
- package/augment-extensions/coding-standards/js/README.md +46 -46
- package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
- package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
- package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
- package/augment-extensions/coding-standards/js/module.json +49 -49
- package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
- package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
- package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
- package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
- package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
- package/augment-extensions/coding-standards/php/README.md +248 -248
- package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
- package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
- package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
- package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
- package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
- package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
- package/augment-extensions/coding-standards/php/module.json +166 -166
- package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
- package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
- package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
- package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
- package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
- package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
- package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
- package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
- package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
- package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
- package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
- package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
- package/augment-extensions/coding-standards/php/rules/security.md +358 -358
- package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
- package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
- package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
- package/augment-extensions/coding-standards/powershell/README.md +154 -154
- package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
- package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
- package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
- package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
- package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
- package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
- package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
- package/augment-extensions/coding-standards/powershell/module.json +165 -165
- package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
- package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
- package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
- package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
- package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
- package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
- package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
- package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
- package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
- package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
- package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
- package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
- package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
- package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
- package/augment-extensions/coding-standards/python/README.md +48 -48
- package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
- package/augment-extensions/coding-standards/python/module.json +30 -30
- package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
- package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
- package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
- package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
- package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
- package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
- package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
- package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
- package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
- package/augment-extensions/coding-standards/react/README.md +45 -45
- package/augment-extensions/coding-standards/react/module.json +27 -27
- package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
- package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
- package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
- package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
- package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
- package/augment-extensions/coding-standards/typescript/README.md +45 -45
- package/augment-extensions/coding-standards/typescript/module.json +27 -27
- package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
- package/augment-extensions/collections/html-css-js/README.md +82 -82
- package/augment-extensions/collections/html-css-js/collection.json +41 -41
- package/augment-extensions/domain-rules/api-design/README.md +41 -41
- package/augment-extensions/domain-rules/api-design/module.json +27 -27
- package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
- package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
- package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
- package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
- package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
- package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
- package/augment-extensions/domain-rules/database/README.md +161 -161
- package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
- package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
- package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
- package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
- package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
- package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
- package/augment-extensions/domain-rules/database/module.json +28 -28
- package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
- package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
- package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
- package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
- package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
- package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
- package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
- package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
- package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
- package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
- package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
- package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
- package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
- package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
- package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
- package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
- package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
- package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
- package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
- package/augment-extensions/domain-rules/mcp/README.md +150 -150
- package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
- package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
- package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
- package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
- package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
- package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
- package/augment-extensions/domain-rules/mcp/module.json +49 -49
- package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
- package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
- package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
- package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
- package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
- package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
- package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
- package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
- package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
- package/augment-extensions/domain-rules/security/README.md +41 -41
- package/augment-extensions/domain-rules/security/module.json +28 -28
- package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
- package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
- package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
- package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
- package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
- package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
- package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
- package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
- package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
- package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
- package/augment-extensions/domain-rules/wordpress/README.md +163 -163
- package/augment-extensions/domain-rules/wordpress/module.json +32 -32
- package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
- package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
- package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
- package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
- package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
- package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
- package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
- package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
- package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
- package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
- package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
- package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
- package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
- package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
- package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
- package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
- package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
- package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
- package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
- package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
- package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
- package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
- package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
- package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
- package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
- package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
- package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
- package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
- package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
- package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
- package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
- package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
- package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
- package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
- package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
- package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
- package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
- package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
- package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
- package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
- package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
- package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
- package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
- package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
- package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
- package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
- package/augment-extensions/examples/design-patterns/README.md +37 -37
- package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
- package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
- package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
- package/augment-extensions/examples/design-patterns/module.json +27 -27
- package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
- package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
- package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
- package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
- package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
- package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
- package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
- package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
- package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
- package/augment-extensions/workflows/beads/README.md +135 -135
- package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
- package/augment-extensions/workflows/beads/module.json +55 -55
- package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
- package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
- package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
- package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
- package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
- package/augment-extensions/workflows/beads-integration/README.md +143 -143
- package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
- package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
- package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
- package/augment-extensions/workflows/beads-integration/module.json +75 -75
- package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
- package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
- package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
- package/augment-extensions/workflows/database/README.md +195 -195
- package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
- package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
- package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
- package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
- package/augment-extensions/workflows/database/module.json +42 -42
- package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
- package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
- package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
- package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
- package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
- package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
- package/augment-extensions/workflows/database/rules/workflow.md +458 -458
- package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
- package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
- package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
- package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
- package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
- package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
- package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
- package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
- package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
- package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
- package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
- package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
- package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
- package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
- package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
- package/augment-extensions/writing-standards/screenplay/README.md +339 -300
- package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
- package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
- package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
- package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
- package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
- package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
- package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
- package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
- package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
- package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
- package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
- package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
- package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
- package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
- package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
- package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
- package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
- package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
- package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
- package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
- package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
- package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
- package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
- package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
- package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
- package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
- package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
- package/augment-extensions/writing-standards/screenplay/module.json +124 -124
- package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
- package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
- package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
- package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
- package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
- package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
- package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
- package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
- package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
- package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
- package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
- package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
- package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
- package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
- package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
- package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
- package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
- package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
- package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
- package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
- package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
- package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
- package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
- package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
- package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
- package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
- package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
- package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
- package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
- package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
- package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
- package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
- package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
- package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
- package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
- package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
- package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
- package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
- package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
- package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
- package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
- package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
- package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
- package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
- package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
- package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
- package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
- package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
- package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
- package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
- package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
- package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
- package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
- package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
- package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
- package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
- package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
- package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
- package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
- package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
- package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
- package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
- package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
- package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
- package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
- package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
- package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
- package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
- package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
- package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
- package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
- package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
- package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
- package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
- package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
- package/cli/MODULES.md +302 -302
- package/cli/dist/cli.js +109 -22
- package/cli/dist/cli.js.map +1 -1
- package/cli/dist/commands/gui.d.ts.map +1 -1
- package/cli/dist/commands/gui.js +54 -6
- package/cli/dist/commands/gui.js.map +1 -1
- package/cli/dist/commands/init.d.ts.map +1 -1
- package/cli/dist/commands/init.js +76 -23
- package/cli/dist/commands/init.js.map +1 -1
- package/cli/dist/commands/self-remove.d.ts.map +1 -1
- package/cli/dist/commands/self-remove.js +48 -74
- package/cli/dist/commands/self-remove.js.map +1 -1
- package/cli/dist/commands/show.d.ts +11 -0
- package/cli/dist/commands/show.d.ts.map +1 -1
- package/cli/dist/commands/show.js +120 -0
- package/cli/dist/commands/show.js.map +1 -1
- package/cli/dist/commands/showCompleted.d.ts +21 -0
- package/cli/dist/commands/showCompleted.d.ts.map +1 -0
- package/cli/dist/commands/showCompleted.js +225 -0
- package/cli/dist/commands/showCompleted.js.map +1 -0
- package/cli/dist/commands/skill.js +88 -88
- package/cli/dist/commands/update.d.ts +2 -0
- package/cli/dist/commands/update.d.ts.map +1 -1
- package/cli/dist/commands/update.js +67 -1
- package/cli/dist/commands/update.js.map +1 -1
- package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
- package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
- package/cli/dist/utils/beadsCompletedChecker.js +198 -0
- package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
- package/cli/dist/utils/catalog-sync.js +13 -13
- package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
- package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
- package/cli/dist/utils/extractCommandHelp.js +250 -0
- package/cli/dist/utils/extractCommandHelp.js.map +1 -0
- package/cli/dist/utils/install-rules.js +55 -55
- package/cli/dist/utils/mcp-integration.js +44 -44
- package/cli/dist/utils/rule-install-hooks.js +8 -8
- package/modules.md +667 -630
- package/package.json +85 -85
|
@@ -1,561 +1,561 @@
|
|
|
1
|
-
# PHP CMS Integration Best Practices
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
This guide provides best practices for developing WordPress and Drupal plugins/modules, including hooks, filters, security, database interactions, and CMS-specific patterns.
|
|
6
|
-
|
|
7
|
-
## WordPress Development
|
|
8
|
-
|
|
9
|
-
### Plugin Structure
|
|
10
|
-
|
|
11
|
-
```php
|
|
12
|
-
<?php
|
|
13
|
-
/**
|
|
14
|
-
* Plugin Name: My Custom Plugin
|
|
15
|
-
* Plugin URI: https://example.com/my-plugin
|
|
16
|
-
* Description: A custom WordPress plugin
|
|
17
|
-
* Version: 1.0.0
|
|
18
|
-
* Author: Your Name
|
|
19
|
-
* Author URI: https://example.com
|
|
20
|
-
* License: GPL v2 or later
|
|
21
|
-
* Text Domain: my-custom-plugin
|
|
22
|
-
* Domain Path: /languages
|
|
23
|
-
*/
|
|
24
|
-
|
|
25
|
-
// Prevent direct access
|
|
26
|
-
if (!defined('ABSPATH')) {
|
|
27
|
-
exit;
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
// Define plugin constants
|
|
31
|
-
define('MY_PLUGIN_VERSION', '1.0.0');
|
|
32
|
-
define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
|
|
33
|
-
define('MY_PLUGIN_URL', plugin_dir_url(__FILE__));
|
|
34
|
-
|
|
35
|
-
// Autoloader
|
|
36
|
-
require_once MY_PLUGIN_PATH . 'includes/class-my-plugin.php';
|
|
37
|
-
|
|
38
|
-
// Initialize plugin
|
|
39
|
-
function my_plugin_init() {
|
|
40
|
-
$plugin = new My_Plugin();
|
|
41
|
-
$plugin->run();
|
|
42
|
-
}
|
|
43
|
-
add_action('plugins_loaded', 'my_plugin_init');
|
|
44
|
-
|
|
45
|
-
// Activation hook
|
|
46
|
-
register_activation_hook(__FILE__, 'my_plugin_activate');
|
|
47
|
-
function my_plugin_activate() {
|
|
48
|
-
// Create database tables, set default options, etc.
|
|
49
|
-
flush_rewrite_rules();
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
// Deactivation hook
|
|
53
|
-
register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
|
|
54
|
-
function my_plugin_deactivate() {
|
|
55
|
-
flush_rewrite_rules();
|
|
56
|
-
}
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Hooks and Filters
|
|
60
|
-
|
|
61
|
-
#### Actions
|
|
62
|
-
|
|
63
|
-
```php
|
|
64
|
-
<?php
|
|
65
|
-
|
|
66
|
-
// Add custom action
|
|
67
|
-
add_action('init', 'my_custom_init_function');
|
|
68
|
-
function my_custom_init_function() {
|
|
69
|
-
// Register custom post types, taxonomies, etc.
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
// Admin menu
|
|
73
|
-
add_action('admin_menu', 'my_plugin_add_admin_menu');
|
|
74
|
-
function my_plugin_add_admin_menu() {
|
|
75
|
-
add_menu_page(
|
|
76
|
-
'My Plugin', // Page title
|
|
77
|
-
'My Plugin', // Menu title
|
|
78
|
-
'manage_options', // Capability
|
|
79
|
-
'my-plugin', // Menu slug
|
|
80
|
-
'my_plugin_admin_page', // Callback
|
|
81
|
-
'dashicons-admin-generic', // Icon
|
|
82
|
-
20 // Position
|
|
83
|
-
);
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
// Enqueue scripts and styles
|
|
87
|
-
add_action('wp_enqueue_scripts', 'my_plugin_enqueue_assets');
|
|
88
|
-
function my_plugin_enqueue_assets() {
|
|
89
|
-
wp_enqueue_style(
|
|
90
|
-
'my-plugin-style',
|
|
91
|
-
MY_PLUGIN_URL . 'assets/css/style.css',
|
|
92
|
-
[],
|
|
93
|
-
MY_PLUGIN_VERSION
|
|
94
|
-
);
|
|
95
|
-
|
|
96
|
-
wp_enqueue_script(
|
|
97
|
-
'my-plugin-script',
|
|
98
|
-
MY_PLUGIN_URL . 'assets/js/script.js',
|
|
99
|
-
['jquery'],
|
|
100
|
-
MY_PLUGIN_VERSION,
|
|
101
|
-
true
|
|
102
|
-
);
|
|
103
|
-
|
|
104
|
-
// Localize script
|
|
105
|
-
wp_localize_script('my-plugin-script', 'myPluginData', [
|
|
106
|
-
'ajaxUrl' => admin_url('admin-ajax.php'),
|
|
107
|
-
'nonce' => wp_create_nonce('my-plugin-nonce')
|
|
108
|
-
]);
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
// Save post hook
|
|
112
|
-
add_action('save_post', 'my_plugin_save_post_meta', 10, 2);
|
|
113
|
-
function my_plugin_save_post_meta($post_id, $post) {
|
|
114
|
-
// Verify nonce
|
|
115
|
-
if (!isset($_POST['my_plugin_nonce']) ||
|
|
116
|
-
!wp_verify_nonce($_POST['my_plugin_nonce'], 'my_plugin_save')) {
|
|
117
|
-
return;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
// Check autosave
|
|
121
|
-
if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
|
|
122
|
-
return;
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
// Check permissions
|
|
126
|
-
if (!current_user_can('edit_post', $post_id)) {
|
|
127
|
-
return;
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
// Save meta
|
|
131
|
-
if (isset($_POST['my_custom_field'])) {
|
|
132
|
-
update_post_meta(
|
|
133
|
-
$post_id,
|
|
134
|
-
'_my_custom_field',
|
|
135
|
-
sanitize_text_field($_POST['my_custom_field'])
|
|
136
|
-
);
|
|
137
|
-
}
|
|
138
|
-
}
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
#### Filters
|
|
142
|
-
|
|
143
|
-
```php
|
|
144
|
-
<?php
|
|
145
|
-
|
|
146
|
-
// Modify content
|
|
147
|
-
add_filter('the_content', 'my_plugin_modify_content');
|
|
148
|
-
function my_plugin_modify_content($content) {
|
|
149
|
-
if (is_single()) {
|
|
150
|
-
$custom_content = '<div class="custom-notice">Custom notice</div>';
|
|
151
|
-
$content = $custom_content . $content;
|
|
152
|
-
}
|
|
153
|
-
return $content;
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
// Modify query
|
|
157
|
-
add_filter('pre_get_posts', 'my_plugin_modify_query');
|
|
158
|
-
function my_plugin_modify_query($query) {
|
|
159
|
-
if (!is_admin() && $query->is_main_query() && $query->is_home()) {
|
|
160
|
-
$query->set('posts_per_page', 20);
|
|
161
|
-
}
|
|
162
|
-
return $query;
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
// Add custom body class
|
|
166
|
-
add_filter('body_class', 'my_plugin_body_class');
|
|
167
|
-
function my_plugin_body_class($classes) {
|
|
168
|
-
if (is_page('special-page')) {
|
|
169
|
-
$classes[] = 'special-page-class';
|
|
170
|
-
}
|
|
171
|
-
return $classes;
|
|
172
|
-
}
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
### Custom Post Types
|
|
176
|
-
|
|
177
|
-
```php
|
|
178
|
-
<?php
|
|
179
|
-
|
|
180
|
-
add_action('init', 'my_plugin_register_post_type');
|
|
181
|
-
function my_plugin_register_post_type() {
|
|
182
|
-
register_post_type('book', [
|
|
183
|
-
'labels' => [
|
|
184
|
-
'name' => __('Books', 'my-plugin'),
|
|
185
|
-
'singular_name' => __('Book', 'my-plugin'),
|
|
186
|
-
'add_new' => __('Add New Book', 'my-plugin'),
|
|
187
|
-
'add_new_item' => __('Add New Book', 'my-plugin'),
|
|
188
|
-
'edit_item' => __('Edit Book', 'my-plugin'),
|
|
189
|
-
],
|
|
190
|
-
'public' => true,
|
|
191
|
-
'has_archive' => true,
|
|
192
|
-
'rewrite' => ['slug' => 'books'],
|
|
193
|
-
'supports' => ['title', 'editor', 'thumbnail', 'excerpt'],
|
|
194
|
-
'menu_icon' => 'dashicons-book',
|
|
195
|
-
'show_in_rest' => true, // Enable Gutenberg
|
|
196
|
-
]);
|
|
197
|
-
}
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### WP_Query
|
|
201
|
-
|
|
202
|
-
```php
|
|
203
|
-
<?php
|
|
204
|
-
|
|
205
|
-
// Basic query
|
|
206
|
-
$args = [
|
|
207
|
-
'post_type' => 'post',
|
|
208
|
-
'posts_per_page' => 10,
|
|
209
|
-
'orderby' => 'date',
|
|
210
|
-
'order' => 'DESC',
|
|
211
|
-
];
|
|
212
|
-
|
|
213
|
-
$query = new WP_Query($args);
|
|
214
|
-
|
|
215
|
-
if ($query->have_posts()) {
|
|
216
|
-
while ($query->have_posts()) {
|
|
217
|
-
$query->the_post();
|
|
218
|
-
the_title('<h2>', '</h2>');
|
|
219
|
-
the_excerpt();
|
|
220
|
-
}
|
|
221
|
-
wp_reset_postdata();
|
|
222
|
-
} else {
|
|
223
|
-
echo '<p>No posts found.</p>';
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
// Advanced query with meta
|
|
227
|
-
$args = [
|
|
228
|
-
'post_type' => 'book',
|
|
229
|
-
'meta_query' => [
|
|
230
|
-
'relation' => 'AND',
|
|
231
|
-
[
|
|
232
|
-
'key' => '_price',
|
|
233
|
-
'value' => 20,
|
|
234
|
-
'compare' => '>=',
|
|
235
|
-
'type' => 'NUMERIC'
|
|
236
|
-
],
|
|
237
|
-
[
|
|
238
|
-
'key' => '_in_stock',
|
|
239
|
-
'value' => '1',
|
|
240
|
-
'compare' => '='
|
|
241
|
-
]
|
|
242
|
-
],
|
|
243
|
-
'tax_query' => [
|
|
244
|
-
[
|
|
245
|
-
'taxonomy' => 'genre',
|
|
246
|
-
'field' => 'slug',
|
|
247
|
-
'terms' => 'fiction'
|
|
248
|
-
]
|
|
249
|
-
]
|
|
250
|
-
];
|
|
251
|
-
|
|
252
|
-
$query = new WP_Query($args);
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
### Shortcodes
|
|
256
|
-
|
|
257
|
-
```php
|
|
258
|
-
<?php
|
|
259
|
-
|
|
260
|
-
// Register shortcode
|
|
261
|
-
add_shortcode('my_shortcode', 'my_shortcode_handler');
|
|
262
|
-
function my_shortcode_handler($atts, $content = null) {
|
|
263
|
-
// Parse attributes
|
|
264
|
-
$atts = shortcode_atts([
|
|
265
|
-
'title' => 'Default Title',
|
|
266
|
-
'count' => 5,
|
|
267
|
-
'type' => 'post'
|
|
268
|
-
], $atts, 'my_shortcode');
|
|
269
|
-
|
|
270
|
-
// Sanitize
|
|
271
|
-
$title = sanitize_text_field($atts['title']);
|
|
272
|
-
$count = absint($atts['count']);
|
|
273
|
-
$type = sanitize_key($atts['type']);
|
|
274
|
-
|
|
275
|
-
// Build output
|
|
276
|
-
ob_start();
|
|
277
|
-
?>
|
|
278
|
-
<div class="my-shortcode">
|
|
279
|
-
<h3><?php echo esc_html($title); ?></h3>
|
|
280
|
-
<?php
|
|
281
|
-
$query = new WP_Query([
|
|
282
|
-
'post_type' => $type,
|
|
283
|
-
'posts_per_page' => $count
|
|
284
|
-
]);
|
|
285
|
-
|
|
286
|
-
if ($query->have_posts()) {
|
|
287
|
-
echo '<ul>';
|
|
288
|
-
while ($query->have_posts()) {
|
|
289
|
-
$query->the_post();
|
|
290
|
-
echo '<li>' . get_the_title() . '</li>';
|
|
291
|
-
}
|
|
292
|
-
echo '</ul>';
|
|
293
|
-
wp_reset_postdata();
|
|
294
|
-
}
|
|
295
|
-
?>
|
|
296
|
-
</div>
|
|
297
|
-
<?php
|
|
298
|
-
return ob_get_clean();
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
// Usage: [my_shortcode title="Recent Posts" count="10" type="post"]
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
### AJAX Handling
|
|
305
|
-
|
|
306
|
-
```php
|
|
307
|
-
<?php
|
|
308
|
-
|
|
309
|
-
// Register AJAX handlers
|
|
310
|
-
add_action('wp_ajax_my_ajax_action', 'my_ajax_handler');
|
|
311
|
-
add_action('wp_ajax_nopriv_my_ajax_action', 'my_ajax_handler');
|
|
312
|
-
|
|
313
|
-
function my_ajax_handler() {
|
|
314
|
-
// Verify nonce
|
|
315
|
-
check_ajax_referer('my-plugin-nonce', 'nonce');
|
|
316
|
-
|
|
317
|
-
// Get data
|
|
318
|
-
$data = isset($_POST['data']) ? sanitize_text_field($_POST['data']) : '';
|
|
319
|
-
|
|
320
|
-
// Process
|
|
321
|
-
$result = process_data($data);
|
|
322
|
-
|
|
323
|
-
// Return JSON
|
|
324
|
-
if ($result) {
|
|
325
|
-
wp_send_json_success([
|
|
326
|
-
'message' => 'Success',
|
|
327
|
-
'data' => $result
|
|
328
|
-
]);
|
|
329
|
-
} else {
|
|
330
|
-
wp_send_json_error([
|
|
331
|
-
'message' => 'Error processing data'
|
|
332
|
-
]);
|
|
333
|
-
}
|
|
334
|
-
}
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
### Security Best Practices
|
|
338
|
-
|
|
339
|
-
#### Nonce Verification
|
|
340
|
-
|
|
341
|
-
```php
|
|
342
|
-
<?php
|
|
343
|
-
|
|
344
|
-
// Create nonce
|
|
345
|
-
$nonce = wp_create_nonce('my-action');
|
|
346
|
-
|
|
347
|
-
// Verify nonce in form submission
|
|
348
|
-
if (!isset($_POST['my_nonce']) || !wp_verify_nonce($_POST['my_nonce'], 'my-action')) {
|
|
349
|
-
wp_die('Security check failed');
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
// Verify nonce in AJAX
|
|
353
|
-
check_ajax_referer('my-ajax-action', 'nonce');
|
|
354
|
-
|
|
355
|
-
// Verify nonce in URL
|
|
356
|
-
if (!isset($_GET['_wpnonce']) || !wp_verify_nonce($_GET['_wpnonce'], 'my-action')) {
|
|
357
|
-
wp_die('Security check failed');
|
|
358
|
-
}
|
|
359
|
-
```
|
|
360
|
-
|
|
361
|
-
#### Data Sanitization
|
|
362
|
-
|
|
363
|
-
```php
|
|
364
|
-
<?php
|
|
365
|
-
|
|
366
|
-
// Sanitize text
|
|
367
|
-
$text = sanitize_text_field($_POST['text']);
|
|
368
|
-
|
|
369
|
-
// Sanitize email
|
|
370
|
-
$email = sanitize_email($_POST['email']);
|
|
371
|
-
|
|
372
|
-
// Sanitize URL
|
|
373
|
-
$url = esc_url_raw($_POST['url']);
|
|
374
|
-
|
|
375
|
-
// Sanitize HTML
|
|
376
|
-
$html = wp_kses_post($_POST['content']);
|
|
377
|
-
|
|
378
|
-
// Sanitize key
|
|
379
|
-
$key = sanitize_key($_POST['key']);
|
|
380
|
-
|
|
381
|
-
// Sanitize file name
|
|
382
|
-
$filename = sanitize_file_name($_FILES['file']['name']);
|
|
383
|
-
|
|
384
|
-
// Sanitize SQL for LIKE
|
|
385
|
-
$search = $wpdb->esc_like($_POST['search']);
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
#### Output Escaping
|
|
389
|
-
|
|
390
|
-
```php
|
|
391
|
-
<?php
|
|
392
|
-
|
|
393
|
-
// Escape HTML
|
|
394
|
-
echo esc_html($text);
|
|
395
|
-
|
|
396
|
-
// Escape attributes
|
|
397
|
-
echo '<input type="text" value="' . esc_attr($value) . '">';
|
|
398
|
-
|
|
399
|
-
// Escape URL
|
|
400
|
-
echo '<a href="' . esc_url($url) . '">Link</a>';
|
|
401
|
-
|
|
402
|
-
// Escape JavaScript
|
|
403
|
-
echo '<script>var data = "' . esc_js($data) . '";</script>';
|
|
404
|
-
|
|
405
|
-
// Escape textarea
|
|
406
|
-
echo '<textarea>' . esc_textarea($content) . '</textarea>';
|
|
407
|
-
```
|
|
408
|
-
|
|
409
|
-
#### Capability Checks
|
|
410
|
-
|
|
411
|
-
```php
|
|
412
|
-
<?php
|
|
413
|
-
|
|
414
|
-
// Check if user can edit posts
|
|
415
|
-
if (!current_user_can('edit_posts')) {
|
|
416
|
-
wp_die('You do not have permission');
|
|
417
|
-
}
|
|
418
|
-
|
|
419
|
-
// Check if user can manage options
|
|
420
|
-
if (!current_user_can('manage_options')) {
|
|
421
|
-
return;
|
|
422
|
-
}
|
|
423
|
-
|
|
424
|
-
// Check if user can edit specific post
|
|
425
|
-
if (!current_user_can('edit_post', $post_id)) {
|
|
426
|
-
wp_die('You cannot edit this post');
|
|
427
|
-
}
|
|
428
|
-
```
|
|
429
|
-
|
|
430
|
-
## Drupal Development
|
|
431
|
-
|
|
432
|
-
### Module Structure
|
|
433
|
-
|
|
434
|
-
```php
|
|
435
|
-
<?php
|
|
436
|
-
|
|
437
|
-
// my_module.info.yml
|
|
438
|
-
name: My Module
|
|
439
|
-
type: module
|
|
440
|
-
description: 'A custom Drupal module'
|
|
441
|
-
core_version_requirement: ^9 || ^10
|
|
442
|
-
package: Custom
|
|
443
|
-
dependencies:
|
|
444
|
-
- drupal:node
|
|
445
|
-
- drupal:user
|
|
446
|
-
```
|
|
447
|
-
|
|
448
|
-
### Hooks
|
|
449
|
-
|
|
450
|
-
```php
|
|
451
|
-
<?php
|
|
452
|
-
|
|
453
|
-
/**
|
|
454
|
-
* Implements hook_help().
|
|
455
|
-
*/
|
|
456
|
-
function my_module_help($route_name, RouteMatchInterface $route_match) {
|
|
457
|
-
switch ($route_name) {
|
|
458
|
-
case 'help.page.my_module':
|
|
459
|
-
return '<p>' . t('Help text for my module.') . '</p>';
|
|
460
|
-
}
|
|
461
|
-
}
|
|
462
|
-
|
|
463
|
-
/**
|
|
464
|
-
* Implements hook_node_presave().
|
|
465
|
-
*/
|
|
466
|
-
function my_module_node_presave(NodeInterface $node) {
|
|
467
|
-
if ($node->getType() == 'article') {
|
|
468
|
-
// Modify node before saving
|
|
469
|
-
$node->setTitle('Modified: ' . $node->getTitle());
|
|
470
|
-
}
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
/**
|
|
474
|
-
* Implements hook_form_alter().
|
|
475
|
-
*/
|
|
476
|
-
function my_module_form_alter(&$form, FormStateInterface $form_state, $form_id) {
|
|
477
|
-
if ($form_id == 'node_article_form') {
|
|
478
|
-
$form['title']['#description'] = t('Custom description');
|
|
479
|
-
}
|
|
480
|
-
}
|
|
481
|
-
```
|
|
482
|
-
|
|
483
|
-
### Services
|
|
484
|
-
|
|
485
|
-
```php
|
|
486
|
-
<?php
|
|
487
|
-
|
|
488
|
-
namespace Drupal\my_module\Service;
|
|
489
|
-
|
|
490
|
-
use Drupal\Core\Database\Connection;
|
|
491
|
-
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
|
|
492
|
-
|
|
493
|
-
class MyService {
|
|
494
|
-
|
|
495
|
-
protected $database;
|
|
496
|
-
protected $logger;
|
|
497
|
-
|
|
498
|
-
public function __construct(
|
|
499
|
-
Connection $database,
|
|
500
|
-
LoggerChannelFactoryInterface $logger_factory
|
|
501
|
-
) {
|
|
502
|
-
$this->database = $database;
|
|
503
|
-
$this->logger = $logger_factory->get('my_module');
|
|
504
|
-
}
|
|
505
|
-
|
|
506
|
-
public function processData($data) {
|
|
507
|
-
try {
|
|
508
|
-
// Process data
|
|
509
|
-
$this->logger->info('Data processed successfully');
|
|
510
|
-
return true;
|
|
511
|
-
} catch (\Exception $e) {
|
|
512
|
-
$this->logger->error('Error: @message', ['@message' => $e->getMessage()]);
|
|
513
|
-
return false;
|
|
514
|
-
}
|
|
515
|
-
}
|
|
516
|
-
}
|
|
517
|
-
```
|
|
518
|
-
|
|
519
|
-
## Best Practices
|
|
520
|
-
|
|
521
|
-
### ✅ DO
|
|
522
|
-
|
|
523
|
-
- Use WordPress/Drupal coding standards
|
|
524
|
-
- Verify nonces for all form submissions
|
|
525
|
-
- Sanitize all input data
|
|
526
|
-
- Escape all output data
|
|
527
|
-
- Check user capabilities before operations
|
|
528
|
-
- Use translation functions for all strings
|
|
529
|
-
- Prefix all function/class names
|
|
530
|
-
- Use hooks and filters instead of modifying core
|
|
531
|
-
- Follow semantic versioning
|
|
532
|
-
- Document code with PHPDoc
|
|
533
|
-
- Use prepared statements for database queries
|
|
534
|
-
- Implement proper error handling
|
|
535
|
-
|
|
536
|
-
### ❌ DON'T
|
|
537
|
-
|
|
538
|
-
- Modify core files
|
|
539
|
-
- Use global variables unnecessarily
|
|
540
|
-
- Trust user input
|
|
541
|
-
- Output unescaped data
|
|
542
|
-
- Hardcode database table names
|
|
543
|
-
- Use deprecated functions
|
|
544
|
-
- Ignore coding standards
|
|
545
|
-
- Skip nonce verification
|
|
546
|
-
- Use direct database queries without sanitization
|
|
547
|
-
- Suppress errors in production
|
|
548
|
-
|
|
549
|
-
## Security Checklist
|
|
550
|
-
|
|
551
|
-
- [ ] Nonce verification on all forms
|
|
552
|
-
- [ ] Input sanitization
|
|
553
|
-
- [ ] Output escaping
|
|
554
|
-
- [ ] Capability checks
|
|
555
|
-
- [ ] SQL injection prevention (prepared statements)
|
|
556
|
-
- [ ] XSS prevention
|
|
557
|
-
- [ ] CSRF protection
|
|
558
|
-
- [ ] File upload validation
|
|
559
|
-
- [ ] Secure AJAX handlers
|
|
560
|
-
- [ ] Proper error handling (no sensitive data exposure)
|
|
561
|
-
|
|
1
|
+
# PHP CMS Integration Best Practices
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This guide provides best practices for developing WordPress and Drupal plugins/modules, including hooks, filters, security, database interactions, and CMS-specific patterns.
|
|
6
|
+
|
|
7
|
+
## WordPress Development
|
|
8
|
+
|
|
9
|
+
### Plugin Structure
|
|
10
|
+
|
|
11
|
+
```php
|
|
12
|
+
<?php
|
|
13
|
+
/**
|
|
14
|
+
* Plugin Name: My Custom Plugin
|
|
15
|
+
* Plugin URI: https://example.com/my-plugin
|
|
16
|
+
* Description: A custom WordPress plugin
|
|
17
|
+
* Version: 1.0.0
|
|
18
|
+
* Author: Your Name
|
|
19
|
+
* Author URI: https://example.com
|
|
20
|
+
* License: GPL v2 or later
|
|
21
|
+
* Text Domain: my-custom-plugin
|
|
22
|
+
* Domain Path: /languages
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
// Prevent direct access
|
|
26
|
+
if (!defined('ABSPATH')) {
|
|
27
|
+
exit;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// Define plugin constants
|
|
31
|
+
define('MY_PLUGIN_VERSION', '1.0.0');
|
|
32
|
+
define('MY_PLUGIN_PATH', plugin_dir_path(__FILE__));
|
|
33
|
+
define('MY_PLUGIN_URL', plugin_dir_url(__FILE__));
|
|
34
|
+
|
|
35
|
+
// Autoloader
|
|
36
|
+
require_once MY_PLUGIN_PATH . 'includes/class-my-plugin.php';
|
|
37
|
+
|
|
38
|
+
// Initialize plugin
|
|
39
|
+
function my_plugin_init() {
|
|
40
|
+
$plugin = new My_Plugin();
|
|
41
|
+
$plugin->run();
|
|
42
|
+
}
|
|
43
|
+
add_action('plugins_loaded', 'my_plugin_init');
|
|
44
|
+
|
|
45
|
+
// Activation hook
|
|
46
|
+
register_activation_hook(__FILE__, 'my_plugin_activate');
|
|
47
|
+
function my_plugin_activate() {
|
|
48
|
+
// Create database tables, set default options, etc.
|
|
49
|
+
flush_rewrite_rules();
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// Deactivation hook
|
|
53
|
+
register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
|
|
54
|
+
function my_plugin_deactivate() {
|
|
55
|
+
flush_rewrite_rules();
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Hooks and Filters
|
|
60
|
+
|
|
61
|
+
#### Actions
|
|
62
|
+
|
|
63
|
+
```php
|
|
64
|
+
<?php
|
|
65
|
+
|
|
66
|
+
// Add custom action
|
|
67
|
+
add_action('init', 'my_custom_init_function');
|
|
68
|
+
function my_custom_init_function() {
|
|
69
|
+
// Register custom post types, taxonomies, etc.
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Admin menu
|
|
73
|
+
add_action('admin_menu', 'my_plugin_add_admin_menu');
|
|
74
|
+
function my_plugin_add_admin_menu() {
|
|
75
|
+
add_menu_page(
|
|
76
|
+
'My Plugin', // Page title
|
|
77
|
+
'My Plugin', // Menu title
|
|
78
|
+
'manage_options', // Capability
|
|
79
|
+
'my-plugin', // Menu slug
|
|
80
|
+
'my_plugin_admin_page', // Callback
|
|
81
|
+
'dashicons-admin-generic', // Icon
|
|
82
|
+
20 // Position
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// Enqueue scripts and styles
|
|
87
|
+
add_action('wp_enqueue_scripts', 'my_plugin_enqueue_assets');
|
|
88
|
+
function my_plugin_enqueue_assets() {
|
|
89
|
+
wp_enqueue_style(
|
|
90
|
+
'my-plugin-style',
|
|
91
|
+
MY_PLUGIN_URL . 'assets/css/style.css',
|
|
92
|
+
[],
|
|
93
|
+
MY_PLUGIN_VERSION
|
|
94
|
+
);
|
|
95
|
+
|
|
96
|
+
wp_enqueue_script(
|
|
97
|
+
'my-plugin-script',
|
|
98
|
+
MY_PLUGIN_URL . 'assets/js/script.js',
|
|
99
|
+
['jquery'],
|
|
100
|
+
MY_PLUGIN_VERSION,
|
|
101
|
+
true
|
|
102
|
+
);
|
|
103
|
+
|
|
104
|
+
// Localize script
|
|
105
|
+
wp_localize_script('my-plugin-script', 'myPluginData', [
|
|
106
|
+
'ajaxUrl' => admin_url('admin-ajax.php'),
|
|
107
|
+
'nonce' => wp_create_nonce('my-plugin-nonce')
|
|
108
|
+
]);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// Save post hook
|
|
112
|
+
add_action('save_post', 'my_plugin_save_post_meta', 10, 2);
|
|
113
|
+
function my_plugin_save_post_meta($post_id, $post) {
|
|
114
|
+
// Verify nonce
|
|
115
|
+
if (!isset($_POST['my_plugin_nonce']) ||
|
|
116
|
+
!wp_verify_nonce($_POST['my_plugin_nonce'], 'my_plugin_save')) {
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// Check autosave
|
|
121
|
+
if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
|
|
122
|
+
return;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
// Check permissions
|
|
126
|
+
if (!current_user_can('edit_post', $post_id)) {
|
|
127
|
+
return;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// Save meta
|
|
131
|
+
if (isset($_POST['my_custom_field'])) {
|
|
132
|
+
update_post_meta(
|
|
133
|
+
$post_id,
|
|
134
|
+
'_my_custom_field',
|
|
135
|
+
sanitize_text_field($_POST['my_custom_field'])
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
#### Filters
|
|
142
|
+
|
|
143
|
+
```php
|
|
144
|
+
<?php
|
|
145
|
+
|
|
146
|
+
// Modify content
|
|
147
|
+
add_filter('the_content', 'my_plugin_modify_content');
|
|
148
|
+
function my_plugin_modify_content($content) {
|
|
149
|
+
if (is_single()) {
|
|
150
|
+
$custom_content = '<div class="custom-notice">Custom notice</div>';
|
|
151
|
+
$content = $custom_content . $content;
|
|
152
|
+
}
|
|
153
|
+
return $content;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
// Modify query
|
|
157
|
+
add_filter('pre_get_posts', 'my_plugin_modify_query');
|
|
158
|
+
function my_plugin_modify_query($query) {
|
|
159
|
+
if (!is_admin() && $query->is_main_query() && $query->is_home()) {
|
|
160
|
+
$query->set('posts_per_page', 20);
|
|
161
|
+
}
|
|
162
|
+
return $query;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
// Add custom body class
|
|
166
|
+
add_filter('body_class', 'my_plugin_body_class');
|
|
167
|
+
function my_plugin_body_class($classes) {
|
|
168
|
+
if (is_page('special-page')) {
|
|
169
|
+
$classes[] = 'special-page-class';
|
|
170
|
+
}
|
|
171
|
+
return $classes;
|
|
172
|
+
}
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### Custom Post Types
|
|
176
|
+
|
|
177
|
+
```php
|
|
178
|
+
<?php
|
|
179
|
+
|
|
180
|
+
add_action('init', 'my_plugin_register_post_type');
|
|
181
|
+
function my_plugin_register_post_type() {
|
|
182
|
+
register_post_type('book', [
|
|
183
|
+
'labels' => [
|
|
184
|
+
'name' => __('Books', 'my-plugin'),
|
|
185
|
+
'singular_name' => __('Book', 'my-plugin'),
|
|
186
|
+
'add_new' => __('Add New Book', 'my-plugin'),
|
|
187
|
+
'add_new_item' => __('Add New Book', 'my-plugin'),
|
|
188
|
+
'edit_item' => __('Edit Book', 'my-plugin'),
|
|
189
|
+
],
|
|
190
|
+
'public' => true,
|
|
191
|
+
'has_archive' => true,
|
|
192
|
+
'rewrite' => ['slug' => 'books'],
|
|
193
|
+
'supports' => ['title', 'editor', 'thumbnail', 'excerpt'],
|
|
194
|
+
'menu_icon' => 'dashicons-book',
|
|
195
|
+
'show_in_rest' => true, // Enable Gutenberg
|
|
196
|
+
]);
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### WP_Query
|
|
201
|
+
|
|
202
|
+
```php
|
|
203
|
+
<?php
|
|
204
|
+
|
|
205
|
+
// Basic query
|
|
206
|
+
$args = [
|
|
207
|
+
'post_type' => 'post',
|
|
208
|
+
'posts_per_page' => 10,
|
|
209
|
+
'orderby' => 'date',
|
|
210
|
+
'order' => 'DESC',
|
|
211
|
+
];
|
|
212
|
+
|
|
213
|
+
$query = new WP_Query($args);
|
|
214
|
+
|
|
215
|
+
if ($query->have_posts()) {
|
|
216
|
+
while ($query->have_posts()) {
|
|
217
|
+
$query->the_post();
|
|
218
|
+
the_title('<h2>', '</h2>');
|
|
219
|
+
the_excerpt();
|
|
220
|
+
}
|
|
221
|
+
wp_reset_postdata();
|
|
222
|
+
} else {
|
|
223
|
+
echo '<p>No posts found.</p>';
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
// Advanced query with meta
|
|
227
|
+
$args = [
|
|
228
|
+
'post_type' => 'book',
|
|
229
|
+
'meta_query' => [
|
|
230
|
+
'relation' => 'AND',
|
|
231
|
+
[
|
|
232
|
+
'key' => '_price',
|
|
233
|
+
'value' => 20,
|
|
234
|
+
'compare' => '>=',
|
|
235
|
+
'type' => 'NUMERIC'
|
|
236
|
+
],
|
|
237
|
+
[
|
|
238
|
+
'key' => '_in_stock',
|
|
239
|
+
'value' => '1',
|
|
240
|
+
'compare' => '='
|
|
241
|
+
]
|
|
242
|
+
],
|
|
243
|
+
'tax_query' => [
|
|
244
|
+
[
|
|
245
|
+
'taxonomy' => 'genre',
|
|
246
|
+
'field' => 'slug',
|
|
247
|
+
'terms' => 'fiction'
|
|
248
|
+
]
|
|
249
|
+
]
|
|
250
|
+
];
|
|
251
|
+
|
|
252
|
+
$query = new WP_Query($args);
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### Shortcodes
|
|
256
|
+
|
|
257
|
+
```php
|
|
258
|
+
<?php
|
|
259
|
+
|
|
260
|
+
// Register shortcode
|
|
261
|
+
add_shortcode('my_shortcode', 'my_shortcode_handler');
|
|
262
|
+
function my_shortcode_handler($atts, $content = null) {
|
|
263
|
+
// Parse attributes
|
|
264
|
+
$atts = shortcode_atts([
|
|
265
|
+
'title' => 'Default Title',
|
|
266
|
+
'count' => 5,
|
|
267
|
+
'type' => 'post'
|
|
268
|
+
], $atts, 'my_shortcode');
|
|
269
|
+
|
|
270
|
+
// Sanitize
|
|
271
|
+
$title = sanitize_text_field($atts['title']);
|
|
272
|
+
$count = absint($atts['count']);
|
|
273
|
+
$type = sanitize_key($atts['type']);
|
|
274
|
+
|
|
275
|
+
// Build output
|
|
276
|
+
ob_start();
|
|
277
|
+
?>
|
|
278
|
+
<div class="my-shortcode">
|
|
279
|
+
<h3><?php echo esc_html($title); ?></h3>
|
|
280
|
+
<?php
|
|
281
|
+
$query = new WP_Query([
|
|
282
|
+
'post_type' => $type,
|
|
283
|
+
'posts_per_page' => $count
|
|
284
|
+
]);
|
|
285
|
+
|
|
286
|
+
if ($query->have_posts()) {
|
|
287
|
+
echo '<ul>';
|
|
288
|
+
while ($query->have_posts()) {
|
|
289
|
+
$query->the_post();
|
|
290
|
+
echo '<li>' . get_the_title() . '</li>';
|
|
291
|
+
}
|
|
292
|
+
echo '</ul>';
|
|
293
|
+
wp_reset_postdata();
|
|
294
|
+
}
|
|
295
|
+
?>
|
|
296
|
+
</div>
|
|
297
|
+
<?php
|
|
298
|
+
return ob_get_clean();
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
// Usage: [my_shortcode title="Recent Posts" count="10" type="post"]
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
### AJAX Handling
|
|
305
|
+
|
|
306
|
+
```php
|
|
307
|
+
<?php
|
|
308
|
+
|
|
309
|
+
// Register AJAX handlers
|
|
310
|
+
add_action('wp_ajax_my_ajax_action', 'my_ajax_handler');
|
|
311
|
+
add_action('wp_ajax_nopriv_my_ajax_action', 'my_ajax_handler');
|
|
312
|
+
|
|
313
|
+
function my_ajax_handler() {
|
|
314
|
+
// Verify nonce
|
|
315
|
+
check_ajax_referer('my-plugin-nonce', 'nonce');
|
|
316
|
+
|
|
317
|
+
// Get data
|
|
318
|
+
$data = isset($_POST['data']) ? sanitize_text_field($_POST['data']) : '';
|
|
319
|
+
|
|
320
|
+
// Process
|
|
321
|
+
$result = process_data($data);
|
|
322
|
+
|
|
323
|
+
// Return JSON
|
|
324
|
+
if ($result) {
|
|
325
|
+
wp_send_json_success([
|
|
326
|
+
'message' => 'Success',
|
|
327
|
+
'data' => $result
|
|
328
|
+
]);
|
|
329
|
+
} else {
|
|
330
|
+
wp_send_json_error([
|
|
331
|
+
'message' => 'Error processing data'
|
|
332
|
+
]);
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### Security Best Practices
|
|
338
|
+
|
|
339
|
+
#### Nonce Verification
|
|
340
|
+
|
|
341
|
+
```php
|
|
342
|
+
<?php
|
|
343
|
+
|
|
344
|
+
// Create nonce
|
|
345
|
+
$nonce = wp_create_nonce('my-action');
|
|
346
|
+
|
|
347
|
+
// Verify nonce in form submission
|
|
348
|
+
if (!isset($_POST['my_nonce']) || !wp_verify_nonce($_POST['my_nonce'], 'my-action')) {
|
|
349
|
+
wp_die('Security check failed');
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
// Verify nonce in AJAX
|
|
353
|
+
check_ajax_referer('my-ajax-action', 'nonce');
|
|
354
|
+
|
|
355
|
+
// Verify nonce in URL
|
|
356
|
+
if (!isset($_GET['_wpnonce']) || !wp_verify_nonce($_GET['_wpnonce'], 'my-action')) {
|
|
357
|
+
wp_die('Security check failed');
|
|
358
|
+
}
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
#### Data Sanitization
|
|
362
|
+
|
|
363
|
+
```php
|
|
364
|
+
<?php
|
|
365
|
+
|
|
366
|
+
// Sanitize text
|
|
367
|
+
$text = sanitize_text_field($_POST['text']);
|
|
368
|
+
|
|
369
|
+
// Sanitize email
|
|
370
|
+
$email = sanitize_email($_POST['email']);
|
|
371
|
+
|
|
372
|
+
// Sanitize URL
|
|
373
|
+
$url = esc_url_raw($_POST['url']);
|
|
374
|
+
|
|
375
|
+
// Sanitize HTML
|
|
376
|
+
$html = wp_kses_post($_POST['content']);
|
|
377
|
+
|
|
378
|
+
// Sanitize key
|
|
379
|
+
$key = sanitize_key($_POST['key']);
|
|
380
|
+
|
|
381
|
+
// Sanitize file name
|
|
382
|
+
$filename = sanitize_file_name($_FILES['file']['name']);
|
|
383
|
+
|
|
384
|
+
// Sanitize SQL for LIKE
|
|
385
|
+
$search = $wpdb->esc_like($_POST['search']);
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
#### Output Escaping
|
|
389
|
+
|
|
390
|
+
```php
|
|
391
|
+
<?php
|
|
392
|
+
|
|
393
|
+
// Escape HTML
|
|
394
|
+
echo esc_html($text);
|
|
395
|
+
|
|
396
|
+
// Escape attributes
|
|
397
|
+
echo '<input type="text" value="' . esc_attr($value) . '">';
|
|
398
|
+
|
|
399
|
+
// Escape URL
|
|
400
|
+
echo '<a href="' . esc_url($url) . '">Link</a>';
|
|
401
|
+
|
|
402
|
+
// Escape JavaScript
|
|
403
|
+
echo '<script>var data = "' . esc_js($data) . '";</script>';
|
|
404
|
+
|
|
405
|
+
// Escape textarea
|
|
406
|
+
echo '<textarea>' . esc_textarea($content) . '</textarea>';
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
#### Capability Checks
|
|
410
|
+
|
|
411
|
+
```php
|
|
412
|
+
<?php
|
|
413
|
+
|
|
414
|
+
// Check if user can edit posts
|
|
415
|
+
if (!current_user_can('edit_posts')) {
|
|
416
|
+
wp_die('You do not have permission');
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
// Check if user can manage options
|
|
420
|
+
if (!current_user_can('manage_options')) {
|
|
421
|
+
return;
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
// Check if user can edit specific post
|
|
425
|
+
if (!current_user_can('edit_post', $post_id)) {
|
|
426
|
+
wp_die('You cannot edit this post');
|
|
427
|
+
}
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
## Drupal Development
|
|
431
|
+
|
|
432
|
+
### Module Structure
|
|
433
|
+
|
|
434
|
+
```php
|
|
435
|
+
<?php
|
|
436
|
+
|
|
437
|
+
// my_module.info.yml
|
|
438
|
+
name: My Module
|
|
439
|
+
type: module
|
|
440
|
+
description: 'A custom Drupal module'
|
|
441
|
+
core_version_requirement: ^9 || ^10
|
|
442
|
+
package: Custom
|
|
443
|
+
dependencies:
|
|
444
|
+
- drupal:node
|
|
445
|
+
- drupal:user
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### Hooks
|
|
449
|
+
|
|
450
|
+
```php
|
|
451
|
+
<?php
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* Implements hook_help().
|
|
455
|
+
*/
|
|
456
|
+
function my_module_help($route_name, RouteMatchInterface $route_match) {
|
|
457
|
+
switch ($route_name) {
|
|
458
|
+
case 'help.page.my_module':
|
|
459
|
+
return '<p>' . t('Help text for my module.') . '</p>';
|
|
460
|
+
}
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* Implements hook_node_presave().
|
|
465
|
+
*/
|
|
466
|
+
function my_module_node_presave(NodeInterface $node) {
|
|
467
|
+
if ($node->getType() == 'article') {
|
|
468
|
+
// Modify node before saving
|
|
469
|
+
$node->setTitle('Modified: ' . $node->getTitle());
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* Implements hook_form_alter().
|
|
475
|
+
*/
|
|
476
|
+
function my_module_form_alter(&$form, FormStateInterface $form_state, $form_id) {
|
|
477
|
+
if ($form_id == 'node_article_form') {
|
|
478
|
+
$form['title']['#description'] = t('Custom description');
|
|
479
|
+
}
|
|
480
|
+
}
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
### Services
|
|
484
|
+
|
|
485
|
+
```php
|
|
486
|
+
<?php
|
|
487
|
+
|
|
488
|
+
namespace Drupal\my_module\Service;
|
|
489
|
+
|
|
490
|
+
use Drupal\Core\Database\Connection;
|
|
491
|
+
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
|
|
492
|
+
|
|
493
|
+
class MyService {
|
|
494
|
+
|
|
495
|
+
protected $database;
|
|
496
|
+
protected $logger;
|
|
497
|
+
|
|
498
|
+
public function __construct(
|
|
499
|
+
Connection $database,
|
|
500
|
+
LoggerChannelFactoryInterface $logger_factory
|
|
501
|
+
) {
|
|
502
|
+
$this->database = $database;
|
|
503
|
+
$this->logger = $logger_factory->get('my_module');
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
public function processData($data) {
|
|
507
|
+
try {
|
|
508
|
+
// Process data
|
|
509
|
+
$this->logger->info('Data processed successfully');
|
|
510
|
+
return true;
|
|
511
|
+
} catch (\Exception $e) {
|
|
512
|
+
$this->logger->error('Error: @message', ['@message' => $e->getMessage()]);
|
|
513
|
+
return false;
|
|
514
|
+
}
|
|
515
|
+
}
|
|
516
|
+
}
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
## Best Practices
|
|
520
|
+
|
|
521
|
+
### ✅ DO
|
|
522
|
+
|
|
523
|
+
- Use WordPress/Drupal coding standards
|
|
524
|
+
- Verify nonces for all form submissions
|
|
525
|
+
- Sanitize all input data
|
|
526
|
+
- Escape all output data
|
|
527
|
+
- Check user capabilities before operations
|
|
528
|
+
- Use translation functions for all strings
|
|
529
|
+
- Prefix all function/class names
|
|
530
|
+
- Use hooks and filters instead of modifying core
|
|
531
|
+
- Follow semantic versioning
|
|
532
|
+
- Document code with PHPDoc
|
|
533
|
+
- Use prepared statements for database queries
|
|
534
|
+
- Implement proper error handling
|
|
535
|
+
|
|
536
|
+
### ❌ DON'T
|
|
537
|
+
|
|
538
|
+
- Modify core files
|
|
539
|
+
- Use global variables unnecessarily
|
|
540
|
+
- Trust user input
|
|
541
|
+
- Output unescaped data
|
|
542
|
+
- Hardcode database table names
|
|
543
|
+
- Use deprecated functions
|
|
544
|
+
- Ignore coding standards
|
|
545
|
+
- Skip nonce verification
|
|
546
|
+
- Use direct database queries without sanitization
|
|
547
|
+
- Suppress errors in production
|
|
548
|
+
|
|
549
|
+
## Security Checklist
|
|
550
|
+
|
|
551
|
+
- [ ] Nonce verification on all forms
|
|
552
|
+
- [ ] Input sanitization
|
|
553
|
+
- [ ] Output escaping
|
|
554
|
+
- [ ] Capability checks
|
|
555
|
+
- [ ] SQL injection prevention (prepared statements)
|
|
556
|
+
- [ ] XSS prevention
|
|
557
|
+
- [ ] CSRF protection
|
|
558
|
+
- [ ] File upload validation
|
|
559
|
+
- [ ] Secure AJAX handlers
|
|
560
|
+
- [ ] Proper error handling (no sensitive data exposure)
|
|
561
|
+
|