├── admin
    └── class-settings.php
├── changelog.md
├── contributing.md
├── inc
    ├── functions-deprecated.php
    ├── functions-filters.php
    ├── functions-options.php
    ├── functions-rewrite.php
    ├── functions-shortcodes.php
    ├── functions-taxonomies.php
    ├── template-general.php
    └── widgets
    │   ├── class-list-posts.php
    │   └── class-list-related.php
├── lang
    └── series.pot
├── license.md
├── readme.md
├── readme.txt
├── screenshot-1.png
├── screenshot-2.png
├── screenshot-3.png
├── screenshot-4.png
└── series.php


/admin/class-settings.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Plugin settings screen.
  4 |  *
  5 |  * @package   Series
  6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
  7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
  8 |  * @link      https://themehybrid.com/plugins/series
  9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 10 |  */
 11 | 
 12 | namespace Series;
 13 | 
 14 | /**
 15 |  * Sets up and handles the plugin settings screen.
 16 |  *
 17 |  * @since  2.0.0
 18 |  * @access public
 19 |  */
 20 | final class Settings_Page {
 21 | 
 22 | 	/**
 23 | 	 * Settings page name.
 24 | 	 *
 25 | 	 * @since  2.0.0
 26 | 	 * @access public
 27 | 	 * @var    string
 28 | 	 */
 29 | 	public $settings_page = '';
 30 | 
 31 | 	/**
 32 | 	 * Sets up the needed actions for adding and saving the meta boxes.
 33 | 	 *
 34 | 	 * @since  2.0.0
 35 | 	 * @access public
 36 | 	 * @return void
 37 | 	 */
 38 | 	private function __construct() {
 39 | 		add_action( 'admin_menu', array( $this, 'admin_menu' ) );
 40 | 	}
 41 | 
 42 | 	/**
 43 | 	 * Sets up custom admin menus.
 44 | 	 *
 45 | 	 * @since  2.0.0
 46 | 	 * @access public
 47 | 	 * @return void
 48 | 	 */
 49 | 	public function admin_menu() {
 50 | 
 51 | 		// Create the settings page.
 52 | 		$this->settings_page = add_options_page(
 53 | 			esc_html__( 'Series Settings', 'series' ),
 54 | 			esc_html__( 'Series', 'series' ),
 55 | 			apply_filters( 'series/settings_capability', 'manage_options' ),
 56 | 			'series-settings',
 57 | 			array( $this, 'settings_page' )
 58 | 		);
 59 | 
 60 | 		if ( $this->settings_page ) {
 61 | 
 62 | 			// Register settings.
 63 | 			add_action( 'admin_init', array( $this, 'register_settings' ) );
 64 | 		}
 65 | 	}
 66 | 
 67 | 	/**
 68 | 	 * Registers the plugin settings.
 69 | 	 *
 70 | 	 * @since  2.0.0
 71 | 	 * @access public
 72 | 	 * @return void
 73 | 	 */
 74 | 	function register_settings() {
 75 | 
 76 | 		// Register the setting.
 77 | 		register_setting( 'series_settings', 'series_settings', array( $this, 'validate_settings' ) );
 78 | 
 79 | 		/* === Settings Sections === */
 80 | 
 81 | 		add_settings_section( 'reading',     esc_html__( 'Reading',    'series' ), array( $this, 'section_reading'    ), $this->settings_page );
 82 | 		add_settings_section( 'permalinks',  esc_html__( 'Permalinks', 'series' ), array( $this, 'section_permalinks' ), $this->settings_page );
 83 | 
 84 | 		/* === Settings Fields === */
 85 | 
 86 | 		// Reading section fields.
 87 | 		add_settings_field( 'posts_per_page', esc_html__( 'Posts Per Page',  'series' ), array( $this, 'field_posts_per_page' ), $this->settings_page, 'reading' );
 88 | 		add_settings_field( 'posts_orderby',  esc_html__( 'Sort By',         'series' ), array( $this, 'field_posts_orderby'  ), $this->settings_page, 'reading' );
 89 | 		add_settings_field( 'posts_order',    esc_html__( 'Order',           'series' ), array( $this, 'field_posts_order'    ), $this->settings_page, 'reading' );
 90 | 
 91 | 		// Permalinks section fields.
 92 | 		add_settings_field( 'series_rewrite_base',  esc_html__( 'Series Slug', 'series' ), array( $this, 'field_series_rewrite_base' ), $this->settings_page, 'permalinks' );
 93 | 	}
 94 | 
 95 | 	/**
 96 | 	 * Validates the plugin settings.
 97 | 	 *
 98 | 	 * @since  2.0.0
 99 | 	 * @access public
100 | 	 * @param  array  $input
101 | 	 * @return array
102 | 	 */
103 | 	function validate_settings( $settings ) {
104 | 
105 | 		// Text boxes.
106 | 		$settings['series_rewrite_base'] = $settings['series_rewrite_base'] ? trim( strip_tags( $settings['series_rewrite_base'] ), '/' ) : '';
107 | 
108 | 		// Numbers.
109 | 		$posts_per_page = intval( $settings['posts_per_page'] );
110 | 		$settings['posts_per_page'] = -2 < $posts_per_page ? $posts_per_page : 10;
111 | 
112 | 		// Select boxes.
113 | 		$settings['posts_orderby'] = isset( $settings['posts_orderby'] ) ? strip_tags( $settings['posts_orderby'] ) : 'date';
114 | 		$settings['posts_order']   = isset( $settings['posts_order'] )   ? strip_tags( $settings['posts_order']   ) : 'DESC';
115 | 
116 | 		/* === Handle Permalink Conflicts ===*/
117 | 
118 | 		// Return the validated/sanitized settings.
119 | 		return $settings;
120 | 	}
121 | 
122 | 	/**
123 | 	 * Reading section callback.
124 | 	 *
125 | 	 * @since  2.0.0
126 | 	 * @access public
127 | 	 * @return void
128 | 	 */
129 | 	public function section_reading() { ?>
130 | 
131 | 		<p class="description">
132 | 			<?php esc_html_e( 'Reading settings for the front end of your site.', 'series' ); ?>
133 | 		</p>
134 | 	<?php }
135 | 
136 | 	/**
137 | 	 * Themes per page field callback.
138 | 	 *
139 | 	 * @since  2.0.0
140 | 	 * @access public
141 | 	 * @return void
142 | 	 */
143 | 	public function field_posts_per_page() { ?>
144 | 
145 | 		<label>
146 | 			<input type="number" class="small-text" min="-1" name="series_settings[posts_per_page]" value="<?php echo esc_attr( get_posts_per_page() ); ?>" />
147 | 		</label>
148 | 	<?php }
149 | 
150 | 	/**
151 | 	 * Themes orderby field callback.
152 | 	 *
153 | 	 * @since  2.0.0
154 | 	 * @access public
155 | 	 * @return void
156 | 	 */
157 | 	public function field_posts_orderby() {
158 | 
159 | 		$orderby = array(
160 | 			'author'   => __( 'Author',           'series' ),
161 | 			'date'     => __( 'Date (Published)', 'series' ),
162 | 			'modified' => __( 'Date (Modified)',  'series' ),
163 | 			'ID'       => __( 'ID',               'series' ),
164 | 			'rand'     => __( 'Random',           'series' ),
165 | 			'name'     => __( 'Slug',             'series' ),
166 | 			'title'    => __( 'Title',            'series' )
167 | 		); ?>
168 | 
169 | 		<label>
170 | 			<select name="series_settings[posts_orderby]">
171 | 
172 | 			<?php foreach ( $orderby as $option => $label ) : ?>
173 | 				<option value="<?php echo esc_attr( $option ); ?>" <?php selected( $option, get_posts_orderby() ); ?>><?php echo esc_html( $label ); ?></option>
174 | 			<?php endforeach; ?>
175 | 
176 | 			</select>
177 | 		<label>
178 | 	<?php }
179 | 
180 | 	/**
181 | 	 * Themes order field callback.
182 | 	 *
183 | 	 * @since  2.0.0
184 | 	 * @access public
185 | 	 * @return void
186 | 	 */
187 | 	public function field_posts_order() {
188 | 
189 | 		$order = array(
190 | 			'ASC'  => __( 'Ascending',  'series' ),
191 | 			'DESC' => __( 'Descending', 'series' )
192 | 		); ?>
193 | 
194 | 		<label>
195 | 			<select name="series_settings[posts_order]">
196 | 
197 | 			<?php foreach ( $order as $option => $label ) : ?>
198 | 				<option value="<?php echo esc_attr( $option ); ?>" <?php selected( $option, get_posts_order() ); ?>><?php echo esc_html( $label ); ?></option>
199 | 			<?php endforeach; ?>
200 | 
201 | 			</select>
202 | 		<label>
203 | 	<?php }
204 | 
205 | 	/**
206 | 	 * Permalinks section callback.
207 | 	 *
208 | 	 * @since  2.0.0
209 | 	 * @access public
210 | 	 * @return void
211 | 	 */
212 | 	public function section_permalinks() { ?>
213 | 
214 | 		<p class="description">
215 | 			<?php esc_html_e( 'Set up custom permalinks for the series on your site.', 'series' ); ?>
216 | 		</p>
217 | 	<?php }
218 | 
219 | 	/**
220 | 	 * Series ewrite base field callback.
221 | 	 *
222 | 	 * @since  2.0.0
223 | 	 * @access public
224 | 	 * @return void
225 | 	 */
226 | 	public function field_series_rewrite_base() { ?>
227 | 
228 | 		<label>
229 | 			<code><?php echo esc_url( home_url( '/' ) ); ?></code>
230 | 			<input type="text" class="regular-text code" name="series_settings[series_rewrite_base]" value="<?php echo esc_attr( get_series_rewrite_base() ); ?>" />
231 | 		</label>
232 | 	<?php }
233 | 
234 | 	/**
235 | 	 * Renders the settings page.
236 | 	 *
237 | 	 * @since  2.0.0
238 | 	 * @access public
239 | 	 * @return void
240 | 	 */
241 | 	public function settings_page() {
242 | 
243 | 		// Flush the rewrite rules if the settings were updated.
244 | 		if ( isset( $_GET['settings-updated'] ) )
245 | 			flush_rewrite_rules(); ?>
246 | 
247 | 		<div class="wrap">
248 | 			<h1><?php esc_html_e( 'Series Settings', 'series' ); ?></h1>
249 | 
250 | 			<form method="post" action="options.php">
251 | 				<?php settings_fields( 'series_settings' ); ?>
252 | 				<?php do_settings_sections( $this->settings_page ); ?>
253 | 				<?php submit_button( esc_attr__( 'Update Settings', 'series' ), 'primary' ); ?>
254 | 			</form>
255 | 
256 | 		</div><!-- wrap -->
257 | 	<?php }
258 | 
259 | 	/**
260 | 	 * Returns the instance.
261 | 	 *
262 | 	 * @since  2.0.0
263 | 	 * @access public
264 | 	 * @return object
265 | 	 */
266 | 	public static function get_instance() {
267 | 
268 | 		static $instance = null;
269 | 
270 | 		if ( is_null( $instance ) )
271 | 			$instance = new self;
272 | 
273 | 		return $instance;
274 | 	}
275 | }
276 | 
277 | Settings_Page::get_instance();
278 | 


