mcguffin/pdf-renderer

WordPress plugin to convert PDFs to Images before uploading them

0.1.0 2021-08-26 15:22 UTC

Requires

• intervention/httpauth: ^3.0
• mcguffin/wp-skeleton-asset: dev-main
• mcguffin/wp-skeleton-plugin: dev-main

Requires (Dev)

• pheromone/phpcs-security-audit: *
• phpcompatibility/php-compatibility: *
• squizlabs/php_codesniffer: *
• wp-coding-standards/wpcs: *

GPL-3.0-or-later

README

Convert PDF Files to Images in your browser when dropped into the media library.

Includes Mozilla pdf.js for browser pdf rendering.

PDF-Contents: cc-by Creative Commons

Installation

Production (using Github Updater – recommended for Multisite)

• Install Andy Fragen's GitHub Updater first.
• In WP Admin go to Settings / GitHub Updater / Install Plugin. Enter mcguffin/pdf-renderer as a Plugin-URI.

Development

• cd into your plugin directory
• $ git clone [e-mail]:mcguffin/pdf-renderer.git
• $ cd pdf-renderer
• $ npm install
• $ npm run dev

Plugin API

Filter pdf_renderer_image_width

Use this to overrule width of generated images. Uses the largest image width known to WP by default. (e.g. the Large size from Settings > Media).

Example:

add_filter( 'pdf_renderer_image_width', function( $width ) {
	// never underestimate a good integer.
	return 12345;
});

Filter pdf_renderer_image_type

Type of generated images. Possible values are image/png and image/jpeg. default is image/png.
To override the JPEG-Quality you can use the WP Core filter jpeg_quality. The string pdf_renderer is passed as a second argument to apply_filters().

Example:

// we want jpeg ...
add_filter( 'pdf_renderer_image_type', function( $type ) {
	return 'image/jpeg';
});
// ... and a specific treatment for PDFs.
add_filter( 'jpeg_quality', function( $quality, $context = '' ) {
	if ( 'pdf_renderer' === $context ) {
		// Everybody loves artifacts.
		return 1;
	}
	return $quality;
}, 10, 2);