view-all-posts-pages.php 24.5 KB
Newer Older
1
<?php
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/**
 * Plugin Name:     View All Posts Pages
 * Plugin URI:      http://www.oomphinc.com/plugins-modules/view-all-posts-pages/
 * Description:     Provides a "view all" (single page) option for posts, pages, and custom post types paged using WordPress' <a href="http://codex.wordpress.org/Write_Post_SubPanel#Quicktags" target="_blank"><code>&lt;!--nextpage--&gt;</code> Quicktag</a> (multipage posts).
 * Author:          Erick Hitter & Oomph, Inc.
 * Author URI:      http://www.oomphinc.com/
 * Text Domain:     view_all_posts_pages
 * Domain Path:     /languages
 * Version:         0.9.1
 *
 * @package         View_All_Posts_Pages
 *
 * 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
 */
28 29

class view_all_posts_pages {
Erick Hitter's avatar
Erick Hitter committed
30 31 32 33 34 35 36 37
	/**
	 * Singleton
	 */
	private static $__instance = null;

	/**
	 * Class variables
	 */
38 39 40 41 42
	private $query_var = 'view-all';

	private $ns = 'view_all_posts_pages';

	private $settings_key = 'vapp';
43
	private $settings_defaults = null;
44 45 46

	private $notice_key = 'vapp_admin_notice_dismissed';

Erick Hitter's avatar
Erick Hitter committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
	/**
	 * 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;
	}

68 69
	/**
	 * Register actions and filters.
Erick Hitter's avatar
Erick Hitter committed
70
	 *
Erick Hitter's avatar
Erick Hitter committed
71 72
	 * @uses register_deactivation_hook
	 * @uses add_action
73 74
	 * @return null
	 */
Erick Hitter's avatar
Erick Hitter committed
75
	private function setup() {
76 77 78 79 80 81
		register_deactivation_hook( __FILE__, array( $this, 'deactivation_hook' ) );

		add_action( 'admin_init', array( $this, 'action_admin_init' ) );
		add_action( 'admin_menu', array( $this, 'action_admin_menu' ) );

		add_action( 'init', array( $this, 'action_init' ), 20 );
Erick Hitter's avatar
Erick Hitter committed
82
		add_action( 'redirect_canonical', array( $this, 'filter_redirect_canonical' ) );
83 84 85 86 87 88

		add_action( 'the_post', array( $this, 'action_the_post' ), 5 );
	}

	/**
	 * Clean up after plugin deactivation.
Erick Hitter's avatar
Erick Hitter committed
89
	 *
Erick Hitter's avatar
Erick Hitter committed
90 91
	 * @uses flush_rewrite_rules
	 * @uses delete_option
92 93 94 95 96 97 98 99 100 101 102 103
	 * @action register_deactivation_hook
	 * @return null
	 */
	public function deactivation_hook() {
		flush_rewrite_rules();

		delete_option( $this->settings_key );
		delete_option( $this->notice_key );
	}

	/**
	 * Register plugin option and disable rewrite rule flush warning.
Erick Hitter's avatar
Erick Hitter committed
104 105 106
	 * @uses register_setting
	 * @uses apply_filters
	 * @uses update_option
107 108 109 110 111 112 113 114 115 116 117 118
	 * @action admin_init
	 * @return null
	 */
	public function action_admin_init() {
		register_setting( $this->settings_key, $this->settings_key, array( $this, 'admin_options_validate' ) );

		if ( isset( $_GET[ $this->notice_key ] ) && apply_filters( 'vapp_display_rewrite_rules_notice', true ) )
			update_option( $this->notice_key, 1 );
	}

	/**
	 * Determine if full post view is being requested.
Erick Hitter's avatar
Erick Hitter committed
119
	 *
120
	 * @global $wp_query
121
	 * @uses is_404
122 123 124 125
	 * @return bool
	 */
	public function is_view_all() {
		global $wp_query;
126
		return is_array( $wp_query->query ) && array_key_exists( $this->query_var, $wp_query->query ) && ! is_404();
127 128 129
	}