--------------------------------------------------------------------------------
/changelog.md:
--------------------------------------------------------------------------------
 1 | # Change Log
 2 | 
 3 | ## [2.0.1] - 2018-12-17
 4 | 
 5 | ### Fixed
 6 | 
 7 | * Enabled `show_in_rest` argument so that the taxonomy works with the new WordPress 5.0 editor.
 8 | 
 9 | ## [2.0.0] - 2017-10-01
10 | 
11 | ### Added
12 | 
13 | * New "Series" settings page for configuring the plugin.
14 | * Reading settings, which include posts per page, order by, and order options.
15 | * Permalink setting for changing the series rewrite slug.
16 | * `[series_list_posts]` shortcode.
17 | * `[series_list_related]` shortcode.
18 | 
19 | ### Changed
20 | 
21 | * Plugin now requires PHP 5.3.0+.
22 | * Overhauled the entire plugin code.  Very little of the original code is left.
23 | 
24 | ### Deprecated
25 | 
26 | * `[the-series]` shortcode.
27 | 
28 | ## [1.0.0] - 2015-07-13
29 | 
30 | ### Fixed
31 | 
32 | * Removed trailing `?>` from file endings to meet standards.
33 | * Call the parent constructor method instead of `WP_Widget`, which was deprecated in WP 4.3.
34 | 
35 | ## [0.2.0]
36 | 
37 | * Completely overhauled the entire code base.
38 | 
39 | ## [0.1.0]
40 | 
41 | * Plugin launch.
42 | 


