README.md 10.5 KB
Newer Older
1 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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 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
# WP Print Friendly #
**Contributors:** ethitter, stevenkword, thinkoomph  
**Donate link:** http://www.thinkoomph.com/plugins-modules/wp-print-friendly/  
**Tags:** print, template, printer, printable  
**Requires at least:** 3.1  
**Tested up to:** 5.2  
**Stable tag:** 0.6.2  
**License:** GPLv2 or later  
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html  

Extends WordPress' template system to support printer-friendly templates. Works with permalink structures to support nice URLs.

## Description ##

Extends WordPress' template system to support printer-friendly templates for posts, pages, and custom post types. Uses WP standard template naming to support templates on a post-type basis. Supports printing paged posts on single page. Adds nice URLs for printer-friendly pages.

**IMPORTANT**: There are certain plugins that may interfere with this plugin's functionality. See the **FAQ** for more information.

## Installation ##

1. Upload wp-print-friendly.php to /wp-content/plugins/.
2. Activate plugin through the WordPress Plugins menu.
3. Navigate to Options > Permalinks and click *Save Changes* to update navigation.

## Frequently Asked Questions ##

### Print links don't work ###
First, navigate to Options > Permalinks in WP Admin, click *Save Changes*, and try again.

If clicking on a print link takes you back to the post or page where the link appeared, see the **Known Plugin Conflicts** item below.

