|
| 1 | +=== Easy Query === |
| 2 | +Contributors: dcooney |
| 3 | +Donate link: https://connekthq.com/donate/ |
| 4 | +Tags: query, builder, wp_query, easy, simple, save, saving query, generator, paging, paged, query builder, shortcode builder, shortcode, search, tags, category, post types, taxonomy, meta_query, post format, wmpl, archives, date |
| 5 | +Requires at least: 3.7 |
| 6 | +Tested up to: 4.1.1 |
| 7 | +Stable tag: 1.0.0 |
| 8 | +License: GPLv2 or later |
| 9 | +License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 10 | + |
| 11 | +Create complex WordPress queries in seconds - it's that easy! |
| 12 | + |
| 13 | +== Description == |
| 14 | + |
| 15 | +Easy Query is the fastest and simplest way to build WordPress queries without ever touching a single line of code. Create complex queries using our Custom Query Builder then add the generated shortcode to your pages via the content editor or directly into your template files using our WP_Query Generator. |
| 16 | + |
| 17 | + |
| 18 | += Features = |
| 19 | + |
| 20 | +* **Query Builder** - Create your own Easy Query shortcode in seconds by adjusting the various query parameters. |
| 21 | +* **Query Generator** - Generate a custom WP_Query by adjusting parameters in the Query Builder. |
| 22 | +* **Customizable Template** - Easy Query’s customizable template allows you to match the look and feel of your website. |
| 23 | +* **Paging** - Enable Easy Query paging by setting paging=”true” in your shortcode. |
| 24 | +* **Multiple Instances** - Include multiple instances of Easy Query on a page, post or page template. |
| 25 | + |
| 26 | +Check out the **[official website](https://connekthq.com/easy-query/)** for more information! |
| 27 | + |
| 28 | +*** |
| 29 | + |
| 30 | += Shortcode Parameters = |
| 31 | + |
| 32 | +Easy Query accepts a number of parameters that are passed to the WordPress query via shortcode. |
| 33 | + |
| 34 | +* **container** - Select the type of container that will wrap your Easy Query templates (<ul>, <ol>, <div>). Default = ‘<ul>’ |
| 35 | +* **classes** - Target your content by adding custom classes to the container. Default = null |
| 36 | +* **template** - Select which template you would like to use. Default = ‘default’ |
| 37 | +* **post_type** - Comma separated list of post types. Default = ‘post’ |
| 38 | +* **category__in** - A comma separated list of categories to include by ID. Default = null |
| 39 | +* **category__not_in** - A comma separated list of categories to exclude by ID. Default = null |
| 40 | +* **tag__in** - A comma separated list of tags to include by ID. Default = null |
| 41 | +* **tag__not_in** - A comma separated list of tags to exclude by ID. Default = null |
| 42 | +* **taxonomy** - Query by custom taxonomy name. Default = null |
| 43 | +* **taxonomy_terms** - Comma separated list of custom taxonomy terms(slug). Default = null |
| 44 | +* **taxonomy_operator** - Operator to compare Taxonomy Terms against (IN/NOT IN). Default = ‘IN’ |
| 45 | +* **day** - Day of the week. Default = null |
| 46 | +* **month** - Month of the year. Default = null |
| 47 | +* **year** - Year of post. Default = null |
| 48 | +* **taxonomy_operator** - Operator to compare Taxonomy Terms against (IN/NOT IN). Default = ‘IN’ |
| 49 | +* **meta_key** - Custom field key(name). Default = null |
| 50 | +* **meta_value** - Custom field value. Default = null |
| 51 | +* **meta_compare** - Operator to compare meta_key and meta_value against (IN/NOT IN/=/!=/>/>=/</<= etc.). Default = ‘IN’ |
| 52 | +* **author** - Query by author id. Default = null |
| 53 | +* **search** - Query search term (‘s’). Default = null |
| 54 | +* **post__in** - Comma separated list of post ID’s to include in query. Default = null |
| 55 | +* **post__not_in** - Comma separated list of post ID’s to exclude from query. Default = null |
| 56 | +* **post_status** - Select status of the post. Default = 'publish' |
| 57 | +* **order** - Display posts in ASC(ascending) or DESC(descending) order. Default = ‘DESC’ |
| 58 | +* **orderby** - Order posts by date, title, name, menu order, random, author, post ID or comment count. Default = ‘date’ |
| 59 | +* **offset** - Offset the initial query (number). Default = ’0′ |
| 60 | +* **posts_per_page** - Number of posts to load with each Ajax request. Default = ’6′ |
| 61 | +* **paging** - Enable Easy Query to page the results. Default = ’true′ |
| 62 | + |
| 63 | +*** |
| 64 | + |
| 65 | += Example Shortcode = |
| 66 | + |
| 67 | + [easy_query type="ul" classes="blog-listing entry-list" template="default" posts_per_page="6" post_type="post, portfolio"] |
| 68 | + |
| 69 | +*** |
| 70 | + |
| 71 | += Demos = |
| 72 | +* **[Default](https://connekthq.com/plugins/easy-query/examples/default/)** - Out of the box functionality and styling |
| 73 | + |
| 74 | + |
| 75 | += Tested Browsers = |
| 76 | + |
| 77 | +* Firefox (Mac, PC) |
| 78 | +* Chrome (Mac, PC, iOS, Android) |
| 79 | +* Safari (Mac, iOS) |
| 80 | +* IE8+ |
| 81 | +* Android (Native) |
| 82 | +* BB10 (Native) |
| 83 | + |
| 84 | +*** |
| 85 | + |
| 86 | += Website = |
| 87 | +https://connekthq.com/easy-query/ |
| 88 | + |
| 89 | + |
| 90 | +== Frequently Asked Questions == |
| 91 | + |
| 92 | + |
| 93 | += What are the steps to getting Easy Query to display on my website = |
| 94 | + |
| 95 | +1. Create your shortcode |
| 96 | +2. Add the shortcode to your page, by adding it through the content editor or placing it directly within one of your template files. |
| 97 | +3. Load a page with your shortcode in place and watch Easy Query load your posts. |
| 98 | + |
| 99 | += What are my server requirements? = |
| 100 | + |
| 101 | +Your server must be able to read/write/create files. Easy Query creates the default template on plugin activation and in order to modify the output Easy Query is required to write to the file as well. |
| 102 | + |
| 103 | += Can I make modifications to the plugin code? = |
| 104 | + |
| 105 | +Sure, but please be aware that if modifications are made it may affect future updates of the plugin. |
| 106 | + |
| 107 | += Can I modify the repeater template? = |
| 108 | + |
| 109 | +Yes, visit the Repeater Template section in your WordPress admin. |
| 110 | + |
| 111 | += How are my templates saved? = |
| 112 | + |
| 113 | +Template data is saved into your WordPress database as well as written directly to a template PHP file in the easy-query plugin directory. |
| 114 | + |
| 115 | += Can I use custom fields in a template? = |
| 116 | + |
| 117 | +Yes, but you will need to define $post at the top of the template before requesting your custom fields. Like so: |
| 118 | +global $post; |
| 119 | + |
| 120 | + |
| 121 | +== Installation == |
| 122 | + |
| 123 | +How to install Easy Query. |
| 124 | + |
| 125 | += Using The WordPress Dashboard = |
| 126 | + |
| 127 | +1. Navigate to the 'Add New' in the plugins dashboard |
| 128 | +2. Search for 'Easy Query' |
| 129 | +3. Click 'Install Now' |
| 130 | +4. Activate the plugin on the Plugin dashboard |
| 131 | + |
| 132 | += Uploading in WordPress Dashboard = |
| 133 | + |
| 134 | +1. Navigate to the 'Add New' in the plugins dashboard |
| 135 | +2. Navigate to the 'Upload' area |
| 136 | +3. Select `easy-query.zip` from your computer |
| 137 | +4. Click 'Install Now' |
| 138 | +5. Activate the plugin in the Plugin dashboard |
| 139 | + |
| 140 | += Using FTP = |
| 141 | + |
| 142 | +1. Download `easy-query.zip` |
| 143 | +2. Extract the `easy-query` directory to your computer |
| 144 | +3. Upload the `easy-query` directory to the `/wp-content/plugins/` directory |
| 145 | +4. Activate the plugin in the Plugin dashboard |
| 146 | + |
| 147 | + |
| 148 | +== Screenshots == |
| 149 | + |
| 150 | +1. Settings screen |
| 151 | +2. Templates |
| 152 | +3. Query Builder |
| 153 | +3. Query Generator |
| 154 | + |
| 155 | +== Changelog == |
| 156 | + |
| 157 | + |
| 158 | += 1.0.0 = |
| 159 | +* Initial Easy Query Commit |
| 160 | + |
| 161 | +== Upgrade Notice == |
| 162 | + |
| 163 | +* None |
| 164 | + |
| 165 | + |
0 commit comments