--------------------------------------------------------------------------------
/contributing.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | The code for the project is handled via its [GitHub Repository](https://github.com/justintadlock/series).  You can open tickets, create patches, and send pull requests there.
 4 | 
 5 | ## Pull requests
 6 | 
 7 | Problem first.  Solution second.
 8 | 
 9 | Pull requests should have a ticket open for discussion first.  I rarely accept pull requests that aren't for a specific issue for various reasons.  It's far better to post an issue and let me or the community provide feedback prior to creating a pull request.
10 | 
11 | Please don't make pull requests against the `master` branch.  This is the latest, stable code.  You can make a pull request against one of the point branches or the `dev` (future release) branch.
12 | 
13 | ## Coding standards
14 | 
15 | In general, the project follows all WordPress [coding standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards).  There are instances where it doesn't, opting for personal choices of my own, but in terms of contributing, following the WordPress standards is best practice.
16 | 
17 | ## Script and style files
18 | 
19 | When making patches or pull requests with changes to script or style files, only do so to the primary file.  Don't create patches for the minified (`.min`) versions of the files.  Those will be minified after a patch is merged into the code base.
20 | 
21 | ## Language
22 | 
23 | All text strings follow U.S. English by default.  While such guides are generally unneeded, in cases where style considerations are necessary, these will typically follow conventions laid out in *Elements of Style* or the *AP Stylebook*.
24 | 
25 | ## Licensing
26 | 
27 | Any code contributed to the project via patches, pull requests, or other means will be licensed under the [GPL version 2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html) or later.  By contributing code to the project, you provide consent to use such code under this license.  The exception to this rule is when bringing in third-party code with an alternate open source license.
28 | 
29 | ## Versioning
30 | 
31 | The project uses [semantic versioning](http://semver.org).  Version numbers will look like `3.2.1` where `3` is the "major" release, `2` is the minor release, and `1` is the patch release.
32 | 


--------------------------------------------------------------------------------
/inc/functions-deprecated.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Deprecated functions.
 4 |  *
 5 |  * @package   Series
 6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
 7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
 8 |  * @link      https://themehybrid.com/plugins/series
 9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
10 |  */
11 | 
12 | class Series_Plugin {}
13 | 
14 | function series_plugin_register_taxonomies() {}
15 | function series_plugin_register_shortcodes() {}
16 | function get_series_feed_link() {}
17 | function create_series_taxonomy() {}
18 | function series_register_widgets() {}
19 | 
20 | /**
21 |  * @since      0.1.0
22 |  * @deprecated 2.0.0
23 |  */
24 | function the_series_shortcode( $attr ) {
25 | 
26 | 	_deprecated_function( __FUNCTION__, '2.0.0', '\Series\the_series_shortcode' );
27 | 
28 | 	return \Series\the_series_shortcode( $attr );
29 | }
30 | 
31 | /**
32 |  * @since      0.1.0
33 |  * @deprecated 0.2.0
34 |  */
35 | function is_series( $slug = false ) {
36 | 
37 | 	_deprecated_function( __FUNCTION__, '0.2.0', '\Series\is_series' );
38 | 
39 | 	return \Series\is_series( $slug );
40 | }
41 | 
42 | /**
43 |  * @since      0.1.0
44 |  * @deprecated 0.2.0
45 |  */
46 | function in_series( $series, $_post = null ) {
47 | 
48 | 	_deprecated_function( __FUNCTION__, '0.2.0', '\Series\in_series' );
49 | 
50 | 	return \Series\in_series( $series, $_post );
51 | }
52 | 
53 | /**
54 |  * @since      0.1.0
55 |  * @deprecated 2.0.0
56 |  */
57 | function series_list_posts( $args = array() ) {
58 | 
59 | 	_deprecated_function( __FUNCTION__, '2.0.0', '\Series\list_posts' );
60 | 
61 | 	return \Series\list_posts( $args );
62 | }
63 | 
64 | /**
65 |  * @since      0.1.0
66 |  * @deprecated 2.0.0
67 |  */
68 | function series_list_related( $args = array() ) {
69 | 
70 | 	_deprecated_function( __FUNCTION__, '2.0.0', '\Series\list_related' );
71 | 
72 | 	return \Series\list_related_posts( null, $args );
73 | }
74 | 


--------------------------------------------------------------------------------
/inc/functions-filters.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Plugin filters.
 4 |  *
 5 |  * @package   Series
 6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
 7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
 8 |  * @link      https://themehybrid.com/plugins/series
 9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
10 |  */
11 | 
12 | namespace Series;
13 | 
14 | # Filter prior to getting posts from the DB.
15 | add_action( 'pre_get_posts', __NAMESPACE__ . '\pre_get_posts' );
16 | 
17 | /**
18 |  * Filter on `pre_get_posts` to alter the main query on series archives.
19 |  *
20 |  * @since  2.0.0
21 |  * @access public
22 |  * @param  object  $query
23 |  * @return void
24 |  */
25 | function pre_get_posts( $query ) {
26 | 
27 | 	if ( ! is_admin() && $query->is_main_query() && is_series() ) {
28 | 
29 | 		// Set the themes per page.
30 | 		$query->set( 'posts_per_page', get_posts_per_page() );
31 | 		$query->set( 'orderby',        get_posts_orderby()  );
32 | 		$query->set( 'order',          get_posts_order()    );
33 | 	}
34 | }


--------------------------------------------------------------------------------
/inc/functions-options.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Functions for handling plugin options.
 4 |  *
 5 |  * @package   Series
 6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
 7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
 8 |  * @link      https://themehybrid.com/plugins/series
 9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
10 |  */
11 | 
12 | namespace Series;
13 | 
14 | /**
15 |  * Returns the number of posts per page for series archives.
16 |  *
17 |  * @since  2.0.0
18 |  * @access public
19 |  * @return int
20 |  */
21 | function get_posts_per_page() {
22 | 
23 | 	return apply_filters( 'series/get_posts_per_page', get_setting( 'posts_per_page' ) );
24 | }
25 | 
26 | /**
27 |  * Returns the posts orderby on series archives.
28 |  *
29 |  * @since  2.0.0
30 |  * @access public
31 |  * @return string
32 |  */
33 | function get_posts_orderby() {
34 | 
35 | 	return apply_filters( 'series/get_posts_orderby', get_setting( 'posts_orderby' ) );
36 | }
37 | 
38 | /**
39 |  * Returns the posts order on series archives.
40 |  *
41 |  * @since  2.0.0
42 |  * @access public
43 |  * @return string
44 |  */
45 | function get_posts_order() {
46 | 
47 | 	return apply_filters( 'series/get_posts_order', get_setting( 'posts_order' ) );
48 | }
49 | 
50 | /**
51 |  * Returns the series rewrite base. Used for series archives.
52 |  *
53 |  * @since  2.0.0
54 |  * @access public
55 |  * @return string
56 |  */
57 | function get_series_rewrite_base() {
58 | 
59 | 	return apply_filters( 'series/get_series_rewrite_base', get_setting( 'series_rewrite_base' ) );
60 | }
61 | 
62 | /**
63 |  * Gets a setting from from the plugin settings in the database.
64 |  *
65 |  * @since  2.0.0
66 |  * @access public
67 |  * @return mixed
68 |  */
69 | function get_setting( $option = '' ) {
70 | 
71 | 	$defaults = get_default_settings();
72 | 
73 | 	$settings = wp_parse_args( get_option( 'series_settings', $defaults ), $defaults );
74 | 
75 | 	return isset( $settings[ $option ] ) ? $settings[ $option ] : false;
76 | }
77 | 
78 | /**
79 |  * Returns an array of the default plugin settings.
80 |  *
81 |  * @since  2.0.0
82 |  * @access public
83 |  * @return array
84 |  */
85 | function get_default_settings() {
86 | 
87 | 	return array(
88 | 		// @since 2.0.0
89 | 		'series_rewrite_base' => 'series',
90 | 		'posts_per_page'      => 10,
91 | 		'posts_orderby'       => 'date',
92 | 		'posts_order'         => 'DESC'
93 | 	);
94 | }
95 | 


--------------------------------------------------------------------------------
/inc/functions-rewrite.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Plugin rewrite functions.
 4 |  *
 5 |  * @package   Series
 6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
 7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
 8 |  * @link      https://themehybrid.com/plugins/series
 9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
10 |  */
11 | 
12 | namespace Series;
13 | 
14 | /**
15 |  * Returns the tag rewrite slug used for tag archives.
16 |  *
17 |  * @since  2.0.0
18 |  * @access public
19 |  * @return string
20 |  */
21 | function get_series_rewrite_slug() {
22 | 
23 | 	$series_base = get_series_rewrite_base();
24 | 
25 | 	$slug = $series_base ? $series_base : 'series';
26 | 
27 | 	return apply_filters( 'series/get_series_rewrite_slug', $slug );
28 | }
29 | 


--------------------------------------------------------------------------------
/inc/functions-shortcodes.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * File for handling shortcodes.
  4 |  *
  5 |  * @package   Series
  6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
  7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
  8 |  * @link      https://themehybrid.com/plugins/series
  9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 10 |  */
 11 | 
 12 | namespace Series;
 13 | 
 14 | # Register shortcodes.
 15 | add_action( 'init', __NAMESPACE__ . '\register_shortcodes' );
 16 | 
 17 | /**
 18 |  * Registers the plugin shortcodes.
 19 |  *
 20 |  * @since  2.0.0
 21 |  * @access public
 22 |  * @return void
 23 |  */
 24 | function register_shortcodes() {
 25 | 
 26 | 	add_shortcode( 'series_list_posts',   __NAMESPACE__ . '\list_posts_shortcode'   );
 27 | 	add_shortcode( 'series_list_related', __NAMESPACE__ . '\list_related_shortcode' );
 28 | 
 29 | 	// @deprecated 2.0.0
 30 | 	add_shortcode( 'the-series', __NAMESPACE__ . '\the_series_shortcode' );
 31 | }
 32 | 
 33 | /**
 34 |  * List posts by series shortcode.
 35 |  *
 36 |  * @since  2.0.0
 37 |  * @access public
 38 |  * @param  array  $attr
 39 |  * @return string
 40 |  */
 41 | function list_posts_shortcode( $attr = array() ) {
 42 | 
 43 | 	$defaults = array(
 44 | 		'series'         => '',
 45 | 		'order'          => 'ASC',
 46 | 		'orderby'        => 'date',
 47 | 		'posts_per_page' => -1,
 48 | 	);
 49 | 
 50 | 	$attr = shortcode_atts( $defaults , $attr, 'series_list_posts' );
 51 | 
 52 | 	$attr['echo'] = false;
 53 | 
 54 | 	return list_posts( $attr );
 55 | }
 56 | 
 57 | /**
 58 |  * List posts in the same series as the current post.
 59 |  *
 60 |  * @since  2.0.0
 61 |  * @access public
 62 |  * @param  array  $attr
 63 |  * @return string
 64 |  */
 65 | function list_related_shortcode( $attr = array() ) {
 66 | 
 67 | 	$defaults = array(
 68 | 		'order'          => 'ASC',
 69 | 		'orderby'        => 'date',
 70 | 		'posts_per_page' => -1,
 71 | 	);
 72 | 
 73 | 	$attr = shortcode_atts( $defaults , $attr, 'series_list_related' );
 74 | 
 75 | 	$attr['echo'] = false;
 76 | 
 77 | 	return list_related_posts( get_the_ID(), $attr );
 78 | }
 79 | 
 80 | /**
 81 |  * Gets the series terms of the current post and displays them.
 82 |  *
 83 |  * @since  2.0.0
 84 |  * @access public
 85 |  * @attr   $attr
 86 |  * @return string
 87 |  */
 88 | function the_series_shortcode( $attr ) {
 89 | 
 90 | 	$attr = shortcode_atts(
 91 | 		array(
 92 | 			'before'    => '',
 93 | 			'after'     => '',
 94 | 			'separator' => ','
 95 | 		),
 96 | 		$attr,
 97 | 		'the-series'
 98 | 	);
 99 | 
100 | 	return get_the_term_list( get_the_ID(), 'series', $attr['before'], $attr['separator'], $attr['after'] );
101 | }
102 | 


--------------------------------------------------------------------------------
/inc/functions-taxonomies.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * File for registering custom taxonomies.
  4 |  *
  5 |  * @package   Series
  6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
  7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
  8 |  * @link      https://themehybrid.com/plugins/series
  9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 10 |  */
 11 | 
 12 | namespace Series;
 13 | 
 14 | # Register taxonomies on the 'init' hook.
 15 | add_action( 'init', __NAMESPACE__ . '\register_taxonomies', 9 );
 16 | 
 17 | # Filter the term updated messages.
 18 | add_filter( 'term_updated_messages', __NAMESPACE__ . '\term_updated_messages', 5 );
 19 | 
 20 | /**
 21 |  * Returns the name of the portfolio category taxonomy.
 22 |  *
 23 |  * @since  2.0.0
 24 |  * @access public
 25 |  * @return string
 26 |  */
 27 | function get_series_taxonomy() {
 28 | 
 29 | 	return apply_filters( 'series/get_series_taxonomy', 'series' );
 30 | }
 31 | 
 32 | /**
 33 |  * Returns the capabilities for the portfolio series taxonomy.
 34 |  *
 35 |  * @since  2.0.0
 36 |  * @access public
 37 |  * @return array
 38 |  */
 39 | function get_series_capabilities() {
 40 | 
 41 | 	$caps = array(
 42 | 		'manage_terms' => 'manage_series',
 43 | 		'edit_terms'   => 'manage_series',
 44 | 		'delete_terms' => 'manage_series',
 45 | 		'assign_terms' => 'edit_posts',
 46 | 	);
 47 | 
 48 | 	return apply_filters( 'series/get_series_capabilities', $caps );
 49 | }
 50 | 
 51 | /**
 52 |  * Returns the labels for the portfolio series taxonomy.
 53 |  *
 54 |  * @since  2.0.0
 55 |  * @access public
 56 |  * @return array
 57 |  */
 58 | function get_series_labels() {
 59 | 
 60 | 	$labels = array(
 61 | 		'name'                       => __( 'Series',                           'custom-content-portfolio' ),
 62 | 		'singular_name'              => __( 'Series',                           'custom-content-portfolio' ),
 63 | 		'menu_name'                  => __( 'Series',                           'custom-content-portfolio' ),
 64 | 		'name_admin_bar'             => __( 'Series',                           'custom-content-portfolio' ),
 65 | 		'search_items'               => __( 'Search Series',                    'custom-content-portfolio' ),
 66 | 		'popular_items'              => __( 'Popular Series',                   'custom-content-portfolio' ),
 67 | 		'all_items'                  => __( 'All Series',                       'custom-content-portfolio' ),
 68 | 		'edit_item'                  => __( 'Edit Series',                      'custom-content-portfolio' ),
 69 | 		'view_item'                  => __( 'View Series',                      'custom-content-portfolio' ),
 70 | 		'update_item'                => __( 'Update Series',                    'custom-content-portfolio' ),
 71 | 		'add_new_item'               => __( 'Add New Series',                   'custom-content-portfolio' ),
 72 | 		'new_item_name'              => __( 'New Series Name',                  'custom-content-portfolio' ),
 73 | 		'not_found'                  => __( 'No series found.',                 'custom-content-portfolio' ),
 74 | 		'no_terms'                   => __( 'No series',                        'custom-content-portfolio' ),
 75 | 		'items_list_navigation'      => __( 'Series list navigation',           'custom-content-portfolio' ),
 76 | 		'items_list'                 => __( 'Series list',                      'custom-content-portfolio' ),
 77 | 
 78 | 		// Non-hierarchical only.
 79 | 		'separate_items_with_commas' => __( 'Separate series with commas',      'custom-content-portfolio' ),
 80 | 		'add_or_remove_items'        => __( 'Add or remove series',             'custom-content-portfolio' ),
 81 | 		'choose_from_most_used'      => __( 'Choose from the most used series', 'custom-content-portfolio' ),
 82 | 	);
 83 | 
 84 | 	return apply_filters( 'series/get_series_labels', $labels );
 85 | }
 86 | 
 87 | /**
 88 |  * Register taxonomies for the plugin.
 89 |  *
 90 |  * @since  2.0.0
 91 |  * @access public
 92 |  * @return void.
 93 |  */
 94 | function register_taxonomies() {
 95 | 
 96 | 	// Set up the arguments for the portfolio series taxonomy.
 97 | 	$series_args = array(
 98 | 		'public'            => true,
 99 | 		'show_ui'           => true,
100 | 		'show_in_nav_menus' => true,
101 | 		'show_tagcloud'     => true,
102 | 		'show_admin_column' => true,
103 | 		'show_in_rest'      => true,
104 | 		'hierarchical'      => false,
105 | 		'query_var'         => get_series_taxonomy(),
106 | 		'capabilities'      => get_series_capabilities(),
107 | 		'labels'            => get_series_labels(),
108 | 
109 | 		// The rewrite handles the URL structure.
110 | 		'rewrite' => array(
111 | 			'slug'         => get_series_rewrite_slug(),
112 | 			'with_front'   => false,
113 | 			'hierarchical' => false,
114 | 			'ep_mask'      => EP_NONE
115 | 		),
116 | 	);
117 | 
118 | 	// Register the taxonomies.
119 | 	register_taxonomy(
120 | 		get_series_taxonomy(),
121 | 		array( 'post' ),
122 | 		apply_filters( 'series/series_taxonomy_args', $series_args )
123 | 	);
124 | }
125 | 
126 | /**
127 |  * Filters the term updated messages in the admin.
128 |  *
129 |  * @since  2.0.0
130 |  * @access public
131 |  * @param  array  $messages
132 |  * @return array
133 |  */
134 | function term_updated_messages( $messages ) {
135 | 
136 | 	$series_taxonomy = get_series_taxonomy();
137 | 
138 | 	// Add the portfolio series messages.
139 | 	$messages[ $series_taxonomy ] = array(
140 | 		0 => '',
141 | 		1 => __( 'Series added.',       'custom-content-portfolio' ),
142 | 		2 => __( 'Series deleted.',     'custom-content-portfolio' ),
143 | 		3 => __( 'Series updated.',     'custom-content-portfolio' ),
144 | 		4 => __( 'Series not added.',   'custom-content-portfolio' ),
145 | 		5 => __( 'Series not updated.', 'custom-content-portfolio' ),
146 | 		6 => __( 'Series deleted.',     'custom-content-portfolio' ),
147 | 	);
148 | 
149 | 	return $messages;
150 | }
151 | 


--------------------------------------------------------------------------------
/inc/template-general.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Functions for use in theme templates.
  4 |  *
  5 |  * @package   Series
  6 |  * @author    Justin Tadlock <justintadlock@gmail.com>
  7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
  8 |  * @link      https://themehybrid.com/plugins/series
  9 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 10 |  */
 11 | 
 12 | namespace Series;
 13 | 
 14 | /**
 15 |  * Conditional tag to check if viewing a series archive.
 16 |  *
 17 |  * @since  2.0.0
 18 |  * @access public
 19 |  * @param  mixed  $term
 20 |  * @return bool
 21 |  */
 22 | function is_series( $term = '' ) {
 23 | 
 24 | 	return apply_filters( 'series/is_series', is_tax( get_series_taxonomy(), $term ), $term );
 25 | }
 26 | 
 27 | /**
 28 |  * Conditional tag to check if the post is in a series.
 29 |  *
 30 |  * @since  2.0.0
 31 |  * @access public
 32 |  * @param  string|int|array  $term
 33 |  * @param  int|object        $post
 34 |  * @return bool
 35 |  */
 36 | function in_series( $term, $post = null ) {
 37 | 
 38 | 	return apply_filters( 'series/in_series', has_term( $series, get_series_taxonomy(), $post ), $term, $post );
 39 | }
 40 | 
 41 | /**
 42 |  * Outputs a post's series.
 43 |  *
 44 |  * @since  2.0.0
 45 |  * @access public
 46 |  * @param  array   $args
 47 |  * @return void
 48 |  */
 49 | function post_series( $args = array() ) {
 50 | 
 51 | 	echo get_post_series( $args );
 52 | }
 53 | 
 54 | /**
 55 |  * Wrapper for `get_the_term_list()` for outputting a list of the current
 56 |  * post's series.
 57 |  *
 58 |  * @since  2.0.0
 59 |  * @access public
 60 |  * @param  array   $args
 61 |  * @return string
 62 |  */
 63 | function get_post_series( $args = array() ) {
 64 | 
 65 | 	$html = '';
 66 | 
 67 | 	$defaults = array(
 68 | 		'post_id'    => get_the_ID(),
 69 | 		'text'       => '%s',
 70 | 		'before'     => '',
 71 | 		'after'      => '',
 72 | 		'wrap'       => '<span %s>%s</span>',
 73 | 		// Translators: Separates tags, categories, etc. when displaying a post.
 74 | 		'sep'        => _x( ', ', 'taxonomy terms separator', 'series' )
 75 | 	);
 76 | 
 77 | 	$args = wp_parse_args( $args, $defaults );
 78 | 
 79 | 	$terms = get_the_term_list( $args['post_id'], get_series_taxonomy(), '', $args['sep'], '' );
 80 | 
 81 | 	if ( $terms ) {
 82 | 		$html .= $args['before'];
 83 | 		$html .= sprintf( $args['wrap'], 'class="entry-terms entry-series"', sprintf( $args['text'], $terms ) );
 84 | 		$html .= $args['after'];
 85 | 	}
 86 | 
 87 | 	return $html;
 88 | }
 89 | 
 90 | /**
 91 |  * Displays a list of posts by series.
 92 |  *
 93 |  * @since  2.0.0
 94 |  * @param  array   $args
 95 |  * @return string
 96 |  */
 97 | function list_posts( $args = array() ) {
 98 | 
 99 | 	if ( empty( $args['series'] ) )
100 | 		return;
101 | 
102 | 	$out     = '';
103 | 	$post_id = 0;
104 | 
105 | 	if ( in_the_loop() )
106 | 		$post_id = get_the_ID();
107 | 
108 | 	else if ( is_singular() )
109 | 		$post_id = get_queried_object_id();
110 | 
111 | 	$defaults = array(
112 | 		'series'         => '', // term slug
113 | 		'order'          => 'ASC',
114 | 		'orderby'        => 'date',
115 | 		'posts_per_page' => -1,
116 | 		'echo'           => true
117 | 	);
118 | 
119 | 	$args = wp_parse_args( $args, $defaults );
120 | 
121 | 	$query_args = array(
122 | 		'order'          => $args['order'],
123 | 		'orderby'        => $args['orderby'],
124 | 		'posts_per_page' => $args['posts_per_page'],
125 | 		'tax_query'      => array(
126 | 			array(
127 | 				'taxonomy' => get_series_taxonomy(),
128 | 				'field'    => is_numeric( $args['series'] ) ? 'term_id' : 'slug',
129 | 				'terms'    => array( $args['series'] )
130 | 			)
131 | 		)
132 | 	);
133 | 
134 | 	$loop = new \WP_Query( $query_args );
135 | 
136 | 	if ( $loop->have_posts() ) {
137 | 
138 | 		$out .= '<ul class="series-list">';
139 | 
140 | 		while ( $loop->have_posts() ) {
141 | 
142 | 			$loop->the_post();
143 | 
144 | 			$title = get_the_title() ? the_title( '', '', false ) : get_the_ID();
145 | 
146 | 			$out .= $post_id === get_the_ID()
147 | 			        ? sprintf( '<li>%s</li>', $title )
148 | 			        : sprintf( '<li><a href="%s">%s</a></li>', esc_url( get_permalink() ), $title );
149 | 		}
150 | 
151 | 		$out .= '</ul>';
152 | 	}
153 | 
154 | 	wp_reset_postdata();
155 | 
156 | 	if ( false === $args['echo'] )
157 | 		return $out;
158 | 
159 | 	echo $out;
160 | }
161 | 
162 | /**
163 |  * Displays a list of posts related to the current post.
164 |  *
165 |  * @since  2.0.0
166 |  * @param  int     $post_id
167 |  * @param  array   $args
168 |  * @return string
169 |  */
170 | function list_related_posts( $post_id = 0, $args = array() ) {
171 | 
172 | 	if ( ! $post_id )
173 | 		get_the_ID();
174 | 
175 | 	if ( $post_id )
176 | 		$series = get_the_terms( $post_id, get_series_taxonomy() );
177 | 
178 | 	if ( empty( $series ) )
179 | 		return;
180 | 
181 | 	$series = reset( $series );
182 | 
183 | 	$args['series'] = $series->slug;
184 | 
185 | 	return list_posts( $args );
186 | }
187 | 


--------------------------------------------------------------------------------
/inc/widgets/class-list-posts.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * List Posts Widget - Lists posts from a given series.
  4 |  *
  5 |  * @package    Series
  6 |  * @author     Justin Tadlock <justintadlock@gmail.com>
  7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
  8 |  * @link       https://themehybrid.com/plugins/plugins
  9 |  * @license    http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 10 |  */
 11 | 
 12 | namespace Series\Widgets;
 13 | 
 14 | /**
 15 |  * List posts widget class.
 16 |  *
 17 |  * @since  2.0.0
 18 |  * @access public
 19 |  */
 20 | class List_Posts extends \WP_Widget {
 21 | 
 22 | 	/**
 23 | 	 * Default arguments for the widget settings.
 24 | 	 *
 25 | 	 * @since  2.0.0
 26 | 	 * @access public
 27 | 	 * @var    array
 28 | 	 */
 29 | 	public $defaults = array();
 30 | 
 31 | 	/**
 32 | 	 * Set up the widget's unique name, ID, class, description, and other options.
 33 | 	 *
 34 | 	 * @since  2.0.0
 35 | 	 * @access public
 36 | 	 * @return void
 37 | 	 */
 38 | 	public function __construct() {
 39 | 
 40 | 		// Set up the widget options.
 41 | 		$widget_options = array(
 42 | 			'classname'   => 'series-list-posts',
 43 | 			'description' => esc_html__( 'Displays a list of posts within a series.', 'series' )
 44 | 		);
 45 | 
 46 | 		// Create the widget.
 47 | 		parent::__construct( 'series-list-posts', __( 'Series - List Posts', 'series' ), $widget_options );
 48 | 
 49 | 		// Set up defaults.
 50 | 		$this->defaults = array(
 51 | 			'title'          => __( 'Series', 'series' ),
 52 | 			'series'         => '',
 53 | 			'order'          => 'ASC',
 54 | 			'orderby'        => 'date',
 55 | 			'posts_per_page' => -1,
 56 | 		);
 57 | 	}
 58 | 
 59 | 	/**
 60 | 	 * Outputs the widget based on the arguments input through the widget controls.
 61 | 	 *
 62 | 	 * @since  2.0.0
 63 | 	 * @access public
 64 | 	 * @return void
 65 | 	 */
 66 | 	public function widget( $sidebar, $instance ) {
 67 | 
 68 | 		// Set the $args for wp_get_archives() to the $instance array.
 69 | 		$args = wp_parse_args( $instance, $this->defaults );
 70 | 
 71 | 		// If there is no series, bail.
 72 | 		if ( ! $args['series'] )
 73 | 			return;
 74 | 
 75 | 		// Output the theme's widget wrapper.
 76 | 		echo $sidebar['before_widget'];
 77 | 
 78 | 		// If a title was input by the user, display it.
 79 | 		if ( ! empty( $instance['title'] ) )
 80 | 			echo $sidebar['before_title'] . apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ) . $sidebar['after_title'];
 81 | 
 82 | 		// Output the posts list.
 83 | 		\Series\list_posts( $args );
 84 | 
 85 | 		// Close the theme's widget wrapper.
 86 | 		echo $sidebar['after_widget'];
 87 | 	}
 88 | 
 89 | 	/**
 90 | 	 * The update callback for the widget control options.  This method is used to sanitize and/or
 91 | 	 * validate the options before saving them into the database.
 92 | 	 *
 93 | 	 * @since  2.0.0
 94 | 	 * @access public
 95 | 	 * @param  array  $new_instance
 96 | 	 * @param  array  $old_instance
 97 | 	 * @return array
 98 | 	 */
 99 | 	function update( $new_instance, $old_instance ) {
100 | 
101 | 		// Sanitize title.
102 | 		$instance['title'] = sanitize_text_field( $new_instance['title'] );
103 | 
104 | 		// Strip tags.
105 | 		$instance['series'] = strip_tags( $new_instance['series'] );
106 | 
107 | 		// Whitelist options.
108 | 		$order   = array( 'ASC', 'DESC' );
109 | 		$orderby = array( 'ID', 'author', 'none', 'title', 'name', 'date', 'modified', 'random', 'comment_count' );
110 | 
111 | 		$instance['order']   = in_array( $new_instance['order'], $order )   ? $new_instance['order']  : 'ASC';
112 | 		$instance['orderby'] = in_array( $new_instance['orderby'], $order )   ? $new_instance['orderby']  : 'date';
113 | 
114 | 		// Integers.
115 | 		$instance['posts_per_page'] = intval( $new_instance['posts_per_page'] );
116 | 
117 | 		// Return sanitized options.
118 | 		return $instance;
119 | 	}
120 | 
121 | 	/**
122 | 	 * Displays the widget control options in the Widgets admin screen.
123 | 	 *
124 | 	 * @since  2.0.0
125 | 	 * @access public
126 | 	 * @param  array  $instance
127 | 	 * @param  void
128 | 	 */
129 | 	public function form( $instance ) {
130 | 
131 | 		// Merge the user-selected arguments with the defaults.
132 | 		$instance = wp_parse_args( (array) $instance, $this->defaults );
133 | 
134 | 		/* Get series. */
135 | 		$terms = get_terms( \Series\get_series_taxonomy() );
136 | 
137 | 		// If there are no terms, return.
138 | 		if ( empty( $terms ) ) {
139 | 			esc_html_e( 'You need at least one series of posts to use this widget.', 'series' );
140 | 			return;
141 | 		}
142 | 
143 | 		// Orderby options.
144 | 		$orderby = array(
145 | 			'ID'            => __( 'ID',               'series' ),
146 | 			'author'        => __( 'Author',           'series' ),
147 | 			'none'          => __( 'None',             'series' ),
148 | 			'title'         => __( 'Title',            'series' ),
149 | 			'name'          => __( 'Slug',             'series' ),
150 | 			'date'          => __( 'Date (Published)', 'series' ),
151 | 			'modified'      => __( 'Date (Modified)',  'series' ),
152 | 			'random'        => __( 'Random',           'series' ),
153 | 			'comment_count' => __( 'Comment Count',    'series' )
154 | 		);
155 | 
156 | 		// Order options.
157 | 		$order = array(
158 | 			'ASC'  => __( 'Ascending',  'series' ),
159 | 			'DESC' => __( 'Descending', 'series' )
160 | 		); ?>
161 | 
162 | 		<p>
163 | 			<label>
164 | 				<?php esc_html_e( 'Title:', 'series' ); ?>
165 | 				<input type="text" class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" value="<?php echo esc_attr( $instance['title'] ); ?>" />
166 | 			</label>
167 | 		</p>
168 | 
169 | 		<p>
170 | 			<label>
171 | 				<?php esc_html_e( 'Series:', 'series' ); ?>
172 | 
173 | 				<select name="<?php echo esc_attr( $this->get_field_name( 'series' ) ); ?>" class="widefat" >
174 | 					<?php foreach ( $terms as $term ) : ?>
175 | 						<option value="<?php echo esc_attr( $term->slug ); ?>" <?php selected( $instance['series'], $term->slug ); ?>><?php echo esc_html( $term->name ); ?></option>
176 | 					<?php endforeach; ?>
177 | 				</select>
178 | 			</label>
179 | 		</p>
180 | 
181 | 		<p>
182 | 			<label>
183 | 				<?php esc_html_e( 'Order By:', 'series' ); ?>
184 | 
185 | 				<select class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'orderby' ) ); ?>">
186 | 					<?php foreach ( $orderby as $option_value => $option_label ) : ?>
187 | 						<option value="<?php echo esc_attr( $option_value ); ?>" <?php selected( $instance['orderby'], $option_value ); ?>><?php echo esc_html( $option_label ); ?></option>
188 | 					<?php endforeach; ?>
189 | 				</select>
190 | 			</label>
191 | 		</p>
192 | 
193 | 		<p>
194 | 			<label>
195 | 				<?php esc_html_e( 'Order:', 'series' ); ?>
196 | 
197 | 				<select class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'order' ) ); ?>">
198 | 					<?php foreach ( $order as $option_value => $option_label ) : ?>
199 | 						<option value="<?php echo esc_attr( $option_value ); ?>" <?php selected( $instance['order'], $option_value ); ?>><?php echo esc_html( $option_label ); ?></option>
200 | 					<?php endforeach; ?>
201 | 				</select>
202 | 			</label>
203 | 		</p>
204 | 
205 | 		<p>
206 | 			<label>
207 | 				<?php esc_html_e( 'Limit:', 'series' ); ?>
208 | 				<input type="text" class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'posts_per_page' ) ); ?>" value="<?php echo esc_attr( $instance['posts_per_page'] ); ?>" />
209 | 			</label>
210 | 		</p>
211 | 	<?php }
212 | }
213 | 