	/**
Erick Hitter's avatar
Erick Hitter committed
130 131 132
	 * Add rewrite endpoint, which sets query var and rewrite rules.
	 *
	 * @global $wp_rewrite
133
	 * @uses __
134 135 136 137 138
	 * @uses this::get_options
	 * @uses add_filter
	 * @uses apply_filters
	 * @uses get_option
	 * @uses add_action
139 140 141 142 143
	 * @uses add_rewrite_endpoint
	 * @action init
	 * @return null
	 */
	public function action_init() {
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
		// Populate default settings, with translation support
		$this->settings_defaults = array(
			'wlp'             => true,
			'wlp_text'        => __( 'View All', 'view_all_posts_pages' ),
			'wlp_class'       => 'vapp',
			'wlp_post_types'  => array(
				'post'
			),
			'link'            => false,
			'link_position'   => 'below',
			'link_text'       => __( 'View All', 'view_all_posts_pages' ),
			'link_class'      => 'vapp',
			'link_post_types' => array(
				'post'
			),
			'link_priority'   => 10,
		);

162 163 164 165 166 167 168 169 170 171 172 173
		// Register additional plugin actions if settings call for them.
		$options = $this->get_options();

		if ( array_key_exists( 'wlp', $options ) && true === $options[ 'wlp' ] )
			add_filter( 'wp_link_pages_args', array( $this, 'filter_wp_link_pages_args_early' ), 0 );

		if ( $options[ 'link' ] )
			add_filter( 'the_content', array( $this, 'filter_the_content_auto' ), $options[ 'link_priority' ] );

		if ( apply_filters( 'vapp_display_rewrite_rules_notice', true ) && ! get_option( $this->notice_key ) )
			add_action( 'admin_notices', array( $this, 'action_admin_notices_activation' ) );

174
		// Register rewrite endpoint, which handles most of our rewrite needs
175
		add_rewrite_endpoint( $this->query_var, EP_ALL );
Erick Hitter's avatar
Erick Hitter committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217

		//Extra rules needed if verbose page rules are requested
		global $wp_rewrite;
		if ( $wp_rewrite->use_verbose_page_rules ) {
			//Build regex
			$regex = substr( str_replace( $wp_rewrite->rewritecode, $wp_rewrite->rewritereplace, $wp_rewrite->permalink_structure ), 1 );
			$regex = trailingslashit( $regex );
			$regex .= $this->query_var . '/?$';

			//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 . '=1';

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

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

	/**
	 * Prevent canonical redirect if full-post page is requested.
	 *
	 * @param string $url
	 * @uses this::is_view_all
	 * @filter redirect_canonical
	 * @return string or false
	 */
	public function filter_redirect_canonical( $url ) {
		if ( $this->is_view_all() )
			$url = false;

		return $url;
218 219 220
	}

	/**
Erick Hitter's avatar
Erick Hitter committed
221
	 * Modify post variables to display entire post on one page.
222 223 224 225 226 227 228 229 230
	 *
	 * @global $pages, $more
	 * @param object $post
	 * @uses this::is_view_all
	 * @action the_post
	 * @return null
	 */
	public function action_the_post( $post ) {
		if ( $this->is_view_all() ) {
231
			global $pages, $more, $multipage;
232 233 234 235 236 237 238 239 240

			$post->post_content = str_replace( "\n<!--nextpage-->\n", "\n\n", $post->post_content );
			$post->post_content = str_replace( "\n<!--nextpage-->", "\n", $post->post_content );
			$post->post_content = str_replace( "<!--nextpage-->\n", "\n", $post->post_content );
			$post->post_content = str_replace( "<!--nextpage-->", ' ', $post->post_content );

			$pages = array( $post->post_content );

			$more = 1;
241
			$multipage = 0;
242 243 244 245 246 247 248
		}
	}

	/**
	 * Add wp_link_pages arguments filter if automatic inclusion is chosen for a given post type.
	 * Automatic inclusion can be disabled by passing false through the vapp_display_link filter.
	 *
Erick Hitter's avatar
Erick Hitter committed
249
	 * @global $post
250
	 * @param array $args
Erick Hitter's avatar
Erick Hitter committed
251 252 253
	 * @uses this::get_options
	 * @uses apply_filters
	 * @uses add_filter
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
	 * @filter wp_link_pages
	 * @return array
	 */
	public function filter_wp_link_pages_args_early( $args ) {
		global $post;

		$options = $this->get_options();

		if ( in_array( $post->post_type, $options[ 'wlp_post_types' ] ) && apply_filters( 'vapp_display_link', true, (int) $post->ID, $options, $post ) )
			add_filter( 'wp_link_pages_args', array( $this, 'filter_wp_link_pages_args' ), 999 );

		return $args;
	}

	/**
	 * Filter wp_link_pages arguments to append "View all" link to output.
Erick Hitter's avatar
Erick Hitter committed
270
	 *
Erick Hitter's avatar
Erick Hitter committed
271
	 * @global $more
272
	 * @param array $args
Erick Hitter's avatar
Erick Hitter committed
273 274 275 276
	 * @uses this::get_options
	 * @uses this::is_view_all
	 * @uses esc_attr
	 * @uses esc_url
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	 * @return array
	 */
	public function filter_wp_link_pages_args( $args ) {
		$options = $this->get_options();

		if ( is_array( $options ) ) {
			extract( $options );

			//Set global $more to false so that wp_link_pages outputs links for all pages when viewing full post page
			if ( $this->is_view_all() )
				$GLOBALS[ 'more' ] = false;

			//Process link text, respecting pagelink parameter.
			$link_text = str_replace( '%', $wlp_text, $args[ 'pagelink' ] );

			//View all
			$link = ' ' . $args[ 'link_before' ];

			if ( $this->is_view_all() )
				$link .= '<span class="' . esc_attr( $wlp_class ) . '">' . $link_text . '</span><!-- .' . esc_attr( $wlp_class ) . ' -->';
			else
				$link .= '<a class="' . esc_attr( $wlp_class ) . '" href="' . esc_url( $this->url() ) . '">' . $link_text . '</a><!-- .' . esc_attr( $wlp_class ) . ' -->';

			$link .= $args[ 'link_after' ] . ' ';

			$args[ 'after' ] = $link . $args[ 'after' ];
		}

		return $args;
	}

	/**
Erick Hitter's avatar
Erick Hitter committed
309 310
	 * Filter the content if automatic link inclusion is selected.
	 *
Erick Hitter's avatar
Erick Hitter committed
311
	 * @global $post
312
	 * @param string $content
Erick Hitter's avatar
Erick Hitter committed
313 314 315 316 317
	 * @uses this::get_options
	 * @uses this::is_view_all
	 * @uses esc_attr
	 * @uses esc_url
	 * @uses this::url
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
	 * @filter the_content
	 * @return string
	 */
	public function filter_the_content_auto( $content ) {
		$options = $this->get_options();

		global $post;

		if ( ! $this->is_view_all() && is_array( $options ) && array_key_exists( 'link', $options ) && true === $options[ 'link' ] && in_array( $post->post_type, $options[ 'link_post_types' ] ) ) {
			extract( $options );

			$link = '<p class="vapp_wrapper"><a class="' . esc_attr( $link_class ) . '" href="' . esc_url( $this->url() ) . '">' . esc_html( $link_text ) . '</a></p><!-- .vapp_wrapper -->';

			if ( 'above' == $link_position )
				$content = $link . $content;
			elseif ( 'below' == $link_position )
				$content = $content . $link;
			elseif ( 'both' == $link_position )
				$content = $link . $content . $link;
		}

		return $content;
	}

	/**
	 * Generate URL
Erick Hitter's avatar
Erick Hitter committed
344
	 *
Erick Hitter's avatar
Erick Hitter committed
345 346
	 * @global $post
	 * @global $wp_rewrite
347
	 * @param int $post_id
Erick Hitter's avatar
Erick Hitter committed
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
	 * @uses is_singular
	 * @uses in_the_loop
	 * @uses get_permalink
	 * @uses is_home
	 * @uses is_front_page
	 * @uses home_url
	 * @uses is_category
	 * @uses get_category_link
	 * @uses get_query_var
	 * @uses is_tag
	 * @uses get_tag_link
	 * @uses is_tax
	 * @uses get_queried_object
	 * @uses get_term_link
	 * @uses path_join
	 * @uses trailingslashit
	 * @uses add_query_arg
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
	 * @return string or bool
	 */
	public function url( $post_id = false ) {
		$link = false;

		//Get link base specific to page type being viewed
		if ( is_singular() || in_the_loop() ) {
			$post_id = intval( $post_id );

			if ( ! $post_id ) {
				global $post;
				$post_id = $post->ID;
			}

			if ( ! $post_id )
				return false;

			$link = get_permalink( $post_id );
		}
		elseif ( is_home() || is_front_page() )
			$link = home_url( '/' );
		elseif ( is_category() )
			$link = get_category_link( get_query_var( 'cat' ) );
		elseif ( is_tag() )
			$link = get_tag_link( get_query_var( 'tag_id' ) );
		/** DISABLED FOR NOW AS PRINTING OF DATE-BASED ARCHIVES DOESN'T WORK YET
		elseif ( is_date() ) {
			$year = get_query_var( 'year' );
			$monthnum = get_query_var( 'monthnum' );
			$day = get_query_var( 'day' );

			if ( $day )
				$link = get_day_link( $year, $monthnum, $day );
			elseif ( $monthnum )
				$link = get_month_link( $year, $monthnum );
			else
				$link = get_year_link( $year );
		}*/
		elseif ( is_tax() ) {
			$queried_object = get_queried_object();

			if ( is_object( $queried_object ) && property_exists( $queried_object, 'taxonomy' ) && property_exists( $queried_object, 'term_id' ) )
				$link = get_term_link( (int)$queried_object->term_id, $queried_object->taxonomy );
		}

		//If link base is set, build link
		if ( false !== $link ) {
			global $wp_rewrite;

			if ( $wp_rewrite->using_permalinks() ) {
				$link = path_join( $link, $this->query_var );

				if ( $wp_rewrite->use_trailing_slashes )
					$link = trailingslashit( $link );
			}
			else {
				$link = add_query_arg( $this->query_var, 1, $link );
			}
		}

		return $link;
	}

	/**
	 * Add menu item for options page
Erick Hitter's avatar
Erick Hitter committed
430
	 *
Erick Hitter's avatar
Erick Hitter committed
431 432
	 * @uses __
	 * @uses add_options_page
433 434 435 436
	 * @action admin_menu
	 * @return null
	 */
	public function action_admin_menu() {
437
		add_options_page( sprintf( __( '%s Options', 'view_all_posts_pages' ), "View All Post's Pages" ), "View All Post's Pages", 'manage_options', $this->ns, array( $this, 'admin_options' ) );
438 439 440 441
	}

	/**
	 * Render options page
Erick Hitter's avatar
Erick Hitter committed
442
	 *
Erick Hitter's avatar
Erick Hitter committed
443 444 445 446 447 448 449 450
	 * @uses settings_fields
	 * @uses this::get_options
	 * @uses this::post_types_array
	 * @uses __
	 * @uses _e
	 * @uses checked
	 * @uses esc_attr
	 * @uses submit_button
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
	 * @return string
	 */
	public function admin_options() {
	?>
		<div class="wrap">
			<h2>View All Post's Pages</h2>

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

					$post_types = $this->post_types_array();
				?>

466
				<h3><?php printf( __( '%s Options', 'view_all_posts_pages' ), '<em>wp_link_pages</em>' ); ?></h3>
467

468
				<p class="description"><?php _e( 'A "view all" link can be appended to WordPress\' standard page navigation using the options below.', 'view_all_posts_pages' ); ?></p>
469 470 471

				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
472
						<th scope="row"><?php _e( 'Automatically append link to post\'s page navigation?', 'view_all_posts_pages' ); ?></th>
473
						<td>
Erick Hitter's avatar
Erick Hitter committed
474 475
							<input type="radio" name="<?php echo $this->settings_key; ?>[wlp]" id="wlp-true" value="1"<?php checked( $options[ 'wlp' ], true, true ); ?> /> <label for="wlp-true"><?php _e( 'Yes', 'view_all_posts_pages' ); ?></label><br />
							<input type="radio" name="<?php echo $this->settings_key; ?>[wlp]" id="wlp-false" value="0"<?php checked( $options[ 'wlp' ], false, true ); ?> /> <label for="wlp-false"><?php _e( 'No', 'view_all_posts_pages' ); ?></label>
476 477 478
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
479
						<th scope="row"><label for="wlp_text"><?php _e( 'Link text:', 'view_all_posts_pages' ); ?></label></th>
480 481 482 483 484
						<td>
							<input type="text" name="<?php echo $this->settings_key; ?>[wlp_text]" id="wlp_text" value="<?php echo esc_attr( $options[ 'wlp_text' ] ); ?>" class="regular-text" />
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
485
						<th scope="row"><label for="wlp_class"><?php _e( 'Link\'s CSS class(es):', 'view_all_posts_pages' ); ?></label></th>
486 487 488
						<td>
							<input type="text" name="<?php echo $this->settings_key;?>[wlp_class]" id="wlp_class" value="<?php echo esc_attr( $options[ 'wlp_class' ] ); ?>" class="regular-text" />

Erick Hitter's avatar
Erick Hitter committed
489
							<p class="description"><?php _e( 'Be aware that Internet Explorer will only interpret the first two CSS classes.', 'view_all_posts_pages' ); ?></p>
490 491 492
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
493
						<th scope="row"><?php _e( 'Display automatically on:', 'view_all_posts_pages' ); ?></th>
494 495 496 497 498 499 500 501
						<td>
							<?php foreach ( $post_types as $post_type ) : ?>
								<input type="checkbox" name="<?php echo $this->settings_key; ?>[wlp_post_types][]" id="wlp-pt-<?php echo $post_type->name; ?>" value="<?php echo $post_type->name; ?>"<?php if ( in_array( $post_type->name, $options[ 'wlp_post_types' ] ) ) echo ' checked="checked"'; ?> /> <label for="wlp-pt-<?php echo $post_type->name; ?>"><?php echo $post_type->labels->name; ?></label><br />
							<?php endforeach; ?>
						</td>
					</tr>
				</table>

502
				<h3><?php _e( 'Standalone Link Options', 'view_all_posts_pages' ); ?></h3>
503

504
				<p class="description"><?php _e( 'In addition to appending the "view all" link to WordPress\' standard navigation, link(s) can be added above and below post content.', 'view_all_posts_pages' ); ?></p>
505 506 507

				<table class="form-table">
					<tr>
Erick Hitter's avatar
Erick Hitter committed
508
						<th scope="row"><?php _e( 'Automatically add links based on settings below?', 'view_all_posts_pages' ); ?></th>
509
						<td>
Erick Hitter's avatar
Erick Hitter committed
510 511
							<input type="radio" name="<?php echo $this->settings_key; ?>[link]" id="link-true" value="1"<?php checked( $options[ 'link' ], true, true ); ?> /> <label for="link-true"><?php _e( 'Yes', 'view_all_posts_pages' ); ?></label><br />
							<input type="radio" name="<?php echo $this->settings_key; ?>[link]" id="link-false" value="0"<?php checked( $options[ 'link' ], false, true ); ?> /> <label for="link-false"><?php _e( 'No', 'view_all_posts_pages' ); ?></label>
512 513 514
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
515
						<th scope="row"><?php _e( 'Automatically place link:', 'view_all_posts_pages' ); ?></th>
516
						<td>
Erick Hitter's avatar
Erick Hitter committed
517 518 519
							<input type="radio" name="<?php echo $this->settings_key; ?>[link_position]" id="link_position-above" value="above"<?php checked( $options[ 'link_position' ], 'above', true ); ?> /> <label for="link_position-above"><?php _e( 'Above content', 'view_all_posts_pages' ); ?></label><br />
							<input type="radio" name="<?php echo $this->settings_key; ?>[link_position]" id="link_position-below" value="below"<?php checked( $options[ 'link_position' ], 'below', true ); ?> /> <label for="link_position-below"><?php _e( 'Below content', 'view_all_posts_pages' ); ?></label><br />
							<input type="radio" name="<?php echo $this->settings_key; ?>[link_position]" id="link_position-both" value="both"<?php checked( $options[ 'link_position' ], 'both', true ); ?> /> <label for="link_position-both"><?php _e( 'Above and below content', 'view_all_posts_pages' ); ?></label>
520 521 522
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
523
						<th scope="row"><?php _e( 'Display automatically on:', 'view_all_posts_pages' ); ?></th>
524 525 526 527 528 529 530
						<td>
							<?php foreach ( $post_types as $post_type ) : ?>
								<input type="checkbox" name="<?php echo $this->settings_key; ?>[link_post_types][]" id="link-pt-<?php echo $post_type->name; ?>" value="<?php echo $post_type->name; ?>"<?php if ( in_array( $post_type->name, $options[ 'link_post_types' ] ) ) echo ' checked="checked"'; ?> /> <label for="link-pt-<?php echo $post_type->name; ?>"><?php echo $post_type->labels->name; ?></label><br />
							<?php endforeach; ?>
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
531
						<th scope="row"><label for="link_text"><?php _e( 'Link text:', 'view_all_posts_pages' ); ?></label></th>
532 533 534 535 536
						<td>
							<input type="text" name="<?php echo $this->settings_key; ?>[link_text]" id="link_text" value="<?php echo esc_attr( $options[ 'link_text' ] ); ?>" class="regular-text" />
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
537
						<th scope="row"><label for="link_class"><?php _e( 'Link\'s CSS class(es):', 'view_all_posts_pages' ); ?></label></th>
538 539 540
						<td>
							<input type="text" name="<?php echo $this->settings_key; ?>[link_class]" id="link_class" value="<?php echo esc_attr( $options[ 'link_class' ] ); ?>" class="regular-text" />

Erick Hitter's avatar
Erick Hitter committed
541
							<p class="description"><?php _e( 'Be aware that Internet Explorer will only interpret the first two CSS classes.', 'view_all_posts_pages' ); ?></p>
542 543 544
						</td>
					</tr>
					<tr>
Erick Hitter's avatar
Erick Hitter committed
545
						<th scope="row"><label for="link_priority"><?php _e( 'Link\'s priority:', 'view_all_posts_pages' ); ?></label></th>
546 547 548
						<td>
							<input type="text" name="<?php echo $this->settings_key; ?>[link_priority]" id="link_priority" class="small-text code" value="<?php echo esc_attr( $options[ 'link_priority' ] ); ?>" />

Erick Hitter's avatar
Erick Hitter committed
549 550
							<p class="description"><?php _e( 'Priority determines when the link is added to a post\'s content. You can use the above setting to modulate the link\'s placement.', 'view_all_posts_pages' ); ?></p>
							<p class="description"><?php _e( 'The default value is <strong>10</strong>. Lower values mean the link will be added earlier, while higher values will add the link later.', 'view_all_posts_pages' ); ?></p>
551 552 553 554 555 556 557 558 559 560 561 562 563
						</td>
					</tr>
				</table>

				<?php submit_button(); ?>
			</form>

		</div><!-- .wrap -->
	<?php
	}

	/**
	 * Validate options
Erick Hitter's avatar
Erick Hitter committed
564
	 *
565
	 * @param array $options
Erick Hitter's avatar
Erick Hitter committed
566 567 568 569
	 * @uses this::get_options
	 * @uses this::post_types_array
	 * @uses sanitize_text_field
	 * @uses absint
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
	 * @return array
	 */
	public function admin_options_validate( $options ) {
		$new_options = array();

		if ( is_array( $options ) ) {
			foreach ( $options as $key => $value ) {
				switch( $key ) {
					case 'wlp':
					case 'link':
						$new_options[ $key ] = (bool)$value;
					break;

					case 'link_position':
						$placements = array(
							'above',
							'below',
							'both'
						);

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

					case 'wlp_post_types':
					case 'link_post_types':
						$post_types = $this->post_types_array();

						$new_options[ $key ] = array();

						if ( is_array( $value ) && is_array( $post_types ) ) {
							foreach ( $post_types as $post_type ) {
								if ( in_array( $post_type->name, $value ) )
									$new_options[ $key ][] = $post_type->name;
							}
						}
					break;

					case 'wlp_text':
					case 'wlp_class':
					case 'link_text':
					case 'link_class':
						$value = sanitize_text_field( $value );

						if ( ( 'wlp_text' == $key || 'link_text' == $key ) && empty( $value ) )
							$value = 'View all';

						$new_options[ $key ] = $value;
					break;

					case 'link_priority':
						$value = absint( $value );

						$new_options[ $key ] = $value;
					break;

					default:
					break;
				}
			}
		}

		return $new_options;
	}

	/**
	 * Return plugin options array parsed with default options
Erick Hitter's avatar
Erick Hitter committed
636
	 *
Erick Hitter's avatar
Erick Hitter committed
637 638
	 * @uses get_option
	 * @uses wp_parse_args
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
	 * @return array
	 */
	private function get_options() {
		$options = get_option( $this->settings_key, $this->settings_defaults );

		if ( ! is_array( $options ) )
			$options = array();

		if ( ! array_key_exists( 'wlp_post_types', $options ) )
			$options[ 'wlp_post_types' ] = array();

		if ( ! array_key_exists( 'link_post_types', $options ) )
			$options[ 'link_post_types' ] = array();

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

	/**
Erick Hitter's avatar
Erick Hitter committed
657 658
	 * Build array of available post types, excluding all built-in ones except 'post' and 'page'.
	 *
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
	 * @uses get_post_types
	 * @return array
	 */
	private function post_types_array() {
		$post_types = array();
		foreach ( get_post_types( array(), 'objects' ) as $post_type ) {
			if ( false == $post_type->_builtin || 'post' == $post_type->name || 'page' == $post_type->name )
				$post_types[] = $post_type;
		}

		return $post_types;
	}

	/**
	 * Display admin notice regarding rewrite rules flush.
Erick Hitter's avatar
Erick Hitter committed
674
	 *
Erick Hitter's avatar
Erick Hitter committed
675 676 677 678 679 680
	 * @uses get_option
	 * @uses apply_filters
	 * @uses _e
	 * @uses __
	 * @uses admin_url
	 * @uses add_query_arg
681 682 683 684 685 686 687 688
	 * @action admin_notices
	 * @return html or null
	 */
	public function action_admin_notices_activation() {
		if ( ! get_option( $this->notice_key ) && apply_filters( 'vapp_display_rewrite_rules_notice', true ) ) :
		?>

		<div id="wpf-rewrite-flush-warning" class="error fade">
Erick Hitter's avatar
Erick Hitter committed
689
			<p><strong><?php _e( 'View All Post\'s Pages', 'view_all_posts_pages' ); ?></strong></p>
690

Erick Hitter's avatar
Erick Hitter committed
691
			<p><?php printf( __( 'You must refresh your site\'s permalinks before <em>View All Post\'s Pages</em> 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.', 'view_all_posts_pages' ), esc_url( admin_url( 'options-permalink.php' ) ) ); ?></p>
692

Erick Hitter's avatar
Erick Hitter committed
693
			<p><?php printf( __( 'When finished, click <a href="%s">here</a> to hide this message.', 'view_all_posts_pages' ), esc_url( admin_url( add_query_arg( $this->notice_key, 1, 'index.php' ) ) ) ); ?></p>
694 695 696 697 698 699
		</div>

		<?php
		endif;
	}
}
Erick Hitter's avatar
Erick Hitter committed
700 701 702 703 704 705
view_all_posts_pages::get_instance();

/**
 * Alias global variable used to hold instantiated plugin prior to singleton's introduction in version 0.7.
 */
$GLOBALS['vapp'] = view_all_posts_pages::get_instance();
706 707 708

/**
 * Shortcut to public function for generating full post view URL
Erick Hitter's avatar
Erick Hitter committed
709
 *
710
 * @param int $post_id
Erick Hitter's avatar
Erick Hitter committed
711
 * @uses view_all_posts_pages::get_instance
712 713 714
 * @return string or bool
 */
function vapp_get_url( $post_id = false ) {
Erick Hitter's avatar
Erick Hitter committed
715
	return view_all_posts_pages::get_instance()->url( intval( $post_id ) );
716 717 718 719
}

/**
 * Output link to full post view.
Erick Hitter's avatar
Erick Hitter committed
720 721
 *
 * @global $post
722 723
 * @param string $link_text
 * @param string $class
Erick Hitter's avatar
Erick Hitter committed
724 725 726 727
 * @uses vapp_get_url
 * @uses esc_attr
 * @uses esc_url
 * @uses esc_html
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
 * @return string or null
 */
function vapp_the_link( $link_text = 'View All', $class = 'vapp' ) {
	global $post;
	$url = vapp_get_url( $post->ID );

	if ( $url ) {
		$link = '<a ' . ( $class ? 'class="' . esc_attr( $class ) . '"' : '' ) . ' href="' . esc_url( $url ) . '">' . esc_html( $link_text ) . '</a>';

		echo $link;
	}
}

/**
 * Filter wp_link_pages args.
 * Function is a shortcut to class' filter.
Erick Hitter's avatar
Erick Hitter committed
744
 *
745
 * @param array $args
Erick Hitter's avatar
Erick Hitter committed
746
 * @uses view_all_posts_pages::get_instance
747 748 749
 * @return array
 */
function vapp_filter_wp_link_pages_args( $args ) {
Erick Hitter's avatar
Erick Hitter committed
750
	return view_all_posts_pages::get_instance()->filter_wp_link_pages_args( $args );
751 752 753 754 755
}

if ( ! function_exists( 'is_view_all' ) ) {
	/**
	 * Conditional tag indicating if full post view was requested.
Erick Hitter's avatar
Erick Hitter committed
756
	 *
Erick Hitter's avatar
Erick Hitter committed
757
	 * @uses view_all_posts_pages::get_instance
758 759 760
	 * @return bool
	 */
	function is_view_all() {
Erick Hitter's avatar
Erick Hitter committed
761
		return view_all_posts_pages::get_instance()->is_view_all();
762 763
	}
}