wp-print-friendly.php 31.5 KB
Newer Older
1 2 3 4 5
<?php
/*
Plugin Name: WP Print Friendly
Plugin URI: http://www.thinkoomph.com/plugins-modules/wp-print-friendly/
Description: Extends WordPress' template system to support printer-friendly templates. Works with permalink structures to support nice URLs.
6
Author: Erick Hitter, Steven K Word & Oomph, Inc.
7
Version: 0.6
8
Author URI: http://www.thinkoomph.com/
Erick Hitter's avatar
Erick Hitter committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
23 24 25
*/

class wp_print_friendly {
26 27 28 29 30 31 32 33
	/**
	 * Singleton
	 */
	private static $__instance = null;

	/**
	 * Class variables
	 */
34
	var $query_var = 'print';
35

36
	var $ns = 'wp_print_friendly';
37

38 39 40 41 42 43 44 45 46 47 48 49
	var $settings_key = 'wpf';
	var $settings_defaults = array(
		'auto' => false,
		'placement' => 'below',
		'post_types' => array( 'post', 'page' ),
		'print_text' => 'Print this entry',
		'print_text_page' => 'Print this page',
		'css_class' => 'print_link',
		'link_target' => 'same',
		'endnotes' => true,
		'endnotes_label' => 'Endnotes:'
	);
50

51
	var $notice_key = 'wpf_admin_notice_dismissed';
52

Erick Hitter's avatar
Erick Hitter committed
53
	/**
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
	 * Silence is golden!
	 */
	private function __construct() {}

	/**
	 * Implement singleton
	 *
	 * @uses self::setup
	 * @return self
	 */
	public static function get_instance() {
		if ( ! is_a( self::$__instance, __CLASS__ ) ) {
			self::$__instance = new self;

			self::$__instance->setup();
		}

		return self::$__instance;
	}

