Skip to content

dreadedhamish/transporter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

=== Infinite Post Transporter ===
Contributors: TomHarrigan, codeandtheory, jmarx75
Tags: AJAX, endless, pagination, reading, scroll, scrolling, genesis, canvas
Requires at least: 3.1
Tested up to: 4.1
Stable tag: 1.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Infinite scroll extended to single post pages

== Description ==

In addition to normal infinite scroll behavior, this plugin adds infinite scroll to the single post page. When reading a single post, once the reader reaches the bottom of the page, the next post loads in. This is similar to functionality on big news sites such as Time.com, LA Times, Quartz, Vogue.com

The default WordPress TwentySomething themes, Genesis themes and Canvas themes are already compatable with this plugin and ready to go!

Relies on add_theme_support. If your theme is not in the above list, add the folliwing to your themes functions.php file: `add_theme_support( 'infinite-transporter' );`

See installation and FAQ sections for more on getting set up. 

== Installation ==

= Using The WordPress Dashboard =

1. Navigate to the 'Add New' Plugin Dashboard
1. Select `infinite-transporter.zip` from your computer
1. Upload
1. Activate the plugin on the WordPress Plugin Dashboard

= Using FTP =

1. Extract `infinite-transporter.zip` to your computer
1. Upload the `infinite-transporter` directory to your `wp-content/plugins` directory
1. Activate the plugin on the WordPress Plugins dashboard

The default WordPress TwentySomething themes, Genesis themes and Canvas themes are already compatable with this plugin and ready to go!

Otherwise, add the following to your themes functions.php file: `add_theme_support( 'infinite-transporter' );`

The available options are the same as those in Jetpack Infinite Scroll. To configure further, see the following: http://jetpack.me/support/infinite-scroll/

The plugin assumes that your themes content container is named 'content', unless otherwise defined. If posts are loaded in a container named differently than that, for example inside of a div named 'main', then in your 'add_theme_support' declaration, include the 'container' argument with name of your themes container div like so: 

`add_theme_support( 'infinite-transporter', array( 'container' => 'main' ) );`
 

== Frequently Asked Questions ==
= What are all of the available settings? =

The following is all of the available parameters that can be set along with their default values:

`add_theme_support( 'infinite-transporter', array(
	'type'            => 'scroll', // scroll | click
	'requested_type'  => 'scroll', // store the original type for use when logic overrides it
	'footer_widgets'  => false, // true | false | sidebar_id | array of sidebar_ids -- last two are checked with is_active_sidebar
	'container'       => 'content', // container html id
	'wrapper'         => true, // true | false | html class
	'render'          => false, // optional function, otherwise the 'content' template part will be used
	'footer'          => true, // boolean to enable or disable the infinite footer | string to provide an html id to derive footer width from
	'google_analytics'=> false, // boolean if using google analytics, set to true
	'post_order'	  => false, // boolean. false to display newest post after initial post. True to display next reverse chronological post after current post.
	'footer_callback' => false, // function to be called to render the IS footer, in place of the default
	'posts_per_page'  => false, // int | false to set based on IS type
	'click_handle'    => true, // boolean to enable or disable rendering the click handler div. If type is click and this is false, page must include its own trigger with the HTML ID 'infinite-handle'.
) );`

== Changelog ==

= 1.3 =
* Single post queries will now use the post type of the initial post, rather than always displaying the 'Post' post type.-
* Add filter 'infinite_transporter_post_type' to filter post type of single post queries. Allows to add additional post types to query.
* Add filter 'infinite_transporter_in_same_cat' to only display posts from the category of the current posts
* Modify Canvas theme render function to use themes loop.php file for non-single post pages to maintain theme options for excerpt/content settings. 

= 1.2 =
* Allow support for themes that aren't well written and don't have an ID defined for the content area, but use a class name instead.
* Add 'infinite_transporter_post_order' filter to allow for changing the post order behavior depending on user defined criteria (ex. different categories of posts, or post types, etc.)

= 1.1 =
* Add Google Analytics integration support
* Add support for Genesis themes
* Add support for Canvas themes
* Add support for Twenty Fifteen theme
* Add 'post_order' parameter to allow loading of posts in sequential reverse-chron order (true), or by starting from latest post after scrolling through initial post (default, false).
* Add 'single_infinite_transporter_query_args' filter
* Fix bug with second post not updating URL
* Fix bug with page parameter being appended in single post page

= 1.0 =
* Initial release

About

Infinite scroll extended to single post pages. Save your readers a few clicks and load the next article for them! Available on .org at https://wordpress.org/plugins/infinite-transporter/

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 58.2%
  • JavaScript 24.1%
  • CSS 17.7%