--------------------------------------------------------------------------------
/inc/widgets/class-list-related.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * List Related Posts Widget - Lists posts within the current post's series.
  4 |  *
  5 |  * @package    Series
  6 |  * @author     Justin Tadlock <justintadlock@gmail.com>
  7 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
  8 |  * @link       https://themehybrid.com/plugins/plugins
  9 |  * @license    http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 10 |  */
 11 | 
 12 | namespace Series\Widgets;
 13 | 
 14 | /**
 15 |  * List related posts widget class.
 16 |  *
 17 |  * @since  2.0.0
 18 |  * @access public
 19 |  */
 20 | class List_Related extends \WP_Widget {
 21 | 
 22 | 	/**
 23 | 	 * Default arguments for the widget settings.
 24 | 	 *
 25 | 	 * @since  2.0.0
 26 | 	 * @access public
 27 | 	 * @var    array
 28 | 	 */
 29 | 	public $defaults = array();
 30 | 
 31 | 	/**
 32 | 	 * Set up the widget's unique name, ID, class, description, and other options.
 33 | 	 *
 34 | 	 * @since  2.0.0
 35 | 	 * @access public
 36 | 	 * @return void
 37 | 	 */
 38 | 	public function __construct() {
 39 | 
 40 | 		// Set up the widget options.
 41 | 		$widget_options = array(
 42 | 			'classname'   => 'series-list-related',
 43 | 			'description' => esc_html__( "Displays a list of posts within the current post's series.", 'series' )
 44 | 		);
 45 | 
 46 | 		// Create the widget.
 47 | 		parent::__construct( 'series-list-related', __( 'Series - List Related', 'series' ), $widget_options );
 48 | 
 49 | 		// Set up defaults.
 50 | 		$this->defaults = array(
 51 | 			'title'          => __( 'In Series', 'series' ),
 52 | 			'order'          => 'ASC',
 53 | 			'orderby'        => 'date',
 54 | 			'posts_per_page' => -1
 55 | 		);
 56 | 	}
 57 | 
 58 | 	/**
 59 | 	 * Outputs the widget based on the arguments input through the widget controls.
 60 | 	 *
 61 | 	 * @since  2.0.0
 62 | 	 * @access public
 63 | 	 * @return void
 64 | 	 */
 65 | 	public function widget( $sidebar, $instance ) {
 66 | 
 67 | 		if ( ! is_singular() )
 68 | 			return;
 69 | 
 70 | 		// Set the $args for wp_get_archives() to the $instance array.
 71 | 		$args = wp_parse_args( $instance, $this->defaults );
 72 | 
 73 | 		// Don't echo.
 74 | 		$args['echo'] = false;
 75 | 
 76 | 		// Get the series list.
 77 | 		$list = \Series\list_related_posts( get_queried_object_id(), $args );
 78 | 
 79 | 		// Only display if we have a series.
 80 | 		if ( empty( $list ) )
 81 | 			return;
 82 | 
 83 | 		// Output the theme's widget wrapper.
 84 | 		echo $sidebar['before_widget'];
 85 | 
 86 | 		// If a title was input by the user, display it.
 87 | 		if ( ! empty( $instance['title'] ) )
 88 | 			echo $sidebar['before_title'] . apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ) . $sidebar['after_title'];
 89 | 
 90 | 		// Output the list.
 91 | 		echo $list;
 92 | 
 93 | 		// Close the theme's widget wrapper.
 94 | 		echo $sidebar['after_widget'];
 95 | 	}
 96 | 
 97 | 	/**
 98 | 	 * The update callback for the widget control options.  This method is used to sanitize and/or
 99 | 	 * validate the options before saving them into the database.
100 | 	 *
101 | 	 * @since  2.0.0
102 | 	 * @access public
103 | 	 * @param  array  $new_instance
104 | 	 * @param  array  $old_instance
105 | 	 * @return array
106 | 	 */
107 | 	function update( $new_instance, $old_instance ) {
108 | 
109 | 		// Sanitize title.
110 | 		$instance['title'] = sanitize_text_field( $new_instance['title'] );
111 | 
112 | 		// Whitelist options.
113 | 		$order   = array( 'ASC', 'DESC' );
114 | 		$orderby = array( 'ID', 'author', 'none', 'title', 'name', 'date', 'modified', 'random', 'comment_count' );
115 | 
116 | 		$instance['order']   = in_array( $new_instance['order'], $order )   ? $new_instance['order']  : 'ASC';
117 | 		$instance['orderby'] = in_array( $new_instance['orderby'], $order )   ? $new_instance['orderby']  : 'date';
118 | 
119 | 		// Integers.
120 | 		$instance['posts_per_page'] = intval( $new_instance['posts_per_page'] );
121 | 
122 | 		// Return sanitized options.
123 | 		return $instance;
124 | 	}
125 | 
126 | 	/**
127 | 	 * Displays the widget control options in the Widgets admin screen.
128 | 	 *
129 | 	 * @since  2.0.0
130 | 	 * @access public
131 | 	 * @param  array  $instance
132 | 	 * @param  void
133 | 	 */
134 | 	public function form( $instance ) {
135 | 
136 | 		// Merge the user-selected arguments with the defaults.
137 | 		$instance = wp_parse_args( (array) $instance, $this->defaults );
138 | 
139 | 		// Orderby options.
140 | 		$orderby = array(
141 | 			'ID'            => __( 'ID',               'series' ),
142 | 			'author'        => __( 'Author',           'series' ),
143 | 			'none'          => __( 'None',             'series' ),
144 | 			'title'         => __( 'Title',            'series' ),
145 | 			'name'          => __( 'Slug',             'series' ),
146 | 			'date'          => __( 'Date (Published)', 'series' ),
147 | 			'modified'      => __( 'Date (Modified)',  'series' ),
148 | 			'random'        => __( 'Random',           'series' ),
149 | 			'comment_count' => __( 'Comment Count',    'series' )
150 | 		);
151 | 
152 | 		// Order options.
153 | 		$order = array(
154 | 			'ASC'  => __( 'Ascending',  'series' ),
155 | 			'DESC' => __( 'Descending', 'series' )
156 | 		); ?>
157 | 
158 | 		<p>
159 | 			<label>
160 | 				<?php esc_html_e( 'Title:', 'series' ); ?>
161 | 				<input type="text" class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" value="<?php echo esc_attr( $instance['title'] ); ?>" />
162 | 			</label>
163 | 		</p>
164 | 
165 | 		<p>
166 | 			<label>
167 | 				<?php esc_html_e( 'Order By:', 'series' ); ?>
168 | 
169 | 				<select class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'orderby' ) ); ?>">
170 | 					<?php foreach ( $orderby as $option_value => $option_label ) : ?>
171 | 						<option value="<?php echo esc_attr( $option_value ); ?>" <?php selected( $instance['orderby'], $option_value ); ?>><?php echo esc_html( $option_label ); ?></option>
172 | 					<?php endforeach; ?>
173 | 				</select>
174 | 			</label>
175 | 		</p>
176 | 
177 | 		<p>
178 | 			<label>
179 | 				<?php esc_html_e( 'Order:', 'series' ); ?>
180 | 
181 | 				<select class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'order' ) ); ?>">
182 | 					<?php foreach ( $order as $option_value => $option_label ) : ?>
183 | 						<option value="<?php echo esc_attr( $option_value ); ?>" <?php selected( $instance['order'], $option_value ); ?>><?php echo esc_html( $option_label ); ?></option>
184 | 					<?php endforeach; ?>
185 | 				</select>
186 | 			</label>
187 | 		</p>
188 | 
189 | 		<p>
190 | 			<label>
191 | 				<?php esc_html_e( 'Limit:', 'series' ); ?>
192 | 				<input type="text" class="widefat" name="<?php echo esc_attr( $this->get_field_name( 'posts_per_page' ) ); ?>" value="<?php echo esc_attr( $instance['posts_per_page'] ); ?>" />
193 | 			</label>
194 | 		</p>
195 | 	<?php }
196 | }
197 | 