	/**
	 * Register deactivation hook and tie balance of plugin hooks to `plugins_loaded`.
Erick Hitter's avatar
Erick Hitter committed
76
	 *
77 78 79
	 * @uses register_deactivation_hook, add_filter
	 * @return null
	 */
80
	private function setup() {
81 82 83
		register_deactivation_hook( __FILE__, array( $this, 'deactivation_hook' ) );
		add_action( 'plugins_loaded', array( $this, 'action_plugins_loaded' ) );
	}
84

Erick Hitter's avatar
Erick Hitter committed
85
	/**
86
	 * Clean up after plugin deactivation.
Erick Hitter's avatar
Erick Hitter committed
87
	 *
88 89 90 91
	 * @uses flush_rewrite_rules, delete_option
	 * @action register_deactivation_hook
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
92
	public function deactivation_hook() {
93
		flush_rewrite_rules();
94

95 96 97
		delete_option( $this->settings_key );
		delete_option( $this->notice_key );
	}
98

Erick Hitter's avatar
Erick Hitter committed
99
	/**
100
	 * Register actions and filters.
Erick Hitter's avatar
Erick Hitter committed
101
	 *
102 103 104 105
	 * @uses add_action, add_filter, get_option
	 * @action plugins_loaded
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
106
	public function action_plugins_loaded() {
107 108 109 110 111 112
		add_action( 'init', array( $this, 'action_init' ), 20 );
		add_action( 'admin_init', array( $this, 'action_admin_init' ) );
		add_action( 'admin_menu', array( $this, 'action_admin_menu' ) );
		add_filter( 'request', array( $this, 'filter_request' ) );
		add_action( 'pre_get_posts', array( $this, 'action_pre_get_posts' ) );
		add_filter( 'template_include', array( $this, 'filter_template_include' ) );
Erick Hitter's avatar
Erick Hitter committed
113
		add_filter( 'redirect_canonical', array( $this, 'filter_redirect_canonical' ) );
114 115 116 117
		add_filter( 'body_class', array( $this, 'filter_body_class' ) );
		add_filter( 'the_content', array( $this, 'filter_the_content' ), 0 );
		add_filter( 'the_content', array( $this, 'filter_the_content_auto' ) );
		add_filter( 'the_content', array( $this, 'filter_the_content_late' ), 99 );
118

Erick Hitter's avatar
Erick Hitter committed
119
		if ( ! get_option( $this->notice_key ) )
120 121
			add_action( 'admin_notices', array( $this, 'action_admin_notices_activation' ) );
	}
122

Erick Hitter's avatar
Erick Hitter committed
123
	/**
124
	 * Add print endpoint and rewrite rules for term taxonomy archives
Erick Hitter's avatar
Erick Hitter committed
125 126
	 *
	 * @uses add_rewrite_endpoint, $wp_rewrite, get_taxonomies, add_rewrite_rule, trailingslashit
127 128 129
	 * @action init
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
130
	public function action_init() {
131
		add_rewrite_endpoint( $this->query_var, EP_ALL );
132

133
		global $wp_rewrite;
134 135

		//Taxonomies, since they aren't covered by add_rewrite_endpoint
Erick Hitter's avatar
Erick Hitter committed
136
		if ( $wp_rewrite->permalink_structure ) {
137
			$taxonomies = get_taxonomies( array(), 'objects' );
Erick Hitter's avatar
Erick Hitter committed
138 139
			foreach ( $taxonomies as $taxonomy => $args ) {
				if ( $args->rewrite == false || 'post_format' == $taxonomy )
140
					continue;
141

142
				$taxonomy_slug = '';
Erick Hitter's avatar
Erick Hitter committed
143
				if ( $args->rewrite[ 'with_front' ] && $wp_rewrite->front != '/' ) $taxonomy_slug .= $wp_rewrite->front;
144
				$taxonomy_slug .= $args->rewrite[ 'slug' ];
145

146
				$query_var = $args->query_var ? $args->query_var : 'taxonomy=' . $taxonomy . '&term';
147 148

				add_rewrite_rule( $taxonomy_slug . '/(.+)/' . $this->query_var . '(/([0-9]*))?/?$', $wp_rewrite->index . '?' . $query_var . '=$matches[1]&' . $this->query_var . '=$matches[3]', 'top' );
149 150
			}
		}
151 152 153

		//Extra rules needed if verbose page rules are requested
		if ( $wp_rewrite->use_verbose_page_rules ) {
154
			//Build regex
155 156 157 158
			$regex = substr( str_replace( $wp_rewrite->rewritecode, $wp_rewrite->rewritereplace, $wp_rewrite->permalink_structure ), 1 );
			$regex = trailingslashit( $regex );
			$regex .= $this->query_var . '(/([0-9]*))?/?$';

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
			//Build corresponding query string
			$query = substr( str_replace( $wp_rewrite->rewritecode, $wp_rewrite->queryreplace, $wp_rewrite->permalink_structure ), 1 );
			$query = explode( '/', $query );
			$query = array_filter( $query );

			$i = 1;
			foreach ( $query as $key => $qv ) {
				$query[ $key ] .= '$matches[' . $i . ']';
				$i++;
			}

			$query[] = $this->query_var . '=$matches[' . ( $i + 1 ) . ']';

			$query = implode( '&', $query );

			//Add rule
			add_rewrite_rule( $regex, $wp_rewrite->index . '?' . $query, 'top' );
176
		}
177
	}
178

Erick Hitter's avatar
Erick Hitter committed
179
	/**
180
	 * Register plugin option and disable rewrite rule flush warning.
Erick Hitter's avatar
Erick Hitter committed
181
	 *
182 183 184 185
	 * @uses register_setting, update_option
	 * @action admin_init
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
186
	public function action_admin_init() {
187
		register_setting( $this->settings_key, $this->settings_key, array( $this, 'admin_options_validate' ) );
188

Erick Hitter's avatar
Erick Hitter committed
189
		if ( isset( $_GET[ $this->notice_key ] ) )
190 191
			update_option( $this->notice_key, 1 );
	}
192

Erick Hitter's avatar
Erick Hitter committed
193
	/**
194
	 * Determine if print template is being requested.
Erick Hitter's avatar
Erick Hitter committed
195
	 *
196 197
	 * If WordPress determined this request is a 404, do nothing and let the main theme handle things.
	 *
198
	 * @global $wp_query
199
	 * @uses is_404
200 201
	 * @return bool
	 */
Erick Hitter's avatar
Erick Hitter committed
202
	public function is_print() {
203
		global $wp_query;
204
		return is_array( $wp_query->query ) && array_key_exists( $this->query_var, $wp_query->query ) && ! is_404();
205
	}
206

Erick Hitter's avatar
Erick Hitter committed
207
	/**
208 209
	 * Select appropriate template based on post type and available templates.
	 * Returns an array with name and path keys for available template or false if no template is found.
Erick Hitter's avatar
Erick Hitter committed
210
	 *
211 212 213
	 * @uses get_queried_object, is_home, is_front_page, locate_template
	 * @return array or false
	 */
Erick Hitter's avatar
Erick Hitter committed
214
	public function template_chooser() {
215 216
		//Get queried object to check post type
		$queried_object = get_queried_object();
217

218 219
		//Get plugin path
		$pluginpath = dirname( __FILE__ );
220

Erick Hitter's avatar
Erick Hitter committed
221
		if ( ( is_home() || is_front_page() ) && ( '' !== ( $path = locate_template( 'wpf-home.php', false ) ) ) ) {
222 223 224 225
			$template = array(
				'name' => 'wpf-home',
				'path' => $path
			);
226
		} elseif (
227 228 229
			is_object( $queried_object ) &&
			property_exists( $queried_object, 'taxonomy' ) &&
			property_exists( $queried_object, 'slug' ) &&
230
			( '' !== ( $path = locate_template( array( 'wpf-' . $queried_object->taxonomy . '-' . $queried_object->slug . '.php', 'wpf-' . $queried_object->taxonomy . '.php' ), false ) ) )
231
		) {
232 233 234 235
			$template = array(
				'name' => 'wpf-' . $queried_object->taxonomy,
				'path' => $path
			);
236
		} elseif (
237 238 239 240
			is_object( $queried_object ) &&
			property_exists( $queried_object, 'post_type' ) &&
			property_exists( $queried_object, 'post_name' ) &&
			( '' !== ( $path = locate_template( array( 'wpf-' . $queried_object->post_type . '-' . $queried_object->post_name . '.php', 'wpf-' . $queried_object->post_type . '.php' ), false ) ) )
241
		) {
242 243 244 245
			$template = array(
				'name' => 'wpf-' . $queried_object->post_type,
				'path' => $path
			);
246
		} elseif (
247 248 249
			is_object( $queried_object ) &&
			property_exists( $queried_object, 'post_name' ) &&
			( '' !== ( $path = locate_template( 'wpf-' . $queried_object->post_name . '.php', false ) ) )
250
		) {
251 252 253 254
			$template = array(
				'name' => 'wpf-' . $queried_object->post_name,
				'path' => $path
			);
255
		} elseif ( '' !== ( $path = locate_template( 'wpf.php', false ) ) ) {
256 257 258 259
			$template = array(
				'name' => 'wpf-default',
				'path' => $path
			);
260
		} elseif ( file_exists( $pluginpath . '/default-template.php' ) ) {
261 262 263 264
			$template = array(
				'name' => 'wpf-plugin-default',
				'path' => $pluginpath . '/default-template.php'
			);
265
		}
266

267 268
		return isset( $template ) ? $template : false;
	}
269

Erick Hitter's avatar
Erick Hitter committed
270 271 272
	/**
	 * Detect request for print stylesheet on the homepage and reset query variables.
	 *
273 274 275 276
	 * @param array $qv
	 * @filter request
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
277 278
	public function filter_request( $qv ) {
		if ( array_key_exists( 'pagename', $qv ) && $qv[ 'pagename' ] == $this->query_var ) {
279 280 281 282
			$qv[ $this->query_var ] = '';
			unset( $qv[ 'page' ] );
			unset( $qv[ 'pagename' ] );
		}
283

Erick Hitter's avatar
Erick Hitter committed
284
		if ( array_key_exists( $this->query_var, $qv ) && is_numeric( $qv[ $this->query_var ] ) )
285
			$qv[ 'page' ] = intval( $qv[ $this->query_var ] );
286

287 288
		return $qv;
	}
289

Erick Hitter's avatar
Erick Hitter committed
290
	/**
291
	 * Filter query when request to print specific page is made.
Erick Hitter's avatar
Erick Hitter committed
292
	 *
293 294 295 296
	 * @param object $query
	 * @action pre_get_posts
	 * @return object
	 */
Erick Hitter's avatar
Erick Hitter committed
297 298
	public function action_pre_get_posts( $query ) {
		if ( array_key_exists( $this->query_var, $query->query_vars ) && ! empty( $query->query_vars[ $this->query_var ] ) ) {
299
			$qv = explode( '/', $query->query_vars[ $this->query_var ] );
300

Erick Hitter's avatar
Erick Hitter committed
301
			if ( array_key_exists( 1, $qv ) && is_numeric( $qv[ 1 ] ) )
302 303
				$query->query_vars[ 'page' ] = (int)$qv[ 1 ];
		}
304

305 306
		return $query;
	}
307

Erick Hitter's avatar
Erick Hitter committed
308
	/**
309
	 * Filter template include to return print template if requested.
Erick Hitter's avatar
Erick Hitter committed
310
	 *
311 312 313 314
	 * @param string $template
	 * @filter template_include
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
315
	public function filter_template_include( $template ) {
316
		if ( $this->is_print() && ( $print_template = $this->template_chooser() ) )
317
			$template = $print_template[ 'path' ];
318

319 320
		return $template;
	}
321

Erick Hitter's avatar
Erick Hitter committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
	/**
	 * Prevent canonical redirect if print URL is requested.
	 *
	 * @param string $url
	 * @uses this::is_print
	 * @filter redirect_canonical
	 * @return string or false
	 */
	public function filter_redirect_canonical( $url ) {
		if ( $this->is_print() )
			$url = false;

		return $url;
	}