If, after reviewing the remaining FAQ, you are still experiencing problems, visit [http://www.thinkoomph.com/plugins-modules/wp-print-friendly/](http://www.thinkoomph.com/plugins-modules/wp-print-friendly/) and leave a comment detailing the problem.

### How should I name print templates? ###
Print templates should be prefixed with *wpf* and follow WordPress template conventions from there. To use one template for all contexts unless otherwise specified, name your template *wpf.php.*

For both built-in and custom post types, *wpf-[post type name].php* will be used for that post type. To use a template for a single post type object, name your template *wpf-[post type name]-[slug].php*.

For custom taxonomies, follow the naming conventions for post types.

Similarly, *wpf-home.php* will load that template for the front page of your site.

The plugin also includes a default template that may suit many needs.

### How do I add a print link to my templates? ###
The function `wpf_the_print_link` will add a link to the print-friendly version of whatever page it appears on. This function accepts the following arguments:

* **$page_link**: Set to true to add a link to the current page in a paged post in addition a to a link for the entire post.
* **$link_text**: Set to text that should appear for the print link. Defaults to *Print this post*.
* **$class**: Specifies the CSS class for the print link. Defaults to *print_link*.
* **$page_link_separator**: If $page_link is true, specifies what separator will appear between the print link for the entire post and the print link for the current page of the post.
* **$page_link_text**: If $page_link is true, specifies what text will appear for the print link for the current page. Defaults to *Print this page*.
* **$link_target**: If set to "new", print links will open in a new window.

### Known Plugin Conflicts ###
This plugin is known to conflict with certain plugins, many pertaining to SEO and permalinks. Conflicting plugins include, but are not limited to, the following:

* **WordPress SEO by Yoast:** This plugin's `Permalink` options, particularly *Redirect attachment URL's to parent post URL* and *Redirect ugly URL's to clean permalinks. (Not recommended in many cases!)*, interfere with WP Print Friendly's ability to display print templates. Both must be disabled, and the site's rewrite rules regenerated (by visiting Options > Permalinks and clicking *Save Changes*), for WP Print Friendly to function.

## Changelog ##

### 0.6.2 ###
* PHP 7.3 compatibility.

### 0.6.1 ###
* Security update: correct misuse of `add_query_arg()` as identified by Sucuri: https://blog.sucuri.net/2015/04/security-advisory-xss-vulnerability-affecting-multiple-wordpress-plugins.html.

### 0.6 ###
* Revert security hotfixes made in 0.5.3 and address the vulnerabilities in the WordPress way.
* If current user can't read a private post, don't display the print template, allowing the standard theme to handle requests.
* If a post is password protected and the viewer hasn't provided the right password, display the password form and prevent plugin from exposing any information about the post that WordPress doesn't already.
* When WordPress determines a request is a 404, don't activate the plugin's templating functionality.
* Convert the plugin to a singleton.
* Audit entire plugin for translation readyness.
* Correct phpdoc.

### 0.5.3 ###
* Creates is_protected() method to determine if the print page should be visible to the current user
* Correct security vulnerability allowing both private and password protected posts from being accessed through the print page
* Remove print_url links from the content when the current user does not have the necessary capabilities to view the print page

### 0.5.2 ###
* Revert change in is_print() method made in version 0.5 as it breaks the method when no page number is specified. See [https://github.com/ethitter/WP-Print-Friendly/issues/2](https://github.com/ethitter/WP-Print-Friendly/issues/2).

### 0.5.1 ###
* Correct construction of query needed in situations where verbose page rules are required.

### 0.5 ###
* Add additional rewrite rules for situations where verbose page rules are required.
* Disable canonical redirect when print template is requested.
* Update is_print() method to use WordPress API.
* Correct translation string implementation.
* Update code to better conform to WordPress Coding Standards.

### 0.4.4.1 ###
* Remove unnecessary query_var filter.

### 0.4.4 ###
* Full support for child themes.
* Expand template choosing to fully support WordPress template hierarchy as described at [http://codex.wordpress.org/Template_Hierarchy](http://codex.wordpress.org/Template_Hierarchy).
* Simplify rewrite rules creation.

### 0.4.3.3 ###
* Correct error that would display wrong page's content when printing a single page of a paged post.
* Correct error in link generation for page-specific print links.
* Increase compatibility with View All Post's Pages plugin.

### 0.4.3.2 ###
* Resolve PHP notice in options retrieval.
* Add compatibility with View All Post's Pages plugin (release forthcoming).

### 0.4.3.1 ###
* Fix bug in options retrieval that caused print links to be added to default post types if no post types were selected.
* Resolve PHP notice when using default permalinks.

### 0.4.3 ###
* Fix bug in page number function.
* Rewrite endnote link processing, including a refined regex pattern.
* Introduce class property for print slug.
* Correct minor bug in print link generation.
* Add canonical link attribute and nofollow declaration to default template.

### 0.4.2.2 ###
* Correct generation of custom post type rewrite rules.

### 0.4.2.1 ###
* Version 0.4.2 omitted the default template.

### 0.4.2 ###
* Correct page rewrite rules to accomodate situations necessitating verbose rules, such as when the permalink structure starts with `%postname%`. Thanks to Wes Herzik at ikonic for discovering and reporting this issue.

### 0.4.1 ###
* Fix bug that displayed post links automatically on the wrong post types.

### 0.4 ###
* Child pages now fully supported.
* Generates and registers rewrite rules more efficiently.
* Rewrite setting for all post types and taxonomies are now considered when adding print support.
* Add option to disable endnotes representing links found in content.
* Move copyright and other static elements from content filters to default template.
* Add function to display page numbers when printing single page of post.
* Options page is now fully translation-ready.
* Notices are translation-ready.
* Correct various other bugs, including many related to non-standard permalink structures, custom post types, and custom taxonomies.

### 0.3.2 ###
* Add option to open print-friendly views in a new window.

### 0.3.1 ###
* Correct PHP error in `is_print()`.

### 0.3 ###
* Initial version.

## Upgrade Notice ##

### 0.6.2 ###
Resolves a warning arising in PHP 7.3.

### 0.6.1 ###
Security update: correct misuse of `add_query_arg()` as identified by Sucuri: https://blog.sucuri.net/2015/04/security-advisory-xss-vulnerability-affecting-multiple-wordpress-plugins.html.

### 0.6 ###
Recommended for all users as this release addresses security vulnerabilities related to privately-published and password-protected posts.

### 0.5.2 ###
Resolves a problem where requests for print templates redirect to the article.

### 0.5.1 ###
Ensure that proper query string is built when verbose page rules are required.

### 0.5 ###
Adds better support for sites that use verbose page rules, resolving situations where requests for print template redirect to the post.

### 0.4.4.1 ###
Removes unnecessary query_var filter.

### 0.4.4 ###
Adds full child theme and template hierarchy support for template selection. Simplifies rewrite rules.

### 0.4.3.3 ###
Corrects a few errors related to paged posts and further enhances compatibility with View All Post's Pages plugin.

### 0.4.3.2 ###
Fixes a minor bug in plugin's options retrieval and enhances compatibility with forthcoming View All Post's Pages plugin.

### 0.4.3.1 ###
Fixes a bug in plugin's options retrieval that caused print links to be added to default post types if no post types were chosen. Also resolves a PHP notice encountered when using default permalinks.

### 0.4.3 ###
Fixes various bugs in the print link, page numbering, and endnote generating functions. Also introduces a class variable for permalink component. Default template is updated to be more SEO friendly, now containing both canonical URL and nofollow declarations.

### 0.4.2.2 ###
Rewrite rules for custom post types are now generated correctly.

### 0.4.2.1 ###
Version 0.4.2 omitted the default template.

### 0.4.2 ###
This release expands the plugin's page rewrite rules to accomodate permalink structures that necessitate verbose rules, such as when the structure begins with `%postname%`.

### 0.4.1 ###
This release fixes bug that displayed post links automatically on the wrong post types.

### 0.4 ###
This release addresses numerous bugs reported by the community, including print templates for child pages. All admin text, save the plugin's name, are now ready for translation. Templates are now completely customizable, and new template functions are included.