WooCommerce — Sublime Text Snippets

The only WooCommerce snippet package with HPOS, Block Checkout, Store API, and Action Scheduler patterns.

172 curated code recipes for WooCommerce development in Sublime Text. Built from the WooCommerce 10.5.2 source — not a dictionary dump of function signatures. Every snippet expands to a complete, working code pattern with intelligent tab stops.

Why This Package?

Every other WooCommerce snippet package on Package Control is frozen at WooCommerce 3.x (2017). In the 8 years since:

• HPOS replaced the wp_posts table for order storage (mandatory since WC 9.0)
• Block Checkout replaced the shortcode checkout (actively deprecated)
• Store API replaced the legacy frontend API
• Action Scheduler replaced WP Cron for background processing
• REST API v3 is the standard for integrations
• Hundreds of new hooks, filters, and API methods were added

This package covers all of it. The dead packages don't.

Curated Recipes, Not Dictionary Dumps

The abandoned “WooCommerce Autocomplete” package has 3,393 flat completions — every function, hook, and constant dumped into one file. It's unusable noise.

This package has 172 curated snippets. Each one is a real code pattern: a complete add_action() call with the correct callback signature, a full payment gateway scaffold, an HPOS-compatible order query with real parameters. Think recipe, not dictionary entry.

Quick Start

1. Install via Package Control: Cmd+Shift+P → Package Control: Install Package → WooCommerce
2. Open any PHP file
3. Type wc: and browse the autocomplete menu
4. Select a snippet and press Tab
5. Use Tab to jump between placeholders

All triggers start with wc: — type it and see every available pattern organized by category.

What's Included

Full Trigger Reference

Action Hooks

Filter Hooks

CRUD

Queries

Cart

Checkout

REST API

Conditionals

Admin

Emails

HPOS

Templates

Shipping

Action Scheduler

Blocks / Store API

Notices

Security

How Snippets Work

All triggers use the wc: prefix with colon-separated categories:

wc:{category}:{name}

1. Open a PHP file in Sublime Text
2. Type wc: — the autocomplete panel shows all available snippets
3. Continue typing to filter: wc:checkout: narrows to checkout patterns
4. Press Tab or Enter to expand
5. The snippet expands with pre-filled defaults and tab stops
6. Press Tab to jump to the next placeholder
7. Edit only what you need — defaults are immediately usable

Tab Stop Design

Every snippet follows these conventions:

• $1 — The value you'll most likely change (hook name, field name, etc.)
• $2–$n — Parameters in order of importance
• $0 — Final cursor position after all tabs
• All stops use ${n:default} — snippets work without editing a single placeholder

Wrap Snippets

Two special snippets use $SELECTION to wrap highlighted code:

• wc:wrap:action — Wrap selected code in add_action()
• wc:wrap:filter — Wrap selected code in add_filter()

Select code, then trigger the snippet via the Command Palette.

Installation

Package Control (Recommended)

1. Open Command Palette: Cmd+Shift+P (Mac) / Ctrl+Shift+P (Windows/Linux)
2. Type Package Control: Install Package
3. Search for WooCommerce
4. Press Enter to install

Manual Installation

1. Download the latest release
2. Extract to your Sublime Text Packages directory:
   • Mac: ~/Library/Application Support/Sublime Text/Packages/
   • Windows: %APPDATA%\Sublime Text\Packages\
   • Linux: ~/.config/sublime-text/Packages/

Git Clone

cd ~/Library/Application\ Support/Sublime\ Text/Packages/
git clone https://github.com/renzojohnson/woocommerce.git WooCommerce

WooCommerce Compatibility

All snippets are built from and tested against WooCommerce 10.5.2 source code. Patterns use the modern WC_Data API, HPOS-compatible methods, and current best practices. Legacy patterns (like update_post_meta for orders) are intentionally excluded.

Works With

These snippets are designed to work alongside:

• WooCommerce Blocks — Block checkout field registration, Store API extensions
• WooCommerce Subscriptions — Subscription query patterns included
• Action Scheduler — Background job scheduling and management
• WooCommerce REST API v3 — Endpoint scaffolds and schema definitions
• HPOS (Custom Order Tables) — All order operations use HPOS-safe methods

Troubleshooting

Snippets don't expand when I press Tab:

Check that : is not in your word_separators setting. Open Preferences → Settings and verify word_separators does not include :.

Snippets show in HTML but not in PHP:

Snippets are scoped to source.php. They only trigger inside <?php ?> blocks, not in HTML regions of PHP files.

I see old completions from another package:

If you have the abandoned “WooCommerce Autocomplete” package installed, remove it first. It conflicts with trigger names.

Contributing

Contributions are welcome. To add or improve a snippet:

1. Fork the repository
2. Create a branch: git checkout -b feature/new-snippet
3. Add your .sublime-snippet file to the appropriate snippets/ subdirectory
4. Follow the naming convention: {category}-{name}.sublime-snippet
5. Ensure all PHP $ variables are escaped as \$ in the CDATA section
6. Include $0 as the final cursor position
7. Submit a pull request

Snippet Conventions

• Trigger format: wc:{category}:{name} (max 3 levels)
• Scope: source.php for all snippets
• Description: 40 characters max, action-oriented
• Tab stops: $1 = most likely to change, $0 = final cursor
• All stops use ${n:default} — never bare $n

Author

Renzo Johnson — renzojohnson.com · Contact

License

MIT

WooCommerce is a registered trademark of Automattic Inc. This package provides development tooling and is not affiliated with or endorsed by Automattic.