--------------------------------------------------------------------------------
/lang/series.pot:
--------------------------------------------------------------------------------
  1 | # Copyright (C) 2017 Series
  2 | # This file is distributed under the same license as the Series package.
  3 | msgid ""
  4 | msgstr ""
  5 | "Project-Id-Version: Series 2.0.0-dev\n"
  6 | "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/series\n"
  7 | "POT-Creation-Date: 2017-10-01 20:19:18+00:00\n"
  8 | "MIME-Version: 1.0\n"
  9 | "Content-Type: text/plain; charset=UTF-8\n"
 10 | "Content-Transfer-Encoding: 8bit\n"
 11 | "PO-Revision-Date: 2017-MO-DA HO:MI+ZONE\n"
 12 | "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 13 | "Language-Team: LANGUAGE <LL@li.org>\n"
 14 | 
 15 | #: admin/class-settings.php:53 admin/class-settings.php:248
 16 | msgid "Series Settings"
 17 | msgstr ""
 18 | 
 19 | #: admin/class-settings.php:54 inc/functions-taxonomies.php:61
 20 | #: inc/functions-taxonomies.php:62 inc/functions-taxonomies.php:63
 21 | #: inc/functions-taxonomies.php:64 inc/widgets/class-list-posts.php:51
 22 | msgid "Series"
 23 | msgstr ""
 24 | 
 25 | #: admin/class-settings.php:81
 26 | msgid "Reading"
 27 | msgstr ""
 28 | 
 29 | #: admin/class-settings.php:82
 30 | msgid "Permalinks"
 31 | msgstr ""
 32 | 
 33 | #: admin/class-settings.php:87
 34 | msgid "Posts Per Page"
 35 | msgstr ""
 36 | 
 37 | #: admin/class-settings.php:88
 38 | msgid "Sort By"
 39 | msgstr ""
 40 | 
 41 | #: admin/class-settings.php:89
 42 | msgid "Order"
 43 | msgstr ""
 44 | 
 45 | #: admin/class-settings.php:92
 46 | msgid "Series Slug"
 47 | msgstr ""
 48 | 
 49 | #: admin/class-settings.php:132
 50 | msgid "Reading settings for the front end of your site."
 51 | msgstr ""
 52 | 
 53 | #: admin/class-settings.php:160 inc/widgets/class-list-posts.php:146
 54 | #: inc/widgets/class-list-related.php:139
 55 | msgid "Author"
 56 | msgstr ""
 57 | 
 58 | #: admin/class-settings.php:161 inc/widgets/class-list-posts.php:150
 59 | #: inc/widgets/class-list-related.php:143
 60 | msgid "Date (Published)"
 61 | msgstr ""
 62 | 
 63 | #: admin/class-settings.php:162 inc/widgets/class-list-posts.php:151
 64 | #: inc/widgets/class-list-related.php:144
 65 | msgid "Date (Modified)"
 66 | msgstr ""
 67 | 
 68 | #: admin/class-settings.php:163 inc/widgets/class-list-posts.php:145
 69 | #: inc/widgets/class-list-related.php:138
 70 | msgid "ID"
 71 | msgstr ""
 72 | 
 73 | #: admin/class-settings.php:164 inc/widgets/class-list-posts.php:152
 74 | #: inc/widgets/class-list-related.php:145
 75 | msgid "Random"
 76 | msgstr ""
 77 | 
 78 | #: admin/class-settings.php:165 inc/widgets/class-list-posts.php:149
 79 | #: inc/widgets/class-list-related.php:142
 80 | msgid "Slug"
 81 | msgstr ""
 82 | 
 83 | #: admin/class-settings.php:166 inc/widgets/class-list-posts.php:148
 84 | #: inc/widgets/class-list-related.php:141
 85 | msgid "Title"
 86 | msgstr ""
 87 | 
 88 | #: admin/class-settings.php:190 inc/widgets/class-list-posts.php:158
 89 | #: inc/widgets/class-list-related.php:151
 90 | msgid "Ascending"
 91 | msgstr ""
 92 | 
 93 | #: admin/class-settings.php:191 inc/widgets/class-list-posts.php:159
 94 | #: inc/widgets/class-list-related.php:152
 95 | msgid "Descending"
 96 | msgstr ""
 97 | 
 98 | #: admin/class-settings.php:215
 99 | msgid "Set up custom permalinks for the series on your site."
