heraspec 0.1.14 → 0.1.16
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/LICENSE +187 -0
- package/README.md +140 -107
- package/bin/heraspec.js +1491 -155
- package/bin/heraspec.js.map +4 -4
- package/dist/cli/index.d.ts +2 -0
- package/dist/commands/audit.d.ts +37 -0
- package/dist/commands/create.d.ts +11 -0
- package/dist/commands/explore.d.ts +17 -0
- package/dist/commands/helper.d.ts +13 -0
- package/dist/commands/hotfix.d.ts +9 -0
- package/dist/commands/make-code.d.ts +14 -0
- package/dist/commands/make-docs.d.ts +36 -0
- package/dist/commands/make-test.d.ts +60 -0
- package/dist/commands/memory.d.ts +101 -0
- package/dist/commands/pack.d.ts +17 -0
- package/dist/commands/show.d.ts +8 -0
- package/dist/commands/skill.d.ts +8 -0
- package/dist/commands/suggest.d.ts +32 -0
- package/dist/commands/validate.d.ts +8 -0
- package/dist/core/archive.d.ts +14 -0
- package/dist/core/config.d.ts +33 -0
- package/dist/core/init.d.ts +97 -0
- package/dist/core/list.d.ts +7 -0
- package/dist/core/memory/config-advisor.d.ts +30 -0
- package/dist/core/memory/context-config.d.ts +14 -0
- package/dist/core/memory/context-generator.d.ts +19 -0
- package/dist/core/memory/index.d.ts +12 -0
- package/dist/core/memory/memory-schema.d.ts +34 -0
- package/dist/core/memory/memory-search.d.ts +45 -0
- package/dist/core/memory/memory-store.d.ts +71 -0
- package/dist/core/memory/memory-types.d.ts +159 -0
- package/dist/core/memory/memory-vector.d.ts +23 -0
- package/dist/core/parsers/code-parser.d.ts +53 -0
- package/dist/core/parsers/markdown-parser.d.ts +18 -0
- package/dist/core/restore.d.ts +9 -0
- package/dist/core/schemas/base.schema.d.ts +55 -0
- package/dist/core/schemas/change.schema.d.ts +35 -0
- package/dist/core/schemas/index.d.ts +7 -0
- package/dist/core/schemas/spec.schema.d.ts +50 -0
- package/dist/core/skills/index.d.ts +6 -0
- package/dist/core/skills/skill-manager.d.ts +28 -0
- package/dist/core/skills/skill-parser.d.ts +24 -0
- package/dist/core/sync.d.ts +6 -0
- package/dist/core/templates/index.d.ts +10 -0
- package/dist/core/templates/skills/README.md +44 -38
- package/dist/core/templates/skills/campaign-plan/skill.md +76 -0
- package/dist/core/templates/skills/campaign-plan/skill.vi.md +76 -0
- package/dist/core/templates/skills/campaign-plan-skill.md +76 -0
- package/dist/core/templates/skills/campaign-plan-skill.vi.md +76 -0
- package/dist/core/templates/skills/code-review/skill.md +70 -0
- package/dist/core/templates/skills/code-review/skill.vi.md +70 -0
- package/dist/core/templates/skills/code-review-skill.md +70 -0
- package/dist/core/templates/skills/code-review-skill.vi.md +70 -0
- package/dist/core/templates/skills/content-creation/skill.md +69 -0
- package/dist/core/templates/skills/content-creation/skill.vi.md +69 -0
- package/dist/core/templates/skills/content-creation-skill.md +69 -0
- package/dist/core/templates/skills/content-creation-skill.vi.md +69 -0
- package/dist/core/templates/skills/content-optimization/skill.md +104 -0
- package/dist/core/templates/skills/debug/skill.md +69 -0
- package/dist/core/templates/skills/debug/skill.vi.md +69 -0
- package/dist/core/templates/skills/debug-skill.md +69 -0
- package/dist/core/templates/skills/debug-skill.vi.md +69 -0
- package/dist/core/templates/skills/deploy-documentation/skill.md +408 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/airbnb/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/airtable/DESIGN.md +89 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/apple/DESIGN.md +313 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/bmw/DESIGN.md +180 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cal/DESIGN.md +259 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/claude/DESIGN.md +312 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/clay/DESIGN.md +304 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/clickhouse/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cohere/DESIGN.md +266 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/coinbase/DESIGN.md +129 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/composio/DESIGN.md +307 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/cursor/DESIGN.md +309 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/elevenlabs/DESIGN.md +265 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/expo/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/figma/DESIGN.md +220 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/framer/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/hashicorp/DESIGN.md +278 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/ibm/DESIGN.md +332 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/index.json +72 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/intercom/DESIGN.md +146 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/kraken/DESIGN.md +125 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/linear.app/DESIGN.md +367 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/lovable/DESIGN.md +298 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/minimax/DESIGN.md +257 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mintlify/DESIGN.md +326 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/miro/DESIGN.md +108 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mistral.ai/DESIGN.md +261 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/mongodb/DESIGN.md +266 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/notion/DESIGN.md +309 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/nvidia/DESIGN.md +293 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/ollama/DESIGN.md +267 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/opencode.ai/DESIGN.md +281 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/pinterest/DESIGN.md +230 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/posthog/DESIGN.md +256 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/raycast/DESIGN.md +268 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/replicate/DESIGN.md +261 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/resend/DESIGN.md +303 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/revolut/DESIGN.md +185 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/runwayml/DESIGN.md +244 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/sanity/DESIGN.md +357 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/sentry/DESIGN.md +262 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/spacex/DESIGN.md +194 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/spotify/DESIGN.md +246 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/stripe/DESIGN.md +322 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/supabase/DESIGN.md +255 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/superhuman/DESIGN.md +252 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/together.ai/DESIGN.md +263 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/uber/DESIGN.md +295 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/vercel/DESIGN.md +310 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/voltagent/DESIGN.md +323 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/warp/DESIGN.md +253 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/webflow/DESIGN.md +92 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/wise/DESIGN.md +173 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/x.ai/DESIGN.md +257 -0
- package/dist/core/templates/skills/design-system/knowledge/design-systems/zapier/DESIGN.md +328 -0
- package/dist/core/templates/skills/design-system/skill.md +176 -0
- package/dist/core/templates/skills/documents/skill.md +104 -0
- package/dist/core/templates/skills/e2e-test/skill.md +119 -0
- package/dist/core/templates/skills/email-sequence/skill.md +68 -0
- package/dist/core/templates/skills/email-sequence/skill.vi.md +68 -0
- package/dist/core/templates/skills/email-sequence-skill.md +68 -0
- package/dist/core/templates/skills/email-sequence-skill.vi.md +68 -0
- package/dist/core/templates/skills/git-embed/skill.md +57 -0
- package/dist/core/templates/skills/integration-test/skill.md +118 -0
- package/dist/core/templates/skills/knowledge/README.md +63 -63
- package/dist/core/templates/skills/knowledge/design-systems/index.json +72 -72
- package/dist/core/templates/skills/knowledge/frameworks/php/codeigniter/rise-cms/profile.json +27 -27
- package/dist/core/templates/skills/knowledge/frameworks/php/codeigniter/rise-cms/structure.md +137 -137
- package/dist/core/templates/skills/knowledge/frameworks/php/laravel/botble/profile.json +39 -39
- package/dist/core/templates/skills/knowledge/frameworks/php/laravel/botble/structure.md +207 -207
- package/dist/core/templates/skills/knowledge/frameworks/php/wordpress/core/profile.json +51 -51
- package/dist/core/templates/skills/knowledge/frameworks/php/wordpress/core/structure.md +369 -369
- package/dist/core/templates/skills/knowledge/index.json +65 -65
- package/dist/core/templates/skills/perfex-module/code-quality-guidelines/skill.md +130 -0
- package/dist/core/templates/skills/perfex-module/envato-review-guidelines/skill.md +132 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/scripts/scaffold-module.js +151 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/skill.md +204 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/Test_Module.php +79 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/controller-admin.php +71 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/controller-api.php +58 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/deploy.ps1 +97 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/helper.php +97 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/install.php +30 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/model-main.php +94 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/module-main.php +91 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/package.json +30 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/uninstall.php +11 -0
- package/dist/core/templates/skills/perfex-module/module-codebase/templates/webpack.config.js +163 -0
- package/dist/core/templates/skills/perfex-module/skill.md +50 -0
- package/dist/core/templates/skills/project-memory/skill.md +222 -0
- package/dist/core/templates/skills/project-memory/skill.vi.md +223 -0
- package/dist/core/templates/skills/seo-audit/skill.md +75 -0
- package/dist/core/templates/skills/seo-audit/skill.vi.md +75 -0
- package/dist/core/templates/skills/seo-audit-skill.md +75 -0
- package/dist/core/templates/skills/seo-audit-skill.vi.md +75 -0
- package/dist/core/templates/skills/smart-explore/skill.md +141 -0
- package/dist/core/templates/skills/sourcecode-analyzer/skill.md +210 -0
- package/dist/core/templates/skills/sourcecode-analyzer/skill.vi.md +210 -0
- package/dist/core/templates/skills/spec-writer/skill.md +61 -0
- package/dist/core/templates/skills/spec-writer/skill.vi.md +61 -0
- package/dist/core/templates/skills/spec-writer-skill.md +61 -0
- package/dist/core/templates/skills/spec-writer-skill.vi.md +61 -0
- package/dist/core/templates/skills/sql-queries/skill.md +67 -0
- package/dist/core/templates/skills/sql-queries/skill.vi.md +67 -0
- package/dist/core/templates/skills/sql-queries-skill.md +67 -0
- package/dist/core/templates/skills/sql-queries-skill.vi.md +67 -0
- package/dist/core/templates/skills/suggestion/skill.md +118 -0
- package/dist/core/templates/skills/system-design/skill.md +70 -0
- package/dist/core/templates/skills/system-design/skill.vi.md +70 -0
- package/dist/core/templates/skills/system-design-skill.md +70 -0
- package/dist/core/templates/skills/system-design-skill.vi.md +70 -0
- package/dist/core/templates/skills/tech-debt/skill.md +70 -0
- package/dist/core/templates/skills/tech-debt/skill.vi.md +70 -0
- package/dist/core/templates/skills/tech-debt-skill.md +70 -0
- package/dist/core/templates/skills/tech-debt-skill.vi.md +70 -0
- package/dist/core/templates/skills/ui-ux/data/charts.csv +26 -0
- package/dist/core/templates/skills/ui-ux/data/colors.csv +97 -0
- package/dist/core/templates/skills/ui-ux/data/design-systems.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/landing.csv +31 -0
- package/dist/core/templates/skills/ui-ux/data/pages-proposed.csv +22 -0
- package/dist/core/templates/skills/ui-ux/data/pages.csv +10 -0
- package/dist/core/templates/skills/ui-ux/data/products.csv +97 -0
- package/dist/core/templates/skills/ui-ux/data/prompts.csv +24 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/flutter.csv +53 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/html-tailwind.csv +56 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/nextjs.csv +53 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/react-native.csv +52 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/react.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/svelte.csv +54 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/swiftui.csv +51 -0
- package/dist/core/templates/skills/ui-ux/data/stacks/vue.csv +50 -0
- package/dist/core/templates/skills/ui-ux/data/styles.csv +59 -0
- package/dist/core/templates/skills/ui-ux/data/typography.csv +58 -0
- package/dist/core/templates/skills/ui-ux/data/ux-guidelines.csv +100 -0
- package/dist/core/templates/skills/ui-ux/scripts/CODE_EXPLANATION.md +394 -0
- package/dist/core/templates/skills/ui-ux/scripts/SEARCH_ALGORITHMS_COMPARISON.md +421 -0
- package/dist/core/templates/skills/ui-ux/scripts/SEARCH_MODES_GUIDE.md +238 -0
- package/dist/core/templates/skills/ui-ux/scripts/core.py +391 -0
- package/dist/core/templates/skills/ui-ux/scripts/search.py +73 -0
- package/dist/core/templates/skills/ui-ux/skill.md +595 -0
- package/dist/core/templates/skills/ui-ux/templates/accessibility-checklist.md +40 -0
- package/dist/core/templates/skills/ui-ux/templates/example-prompt-full-theme.md +333 -0
- package/dist/core/templates/skills/ui-ux/templates/page-types-guide.md +338 -0
- package/dist/core/templates/skills/ui-ux/templates/pages-proposed-summary.md +273 -0
- package/dist/core/templates/skills/ui-ux/templates/pre-delivery-checklist.md +42 -0
- package/dist/core/templates/skills/ui-ux/templates/prompt-template-full-theme.md +313 -0
- package/dist/core/templates/skills/ui-ux/templates/responsive-design.md +40 -0
- package/dist/core/templates/skills/unit-test/skill.md +111 -0
- package/dist/core/templates/skills/wordpress/plugin-check/skill.md +151 -0
- package/dist/core/templates/skills/wordpress/plugin-directory/skill.md +396 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/skill.md +100 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/admin-dashboard.php +47 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/admin-settings.php +60 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/assets/admin-css.css +22 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/assets/admin-js.js +15 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/plugin-main.php +169 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/readme.txt +41 -0
- package/dist/core/templates/skills/wordpress/plugin-standard/templates/uninstall.php +21 -0
- package/dist/core/templates/skills/wordpress/ux-element/skill.md +83 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Controller.php +50 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Shortcode.php +23 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Template.html +20 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/Thumbnail.svg +8 -0
- package/dist/core/templates/skills/wordpress/ux-element/templates/View.php +21 -0
- package/dist/core/templates/skills-template-map.d.ts +29 -0
- package/dist/core/validation/validator.d.ts +26 -0
- package/dist/core/view.d.ts +4 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +350 -114
- package/dist/utils/file-system.d.ts +19 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/task-parser.d.ts +26 -0
- package/package.json +2 -2
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Skill: WordPress Plugin Standard (WP.org Compliant)
|
|
2
|
+
|
|
3
|
+
This skill guides the creation of a high-quality, secure, and WordPress.org compliant plugin. It focuses on adherence to the Plugin Check (PCP) requirements and provides a robust structure including admin interfaces.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
Standardize WordPress plugin development to ensure acceptance into the official repository, maximize security, and promote maintainability through strict separation of concerns.
|
|
7
|
+
|
|
8
|
+
## Required Variables
|
|
9
|
+
- `{{plugin_name}}`: Human-readable name (e.g., My Awesome Plugin).
|
|
10
|
+
- `{{plugin_slug}}`: Unique slug (e.g., my-awesome-plugin).
|
|
11
|
+
- `{{namespace}}`: PHP Namespace (e.g., PolyXGO\MyPlugin).
|
|
12
|
+
- `{{prefix}}`: Unique prefix for functions/variables (e.g., pxmp_).
|
|
13
|
+
- `{{text_domain}}`: I18n text domain (usually same as plugin slug).
|
|
14
|
+
|
|
15
|
+
## Core Requirements (WordPress.org & PCP)
|
|
16
|
+
|
|
17
|
+
### 1. Security & Protection
|
|
18
|
+
- **Direct Access**: Use `if ( ! defined( 'ABSPATH' ) ) exit;` at the top of every PHP file.
|
|
19
|
+
- **Nonces**: Verify nonces for all form submissions and AJAX requests.
|
|
20
|
+
- **Validation & Sanitization**: Sanitize all inputs (`sanitize_text_field`, `absint`, etc.) and validate data before processing.
|
|
21
|
+
- **Escaping**: Escape all outputs strictly based on context (`esc_html`, `esc_attr`, `wp_kses`, etc.).
|
|
22
|
+
- **Capabilities**: Explicitly check user capabilities (`current_user_can`) for all admin actions.
|
|
23
|
+
|
|
24
|
+
### 2. Code Organization & Standards
|
|
25
|
+
- **Naming**: Use the `{{prefix}}` for all global functions, variables, and constants.
|
|
26
|
+
- **Namespace**: Use PSR-4 namespacing (`{{namespace}}`) to avoid class collisions.
|
|
27
|
+
- **Separation of Concerns**: Keep CSS and JS in separate files. AVOID inline styles or scripts unless dynamically generated values are required (use `wp_localize_script` or `wp_add_inline_style` only when necessary).
|
|
28
|
+
- **No Prohibited Constructs**: Never use `eval()`, `base64_decode()` for obfuscation, or short tags (`<?`).
|
|
29
|
+
|
|
30
|
+
### 3. Required Components
|
|
31
|
+
- **Main Plugin File**: Must contain the required header comment.
|
|
32
|
+
- **`readme.txt`**: Standard WordPress.org format.
|
|
33
|
+
- **Admin Interface**:
|
|
34
|
+
- A top-level or sub-menu item for the **Dashboard**.
|
|
35
|
+
- A dedicated **Settings** page for configuration.
|
|
36
|
+
- **Uninstallation**: Provide an `uninstall.php` file to clean up data (options, tables) when the plugin is deleted.
|
|
37
|
+
|
|
38
|
+
## Implementation Steps
|
|
39
|
+
|
|
40
|
+
### Step 1: Initialize Main Structure
|
|
41
|
+
1. Create the main plugin file `{{plugin_slug}}.php` with the correct header.
|
|
42
|
+
2. Initialize the main class with a singleton or static instance.
|
|
43
|
+
3. Hook into `plugins_loaded` to start the plugin logic.
|
|
44
|
+
|
|
45
|
+
### Step 2: Register Admin Menu
|
|
46
|
+
1. Hook into `admin_menu`.
|
|
47
|
+
2. Add a menu page and a sub-page for Settings.
|
|
48
|
+
3. Enqueue admin-specific assets (CSS/JS) only on plugin pages.
|
|
49
|
+
|
|
50
|
+
### Step 3: Integrate UI/UX Skill
|
|
51
|
+
When designing the Dashboard or Settings page:
|
|
52
|
+
1. **Call Skill**: Use `(skill: ui-ux)` to define the design language.
|
|
53
|
+
2. **Apply Styles**: Use the colors, typography, and spacing defined by the `ui-ux` skill result.
|
|
54
|
+
3. Write styles in `assets/admin.css`.
|
|
55
|
+
|
|
56
|
+
### Step 4: Handle Data Persistence
|
|
57
|
+
1. Use the Options API (`get_option`, `update_option`) for settings.
|
|
58
|
+
2. Ensure all data saved to the database is sanitized.
|
|
59
|
+
3. Ensure all data retrieved from the database is escaped on output.
|
|
60
|
+
|
|
61
|
+
## Standards and Rules
|
|
62
|
+
|
|
63
|
+
### The Prefixing Rule
|
|
64
|
+
Every global identifier MUST start with `{{prefix}}`.
|
|
65
|
+
- ✅ `{{prefix}}get_settings()`
|
|
66
|
+
- ❌ `get_settings()`
|
|
67
|
+
|
|
68
|
+
### The "No Inline" Rule
|
|
69
|
+
- CSS must be in `assets/css/admin.css`.
|
|
70
|
+
- JS must be in `assets/js/admin.js`.
|
|
71
|
+
- Use `wp_enqueue_style` and `wp_enqueue_script` correctly.
|
|
72
|
+
|
|
73
|
+
### The "Smart Flush" Rule (Friendly URLs)
|
|
74
|
+
If the plugin uses custom post types or custom permalink structures, you MUST implement a "Queue & Flush" mechanism to update rewrite rules automatically. **NEVER** call `flush_rewrite_rules()` on every page load or `init` hook directly without a condition.
|
|
75
|
+
|
|
76
|
+
**Implementation Pattern:**
|
|
77
|
+
1. **Queue Flush**: When settings verify (e.g., via `update_option` hook), set a temporary flag.
|
|
78
|
+
```php
|
|
79
|
+
add_action('update_option_{{prefix}}permalink_settings', function($old, $new) {
|
|
80
|
+
update_option('{{prefix}}flush_rewrite_flag', true);
|
|
81
|
+
}, 10, 2);
|
|
82
|
+
```
|
|
83
|
+
2. **Execute Flush**: On the next `admin_init`, check and flush.
|
|
84
|
+
```php
|
|
85
|
+
add_action('admin_init', function() {
|
|
86
|
+
if (get_option('{{prefix}}flush_rewrite_flag')) {
|
|
87
|
+
flush_rewrite_rules();
|
|
88
|
+
delete_option('{{prefix}}flush_rewrite_flag');
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Templates
|
|
94
|
+
- [plugin-main.php](templates/plugin-main.php)
|
|
95
|
+
- [admin-dashboard.php](templates/admin-dashboard.php)
|
|
96
|
+
- [admin-settings.php](templates/admin-settings.php)
|
|
97
|
+
- [readme.txt](templates/readme.txt)
|
|
98
|
+
- [uninstall.php](templates/uninstall.php)
|
|
99
|
+
- [assets/admin-css.css](templates/assets/admin-css.css)
|
|
100
|
+
- [assets/admin-js.js](templates/assets/admin-js.js)
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
/**
|
|
3
|
+
* Admin Dashboard Template
|
|
4
|
+
*
|
|
5
|
+
* @package {{namespace}}
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
if ( ! defined( 'ABSPATH' ) ) {
|
|
9
|
+
exit;
|
|
10
|
+
}
|
|
11
|
+
?>
|
|
12
|
+
|
|
13
|
+
<div class="wrap {{plugin_slug}}-dashboard">
|
|
14
|
+
<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
|
|
15
|
+
|
|
16
|
+
<div class="welcome-panel">
|
|
17
|
+
<div class="welcome-panel-content">
|
|
18
|
+
<h2><?php esc_html_e( 'Welcome to {{plugin_name}}', '{{text_domain}}' ); ?></h2>
|
|
19
|
+
<p class="about-description"><?php esc_html_e( 'Thank you for using our plugin. This dashboard provides an overview of your activity.', '{{text_domain}}' ); ?></p>
|
|
20
|
+
|
|
21
|
+
<div class="welcome-panel-column-container">
|
|
22
|
+
<div class="welcome-panel-column">
|
|
23
|
+
<h3><?php esc_html_e( 'Get Started', '{{text_domain}}' ); ?></h3>
|
|
24
|
+
<a class="button button-primary button-hero" href="<?php echo esc_url( admin_url( 'admin.php?page={{plugin_slug}}-settings' ) ); ?>"><?php esc_html_e( 'Configure Settings', '{{text_domain}}' ); ?></a>
|
|
25
|
+
</div>
|
|
26
|
+
<div class="welcome-panel-column">
|
|
27
|
+
<h3><?php esc_html_e( 'Next Steps', '{{text_domain}}' ); ?></h3>
|
|
28
|
+
<ul>
|
|
29
|
+
<li><a href="#" class="welcome-icon welcome-view-site"><?php esc_html_e( 'Check Features', '{{text_domain}}' ); ?></a></li>
|
|
30
|
+
<li><a href="#" class="welcome-icon welcome-edit-page"><?php esc_html_e( 'Documentation', '{{text_domain}}' ); ?></a></li>
|
|
31
|
+
</ul>
|
|
32
|
+
</div>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
<div class="postbox-container">
|
|
38
|
+
<div class="postbox">
|
|
39
|
+
<div class="postbox-header">
|
|
40
|
+
<h2 class="hndle"><?php esc_html_e( 'Overview Stats', '{{text_domain}}' ); ?></h2>
|
|
41
|
+
</div>
|
|
42
|
+
<div class="inside">
|
|
43
|
+
<p><?php esc_html_e( 'Summary of your plugin usage will appear here.', '{{text_domain}}' ); ?></p>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
</div>
|
|
47
|
+
</div>
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
/**
|
|
3
|
+
* Admin Settings Template
|
|
4
|
+
*
|
|
5
|
+
* @package {{namespace}}
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
if ( ! defined( 'ABSPATH' ) ) {
|
|
9
|
+
exit;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
// Handle form submission
|
|
13
|
+
if ( isset( $_POST['{{prefix}}save_settings'] ) ) {
|
|
14
|
+
|
|
15
|
+
// Check nonce
|
|
16
|
+
if ( ! isset( $_POST['{{prefix}}settings_nonce'] ) || ! wp_verify_nonce( $_POST['{{prefix}}settings_nonce'], '{{prefix}}settings_action' ) ) {
|
|
17
|
+
wp_die( esc_html__( 'Security check failed.', '{{text_domain}}' ) );
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// Check capabilities
|
|
21
|
+
if ( ! current_user_can( 'manage_options' ) ) {
|
|
22
|
+
wp_die( esc_html__( 'You do not have sufficient permissions to access this page.', '{{text_domain}}' ) );
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// Save settings (example)
|
|
26
|
+
if ( isset( $_POST['{{prefix}}api_key'] ) ) {
|
|
27
|
+
update_option( '{{prefix}}api_key', sanitize_text_field( wp_unslash( $_POST['{{prefix}}api_key'] ) ) );
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
echo '<div class="updated"><p>' . esc_html__( 'Settings saved.', '{{text_domain}}' ) . '</p></div>';
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
$api_key = get_option( '{{prefix}}api_key', '' );
|
|
34
|
+
?>
|
|
35
|
+
|
|
36
|
+
<div class="wrap {{plugin_slug}}-settings">
|
|
37
|
+
<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
|
|
38
|
+
|
|
39
|
+
<form method="post" action="">
|
|
40
|
+
<?php wp_nonce_field( '{{prefix}}settings_action', '{{prefix}}settings_nonce' ); ?>
|
|
41
|
+
|
|
42
|
+
<table class="form-table" role="presentation">
|
|
43
|
+
<tbody>
|
|
44
|
+
<tr>
|
|
45
|
+
<th scope="row">
|
|
46
|
+
<label for="{{prefix}}api_key"><?php esc_html_e( 'API Key', '{{text_domain}}' ); ?></label>
|
|
47
|
+
</th>
|
|
48
|
+
<td>
|
|
49
|
+
<input name="{{prefix}}api_key" type="text" id="{{prefix}}api_key" value="<?php echo esc_attr( $api_key ); ?>" class="regular-text">
|
|
50
|
+
<p class="description"><?php esc_html_e( 'Enter your API key here.', '{{text_domain}}' ); ?></p>
|
|
51
|
+
</td>
|
|
52
|
+
</tr>
|
|
53
|
+
</tbody>
|
|
54
|
+
</table>
|
|
55
|
+
|
|
56
|
+
<p class="submit">
|
|
57
|
+
<input type="submit" name="{{prefix}}save_settings" id="submit" class="button button-primary" value="<?php esc_attr_e( 'Save Changes', '{{text_domain}}' ); ?>">
|
|
58
|
+
</p>
|
|
59
|
+
</form>
|
|
60
|
+
</div>
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin Styles for {{plugin_name}}
|
|
3
|
+
*
|
|
4
|
+
* DESIGN SYSTEM:
|
|
5
|
+
* Use the ui-ux skill to define colors, fonts, and spacing.
|
|
6
|
+
* This file should contain layout and component-specific styles.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
.{{plugin_slug}}-dashboard .welcome-panel {
|
|
10
|
+
margin-top: 20px;
|
|
11
|
+
border: 1px solid #ccd0d4;
|
|
12
|
+
background: #fff;
|
|
13
|
+
padding: 20px;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
.{{plugin_slug}}-dashboard .welcome-panel h2 {
|
|
17
|
+
margin-top: 0;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
.{{plugin_slug}}-settings .form-table {
|
|
21
|
+
margin-top: 20px;
|
|
22
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin JavaScript for {{plugin_name}}
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
(function($) {
|
|
6
|
+
'use strict';
|
|
7
|
+
|
|
8
|
+
$(document).ready(function() {
|
|
9
|
+
console.log('{{plugin_name}} Admin Loaded');
|
|
10
|
+
|
|
11
|
+
// Example: Handle AJAX or UI interactions
|
|
12
|
+
// Use {{prefix}}params.ajax_url and {{prefix}}params.nonce
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
})(jQuery);
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
/**
|
|
3
|
+
* Plugin Name: {{plugin_name}}
|
|
4
|
+
* Description: A high-quality WordPress plugin following WP.org standards.
|
|
5
|
+
* Version: 1.0.0
|
|
6
|
+
* Author: Your Name
|
|
7
|
+
* Author URI: https://example.com
|
|
8
|
+
* License: GPL-2.0-or-later
|
|
9
|
+
* License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
|
10
|
+
* Text Domain: {{text_domain}}
|
|
11
|
+
* Domain Path: /languages
|
|
12
|
+
*
|
|
13
|
+
* @package {{namespace}}
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
// If this file is called directly, abort.
|
|
17
|
+
if ( ! defined( 'ABSPATH' ) ) {
|
|
18
|
+
exit;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* The core plugin class.
|
|
23
|
+
*/
|
|
24
|
+
class {{namespace}}\Main {
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Instance of this class.
|
|
28
|
+
*
|
|
29
|
+
* @var object
|
|
30
|
+
*/
|
|
31
|
+
protected static $instance = null;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Initialize the plugin.
|
|
35
|
+
*/
|
|
36
|
+
public function __construct() {
|
|
37
|
+
$this->define_constants();
|
|
38
|
+
$this->includes();
|
|
39
|
+
$this->init_hooks();
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Return an instance of this class.
|
|
44
|
+
*/
|
|
45
|
+
public static function get_instance() {
|
|
46
|
+
if ( null === self::$instance ) {
|
|
47
|
+
self::$instance = new self();
|
|
48
|
+
}
|
|
49
|
+
return self::$instance;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Define constants.
|
|
54
|
+
*/
|
|
55
|
+
private function define_constants() {
|
|
56
|
+
define( '{{prefix|upper}}VERSION', '1.0.0' );
|
|
57
|
+
define( '{{prefix|upper}}PATH', plugin_dir_path( __FILE__ ) );
|
|
58
|
+
define( '{{prefix|upper}}URL', plugin_dir_url( __FILE__ ) );
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Include required files.
|
|
63
|
+
*/
|
|
64
|
+
private function includes() {
|
|
65
|
+
// Include admin classes, helpers, etc.
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Initialize hooks.
|
|
70
|
+
*/
|
|
71
|
+
private function init_hooks() {
|
|
72
|
+
add_action( 'admin_menu', [ $this, 'add_menu_pages' ] );
|
|
73
|
+
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_admin_assets' ] );
|
|
74
|
+
|
|
75
|
+
// Activation / Deactivation hooks
|
|
76
|
+
register_activation_hook( __FILE__, [ $this, 'activate' ] );
|
|
77
|
+
register_deactivation_hook( __FILE__, [ $this, 'deactivate' ] );
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Add Admin Menu Pages.
|
|
82
|
+
*/
|
|
83
|
+
public function add_menu_pages() {
|
|
84
|
+
add_menu_page(
|
|
85
|
+
__( '{{plugin_name}}', '{{text_domain}}' ),
|
|
86
|
+
__( '{{plugin_name}}', '{{text_domain}}' ),
|
|
87
|
+
'manage_options',
|
|
88
|
+
'{{plugin_slug}}',
|
|
89
|
+
[ $this, 'render_dashboard_page' ],
|
|
90
|
+
'dashicons-admin-generic',
|
|
91
|
+
100
|
|
92
|
+
);
|
|
93
|
+
|
|
94
|
+
add_submenu_page(
|
|
95
|
+
'{{plugin_slug}}',
|
|
96
|
+
__( 'Dashboard', '{{text_domain}}' ),
|
|
97
|
+
__( 'Dashboard', '{{text_domain}}' ),
|
|
98
|
+
'manage_options',
|
|
99
|
+
'{{plugin_slug}}',
|
|
100
|
+
[ $this, 'render_dashboard_page' ]
|
|
101
|
+
);
|
|
102
|
+
|
|
103
|
+
add_submenu_page(
|
|
104
|
+
'{{plugin_slug}}',
|
|
105
|
+
__( 'Settings', '{{text_domain}}' ),
|
|
106
|
+
__( 'Settings', '{{text_domain}}' ),
|
|
107
|
+
'manage_options',
|
|
108
|
+
'{{plugin_slug}}-settings',
|
|
109
|
+
[ $this, 'render_settings_page' ]
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* Enqueue Admin Assets.
|
|
115
|
+
*/
|
|
116
|
+
public function enqueue_admin_assets( $hook ) {
|
|
117
|
+
// Only load on our plugin pages
|
|
118
|
+
if ( strpos( $hook, '{{plugin_slug}}' ) === false ) {
|
|
119
|
+
return;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
wp_enqueue_style( '{{plugin_slug}}-admin', {{prefix|upper}}URL . 'assets/css/admin.css', [], {{prefix|upper}}VERSION );
|
|
123
|
+
wp_enqueue_script( '{{plugin_slug}}-admin', {{prefix|upper}}URL . 'assets/js/admin.js', [ 'jquery' ], {{prefix|upper}}VERSION, true );
|
|
124
|
+
|
|
125
|
+
wp_localize_script( '{{plugin_slug}}-admin', '{{prefix}}params', [
|
|
126
|
+
'ajax_url' => admin_url( 'admin-ajax.php' ),
|
|
127
|
+
'nonce' => wp_create_nonce( '{{prefix}}nonce' ),
|
|
128
|
+
]);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Render Dashboard Page.
|
|
133
|
+
*/
|
|
134
|
+
public function render_dashboard_page() {
|
|
135
|
+
// Include template file
|
|
136
|
+
include {{prefix|upper}}PATH . 'templates/admin-dashboard.php';
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Render Settings Page.
|
|
141
|
+
*/
|
|
142
|
+
public function render_settings_page() {
|
|
143
|
+
// Include template file
|
|
144
|
+
include {{prefix|upper}}PATH . 'templates/admin-settings.php';
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Activation logic.
|
|
149
|
+
*/
|
|
150
|
+
public function activate() {
|
|
151
|
+
// Setup database tables, default options, etc.
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Deactivation logic.
|
|
156
|
+
*/
|
|
157
|
+
public function deactivate() {
|
|
158
|
+
// Clear scheduled tasks, etc.
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Initialize the plugin.
|
|
164
|
+
*/
|
|
165
|
+
function {{prefix}}init() {
|
|
166
|
+
return {{namespace}}\Main::get_instance();
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
add_action( 'plugins_loaded', '{{prefix}}init' );
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
=== {{plugin_name}} ===
|
|
2
|
+
Contributors: yourname
|
|
3
|
+
Tags: wordpress, plugin, standard
|
|
4
|
+
Requires at least: 6.0
|
|
5
|
+
Tested up to: 6.4
|
|
6
|
+
Requires PHP: 7.4
|
|
7
|
+
Stable tag: 1.0.0
|
|
8
|
+
License: GPLv2 or later
|
|
9
|
+
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
|
10
|
+
|
|
11
|
+
{{plugin_name}} is a high-quality WordPress plugin built with HeraSpec.
|
|
12
|
+
|
|
13
|
+
== Description ==
|
|
14
|
+
|
|
15
|
+
Describe your plugin features here.
|
|
16
|
+
|
|
17
|
+
== Installation ==
|
|
18
|
+
|
|
19
|
+
1. Upload the plugin files to the `/wp-content/plugins/{{plugin_slug}}` directory.
|
|
20
|
+
2. Activate the plugin through the 'Plugins' screen in WordPress.
|
|
21
|
+
3. Go to {{plugin_name}} -> Settings to configure.
|
|
22
|
+
|
|
23
|
+
== Frequently Asked Questions ==
|
|
24
|
+
|
|
25
|
+
= Is this plugin free? =
|
|
26
|
+
|
|
27
|
+
Yes!
|
|
28
|
+
|
|
29
|
+
== Screenshots ==
|
|
30
|
+
|
|
31
|
+
1. Dashboard view.
|
|
32
|
+
|
|
33
|
+
== Changelog ==
|
|
34
|
+
|
|
35
|
+
= 1.0.0 =
|
|
36
|
+
* Initial release.
|
|
37
|
+
|
|
38
|
+
== Upgrade Notice ==
|
|
39
|
+
|
|
40
|
+
= 1.0.0 =
|
|
41
|
+
* First version.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
/**
|
|
3
|
+
* Fired when the plugin is uninstalled.
|
|
4
|
+
*
|
|
5
|
+
* @package {{namespace}}
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
// If uninstall not called from WordPress, then exit.
|
|
9
|
+
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
|
|
10
|
+
exit;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Clean up plugin data.
|
|
15
|
+
*/
|
|
16
|
+
delete_option( '{{prefix}}version' );
|
|
17
|
+
delete_option( '{{prefix}}api_key' );
|
|
18
|
+
|
|
19
|
+
// Delete custom tables if any...
|
|
20
|
+
// global $wpdb;
|
|
21
|
+
// $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}your_table_name" );
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Skill: Flatsome UX Element
|
|
2
|
+
|
|
3
|
+
This skill guides the creation of custom UX Builder elements for the Flatsome theme within the PolyUtilities plugin.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
Standardize the development of UX elements to ensure consistency across controllers, shortcodes, and templates, with special focus on real-time preview functionality. This skill is portable and uses dynamic prefixes for identity (Shortcode, Namespace, CSS Classes).
|
|
7
|
+
|
|
8
|
+
## Required Variables
|
|
9
|
+
When calling this skill, define the following identity prefixes:
|
|
10
|
+
- `{{namespace_prefix}}`: The root namespace (e.g., `polyxgo\PolyUtilities`).
|
|
11
|
+
- `{{shortcode_prefix}}`: Prefix for shortcode names (e.g., `poly_ux_`).
|
|
12
|
+
- `{{class_prefix}}`: Prefix for CSS classes (e.g., `poly-`).
|
|
13
|
+
- `{{plugin_dir_const}}`: The plugin directory constant (e.g., `__POLYUTILITIES_PLUGIN_DIR__`).
|
|
14
|
+
|
|
15
|
+
## Prerequisites
|
|
16
|
+
- Knowledge of PHP, WordPress Shortcodes, and AngularJS (for UX Builder templates).
|
|
17
|
+
- Access to `inc/Core/Helper.php` for utility functions.
|
|
18
|
+
|
|
19
|
+
## Implementation Steps
|
|
20
|
+
|
|
21
|
+
### 1. Register Shortcode Logic (The Controller)
|
|
22
|
+
Create a new controller class in `inc/Controllers/Elements/`.
|
|
23
|
+
- **Namespace**: `{{namespace_prefix}}\Controllers\Elements`
|
|
24
|
+
- **Method `register_hooks()`**: Add the shortcode `{{shortcode_prefix}}{{element_slug}}` and `ux_builder_setup` action.
|
|
25
|
+
- **Method `render_element($atts, $content)`**: Handle the frontend output.
|
|
26
|
+
|
|
27
|
+
### 2. Register UX Builder UI (The Shortcode)
|
|
28
|
+
Create a registration file in `inc/builder/shortcodes/`.
|
|
29
|
+
- Use `add_ux_builder_shortcode('{{shortcode_prefix}}{{element_slug}}', ...)`.
|
|
30
|
+
- Define options (textfield, select, colorpicker, slider, etc.).
|
|
31
|
+
- Link to the AngularJS template using `Helper::get_poly_ux_builder_template()`.
|
|
32
|
+
|
|
33
|
+
### 3. Build the Preview Template (AngularJS)
|
|
34
|
+
Create an HTML file in `inc/builder/shortcodes/templates/`.
|
|
35
|
+
- **CRITICAL**: Wrap the entire content in a `<span>` with `id="{{:: shortcode.$id }}"`.
|
|
36
|
+
- This ensures that clicking the element in the builder correctly selects it and shows options.
|
|
37
|
+
- Use `ng-style` and `style scope="scope"` for real-time CSS updates.
|
|
38
|
+
|
|
39
|
+
### 4. Create SVG Thumbnail
|
|
40
|
+
Create an SVG file in `inc/builder/shortcodes/thumbnails/`.
|
|
41
|
+
- **Naming**: Use `{{element_slug}}.svg`.
|
|
42
|
+
- **Dimensions**: Use `100x68px`.
|
|
43
|
+
- **Theme**: Use the "Pastel Red" theme (`#F87171` for accents, `#FCA5A5` for fills).
|
|
44
|
+
|
|
45
|
+
### 5. Create the Frontend View
|
|
46
|
+
(Optional) Extract the HTML into `inc/Views/elements/` for cleaner controllers.
|
|
47
|
+
|
|
48
|
+
## Standards and Rules
|
|
49
|
+
|
|
50
|
+
### The Wrapping Rule
|
|
51
|
+
Every UX Builder template MUST follow this structure:
|
|
52
|
+
```html
|
|
53
|
+
<span id="{{:: shortcode.$id }}">
|
|
54
|
+
<!-- Main element (e.g., <a>, <div>, <section>) -->
|
|
55
|
+
<div class="{{class_prefix}}{{element_slug}}" ng-style="{ 'color': shortcode.options.color }">
|
|
56
|
+
{{ shortcode.options.text }}
|
|
57
|
+
</div>
|
|
58
|
+
|
|
59
|
+
<!-- Scoped styles for hover effects or complex rules -->
|
|
60
|
+
<style scope="scope">
|
|
61
|
+
#{{::shortcode.$id }} .{{class_prefix}}{{element_slug}}:hover {
|
|
62
|
+
opacity: 0.8;
|
|
63
|
+
}
|
|
64
|
+
</style>
|
|
65
|
+
</span>
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Variable Naming (PHP vs AngularJS)
|
|
69
|
+
**CRITICAL**: When accessing shortcode options in the AngularJS template (`.html`), variables declared with underscores (`_`) in PHP MUST be accessed via **camelCase**.
|
|
70
|
+
- **PHP**: `bg_color` → **AngularJS**: `shortcode.options.bgColor`
|
|
71
|
+
- **PHP**: `pxg_clock_font` → **AngularJS**: `shortcode.options.pxgClockFont`
|
|
72
|
+
- **PHP**: `text_align` → **AngularJS**: `shortcode.options.textAlign`
|
|
73
|
+
|
|
74
|
+
### Color Handling
|
|
75
|
+
- Use HEX or RGBA strings consistently.
|
|
76
|
+
- Always provide default values in the shortcode registration or handle them in the template/controller.
|
|
77
|
+
|
|
78
|
+
## Templates
|
|
79
|
+
- [Controller.php](templates/Controller.php)
|
|
80
|
+
- [Shortcode.php](templates/Shortcode.php)
|
|
81
|
+
- [Template.html](templates/Template.html)
|
|
82
|
+
- [View.php](templates/View.php)
|
|
83
|
+
- [Thumbnail.svg](templates/Thumbnail.svg)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
|
|
3
|
+
namespace {{namespace_prefix}}\Controllers\Elements;
|
|
4
|
+
|
|
5
|
+
use polyxgo\PolyUtilities\Core\Helper;
|
|
6
|
+
|
|
7
|
+
class Element{{ElementName}}Controller
|
|
8
|
+
{
|
|
9
|
+
public function register_hooks()
|
|
10
|
+
{
|
|
11
|
+
// 1. Frontend Shortcode
|
|
12
|
+
add_shortcode('{{shortcode_prefix}}{{element_slug}}', [$this, 'render_element']);
|
|
13
|
+
|
|
14
|
+
// 2. UX Builder Integration (Flatsome only)
|
|
15
|
+
if (Helper::is_flatsome_theme_activated()) {
|
|
16
|
+
add_action('ux_builder_setup', [$this, 'register_ux_builder_element']);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
public function register_ux_builder_element()
|
|
21
|
+
{
|
|
22
|
+
if (function_exists('add_ux_builder_shortcode')) {
|
|
23
|
+
// Include the UI registration file
|
|
24
|
+
require_once Helper::get_poly_ux_builder_shortcode('{{element_slug}}');
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
public function render_element($atts, $content = null)
|
|
29
|
+
{
|
|
30
|
+
$atts = shortcode_atts([
|
|
31
|
+
'_id' => '{{element_slug}}-' . rand(),
|
|
32
|
+
'title' => '',
|
|
33
|
+
'class' => '',
|
|
34
|
+
'visibility' => '',
|
|
35
|
+
// Add more attributes here
|
|
36
|
+
], $atts, '{{shortcode_prefix}}{{element_slug}}');
|
|
37
|
+
|
|
38
|
+
ob_start();
|
|
39
|
+
$view_path = plugin_dir_path({{plugin_dir_const}}) . '/inc/Views/elements/{{element_slug}}.php';
|
|
40
|
+
|
|
41
|
+
if (file_exists($view_path)) {
|
|
42
|
+
include $view_path;
|
|
43
|
+
} else {
|
|
44
|
+
// Fallback inline rendering
|
|
45
|
+
echo '<div class="' . esc_attr($atts['class']) . '">' . esc_html($atts['title']) . '</div>';
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
return ob_get_clean();
|
|
49
|
+
}
|
|
50
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<?php
|
|
2
|
+
|
|
3
|
+
use polyxgo\PolyUtilities\Core\Helper;
|
|
4
|
+
use polyxgo\PolyUtilities\Core\Options;
|
|
5
|
+
|
|
6
|
+
add_ux_builder_shortcode('{{shortcode_prefix}}{{element_slug}}', array(
|
|
7
|
+
'name' => __('{{ElementName}}', 'polyutilities'),
|
|
8
|
+
'category' => __('PolyUtilities', 'polyutilities'),
|
|
9
|
+
'template' => Helper::get_poly_ux_builder_template('{{element_slug}}'),
|
|
10
|
+
'thumbnail' => Helper::get_poly_ux_builder_thumbnail('{{element_slug}}'),
|
|
11
|
+
'info' => '{{ title }}',
|
|
12
|
+
'priority' => 10,
|
|
13
|
+
'options' => array(
|
|
14
|
+
'title' => array(
|
|
15
|
+
'type' => 'textfield',
|
|
16
|
+
'heading' => __('Title', 'polyutilities'),
|
|
17
|
+
'default' => 'Element Title',
|
|
18
|
+
'auto_focus' => true,
|
|
19
|
+
),
|
|
20
|
+
// Add more options here (colorpicker, slider, select, etc.)
|
|
21
|
+
'advanced_options' => require Helper::get_poly_ux_builder_element('commons', 'advanced'),
|
|
22
|
+
),
|
|
23
|
+
));
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<span id="{{:: shortcode.$id }}">
|
|
2
|
+
<div class="{{class_prefix}}{{element_slug}} {{ shortcode.options.class }} {{ shortcode.options.visibility }}"
|
|
3
|
+
ng-style="{
|
|
4
|
+
'color': shortcode.options.textColor,
|
|
5
|
+
'background-color': shortcode.options.bgColor,
|
|
6
|
+
'font-family': shortcode.options.pxgClockFont
|
|
7
|
+
}">
|
|
8
|
+
<span ng-bind="shortcode.options.title"></span>
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
<style scope="scope">
|
|
12
|
+
#{{::shortcode.$id }} .{{class_prefix}}{{element_slug}} {
|
|
13
|
+
/* Add scoped styles here */
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
#{{::shortcode.$id }} .{{class_prefix}}{{element_slug}}:hover {
|
|
17
|
+
/* Hover effects */
|
|
18
|
+
}
|
|
19
|
+
</style>
|
|
20
|
+
</span>
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<svg width="100px" height="68px" viewBox="0 0 100 68" version="1.1" xmlns="http://www.w3.org/2000/svg">
|
|
3
|
+
<rect x="0" y="0" width="100" height="68" fill="#FFFFFF"></rect>
|
|
4
|
+
<!-- Placeholder: Replace with actual icon geometry -->
|
|
5
|
+
<rect x="25" y="20" width="50" height="28" rx="2" fill="#FCA5A5" stroke="#F87171" stroke-width="2"></rect>
|
|
6
|
+
<rect x="30" y="28" width="40" height="4" rx="1" fill="#FFFFFF"></rect>
|
|
7
|
+
<rect x="30" y="36" width="25" height="4" rx="1" fill="#FFFFFF"></rect>
|
|
8
|
+
</svg>
|