|
| 1 | +# Bricks QuickNav – for Bricks Builder |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +The **Bricks QuickNav** plugin adds a quick-access navigator to the WordPress Admin Bar (Toolbar). It allows easy access to Bricks Builder Templates, Headers, Footers, and (regular WordPress) Pages edited with Bricks, along with lots of other essential settings and stuff. |
| 6 | + |
| 7 | +* Contributors: [David Decker](https://github.com/deckerweb), [contributors](https://github.com/deckerweb/bricks-quicknav/graphs/contributors) |
| 8 | +* Tags: bricks, bricks builder, quicknav, admin bar, toolbar, site builder, administrators |
| 9 | +* Requires at least: 6.7 |
| 10 | +* Requires PHP: 7.4 |
| 11 | +* Stable tag: [main](https://github.com/deckerweb/bricks-quicknav/releases/latest) |
| 12 | +* Donate link: https://paypal.me/deckerweb |
| 13 | +* License: GPL v2 or later |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +[Support Project](#support-the-project) | [Installation](#installation) | [Updates](#updates) | [Description](#description) | [FAQ](#frequently-asked-questions) | [Custom Tweaks](#custom-tweaks) | [Changelog](#changelog) | [Plugin Scope / Disclaimer](#plugin-scope--disclaimer) |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Support the Project |
| 22 | + |
| 23 | +If you find this project helpful, consider showing your support by buying me a coffee! Your contribution helps me keep developing and improving this plugin. |
| 24 | + |
| 25 | +Enjoying the plugin? Feel free to treat me to a cup of coffee ☕🙂 through the following options: |
| 26 | + |
| 27 | +- [](https://ko-fi.com/W7W81BNTZE) |
| 28 | +- [Buy me a coffee](https://buymeacoffee.com/daveshine) |
| 29 | +- [PayPal donation](https://paypal.me/deckerweb) |
| 30 | +- [Join my **newsletter** for DECKERWEB WordPress Plugins](https://eepurl.com/gbAUUn) |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Installation |
| 35 | + |
| 36 | +#### **Quick Install – as Plugin** |
| 37 | +[](https://github.com/deckerweb/bricks-quicknav/releases/latest/download/bricks-quicknav.zip) |
| 38 | + |
| 39 | +1. **Download ZIP:** [**bricks-quicknav.zip**](https://github.com/deckerweb/bricks-quicknav/releases/latest/download/bricks-quicknav.zip) |
| 40 | +2. Upload via WordPress Plugins > Add New > Upload Plugin |
| 41 | +3. Once activated, you’ll see the **Bricks** menu item in the Admin Bar. |
| 42 | + |
| 43 | +#### **Alternative: Use as Code Snippet** |
| 44 | +[](https://github.com/deckerweb/bricks-quicknav/releases/latest/download/ddw-bricks-quicknav.code-bricks.json) |
| 45 | +1. Below, download the appropriate snippet version |
| 46 | +2. Activate or deactivate in your snippets plugin |
| 47 | + |
| 48 | +[**Download .json**](https://github.com/deckerweb/bricks-quicknav/releases/latest/download/ddw-bricks-quicknav.code-snippets.json) version for: _Code Snippets_ (free & Pro), _Advanced Scripts_ (Premium), _Scripts Organizer_ (Premium) |
| 49 | +➔ just use their elegant script import features |
| 50 | +➔ in _Scripts Organizer_ use the "Code Snippets Import" |
| 51 | + |
| 52 | +For all other snippet manager plugins just use our plugin's main .php file [`bricks-quicknav.php`](https://github.com/deckerweb/bricks-quicknav/blob/master/bricks-quicknav.php) and use its content as snippet (bevor saving your snippet: please check for your plugin if the opening php tag needs to be removed or not!). |
| 53 | + |
| 54 | +➔ Please decide for one of both alternatives! |
| 55 | + |
| 56 | +#### Minimum Requirements |
| 57 | +* WordPress version 6.7 or higher |
| 58 | +* PHP version 7.4 or higher (better 8.3+) |
| 59 | +* MySQL version 8.0 or higher / OR MariaDB 10.1 or higher |
| 60 | +* Administrator user with capability `manage_options` and `activate_plugins` |
| 61 | + |
| 62 | +### Tested Compatibility |
| 63 | +- **Bricks**: 1.12.4 ... 2.0.0 Alpha |
| 64 | +- **WordPress**: 6.7.2 ... 6.8.1 |
| 65 | +- **PHP**: 8.0 – 8.3 |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +## Updates |
| 70 | + |
| 71 | +#### For Plugin Version: |
| 72 | + |
| 73 | +1) Alternative 1: Just download a new [ZIP file](https://github.com/deckerweb/bricks-quicknav/releases/latest/download/bricks-quicknav.zip) (see above), upload and override existing version. Done. |
| 74 | + |
| 75 | +2) Alternative 2: Use the (free) [**_Git Updater_ plugin**](https://git-updater.com/) and get updates automatically. |
| 76 | + |
| 77 | +3) Alternative 3: Upcoming! – In future I will built-in our own deckerweb updater. This is currently being worked on for my plugins. Stay tuned! |
| 78 | + |
| 79 | +#### For Code Snippet Version: |
| 80 | + |
| 81 | +Just manually: Download the latest Snippet version (see above) and import it in your favorite snippets manager plugin. – You can delete the old snippet; then just activate the new one. Done. |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## Description |
| 86 | + |
| 87 | +### How this Plugin Works |
| 88 | + |
| 89 | +1. **Pages and Bricks Templates (including all its types)**: Displays up to 20 items (by default), ordered by the last modified date (descending). The "Pages" menu only shows pages built with Bricks by checking the `_bricks_editor_mode` custom field. |
| 90 | +2. **Settings**: Direct links to all relevant Bricks settings & sections. |
| 91 | +3. **Child Themes functions.php** (if child is used), including the special "plugin-like" _SNN BRX_ child theme; plus support for 6 typical code snippets plugins (to organize custom code & scripts) |
| 92 | +4. Lots of typical & popular **Bricks-specific add-on plugins** with their settings or actions |
| 93 | +5. **Additional Links**: Includes links to lots of official resources like the Bricks website and Facebook group. Some may contain affiliate links. |
| 94 | +6. **Community Links**: Collected and hand-picked community links grouped by topic. |
| 95 | +7. **About**: Includes links to the plugin author. |
| 96 | +8. Optionally show **Admin Bar** also **within Bricks Builder** itself (Builder context) |
| 97 | +9. Show **Admin Bar** also **in Block Editor** full screen mode. (Not there in WP default but this plugin here changes that!) |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## Frequently Asked Questions |
| 102 | + |
| 103 | +### How can I change / tweak things? |
| 104 | +Please see here under [**Custom Tweaks via Constants**](#custom-tweaks-via-constants) what is possible! |
| 105 | + |
| 106 | +### Why no settings page? |
| 107 | +That overcomplicates things – setting up a few constants is easy and fast. Also, needed code for settings makes plugin more "bloated" and even less fitting for the alternative use as a code snippet. Use of code snippet is only possible with a "one-file-plugin"! And remember, this is a plugin geared towards Administrators who are normally able to add a little line of code if needed. |
| 108 | + |
| 109 | +### Why can't certain strings not be translated? |
| 110 | +To keep translation files as small and clean as possible not all strings need translations, especially those product names like "Automatic.CSS" or "Bricksforge" and so on. These product and/ or company names are as is and **not** declared with regular translation functions. |
| 111 | + |
| 112 | +### Why is this functionality not baked into _Bricks Builder_ itself? |
| 113 | +I don't know. Not everything needs to be built-in. That's what plugins are for: those who _need_ this functionality can install and use them. Also, _Bricks QuickNav_ just goes far and beyond, it adds the things, I wanted and/or needed _myself_. So, that's just what you get here for free. |
| 114 | + |
| 115 | +### Why did you create this plugin? |
| 116 | +Because I needed (and wanted!) it myself for the sites I maintain. [Read the backstory here ...](#plugins-backstory) |
| 117 | + |
| 118 | +### Why is this plugin not on wordpress.org plugin repository? |
| 119 | +Because the restrictions there for plugin authors are becoming more and more. It would be possible but I don't want that anymore. The same for limited support forums for plugin authors on .org. I have decided to leave this whole thing behind me. |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +## Custom Tweaks via Constants |
| 124 | + |
| 125 | +### Default capability (aka permission) |
| 126 | +The intended usage of this plugin is for Administrator users only. Therefore the default capability to see the new Admin Bar node is set to `activate_plugins`. You can change this via constant |
| 127 | +in `wp-config.php` or via a Code Snippets plugin, for example: |
| 128 | +``` |
| 129 | +define( 'BXQN_VIEW_CAPABILITY', 'edit_posts' ); |
| 130 | +``` |
| 131 | + |
| 132 | + |
| 133 | +### Restrict to defined user IDs only |
| 134 | +You can define an array of user IDs (can also be only _one_ ID) and that way restrict showing the Bricks Admin Bar item only for those users. Define that via `wp-config.php` or via a Code Snippets plugin: |
| 135 | +``` |
| 136 | +define( 'BXQN_ENABLED_USERS', [ 1, 500, 867 ] ); |
| 137 | +``` |
| 138 | +This would enable only for the users with the IDs 1, 500 and 867. Note the square brackets around, and no single quotes, just the ID numbers. |
| 139 | + |
| 140 | +For example you are one of many admin users (role `administrator`) but _only you_ want to show it _for yourself_. Given you have user ID 1: |
| 141 | +``` |
| 142 | +define( 'BXQN_ENABLED_USERS', [ 1 ] ); |
| 143 | +``` |
| 144 | +That way only you can see it, the other admins can't! |
| 145 | + |
| 146 | + |
| 147 | +### Name of main menu item |
| 148 | +The default is just "Bricks" – catchy and short. However, if you don't enjoy "Bricks" you can tweak that also via the constant `BXQN_NAME_IN_ADMINBAR` – define that also via `wp-config.php` or via a Code Snippets plugin: |
| 149 | +``` |
| 150 | +define( 'BXQN_NAME_IN_ADMINBAR', 'BRX' ); |
| 151 | +``` |
| 152 | + |
| 153 | + |
| 154 | +### Position of main menu item |
| 155 | +You can define an integer value to adjust the menu position of the main menu item. Define that via `wp-config.php` or via a Code Snippets plugin: |
| 156 | +``` |
| 157 | +define( 'BXQN_MENU_POSITION', 81 ); |
| 158 | +``` |
| 159 | +This example will place it somewhere after the default `+ New` item. Note: the default value is `999` which puts the item quite on the middle or right side of the Admin Bar. |
| 160 | + |
| 161 | + |
| 162 | +### Default icon of main menu item |
| 163 | +The bold "b" default logo icon is awesome but at the same time a bit too normal? Who knows. – At least within the Admin Bar? Therefore, I offer TWO alternative icons for you to use and be happy with: the yellow Bricks "b" icon and the bricked icon with the 3 brick stones. You can tweak that via a constant in `wp-config.php` or via a Code Snippets plugin: |
| 164 | +``` |
| 165 | +/** Bricks yellow "b" icon */ |
| 166 | +define( 'BXQN_ICON', 'yellow' ); |
| 167 | +
|
| 168 | +/** Bricks "bricked" icon (3 brick stones) */ |
| 169 | +define( 'BXQN_ICON', 'brick' ); |
| 170 | +``` |
| 171 | + |
| 172 | + |
| 173 | +### Adjust the number of displayed Templates/ Pages |
| 174 | +The default number of displayed Templates/ Pages is 20. That means up to 20 items, starting from latest (newest) down to older ones. You can adjust that value via constant in `wp-config.php` or via a Code Snippets plugin: |
| 175 | +``` |
| 176 | +define( 'BXQN_NUMBER_TEMPLATES', 5 ); |
| 177 | +``` |
| 178 | +In that example it would only display up to 5 items. NOTE: just add the number, no quotes around it. |
| 179 | + |
| 180 | + |
| 181 | +### Disable footer items (_Links_, _Community_ and _About_) |
| 182 | +To disable these menu items, just use another constant in `wp-config.php` or via a Code Snippets plugin: |
| 183 | +``` |
| 184 | +define( 'BXQN_DISABLE_FOOTER', 'yes' ); |
| 185 | +``` |
| 186 | + |
| 187 | + |
| 188 | +### Use "Compact Mode" |
| 189 | +This mode just disables a few Admin Bar items to free up some precious space (for example, not displaying the link for "Sidebars"). |
| 190 | +``` |
| 191 | +define( 'BXQN_COMPACT_MODE', TRUE ); |
| 192 | +``` |
| 193 | +Note: Just use `TRUE` or `FALSE`, no quotes around it. |
| 194 | + |
| 195 | + |
| 196 | +### Use the Admin Bar also _WITHIN_ the Builder itself |
| 197 | +Yes, it's possible, just add this constant declaration in `wp-config.php` or via a Code Snippets plugin: |
| 198 | +``` |
| 199 | +define( 'BXQN_ADMINBAR_IN_BUILDER', 'yes' ); |
| 200 | +``` |
| 201 | + |
| 202 | +--- |
| 203 | + |
| 204 | +## Changelog |
| 205 | + |
| 206 | +### [The Releases](https://github.com/deckerweb/bricks-quicknav/releases) |
| 207 | + |
| 208 | +### 🎉 v1.0.0 – 2025-05-12 |
| 209 | +* Initial release |
| 210 | +* Includes support for Bricks Builder 1.12.x as well as Bricks 2.0-alpha |
| 211 | +* Includes support for 11 Bricks specific plugins/ Add-Ons, plus 1 general plugin, plus 1 "plugin-like" Code Snippet |
| 212 | +* Includes support for 3 Frameworks, plus 3 "Add-Ons" (Libraries) |
| 213 | +* Includes support for Bricks Child Themes; specifically also for "SNN BRX Bricks Child Theme" (third-party) |
| 214 | + |
| 215 | + |
| 216 | +--- |
| 217 | + |
| 218 | +## Plugin's Backstory |
| 219 | + |
| 220 | +_I needed and wanted this plugin (Bricks QuickNav) myself for a long time so I developed it. I work with Bricks Builder since summer of 2022 and there was the lovely BricksLabs Bricks Navigator already there. However, I wanted a lot of things differently so it became clear I needed to get active somehow. When I started coding and testing and playing around it became clear to me I wanted a full featured and full integrated "thing". So my take on this "Bricks Admin Bar Thing" is different than every other such plugin, in that way what it lists, integrates and supports. And since I like to share my stuff with the wider Bricks Community I decided to give it away for free. So my hope is, that you will enjoy it as well (the finished plugin)._ |
| 221 | + |
| 222 | +–– David Decker, plugin developer, in May of 2025 |
| 223 | + |
| 224 | +--- |
| 225 | + |
| 226 | +## Plugin Scope / Disclaimer |
| 227 | + |
| 228 | +This plugin comes as is. I have no intention to add support for every little detail / third-party plugin / library etc. Its main focus is support for the template types and Oxygen 6+ settings. Plugin support is added where it makes sense for the daily work of an Administrator and Site Builder. |
| 229 | + |
| 230 | +_Disclaimer 1:_ So far I will support the plugin for breaking errors to keep it working. Otherwise support will be very limited. Also, it will NEVER be released to WordPress.org Plugin Repository for a lot of reasons. Furthermore, I will ONLY add support for direct Oxygen 6+ add-on plugins. And I can only add support if I would own a license myself (for testing etc.). Therefore, if there might be Oxygen 6+ plugins you want me to add integration for, please open an issue on the plugin page on GitHub so we might discuss that. (Thanks in advance!) |
| 231 | + |
| 232 | +_Disclaimer 2:_ All of the above might change. I do all this stuff only in my spare time. |
| 233 | + |
| 234 | +_Most of all:_ Have fun building great Oxygen 6+ powered sites!!! ;-) |
| 235 | + |
| 236 | +--- |
| 237 | + |
| 238 | +Official _Bricks_ company / product logo icons: © bricksbuilder.io |
| 239 | + |
| 240 | +Icon used in promo graphics: [© Remix Icon](https://remixicon.com/) |
| 241 | + |
| 242 | +Readme & Plugin Copyright: © 2025, David Decker – DECKERWEB.de |
0 commit comments