zoninator / README.md

README.md in Zone Manager (Zoninator) 0.11.0, at README.md

120 lines 3.9 KB

Raw Download Zip

1	# Zone Manager (Zoninator)
2
3	Stable tag: 0.11.0
4	Requires at least: 6.4
5	Tested up to: 6.9
6	Requires PHP: 7.4
7	License: GPLv2 or later
8	License URI: https://www.gnu.org/licenses/gpl-2.0.html
9	Tags: zones, post order, post list, posts, order, zonination, content curation, curation, content management
10	Contributors: batmoo, automattic, wpcomvip, pkevan, matthumphreys, potatomaster, jblz, nickdaugherty, betzster, garyj
11
12	Content curation made easy! Create "zones" then add and order your content!
13
14	## Description
15
16	This plugin is designed to help you curate your content. It lets you assign and order stories within zones that you create, edit, and delete, and display those groupings of related stories on your site.
17
18	This plugin was originally built by [](http://digitalize.caMohammad Jangda](http://digitalize.ca](http://digitalize.ca) in conjunction with [](http://wpdavis.com/William Davis](http://wpdavis.com/](http://wpdavis.com/) and the [](http://www.bangordailynews.com/Bangor Daily News](http://www.bangordailynews.com/](http://www.bangordailynews.com/).
19
20	### Features
21
22	* Add, edit, and delete zones.
23	* Add and remove posts (or any custom post type) to or from zones.
24	* Order posts in any given zone.
25	* Limit capabilities on who can add, edit, and delete zones vs add content to zones.
26	* Locking mechanism, so only one user can edit a zone at a time (to avoid conflicts).
27	* Idle control, so people can't keep the zone locked.
28
29	## Installation
30
31	1. Unzip contents and upload to the `/wp-content/plugins/` directory
32	2. Activate the plugin through the 'Plugins' menu in WordPress
33	3. Go to Dashboard > Zones to create and manage your zones, and easily search for and add existing posts.
34	4. Use the plugin's handy API functions to add zones to your theme that retrieve and display your content. Or, for those who are a bit code-averse, go to Appearance-Widgets and add Zone Posts widgets to display your zone posts in your sidebar or footer. The widget will pull the posts from the chosen zone.
35
36	### Usage examples
37
38	You can work with a zone's posts either as an array or a WP_Query object.
39
40	WP_Query
41
42	~~~php
43	$zone_query = z_get_zone_query( 'homepage' );
44	if ( $zone_query->have_posts() ) :
45	while ( $zone_query->have_posts() ) : $zone_query->the_post();
46	echo '<li>' . get_the_title() . '</li>';
47	endwhile;
48	endif;
49	wp_reset_query();
50	~~~
51
52	Posts Array
53
54	~~~php
55	$zone_posts = z_get_posts_in_zone( 'homepage' );
56	foreach ( $zone_posts as $zone_post ) :
57	echo '<li>' . get_the_title( $zone_post->ID ) . '</li>';
58	endforeach;
59	~~~
60
61	## Function Reference
62
63	Get an array of all zones:
64
65	~~~php
66	z_get_zones()
67	~~~
68
69	Get a single zone, accepts either ID or slug:
70
71	~~~php
72	z_get_zone( $zone )
73	~~~
74
75	Get an array of ordered posts in a given zone, accepts either ID or slug:
76
77	~~~php
78	z_get_posts_in_zone( $zone )
79	~~~
80
81	Get a WP_Query object for a given zone, accepts either ID or slug:
82
83	~~~php
84	z_get_zone_query( $zone );
85	~~~
86
87	More functions listed in `functions.php`.
88
89	## Frequently Asked Questions
90
91	### How do I disable the locking feature?
92
93	You can use a filter:
94
95	~~~php
96	add_filter( 'zoninator_zone_max_lock_period', 'z_disable_zoninator_locks' );
97	~~~
98
99	### How do I change the locking feature settings?
100
101	Filter the following and change according to your needs:
102
103	* Number of seconds a lock is valid for, default `30`: `zoninator_zone_lock_period`
104	* Max idle time in seconds: `zoninator_zone_max_lock_period`
105
106	## Changelog
107
108	Please visit the [](https://github.com/automattic/zoninator/blob/trunk/CHANGELOG.mdchangelog](https://github.com/automattic/zoninator/blob/trunk/CHANGELOG.md](https://github.com/automattic/zoninator/blob/trunk/CHANGELOG.md).
109
110	## Screenshots
111
112	1. Create and manage your zones and content through a fairly intuitive and familiar interface.
113	![Overview of a homepage slideshow zone showing the name and description, and two posts assigned to that zone](.wordpress-org/screenshot-1.png)
114	2. Zone editing
115	![Editing a food zone in Zoninator](.wordpress-org/screenshot-2.png)
116	3. Use the Zone Posts widget in the widgets area.
117	![A sidebar widget area with a couple of Zone Posts widgets](.wordpress-org/screenshot-3.png)
118	4. Output of the zone posts widgets.
119	![Sidebar front end with the links to posts showing](.wordpress-org/screenshot-4.png)
120