	/**
338
	 * Filter body classes to include references to print template.
Erick Hitter's avatar
Erick Hitter committed
339
	 *
340 341 342 343
	 * @param array $classes
	 * @filter body_class
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
344 345 346
	public function filter_body_class( $classes ) {
		if ( $this->is_print() && ( $print_template = $this->template_chooser() ) ) {
			if ( $print_template[ 'name' ] == 'default' )
347 348 349 350
				$classes[] = 'wpf';
			else
				$classes[] = $print_template[ 'name' ];
		}
351

352 353
		return $classes;
	}
354

Erick Hitter's avatar
Erick Hitter committed
355
	/**
356
	 * Filter post content to support printing entire post on one page.
Erick Hitter's avatar
Erick Hitter committed
357
	 *
358
	 * @param string $content
359
	 * @uses post_password_required
360 361 362 363
	 * @uses get_query_var
	 * @filter the_content
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
364
	public function filter_the_content( $content ) {
365
		if ( $this->is_print() && ! post_password_required() ) {
366
			$print = get_query_var( $this->query_var );
367

Erick Hitter's avatar
Erick Hitter committed
368
			if ( $print == 'all' || $print == '/all' || empty( $print ) ) {
369
				global $post;
370

371 372 373 374 375 376 377
				$content = $post->post_content;
				$content = str_replace("\n<!--nextpage-->\n", "\n\n", $content);
				$content = str_replace("\n<!--nextpage-->", "\n", $content);
				$content = str_replace("<!--nextpage-->\n", "\n", $content);
				$content = str_replace("<!--nextpage-->", ' ', $content);
			}
		}
378

379 380
		return $content;
	}
381

Erick Hitter's avatar
Erick Hitter committed
382 383 384
	/**
	 * Filter the content if automatic inclusion is selected.
	 *
385
	 * @param string $content
386
	 * @uses $this::get_options, $post, $this::print_url, get_query_var, apply_filters
387 388 389
	 * @filter the_content
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
390
	public function filter_the_content_auto( $content ) {
391
		$options = $this->get_options();
392

393
		global $post;
394

Erick Hitter's avatar
Erick Hitter committed
395
		if ( is_array( $options ) && array_key_exists( 'auto', $options ) && $options[ 'auto' ] == true && in_array( $post->post_type, $options[ 'post_types' ] ) && ! $this->is_print() ) {
396
			extract( $options );
397

398 399
			//Basic URL
			$print_url = $this->print_url();
400

401
			//Page URL, if necessary
Erick Hitter's avatar
Erick Hitter committed
402
			if ( ! empty( $print_text_page ) && strpos( $post->post_content, '<!--nextpage-->' ) !== false ) {
403 404
				$page = get_query_var( 'page' );
				$page = $page ? $page : 1;
405

406 407
				$print_url_page = $this->print_url( false, $page );
			}
408

409 410
			//Build link(s)
			$link = '<p class="wpf_wrapper"><a class="' . $css_class . '" href="' . $print_url . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $print_text . '</a>';
411

Erick Hitter's avatar
Erick Hitter committed
412
			if ( isset( $print_url_page ) ) {
413 414 415
				$link .= ' | ';
				$link .= '<a class="' . $css_class . ' ' . $css_class . '_cur" href="' . $print_url_page . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $print_text_page . '</a>';
			}
416

417
			$link .= '</p><!-- .wpf_wrapper -->';
418

419
			//Place link(s)
Erick Hitter's avatar
Erick Hitter committed
420
			if ( $placement == 'above' )
421
				$content = $link . $content;
Erick Hitter's avatar
Erick Hitter committed
422
			elseif ( $placement == 'below' )
423
				$content = $content . $link;
Erick Hitter's avatar
Erick Hitter committed
424
			elseif ( $placement == 'both' )
425 426
				$content = $link . $content . $link;
		}
427

428 429
		return $content;
	}
430

Erick Hitter's avatar
Erick Hitter committed
431 432 433
	/**
	 * Convert links to endnotes if desired.
	 *
434
	 * @param string $content
435 436 437
	 * @uses this::is_print
	 * @uses post_password_required
	 * @uses this::get_options
438 439 440
	 * @filter the_content
	 * @return string
	 */
Erick Hitter's avatar
Erick Hitter committed
441
	public function filter_the_content_late( $content ) {
442
		if ( $this->is_print() && ! post_password_required() ) {
443
			global $post;
444

445
			$options = $this->get_options();
446

447
			//Endnotes
Erick Hitter's avatar
Erick Hitter committed
448
			if ( $options[ 'endnotes' ] ) {
449 450
				$links = array();
				$i = 1;
451

452 453
				//Build array of links
				preg_match_all( '#<a href=(["\'{1}])([^"\']+)(["\'{1}])([^>]*)>(.*?)</a>#i', $content, $matches );
454

Erick Hitter's avatar
Erick Hitter committed
455
				if (
456
					isset( $matches ) && is_array( $matches ) &&
Erick Hitter's avatar
Erick Hitter committed
457 458 459
					array_key_exists( 0, $matches ) && ! empty( $matches[ 0 ] ) &&
					array_key_exists( 2, $matches ) && ! empty( $matches[ 2 ] ) &&
					array_key_exists( 5, $matches ) && ! empty( $matches[ 5 ] )
460 461 462
				) {
					//Format matches for replacement in content
					$replacements = array();
Erick Hitter's avatar
Erick Hitter committed
463
					foreach ( $matches[ 0 ] as $key => $match ) {
464 465 466 467 468
						$replacements[ $match ] = array(
							'url' => $matches[ 2 ][ $key ],
							'title' => $matches[ 5 ][ $key ]
						);
					}
469

470
					//Replace links with endnote markers
Erick Hitter's avatar
Erick Hitter committed
471
					foreach ( $replacements as $match => $args ) {
472 473 474 475
						$content = str_replace( $match, $args[ 'title' ] . '[' . $i . ']', $content );
						$links[ $i ] = $args;
						$i++;
					}
476

477 478 479 480
					//Output endnotes
					$endnotes = '<div class="wpf-endnotes">';
					$endnotes .= '<strong>' . $options[ 'endnotes_label' ] . '</strong>';
					$endnotes .= '<ol>';
Erick Hitter's avatar
Erick Hitter committed
481
					foreach ( $links as $link ) {
482 483 484 485 486
						$endnotes .= '<li>';
						$endnotes .=  preg_replace( '#<img(.*)>#', '[Image]', $link[ 'title' ] ) . ': ' . esc_url( $link[ 'url' ] );
						$endnotes .= '</li>';
					}
					$endnotes .= '</ol></div><!-- .wpf-endnotes -->';
487

488 489 490 491
					$content .= $endnotes;
				}
			}
		}
492

493 494
		return $content;
	}
495

Erick Hitter's avatar
Erick Hitter committed
496 497 498
	/**
	 * Generate URL for post's printer-friendly format.
	 *
499 500 501 502 503
	 * @param int $post_id
	 * @param int $page
	 * @uses is_view_all, is_home, is_front_page, home_url, $post, get_permalink, is_category, get_category_link, is_tag, get_tag_link, is_date, get_query_var, get_day_link, get_month_link, get_year_link, is_tax, get_queried_object, get_term_link, $wp_rewrite, path_join, trailingslashit, add_query_arg
	 * @return string or bool
	 */
Erick Hitter's avatar
Erick Hitter committed
504 505
	public function print_url( $post_id = false, $page = false ) {
		if ( $page === true )
506
			return false;
507

Erick Hitter's avatar
Erick Hitter committed
508
		if ( function_exists( 'is_view_all' ) && is_view_all() )
509
			$page = false;
510

511
		$link = false;
512

513
		//Get link base specific to page type being viewed
Erick Hitter's avatar
Erick Hitter committed
514 515
		if ( is_singular() || in_the_loop() ) {
			if ( $post_id == false ) {
516 517 518
				global $post;
				$post_id = $post->ID;
			}
519

Erick Hitter's avatar
Erick Hitter committed
520
			if ( ! $post_id )
521
				return false;
522

523 524
			$link = get_permalink( $post_id );
		}
Erick Hitter's avatar
Erick Hitter committed
525
		elseif ( is_home() || is_front_page() )
526
			$link = home_url( '/' );
Erick Hitter's avatar
Erick Hitter committed
527
		elseif ( is_category() )
528
			$link = get_category_link( get_query_var( 'cat' ) );
Erick Hitter's avatar
Erick Hitter committed
529
		elseif ( is_tag() )
530 531
			$link = get_tag_link( get_query_var( 'tag_id' ) );
		/* DISABLED FOR NOW AS PRINTING OF DATE-BASED ARCHIVES DOESN'T WORK YET
Erick Hitter's avatar
Erick Hitter committed
532
		elseif ( is_date() ) {
533 534 535
			$year = get_query_var( 'year' );
			$monthnum = get_query_var( 'monthnum' );
			$day = get_query_var( 'day' );
536

Erick Hitter's avatar
Erick Hitter committed
537
			if ( $day )
538
				$link = get_day_link( $year, $monthnum, $day );
Erick Hitter's avatar
Erick Hitter committed
539
			elseif ( $monthnum )
540 541 542 543
				$link = get_month_link( $year, $monthnum );
			else
				$link = get_year_link( $year );
		}*/
Erick Hitter's avatar
Erick Hitter committed
544
		elseif ( is_tax() ) {
545
			$queried_object = get_queried_object();
546

Erick Hitter's avatar
Erick Hitter committed
547
			if ( is_object( $queried_object ) && property_exists( $queried_object, 'taxonomy' ) && property_exists( $queried_object, 'term_id' ) )
548 549
				$link = get_term_link( (int)$queried_object->term_id, $queried_object->taxonomy );
		}
550

551
		//If link base is set, build link
Erick Hitter's avatar
Erick Hitter committed
552
		if ( $link !== false ) {
553
			global $wp_rewrite;
554

555
			$page = intval( $page );
556

Erick Hitter's avatar
Erick Hitter committed
557
			if ( $wp_rewrite->using_permalinks() ) {
558
				$link = path_join( $link, $this->query_var );
559

Erick Hitter's avatar
Erick Hitter committed
560
				if ( $page )
561
					$link = path_join( $link, intval( $page ) );
562

Erick Hitter's avatar
Erick Hitter committed
563
				if ( $wp_rewrite->use_trailing_slashes )
564 565 566 567
					$link = trailingslashit( $link );
			}
			else {
				$link = add_query_arg( $this->query_var, is_numeric( $page ) ? intval( $page ) : 'all', $link );
568

Erick Hitter's avatar
Erick Hitter committed
569
				if ( $page )
570 571 572
					$link = add_query_arg( 'page', is_numeric( $page ) ? intval( $page ) : 'all', $link );
			}
		}
573

574 575
		return $link;
	}
576

Erick Hitter's avatar
Erick Hitter committed
577 578 579
	/**
	 * Add menu item for options page.
	 *
580 581 582 583
	 * @uses add_options_page
	 * @action admin_menu
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
584
	public function action_admin_menu() {
585 586
		add_options_page( 'WP Print Friendly Options', 'WP Print Friendly', 'manage_options', $this->ns, array( $this, 'admin_options' ) );
	}
587

Erick Hitter's avatar
Erick Hitter committed
588 589 590
	/**
	 * Render options page.
	 *
591 592 593
	 * @uses settings_fields, $this::get_options, _e, checked, esc_attr
	 * @return html
	 */
Erick Hitter's avatar
Erick Hitter committed
594
	public function admin_options() {
595 596 597
	?>
		<div class="wrap">
			<h2>WP Print Friendly</h2>
598

599 600 601 602
			<form action="options.php" method="post">
				<?php
					settings_fields( $this->settings_key );
					$options = $this->get_options();
603

604 605
					$post_types = $this->post_types_array();
				?>
606

607
				<h3>Display Options</h3>
608

609 610
				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
611
						<th scope="row"><?php _e( 'Automatically add print links based on settings below?', 'wp_print_friendly' ); ?></th>
612
						<td>
Erick Hitter's avatar
Erick Hitter committed
613 614
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[auto]" id="auto-true" value="1"<?php checked( $options[ 'auto' ], true, true ); ?> /> <label for="auto-true"><?php _e( 'Yes', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[auto]" id="auto-false" value="0"<?php checked( $options[ 'auto' ], false, true ); ?> /> <label for="auto-false"><?php _e( 'No', 'wp_print_friendly' ); ?></label>
615 616 617
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
618
						<th scope="row"><?php _e( 'Automatically place link:', 'wp_print_friendly' ); ?></th>
619
						<td>
Erick Hitter's avatar
Erick Hitter committed
620 621 622
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[placement]" id="placement-above" value="above"<?php checked( $options[ 'placement' ], 'above', true ); ?> /> <label for="placement-above"><?php _e( 'Above content', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[placement]" id="placement-below" value="below"<?php checked( $options[ 'placement' ], 'below', true ); ?> /> <label for="placement-below"><?php _e( 'Below content', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[placement]" id="placement-both" value="both"<?php checked( $options[ 'placement' ], 'both', true ); ?> /> <label for="placement-both"><?php _e( 'Above and below content', 'wp_print_friendly' ); ?></label>
623 624 625
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
626
						<th scope="row"><?php _e( 'Display automatically on:', 'wp_print_friendly' ); ?></th>
627
						<td>
Erick Hitter's avatar
Erick Hitter committed
628 629
							<?php foreach ( $post_types as $post_type ): ?>
								<input type="checkbox" name="<?php echo esc_attr( $this->settings_key ); ?>[post_types][]" id="pt-<?php echo $post_type->name; ?>" value="<?php echo $post_type->name; ?>"<?php if ( in_array( $post_type->name, $options[ 'post_types' ] ) ) echo ' checked="checked"'; ?> /> <label for="pt-<?php echo $post_type->name; ?>"><?php echo $post_type->labels->name; ?></label><br />
630 631 632 633
							<?php endforeach; ?>
						</td>
					</tr>
				</table>
634

635
				<h3>Link Options</h3>
636

637 638
				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
639
						<th scope="row"><?php _e( 'Text for link to print entire item:', 'wp_print_friendly' ); ?></th>
640
						<td>
641
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[print_text]" id="print_text" value="<?php echo esc_attr( $options[ 'print_text' ] ); ?>" style="width: 40%;" />
642 643 644
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
645
						<th scope="row"><?php _e( 'Text for link to print current page:', 'wp_print_friendly' ); ?></th>
646
						<td>
647 648
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[print_text_page]" id="print_text_page" value="<?php echo esc_attr( $options[ 'print_text_page' ] ); ?>" style="width: 40%;" />

Erick Hitter's avatar
Erick Hitter committed
649 650
							<p class="description"><?php _e( 'If viewing a multipage post (set by using the &lt;!--nextpage--&gt; tag), the text above is used for a link to print just the current page.', 'wp_print_friendly' ); ?></p>
							<p class="description"><?php _e( '<strong>To hide this link,</strong> clear the field\'s contents.', 'wp_print_friendly' ); ?></p>
651 652 653
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
654
						<th scope="row"><?php _e( 'CSS for print links:', 'wp_print_friendly' ); ?></th>
655
						<td>
656 657
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[css_class]" id="css_class" value="<?php echo esc_attr( $options[ 'css_class' ] ); ?>" style="width: 40%;" />

Erick Hitter's avatar
Erick Hitter committed
658 659
							<p class="description"><?php _e( 'For page-specific print links, a second class, created by appending <strong>_cur</strong> to the above text, is added to each link.', 'wp_print_friendly' ); ?></p>
							<p class="description"><?php _e( 'Be aware that Internet Explorer will only interpret the first two CSS classes, so if multiple classes are entered above, the page-specific class may not be available in IE.', 'wp_print_friendly' ); ?></p>
660 661 662
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
663
						<th scope="row"><?php _e( 'Open print-friendly views:', 'wp_print_friendly' ); ?></th>
664
						<td>
Erick Hitter's avatar
Erick Hitter committed
665 666
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[link_target]" id="target-same" value="same"<?php checked( $options[ 'link_target' ], 'same', true ); ?> /> <label for="target-same"><?php _e( 'In the same window', 'wp_print_friendly' ); ?></label><br />
							<input type="radio" name="<?php echo esc_attr( $this->settings_key ); ?>[link_target]" id="target-new" value="new"<?php checked( $options[ 'link_target' ], 'new', true ); ?> /> <label for="target-new"><?php _e( 'In a new window', 'wp_print_friendly' ); ?></label>
667 668 669
						</td>
					</tr>
				</table>
670

671
				<h3>Endnote Options</h3>
672

673 674
				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
675
						<th scope="row"><?php _e( 'Include endnotes for links found in content?', 'wp_print_friendly' ); ?></th>
676
						<td>
Erick Hitter's avatar
Erick Hitter committed
677
							<input type="checkbox" name="<?php echo esc_attr( $this->settings_key ); ?>[endnotes]" id="endnotes" value="1"<?php checked( $options[ 'endnotes' ], true, true ); ?> /> <label for="endnotes"><?php _e( 'Yes', 'wp_print_friendly' ); ?></label>
678

Erick Hitter's avatar
Erick Hitter committed
679
							<p class="description"><?php _e( 'If enabled, content is automatically scanned for links and an endnote is added for each link found. This can be helpful for users if your content includes many links.', 'wp_print_friendly' ); ?></p>
680 681 682
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
683
						<th scope="row"><label for="endnotes-label"><?php _e( 'Endnotes heading:', 'wp_print_friendly' ); ?></label></th>
684
						<td>
685 686
							<input type="text" name="<?php echo esc_attr( $this->settings_key ); ?>[endnotes_label]" class="regular-text code" id="endnotes-label" value="<?php echo esc_attr( $options[ 'endnotes_label' ] ); ?>" />

Erick Hitter's avatar
Erick Hitter committed
687
							<p class="description"><?php _e( 'If endnotes are enabled, the text entered above will be output above the list of links.', 'wp_print_friendly' ); ?></p>
688 689 690
						</td>
					</tr>
				</table>
691

692 693 694 695
				<p class="submit">
					<input type="submit" class="button-primary" value="Save Changes" />
				</p>
			</form>
696

697 698 699
		</div><!-- .wrap -->
	<?php
	}
700

Erick Hitter's avatar
Erick Hitter committed
701
	/**
702
	 * Validate options
Erick Hitter's avatar
Erick Hitter committed
703
	 *
704 705 706 707
	 * @param array $options
	 * @uses $this::get_options, $this::post_types_array, delete_option, sanitize_text_field
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
708
	public function admin_options_validate( $options ) {
709 710 711
		$new_options = array(
			'endnotes' => false
		);
712

Erick Hitter's avatar
Erick Hitter committed
713 714
		if ( is_array( $options ) ) {
			foreach ( $options as $key => $value ) {
715 716 717 718 719
				switch( $key ) {
					case 'auto':
					case 'endnotes':
						$new_options[ $key ] = (bool)$value;
					break;
720

721 722 723 724 725 726
					case 'placement':
						$placements = array(
							'above',
							'below',
							'both'
						);
727

728 729
						$new_options[ $key ] = in_array( $value, $placements ) ? $value : 'below';
					break;
730

731 732
					case 'post_types':
						$post_types = $this->post_types_array();
733

734
						$new_options[ $key ] = array();
735

Erick Hitter's avatar
Erick Hitter committed
736 737 738
						if ( is_array( $value ) && is_array( $post_types ) ) {
							foreach ( $post_types as $post_type ) {
								if ( in_array( $post_type->name, $value ) )
739 740 741 742
									$new_options[ $key ][] = $post_type->name;
							}
						}
					break;
743

744 745 746 747 748
					case 'print_text':
					case 'print_text_page':
					case 'css_class':
					case 'endnotes_label':
						$value = sanitize_text_field( $value );
749

Erick Hitter's avatar
Erick Hitter committed
750
						if ( $key == 'print_text' && empty( $value ) )
751
							$value = 'Print this entry';
752

753 754
						$new_options[ $key ] = $value;
					break;
755

756 757 758
					case 'link_target':
						$new_options[ $key ] = $value == 'new' ? 'new' : 'same';
					break;
759

760 761 762 763 764 765
					default:
						continue;
					break;
				}
			}
		}
766

767 768
		return $new_options;
	}
769

Erick Hitter's avatar
Erick Hitter committed
770 771 772
	/**
	 * Return plugin options array parsed with default options.
	 *
773 774 775
	 * @uses wp_parse_args, get_option
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
776
	public function get_options() {
777
		$options = get_option( $this->settings_key, $this->settings_defaults );
778

Erick Hitter's avatar
Erick Hitter committed
779
		if ( ! array_key_exists( 'post_types', $options ) )
780
			$options[ 'post_types' ] = array();
781

782 783
		return wp_parse_args( $options, $this->settings_defaults );
	}
784

Erick Hitter's avatar
Erick Hitter committed
785 786 787
	/**
	 * Build array of available post types, excluding all builtin ones except 'post' and 'page'.
	 *
788 789 790
	 * @uses get_post_types
	 * @return array
	 */
Erick Hitter's avatar
Erick Hitter committed
791
	public function post_types_array() {
792
		$post_types = array();
Erick Hitter's avatar
Erick Hitter committed
793 794
		foreach ( get_post_types( array(), 'objects' ) as $post_type ) {
			if ( $post_type->_builtin == false || $post_type->name == 'post' || $post_type->name == 'page' )
795 796
				$post_types[] = $post_type;
		}
797

798 799
		return $post_types;
	}
800

Erick Hitter's avatar
Erick Hitter committed
801
	/**
802
	 * Display admin notice regarding rewrite rules flush.
Erick Hitter's avatar
Erick Hitter committed
803
	 *
804 805 806 807
	 * @uses get_option, _e, __, admin_url, add_query_arg
	 * @action admin_notices
	 * @return html or null
	 */
Erick Hitter's avatar
Erick Hitter committed
808 809
	public function action_admin_notices_activation() {
		if ( ! get_option( $this->notice_key ) ):
810
		?>
811

812
		<div id="wpf-rewrite-flush-warning" class="error fade">
Erick Hitter's avatar
Erick Hitter committed
813
			<p><strong><?php _e( 'WP Print Friendly', 'wp_print_friendly' ); ?></strong></p>
814

Erick Hitter's avatar
Erick Hitter committed
815
			<p><?php printf( __( 'You must refresh your site\'s permalinks before WP Print Friendly is fully activated. To do so, go to <a href="%s">Permalinks</a> and click the <strong><em>Save Changes</em></strong> button at the bottom of the screen.', 'wp_print_friendly' ), admin_url( 'options-permalink.php' ) ); ?></p>
816

Erick Hitter's avatar
Erick Hitter committed
817
			<p><?php printf( __( 'When finished, click <a href="%s">here</a> to hide this message.', 'wp_print_friendly' ), admin_url( add_query_arg( $this->notice_key, 1, 'index.php' ) ) ); ?></p>
818
		</div>
819

820 821 822
		<?php
		endif;
	}
823

Erick Hitter's avatar
Erick Hitter committed
824
	/**
825
	 * Render page numbers, such as "Page 1 of 5."
Erick Hitter's avatar
Erick Hitter committed
826
	 *
827 828 829 830
	 * @param int $post_id
	 * @param string $before
	 * @param string $separator
	 * @param string $after
831 832 833 834
	 * @uses this::is_print
	 * @uses post_password_required
	 * @uses get_query_var
	 * @uses get_post_field
835 836
	 * @return string or false
	 */
Erick Hitter's avatar
Erick Hitter committed
837
	public function page_numbers( $post_id = false, $before = 'Page ', $separator = ' of ', $after = '' ) {
838
		if ( ! $this->is_print() || post_password_required() )
839
			return false;
840

841 842
		//Don't display on views that include all pages of a post
		$print = get_query_var( $this->query_var );
Erick Hitter's avatar
Erick Hitter committed
843
		if ( $print == 'all' || $print == '/all' || empty( $print ) )
844
			return false;
845

846 847
		//Get post ID and post content, or return false it either fails validation
		$post_id = intval( $post_id );
848

Erick Hitter's avatar
Erick Hitter committed
849
		if ( ! $post_id ) {
850 851 852 853
			global $post;
			$post_id = $post->ID;
			$post_content = $post->post_content;
		}
854

855
		$post_id = intval( $post_id );
856

Erick Hitter's avatar
Erick Hitter committed
857
		if ( ! $post_id )
858
			return false;
859

Erick Hitter's avatar
Erick Hitter committed
860
		if ( ! isset( $post_content ) || empty( $post_content ) )
861
			$post_content = get_post_field( 'post_content', $post_id );
862

Erick Hitter's avatar
Erick Hitter committed
863
		if ( ! is_string( $post_content ) || empty( $post_content ) || strpos( $post_content, '<!--nextpage-->' ) === false )
864
			return false;
865

866 867 868
		//Get current page
		$page = get_query_var( $this->query_var );
		$page = $page ? $page : 1;
869

870 871
		//Get total number of pages, or return false if total cannot be determined
		$num_pages = substr_count( $post_content, '<!--nextpage-->' );
872

Erick Hitter's avatar
Erick Hitter committed
873
		if ( is_int( $num_pages ) && $num_pages > 0 )
874 875 876
			$num_pages = $num_pages + 1;
		else
			return false;
877

878 879 880 881
		//Having made it this far, return the specified string
		return $before . $page . $separator . $num_pages . $after;
	}
}
882 883 884 885 886 887
wp_print_friendly::get_instance();

/**
 * Alias global variable used to hold instantiated plugin prior to singleton's introduction in version 0.6.
 */
$GLOBALS['wpf'] = wp_print_friendly::get_instance();
888

Erick Hitter's avatar
Erick Hitter committed
889
/**
890
 * Shortcut to function for generating post's printer-friendly format URL
Erick Hitter's avatar
Erick Hitter committed
891
 *
892 893
 * @param int $post_id
 * @param int $page
894
 * @uses wp_print_friendly::get_instance
895 896 897
 * @return string or bool
 */
function wpf_get_print_url( $post_id = false, $page = false ) {
898
	return wp_print_friendly::get_instance()->print_url( intval( $post_id ), intval( $page ) );
899 900
}

Erick Hitter's avatar
Erick Hitter committed
901
/**
902
 * Output link to printer-friendly post format.
Erick Hitter's avatar
Erick Hitter committed
903
 *
904 905 906 907 908 909 910 911 912 913 914 915
 * @param string $link_text
 * @param string $class
 * @param int $post_id
 * @param bool $page_link
 * @param string $page_link_separator
 * @param string $page_link_text
 * @param string $link_target
 * @uses $post, wpf_get_print_url, esc_attr, esc_url, get_query_var
 * @return string or null
 */
function wpf_the_print_link( $page_link = false, $link_text = 'Print this post', $class = 'print_link', $page_link_separator = ' | ', $page_link_text = 'Print this page', $link_target = 'same' ) {
	global $post;
916

917
	$url = wpf_get_print_url( $post->ID );
918

919
	$page_link = (bool)$page_link;
920

Erick Hitter's avatar
Erick Hitter committed
921
	if ( function_exists( 'is_view_all' ) && is_view_all() )
922
		$page_link = false;
923

Erick Hitter's avatar
Erick Hitter committed
924
	if ( $url ) {
925
		$link = '<a ' . ( $class ? 'class="' . esc_attr( $class ) . '"' : '' ) . ' href="' . esc_url( $url ) . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $link_text . '</a>';
926

Erick Hitter's avatar
Erick Hitter committed
927
		if ( $page_link && strpos( $post->post_content, '<!--nextpage-->' ) !== false ) {
928 929 930 931
			$page = get_query_var( 'page' );
			$page = $page ? $page : 1;
			$link .= $page_link_separator . '<a ' . ( $class ? 'class="' . esc_attr( $class ) . '_cur ' . esc_attr( $class ) . '"' : '' ) . ' href="' . esc_url( wpf_get_print_url( $post->ID, $page ) ) . '"' . ( $link_target == 'new' ? ' target="_blank"' : '' ) . '>' . $page_link_text . '</a>';
		}
932

933 934 935 936
		echo $link;
	}
}

Erick Hitter's avatar
Erick Hitter committed
937
/**
938
 * Display page numbers, such as "Page 1 of 5."
Erick Hitter's avatar
Erick Hitter committed
939
 *
940 941 942 943
 * @param int $post_id
 * @param string $before
 * @param string $separator
 * @param string $after
944
 * @uses wp_print_friendly::get_instance
945 946 947
 * @return string or false
 */
function wpf_the_page_numbers( $post_id = false, $before = 'Page ', $separator = ' of ', $after = '' ) {
948
	echo wp_print_friendly::get_instance()->page_numbers( intval( $post_id ), $before, $separator, $after );
949 950
}

Erick Hitter's avatar
Erick Hitter committed
951 952
if ( ! function_exists( 'is_print' ) ) {
	/**
953
	 * Conditional tag indicating if printer-friendly format was requested.
Erick Hitter's avatar
Erick Hitter committed
954
	 *
955
	 * @uses wp_print_friendly::get_instance
956 957 958
	 * @return bool
	 */
	function is_print() {