100 | msgstr ""
101 | 
102 | #: admin/class-settings.php:253
103 | msgid "Update Settings"
104 | msgstr ""
105 | 
106 | #: inc/functions-capabilities.php:33
107 | msgid "Portfolio"
108 | msgstr ""
109 | 
110 | #: inc/functions-capabilities.php:52
111 | msgid "Create Projects"
112 | msgstr ""
113 | 
114 | #: inc/functions-capabilities.php:53
115 | msgid "Edit Projects"
116 | msgstr ""
117 | 
118 | #: inc/functions-capabilities.php:54
119 | msgid "Edit Others' Projects"
120 | msgstr ""
121 | 
122 | #: inc/functions-capabilities.php:55
123 | msgid "Read Private Projects"
124 | msgstr ""
125 | 
126 | #: inc/functions-capabilities.php:56
127 | msgid "Delete Projects"
128 | msgstr ""
129 | 
130 | #: inc/functions-capabilities.php:57
131 | msgid "Delete Private Projects"
132 | msgstr ""
133 | 
134 | #: inc/functions-capabilities.php:58
135 | msgid "Delete Published Projects"
136 | msgstr ""
137 | 
138 | #: inc/functions-capabilities.php:59
139 | msgid "Delete Others' Projects"
140 | msgstr ""
141 | 
142 | #: inc/functions-capabilities.php:60
143 | msgid "Edit Private Projects"
144 | msgstr ""
145 | 
146 | #: inc/functions-capabilities.php:61
147 | msgid "Edit Published Projects"
148 | msgstr ""
149 | 
150 | #: inc/functions-capabilities.php:62
151 | msgid "Publish Projects"
152 | msgstr ""
153 | 
154 | #: inc/functions-capabilities.php:65
155 | msgid "Assign Project Categories"
156 | msgstr ""
157 | 
158 | #: inc/functions-capabilities.php:66
159 | msgid "Delete Project Categories"
160 | msgstr ""
161 | 
162 | #: inc/functions-capabilities.php:67
163 | msgid "Edit Project Categories"
164 | msgstr ""
165 | 
166 | #: inc/functions-capabilities.php:68
167 | msgid "Manage Project Categories"
168 | msgstr ""
169 | 
170 | #: inc/functions-capabilities.php:71
171 | msgid "Assign Project Tags"
172 | msgstr ""
173 | 
174 | #: inc/functions-capabilities.php:72
175 | msgid "Delete Project Tags"
176 | msgstr ""
177 | 
178 | #: inc/functions-capabilities.php:73
179 | msgid "Edit Project Tags"
180 | msgstr ""
181 | 
182 | #: inc/functions-capabilities.php:74
183 | msgid "Manage Project Tags"
184 | msgstr ""
185 | 
186 | #: inc/functions-taxonomies.php:65
187 | msgid "Search Series"
188 | msgstr ""
189 | 
190 | #: inc/functions-taxonomies.php:66
191 | msgid "Popular Series"
192 | msgstr ""
193 | 
194 | #: inc/functions-taxonomies.php:67
195 | msgid "All Series"
196 | msgstr ""
197 | 
198 | #: inc/functions-taxonomies.php:68
199 | msgid "Edit Series"
200 | msgstr ""
201 | 
202 | #: inc/functions-taxonomies.php:69
203 | msgid "View Series"
204 | msgstr ""
205 | 
206 | #: inc/functions-taxonomies.php:70
207 | msgid "Update Series"
208 | msgstr ""
209 | 
210 | #: inc/functions-taxonomies.php:71
211 | msgid "Add New Series"
212 | msgstr ""
213 | 
214 | #: inc/functions-taxonomies.php:72
215 | msgid "New Series Name"
216 | msgstr ""
217 | 
218 | #: inc/functions-taxonomies.php:73
219 | msgid "No series found."
220 | msgstr ""
221 | 
222 | #: inc/functions-taxonomies.php:74
223 | msgid "No series"
224 | msgstr ""
225 | 
226 | #: inc/functions-taxonomies.php:75
227 | msgid "Series list navigation"
228 | msgstr ""
229 | 
230 | #: inc/functions-taxonomies.php:76
231 | msgid "Series list"
232 | msgstr ""
233 | 
234 | #: inc/functions-taxonomies.php:79
235 | msgid "Separate series with commas"
236 | msgstr ""
237 | 
238 | #: inc/functions-taxonomies.php:80
239 | msgid "Add or remove series"
240 | msgstr ""
241 | 
242 | #: inc/functions-taxonomies.php:81
243 | msgid "Choose from the most used series"
244 | msgstr ""
245 | 
246 | #: inc/functions-taxonomies.php:140
247 | msgid "Series added."
248 | msgstr ""
249 | 
250 | #: inc/functions-taxonomies.php:141 inc/functions-taxonomies.php:145
251 | msgid "Series deleted."
252 | msgstr ""
253 | 
254 | #: inc/functions-taxonomies.php:142
255 | msgid "Series updated."
256 | msgstr ""
257 | 
258 | #: inc/functions-taxonomies.php:143
259 | msgid "Series not added."
260 | msgstr ""
261 | 
262 | #: inc/functions-taxonomies.php:144
263 | msgid "Series not updated."
264 | msgstr ""
265 | 
266 | #. Translators: Separates tags, categories, etc. when displaying a post.
267 | 
268 | #: inc/template-general.php:74
269 | msgctxt "taxonomy terms separator"
270 | msgid ", "
271 | msgstr ""
272 | 
273 | #: inc/widgets/class-list-posts.php:43
274 | msgid "Displays a list of posts within a series."
275 | msgstr ""
276 | 
277 | #: inc/widgets/class-list-posts.php:47
278 | msgid "Series - List Posts"
279 | msgstr ""
280 | 
281 | #: inc/widgets/class-list-posts.php:139
282 | msgid "You need at least one series of posts to use this widget."
283 | msgstr ""
284 | 
285 | #: inc/widgets/class-list-posts.php:147 inc/widgets/class-list-related.php:140
286 | msgid "None"
287 | msgstr ""
288 | 
289 | #: inc/widgets/class-list-posts.php:153 inc/widgets/class-list-related.php:146
290 | msgid "Comment Count"
291 | msgstr ""
292 | 
293 | #: inc/widgets/class-list-posts.php:164 inc/widgets/class-list-related.php:157
294 | msgid "Title:"
295 | msgstr ""
296 | 
297 | #: inc/widgets/class-list-posts.php:171
298 | msgid "Series:"
299 | msgstr ""
300 | 
301 | #: inc/widgets/class-list-posts.php:183 inc/widgets/class-list-related.php:164
302 | msgid "Order By:"
303 | msgstr ""
304 | 
305 | #: inc/widgets/class-list-posts.php:195 inc/widgets/class-list-related.php:176
306 | msgid "Order:"
307 | msgstr ""
308 | 
309 | #: inc/widgets/class-list-posts.php:207 inc/widgets/class-list-related.php:188
310 | msgid "Limit:"
311 | msgstr ""
312 | 
313 | #: inc/widgets/class-list-related.php:43
314 | msgid "Displays a list of posts within the current post's series."
315 | msgstr ""
316 | 
317 | #: inc/widgets/class-list-related.php:47
318 | msgid "Series - List Related"
319 | msgstr ""
320 | 
321 | #: inc/widgets/class-list-related.php:51
322 | msgid "In Series"
323 | msgstr ""
324 | #. Plugin Name of the plugin/theme
325 | msgid "Series"
326 | msgstr ""
327 | 
328 | #. Plugin URI of the plugin/theme
329 | msgid "https://themehybrid.com/plugins/series"
330 | msgstr ""
331 | 
332 | #. Description of the plugin/theme
333 | msgid "Plugin that allows you to collect posts in a series."
334 | msgstr ""
335 | 
336 | #. Author of the plugin/theme
337 | msgid "Justin Tadlock"
338 | msgstr ""
339 | 
340 | #. Author URI of the plugin/theme
341 | msgid "https://themehybrid.com"
342 | msgstr ""
343 | 


