README.md 3.55 KB
Newer Older
Erick Hitter's avatar
Erick Hitter committed
1
# Automatically Paginate Posts #
Erick Hitter's avatar
Erick Hitter committed
2
**Contributors:** [ethitter](https://profiles.wordpress.org/ethitter/), [thinkoomph](https://profiles.wordpress.org/thinkoomph/), [bendoh](https://profiles.wordpress.org/bendoh/)  
Erick Hitter's avatar
Erick Hitter committed
3
4
5
Donate link:
**Tags:** paginate, nextpage, Quicktag  
**Requires at least:** 3.4  
Erick Hitter's avatar
Erick Hitter committed
6
**Tested up to:** 6.0  
Erick Hitter's avatar
Erick Hitter committed
7
**Stable tag:** 0.3.1  
Erick Hitter's avatar
Erick Hitter committed
8
**Requires PHP:** 5.6  
Erick Hitter's avatar
Erick Hitter committed
9
10
11
**License:** GPLv2 or later  
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html  

Erick Hitter's avatar
Erick Hitter committed
12
Automatically paginate posts by inserting the `<!--nextpage-->` Quicktag.
Erick Hitter's avatar
Erick Hitter committed
13

Erick Hitter's avatar
Erick Hitter committed
14
## Description ##
Erick Hitter's avatar
Erick Hitter committed
15

Erick Hitter's avatar
Erick Hitter committed
16
Automatically paginate WordPress content by inserting the `<!--nextpage-->` Quicktag at intervals controlled by plugin's settings.
Erick Hitter's avatar
Erick Hitter committed
17

Erick Hitter's avatar
Erick Hitter committed
18
Option is provided to control which post types are automatically paginated (default is the "Post" post type). Supports any public custom post types (non-public types are supported via the `autopaging_post_types` filter).
Erick Hitter's avatar
Erick Hitter committed
19
20
21
22
23

Option is also provided to specify how many pages content should be broken out over, or how many words should be included per page.

## Installation ##

Erick Hitter's avatar
Erick Hitter committed
24
1. Upload automatically-paginate-posts to `/wp-content/plugins/`.
Erick Hitter's avatar
Erick Hitter committed
25
2. Activate plugin through the WordPress Plugins menu.
Erick Hitter's avatar
Erick Hitter committed
26
3. Configure plugin by going to **Settings > Reading**.
Erick Hitter's avatar
Erick Hitter committed
27
28
29

## Frequently Asked Questions ##

Erick Hitter's avatar
Erick Hitter committed
30
### Where do I set the plugin's options? ###
Erick Hitter's avatar
Erick Hitter committed
31
32
The plugin's options are added to the built-in **Reading** settings page in WordPress.

Erick Hitter's avatar
Erick Hitter committed
33
### Can I disable the plugin's functionality for specific content? ###
Erick Hitter's avatar
Erick Hitter committed
34
Yes, the plugin adds a metabox (Classic Editor) and a sidebar component (Block Editor) to individual items in supported post types that allows the autopaging to be disabled on a per-post basis.
Erick Hitter's avatar
Erick Hitter committed
35
36

### How can I add support for my custom post type? ###
Erick Hitter's avatar
Erick Hitter committed
37
Navigate to **Settings > Reading** in WP Admin to enable this plugin for your custom post type.
Erick Hitter's avatar
Erick Hitter committed
38
39
40
41
42
43
44
45
46
47

You can also use the filter `autopaging_post_types` to add support by appending your post type's name to the array.

### What filters does this plugin include? ###
* `autopaging_post_types` - modify the post types supported by this plugin. Will override the values set under Settings > Reading.
* `autopaging_num_pages_default` - modify the default number of pages over which a post is displayed. Will override the value set under Settings > Reading.
* `autopaging_max_num_pages` - override the maximum number of pages available in the settings page dropdown when the paging type is "pages".
* `autopaging_max_num_words` - override the minimum number of words allowed per page page when the paging type is "words".
* `autopaging_num_pages` - change the number of pages content is displayed on at runtime. Filter provides access to the full post object in addition to the number of pages.
* `autopaging_num_words` - change the number of words displayed per page at runtime. Filter provides access to the full post object in addition to the number of words.
Erick Hitter's avatar
Erick Hitter committed
48
* `autopaging_supported_block_types_for_word_counts` - specify which block types are considered when splitting a block-editor post by word count.
Erick Hitter's avatar
Erick Hitter committed
49
50
51

## Changelog ##

Erick Hitter's avatar
Erick Hitter committed
52
53
54
### 0.3.1 ###
* Fix translation support.

Erick Hitter's avatar
Erick Hitter committed
55
56
57
58
### 0.3 ###
* Add support for content authored in block editor (Gutenberg).
* Add native block-editor control to replace legacy metabox.
* Fix bug that created empty pages.
Erick Hitter's avatar
Erick Hitter committed
59
60
61
62

### 0.2 ###
* Allow for number of words to be specified instead of number of pages.

Erick Hitter's avatar
Erick Hitter committed
63
64
65
### 0.1 ###
* Initial release.

Erick Hitter's avatar
Erick Hitter committed
66
67
## Upgrade Notice ##

Erick Hitter's avatar
Erick Hitter committed
68
69
70
### 0.3.1 ###
Fixes translation support.

Erick Hitter's avatar
Erick Hitter committed
71
72
### 0.3 ###
Add support for block editor and fix bug that created empty pages.
Erick Hitter's avatar
Erick Hitter committed
73
74

### 0.2 ###
Erick Hitter's avatar
Erick Hitter committed
75
76
77
78
Allow for number of words to be specified instead of number of pages.

### 0.1 ###
Initial release