Sublime-WP-Customizer-Snippets
Sublime Package of snippets for WordPress Customizer.
|
|
A FOSS (Free & Open Source Software) project. Maintained by @AhmadAwais.
|
|
# ⚡️ Sublime-WP-Customizer
[](https://VSCode.pro "This open source project is supported by VSCode.pro") [](http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) [](https://packagecontrol.io/packages/WordPress%20Customizer) [](https://github.com/ahmadawais/Sublime-WP-Customizer/releases) [](https://github.com/ahmadawais/Sublime-WP-Customizer/) [](http://docs.wpcustomizer.xyz/) [](https://github.com/ahmadawais/Sublime-WP-Customizer/stargazers)
Sublime snippets for WordPress Customizer.
## ✅ Getting Started
Read the [official documentation and snippet reference](http://docs.wpcustomizer.xyz/).
1. [INTRODUCTION](http://docs.wpcustomizer.xyz/)
2. [GETTING STARTED](http://docs.wpcustomizer.xyz/getting-started/)
3. [SNIPPET REFERENCE](http://docs.wpcustomizer.xyz/snippet/)
4. IMPLEMENTATION
- [Adding a Register Function](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-register-function/)
- [Adding a Cutsomizer Panel](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-panel/)
- [Adding a Customizer Section](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-section/)
- [Adding a Customizer Setting](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-setting/)
- [Adding a Customizer Control](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-basic-control/)
- [Adding a Customizer Color](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-control-color/)
- [Adding a Customizer Image](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-control-image/)
- [Adding a Customizer Upload](http://docs.wpcustomizer.xyz/wordpress-customizer-snippets/add-file-upload/)
## → General Information
```
WordPress Version: 4.6.0
Snippets: 09
Version: 1.0.4
```
## 🛡 Snippets
1. Snippet: WP Customize Add Pannel
* Tab trigger: `wpCustomizerAddPanel`
2. Snippet: WP Customize Add Section
* Tab trigger: `wpCustomizerAddSection`
3. Snippet: WP Customize Add Setting
* Tab trigger: `wpCustomizerAddSetting`
4. Snippet: WP Customize Add Control Basic
* Tab trigger: `wpCustomizerAddControlBasic`
5. Snippet: WP Customize Add Control Image
* Tab trigger: `wpCustomizerAddControlImage`
6. Snippet: WP Customize Add Control Upload
* Tab trigger: `wpCustomizerAddControlUpload`
7. Snippet: WP Customize Add Control Color
* Tab trigger: `wpCustomizerAddControlColor`
8. Snippet: WP Customize postMessage JS Basic
* Tab trigger: `wpCustomizerPostMessageJSBasic`
9. Snippet: WP Customize Register Function
* Tab trigger: `wpCustomizerRegisterFunction`
### 🤞 Tab Triggers
You can do a fuzzy search inside PHP or JS file with initials of the snippets' names. E.g. To add a `WP Customizer Add Pannel` you can just type `wpcap` and Sublime will suggest the snippet. If that doesn't happen read the optional tip below. You can also open Package Control's Command Pallet: Command+Shift+P on Mac Ctrl+Shift+P on Windows or Linux and search for these snippets.
### ⚙ How to Use the Snippets?
WP Customize snippets are meant to bring ease to your workflow. All you have to do is select a snippet and then press Tab button to go from one editable area to another. E.g.
### ▶︎ Optional Tip
Sublime won't autocomplete PHP files when there is no closing `?>` tags , so go to `Sublime Text > Preferences > Settings-User` add this snippet:
```bash
"auto_complete_selector": "source, text",
```
## 👍 Installation Instructions
### 🤘 Package Control installation
The preferred method of installation is via Package Control.
1. [Install Package Control](https://packagecontrol.io/installation).
2. From inside the Sublime Text, open Package Control's Command Pallet: Command+Shift+P on Mac Ctrl+Shift+P on Windows or Linux.
3. Type `Install Package` and hit Return or Enter. A list of available packages will be displayed.
4. Type `WordPress Customizer` and hit Return or Enter. The package will be downloaded to the appropriate directory (You can watch the progress bar in the left bottom bar of Sublime).
5. Restart Sublime Text to complete installation. The features listed above should now be available.
### 🤔 Manual Installation
1. Close Sublime Text.
2. Download or clone this repository to a directory named `WordPress-Customizer` in the Sublime Text Packages directory for your platform:
* Sublime Text 3
- **OS X**: `git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/WordPress-Customizer`
- **Windows**: `git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git %APPDATA%\Sublime/ Text/ 3/Packages/WordPress-Customizer`
- **Linux**: `git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git ~/.config/sublime-text-3/Packages/WordPress-Customizer`
* Sublime Text 2
- **OS X**: `git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/WordPress-Customizer`
- **Windows**: `git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git %APPDATA%\Sublime/ Text/ 2/Packages/WordPress-Customizer`
- **Linux**: `git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git ~/.config/sublime-text-2/Packages/WordPress-Customizer`
3. Restart Sublime Text to complete installation. The features listed above should now be available.
### 🎩 Understand manual installation
You can manually install by cloning this repository into your Sublime Text `Packages` directory. Get to it quickly from within Sublime via the menu at `Sublime Text > Preferences > Browse Packages`.
So, browse the `Packages` directory in terminal and clone this repository inside it by running the following command.
```bash
$ git clone https://github.com/ahmadawais/Sublime-WP-Customizer.git WP-Customizer
```
`Packages` directory can be found in
#### **OSX Macbook**
- Sublime Text 2 `/Users/{user}/Library/Application Support/Sublime Text 2/Packages`
- Sublime Text 3 `/Users/{user}/Library/Application Support/Sublime Text 3/Packages`
#### **WINDOWS**
- Sublime Text 2 `C:\Users\%username%\AppData\Roaming\Sublime Text 2\Packages`
- Sublime Text 3 `C:\Users\%username%\AppData\Roaming\Sublime Text 3\Packages`
### 📣 Changelog
#### Version 1.0.4
- UPDATE: ReadMe updated
- FIX: Add Section Tab trigger
#### Version 1.0.3
- UPDATE: ReadMe updated
- NEW: Package Control Messages
#### Version 1.0.2
- ReadMe updated
- Small Snippet bug fixes in WP Customize Register Function
#### Version 1.0.1
- Package Control Support
- New Snippet: WP Customize Register Function
#### Version 1.0.0
- First version
- Snippets 8
### License & Copyright
GPL v2.0 or later.
Copyright (C) 2016 Ahmad Awais http://AhmadAwais.com/
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
---
### 🙌 [THEDEVCOUPLE PARTNERS](https://TheDevCouple.com/partners)
This open source project is maintained by the help of awesome businesses listed below. What? [Read more about it →](https://TheDevCouple.com/partners)
_Follow me 👋 on Twitter_ → [](https://twitter.com/mrahmadawais/)
For anything else, tweet at @MrAhmadAwais