--------------------------------------------------------------------------------
/license.md:
--------------------------------------------------------------------------------
  1 | 		    GNU GENERAL PUBLIC LICENSE
  2 | 		       Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  5 |  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 | 			    Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 | 		    GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 | 			    NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 | 		     END OF TERMS AND CONDITIONS
281 | 
282 | 	    How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     <one line to give the program's name and a brief idea of what it does.>
294 |     Copyright (C) <year>  <name of author>
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License along
307 |     with this program; if not, write to the Free Software Foundation, Inc.,
308 |     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 | 
310 | Also add information on how to contact you by electronic and paper mail.
311 | 
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 | 
315 |     Gnomovision version 69, Copyright (C) year name of author
316 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 |     This is free software, and you are welcome to redistribute it
318 |     under certain conditions; type `show c' for details.
319 | 
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License.  Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 | 
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary.  Here is a sample; alter the names:
328 | 
329 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 | 
332 |   <signature of Ty Coon>, 1 April 1989
333 |   Ty Coon, President of Vice
334 | 
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs.  If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library.  If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
 1 | # Series
 2 | 
 3 | Adds a new taxonomy called "series" to your blog that allows you to link together several posts in a series.
 4 | 
 5 | Series is a plugin created to allow users to easily link posts together by using a WordPress taxonomy (like tags or categories) called "series".  It can be particularly useful if you write several posts spanning the same topic and want them tied together in some way that tags or categories doesn't cover.
 6 | 
 7 | ## Professional Support
 8 | 
 9 | If you need professional plugin support from me, the plugin author, you can access the support forums at [Theme Hybrid](https://themehybrid.com/support), which is a professional WordPress help/support site where I handle support for all my plugins and themes for a community of 75,000+ users (and growing).
10 | 
11 | ## Copyright and License
12 | 
13 | This project is licensed under the [GNU GPL](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html), version 2 or later.
14 | 
15 | 2009 - 2018 &copy; [Justin Tadlock](http://justintadlock.com).
16 | 


--------------------------------------------------------------------------------
/readme.txt:
--------------------------------------------------------------------------------
  1 | === Series ===
  2 | 
  3 | Contributors: greenshady
  4 | Donate link: https://themehybrid.com/donate
  5 | Tags: series, widgets, shortcodes
  6 | Requires at least: 4.8
  7 | Tested up to: 5.0.2
  8 | Requires PHP: 5.3
  9 | Stable tag: 2.0.1
 10 | License: GPLv2 or later
 11 | License URI: http://www.gnu.org/licenses/gpl-2.0.html
 12 | 
 13 | Plugin that allows you to collect posts in a series.
 14 | 
 15 | == Description ==
 16 | 
 17 | Series is a plugin created to allow users to easily link posts together by using a WordPress taxonomy (like tags or categories) called "series".  It can be particularly useful if you write several posts spanning the same topic and want them tied together in some way that tags or categories doesn't cover.
 18 | 
 19 | ### Professional Support
 20 | 
 21 | If you need professional plugin support from me, the plugin author, you can access the support forums at [Theme Hybrid](https://themehybrid.com/support), which is a professional WordPress help/support site where I handle support for all my plugins and themes for a community of 75,000+ users (and growing).
 22 | 
 23 | ### Plugin Development
 24 | 
 25 | If you're a theme author, plugin author, or just a code hobbyist, you can follow the development of this plugin on it's [GitHub repository](https://github.com/justintadlock/series).
 26 | 
 27 | ### Donations
 28 | 
 29 | Yes, I do accept donations.  If you want to donate, you can do so from my [donations page](https://themehybrid.com/donate) or grab me something from my [Amazon Wish List](http://a.co/flUb0ns).
 30 | 
 31 | I appreciate all donations, no matter the size.  Further development of this plugin is not contingent on donations, but they are always a nice incentive.
 32 | 
 33 | == Frequently Asked Questions ==
 34 | 
 35 | ### Why was this plugin created?
 36 | 
 37 | Originally, it was a bit of a proof-of-concept of how plugins could create custom taxonomies based off a couple of highly-popular WordPress tutorials I wrote ([Custom taxonomies in WordPress 2.8](http://justintadlock.com/archives/2009/05/06/custom-taxonomies-in-wordpress-28) and [Using custom taxonomies to create a movie database](http://justintadlock.com/archives/2009/06/04/using-custom-taxonomies-to-create-a-movie-database)).
 38 | 
 39 | However, it was also a plugin I wanted for my personal blog.  I'd been using custom fields for years to handle series, but it was always kind of a crude method of doing so.  When WordPress created the Taxonomy API, I knew it was time to build something simple and usable for handling series on my site.
 40 | 
 41 | ### What does this plugin do, exactly?
 42 | 
 43 | It creates a new taxonomy called "series" for use on your site.  It gives you template tags, shortcodes, and widgets to allow you to more easily tie posts together in a series.
 44 | 
 45 | Basically, you get a new meta box on the edit post screen titled "Series" that works just like regular tags.  You can input a series name to add a post to a series.  You also get a "Series" screen under the "Posts" menu in the WordPress admin.
 46 | 
 47 | ### Why am I getting a 404 error on series pages?
 48 | 
 49 | You just need to set up the plugin.  Go to Settings > Series in your WordPress admin and save the settings.  It'll let WordPress know about your series permalink, which is necessary for showing series on the front end of the site.
 50 | 
 51 | ### What widgets are available to use?
 52 | 
 53 | * **Series - List Posts** - This widget allows you to list posts from any series you've created.
 54 | * **Series - List Related** - This widget displays posts within the current post's series.  So, it only shows up under two conditions: 1) you're viewing a single post and 2) the current post is within a series.
 55 | 
 56 | ### Are there other functions to use in my theme?
 57 | 
 58 | All standard WordPress functions for taxonomies work.  The name of the taxonomy is `series`.  So, if you want to do anything custom, WordPress already has the functions you need.  I'm not going to list them all here.  That'd be just like rewriting a large portion of the WordPress Codex, which is already available to you.
 59 | 
 60 | If you're looking for a specific template tag, start with the [category template tags](http://codex.wordpress.org/Template_Tags#Category_tags).  Most of them allow you to use custom taxonomies.
 61 | 
 62 | ### Can you show me some examples?
 63 | 
 64 | Okay.  I'll show a few, but you've probably seen them before if you've done anything with tags or categories.
 65 | 
 66 | #### Displaying a "tag" cloud
 67 | 
 68 | 	<?php wp_tag_cloud( array( 'taxonomy' => 'series' ) ); ?>
 69 | 
 70 | #### Displaying the current post's series
 71 | 
 72 | 	<?php echo get_the_term_list( get_the_ID(), 'series', 'Series: ', ', ', '' ); ?>
 73 | 
 74 | #### Displaying a "category" list of series
 75 | 
 76 | 	<ul>
 77 | 		<?php wp_list_categories( array( 'taxonomy' => 'series', 'title_li' => false ) ); ?>
 78 | 	</ul>
 79 | 
 80 | ### Can I create custom templates for series?
 81 | 
 82 | Certainly.  You can create templates for series archives.  Just copy your theme's `archive.php` or `index.php` template.  Then, rename it to `taxonomy-series.php` and make custom modifications from there.
 83 | 
 84 | If you want a template for a specific series, name the template `taxonomy-series-exampleslug.php`.
 85 | 
 86 | ### Can you add feature X?
 87 | 
 88 | I'll consider it.  Let me know what features you'd like to see added to the plugin.
 89 | 
 90 | ### This is way too complicated for me!
 91 | 
 92 | Please let me know how I could make things simpler for you in a future version of the plugin.
 93 | 
 94 | Also, keep in mind that there are other series plugins out there.  This particular plugin might not be the best fit for you.  However, I'm more than willing to listen to feedback on making things easier.
 95 | 
 96 | == Upgrade Notice ==
 97 | 
 98 | If upgrading from a version earlier than 0.2.0, be sure to check your widgets.  You may need to reset them.
 99 | 
100 | == Screenshots ==
101 | 
102 | 1. Series meta box on the edit post screen.
103 | 2. Widgets on the widgets admin screen.
104 | 3. Manage series admin screen.
105 | 4. Example widget output in theme.
106 | 
107 | == Changelog ==
108 | 
109 | Please see the `changelog.md` file included with the plugin.  Or, you can view the [online change log](https://github.com/justintadlock/series/blob/master/changelog.md).
110 | 


--------------------------------------------------------------------------------
/screenshot-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/justintadlock/series/ee896f5540ce19f98ab52431bc7274dd7468f33e/screenshot-1.png


--------------------------------------------------------------------------------
/screenshot-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/justintadlock/series/ee896f5540ce19f98ab52431bc7274dd7468f33e/screenshot-2.png


--------------------------------------------------------------------------------
/screenshot-3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/justintadlock/series/ee896f5540ce19f98ab52431bc7274dd7468f33e/screenshot-3.png


--------------------------------------------------------------------------------
/screenshot-4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/justintadlock/series/ee896f5540ce19f98ab52431bc7274dd7468f33e/screenshot-4.png


--------------------------------------------------------------------------------
/series.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Plugin Name: Series
  4 |  * Plugin URI:  https://themehybrid.com/plugins/series
  5 |  * Description: Plugin that allows you to collect posts in a series.
  6 |  * Version:     2.0.1
  7 |  * Author:      Justin Tadlock
  8 |  * Author URI:  https://themehybrid.com
  9 |  * Text Domain: series
 10 |  * Domain Path: /lang
 11 |  *
 12 |  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
 13 |  * General Public License as published by the Free Software Foundation; either version 2 of the License,
 14 |  * or (at your option) any later version.
 15 |  *
 16 |  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 17 |  * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 18 |  *
 19 |  * You should have received a copy of the GNU General Public License along with this program; if not,
 20 |  * write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 21 |  *
 22 |  * @package   Series
 23 |  * @author    Justin Tadlock <justintadlock@gmail.com>
 24 |  * @copyright Copyright (c) 2009 - 2018, Justin Tadlock
 25 |  * @link      https://themehybrid.com/plugins/series
 26 |  * @license   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 27 |  */
 28 | 
 29 | namespace Series;
 30 | 
 31 | /**
 32 |  * Singleton class that sets up and initializes the plugin.
 33 |  *
 34 |  * @since  2.0.0
 35 |  * @access public
 36 |  * @return void
 37 |  */
 38 | final class Plugin {
 39 | 
 40 | 	/**
 41 | 	 * Plugin directory path.
 42 | 	 *
 43 | 	 * @since  2.0.0
 44 | 	 * @access public
 45 | 	 * @var    string
 46 | 	 */
 47 | 	public $dir = '';
 48 | 
 49 | 	/**
 50 | 	 * Plugin directory URI.
 51 | 	 *
 52 | 	 * @since  2.0.0
 53 | 	 * @access public
 54 | 	 * @var    string
 55 | 	 */
 56 | 	public $uri = '';
 57 | 
 58 | 	/**
 59 | 	 * Returns the instance.
 60 | 	 *
 61 | 	 * @since  2.0.0
 62 | 	 * @access public
 63 | 	 * @return object
 64 | 	 */
 65 | 	public static function get_instance() {
 66 | 
 67 | 		static $instance = null;
 68 | 
 69 | 		if ( is_null( $instance ) ) {
 70 | 			$instance = new self;
 71 | 			$instance->setup();
 72 | 			$instance->includes();
 73 | 			$instance->setup_actions();
 74 | 		}
 75 | 
 76 | 		return $instance;
 77 | 	}
 78 | 
 79 | 	/**
 80 | 	 * Constructor method.
 81 | 	 *
 82 | 	 * @since  2.0.0
 83 | 	 * @access private
 84 | 	 * @return void
 85 | 	 */
 86 | 	private function __construct() {}
 87 | 
 88 | 	/**
 89 | 	 * Magic method to output a string if trying to use the object as a string.
 90 | 	 *
 91 | 	 * @since  2.0.0
 92 | 	 * @access public
 93 | 	 * @return void
 94 | 	 */
 95 | 	public function __toString() {
 96 | 		return 'series';
 97 | 	}
 98 | 
 99 | 	/**
100 | 	 * Sets up globals.
101 | 	 *
102 | 	 * @since  2.0.0
103 | 	 * @access private
104 | 	 * @return void
105 | 	 */
106 | 	private function setup() {
107 | 
108 | 		// Main plugin directory path and URI.
109 | 		$this->dir = trailingslashit( plugin_dir_path( __FILE__ ) );
110 | 		$this->uri  = trailingslashit( plugin_dir_url(  __FILE__ ) );
111 | 	}
112 | 
113 | 	/**
114 | 	 * Loads files needed by the plugin.
115 | 	 *
116 | 	 * @since  2.0.0
117 | 	 * @access private
118 | 	 * @return void
119 | 	 */
120 | 	private function includes() {
121 | 
122 | 		// Include functions files.
123 | 		require_once( $this->dir . 'inc/functions-filters.php'    );
124 | 		require_once( $this->dir . 'inc/functions-options.php'    );
125 | 		require_once( $this->dir . 'inc/functions-rewrite.php'    );
126 | 		require_once( $this->dir . 'inc/functions-shortcodes.php' );
127 | 		require_once( $this->dir . 'inc/functions-taxonomies.php' );
128 | 		require_once( $this->dir . 'inc/functions-deprecated.php' );
129 | 
130 | 		// Include template files.
131 | 		require_once( $this->dir . 'inc/template-general.php' );
132 | 
133 | 		// Load widget classes.
134 | 		require_once( $this->dir . 'inc/widgets/class-list-posts.php'   );
135 | 		require_once( $this->dir . 'inc/widgets/class-list-related.php' );
136 | 
137 | 		// Load admin files.
138 | 		if ( is_admin() ) {
139 | 
140 | 			require_once( $this->dir . 'admin/class-settings.php' );
141 | 		}
142 | 	}
143 | 
144 | 	/**
145 | 	 * Sets up main plugin actions and filters.
146 | 	 *
147 | 	 * @since  1.0.0
148 | 	 * @access private
149 | 	 * @return void
150 | 	 */
151 | 	private function setup_actions() {
152 | 
153 | 		// Internationalize the text strings used.
154 | 		add_action( 'plugins_loaded', array( $this, 'i18n' ), 2 );
155 | 
156 | 		/* Register widgets. */
157 | 		add_action( 'widgets_init', array( $this, 'register_widgets' ) );
158 | 
159 | 		// Register activation hook.
160 | 		register_activation_hook( __FILE__, array( $this, 'activation' ) );
161 | 	}
162 | 
163 | 	/**
164 | 	 * Loads the translation files.
165 | 	 *
166 | 	 * @since  2.0.0
167 | 	 * @access public
168 | 	 * @return void
169 | 	 */
170 | 	public function i18n() {
171 | 
172 | 		load_plugin_textdomain( 'series', false, trailingslashit( dirname( plugin_basename( __FILE__ ) ) ) . 'lang' );
173 | 	}
174 | 
175 | 	/**
176 | 	 * Loads the admin functions and files.
177 | 	 *
178 | 	 * @since  2.0.0
179 | 	 * @access public
180 | 	 * @return void
181 | 	 */
182 | 	public function register_widgets() {
183 | 
184 | 		register_widget( __NAMESPACE__ . '\Widgets\List_Posts'   );
185 | 		register_widget( __NAMESPACE__ . '\Widgets\List_Related' );
186 | 	}
187 | 
188 | 	/**
189 | 	 * Method that runs only when the plugin is activated.
190 | 	 *
191 | 	 * @since  2.0.0
192 | 	 * @access public
193 | 	 * @return void
194 | 	 */
195 | 	public function activation() {
196 | 
197 | 		// Get the administrator role.
198 | 		$role = get_role( 'administrator' );
199 | 
200 | 		// If the administrator role exists, add required capabilities for the plugin.
201 | 		if ( ! empty( $role ) ) {
202 | 
203 | 			$role->add_cap( 'manage_series' );
204 | 		}
205 | 	}
206 | }
207 | 
208 | /**
209 |  * Gets the instance of the `Plugin` class.  This function is useful for quickly grabbing data
210 |  * used throughout the plugin.
211 |  *
212 |  * @since  2.0.0
213 |  * @access public
214 |  * @return object
215 |  */
216 | function plugin() {
217 | 
218 | 	return Plugin::get_instance();
219 | }
220 | 
221 | // Let's roll!
222 | plugin();
223 | 


--------------------------------------------------------------------------------