A powerful class representing an image file within your WordPress site, which offers resizing, cropping, and manipulation features.
Implements the __toString PHP magic method to convert this object to an HTML tag when it is echoed.
Gets or sets the attributes stored inside this image object, which are used to output HTML attributes.
Retrieves the bit-depth of the image.
Retrieves a WOOF_EXIF object representing the EXIF data in the image, if available.
Retrieves the height of the image in pixels.
Retrieves an associative array of info about this image file.
Returns true if the image is a landscape orientation (width is larger than height).
Returns true if the image is a portrait orientation (height is larger than width).
Returns true if the image is square (width equals height).
Returns a string representing the orientation of the image:“landscape” – if the image is wider than it is tall“portrait” – if the image is taller than it is wide“square” – if the image is of equal width and height.
Retrieves the width of the image in pixels.
A utility method used by this class to save an image resource to disk, auto-detecting the correct format and required PHP function needed to do so.Note: this method is intended for internal use.
Returns an image tag that removes the width and height attributes, for use with responsive image techniques.
An alias for the WOOF_Image::tag method to generate an HTML tag for the image.
Outputs markup for use with the picturefill responsive images library by Scott Jehl, which allows you to specify a number of images to use at different media query breakpoints, as well as images for high-resolution displays. This method accepts a number of shorthand argument keys to quickly output the necessary media query min-width, max-width, and min-device-pixel ratio media query declarations, as well as smart values for these keys to define either separate image files to use, or a resize operation on this image. Note: MasterPress includes the picturefill.js and matchmedia.js libraries which can be enqueued with the following identifiers, anytime before wp_head().wp_enqueue_script(‘mp-matchmedia’);wp_enqueue_script(‘mp-picturefill’);.
A preset on the WOOF_Image::picture method to output markup for use with the picturefill responsive images library by Scott Jehl.
Retrieves an HTML tag for the image.
Creates a thumbnail link to a larger full size image, which is highly useful for lightbox plugins and so on.
A preset on the WOOF_Image::resize method which uses the argument “c=2” which will crop the image to a specified width and height without scaling the image.
An alias for the WOOF_Image::resize method to resize an image, with various cropping options.
A convenience method to retrieve the GD image resource for the image this file represents.
An alias for woof-image which is a more appropriate method name when we just want to change the jpeg quality without resizing.
A highly useful method to resize an image, and cache the result in the image cache.
An alias for WOOF_Image::resize to resize an image, and cache the result in the image cache.
Creates a thumbnail link to a larger full size image, which is highly useful for lightbox plugins and so on.
A more concise alias for the WOOF_Image::selective_blur filter to apply a selective blur to the image, and cache the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Adjusts the brightness of the image, and caches the result in the image cache.
Colorizes the image, with a given color (while retaining the other colors in the image), and caches the result in the image cache.Given the following unprocessed image:The example code produces these images:A more useful function might be the WOOF_Image::tint method, which applies a grayscale filter before colorizing the image, which produces a generally nicer effect.
Adjusts the brightness of the image, and caches the result in the image cache.
Applies a convolution filter to the image, using the imageconvolution PHP function.
Creates an image based on edge detection of the source, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Creates an embossed-look version of the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Applies a gaussian blur to the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
A more concise alias for the WOOF_Image::gaussian_blur method (“gaussian” is rather annoying to type), to apply a gaussian blur to the image, and cache the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Removes the color from the image, and caches the result in the image cache.Given the following unprocessed image:The example code produces this image:.
Applies a laplace effect to the image via convolution.Given the following unprocessed image: The example code produces this image:.
Applies a laplace diagonal effect to the image via convolution.Given the following unprocessed image: The example code produces this image:.
Applies a mean removal effect (giving a “sketched” appearance) to the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Generates a pixelated version of the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces these images:.
The WOOF_Image::selective_blur filter to apply a selective blur to the image, and cache the result in the image cache.Given the following unprocessed image: The example code produces this image:.
A specialisation of the WOOF_Image::tint method, to create a sepia-tone effect on the image, and save the result to the image cache.Colorizes the image, with a given color (while retaining the other colors in the image), and caches the result in the image cache.Given the following unprocessed image:The example code produces this image: .
Sharpens an image via convolution, and caches the result.Given the following unprocessed image: The example code produces this image:.
An alias for the WOOF_Image::mean_removal to give the image a “sketched” appearance, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Smooths the image, and caches the result in the image cache. Given the following unprocessed image: The example code produces these images:.
Applies a sobel effect to the image via convolution.Given the following unprocessed image: The example code produces this image:.
Applies a grayscale filter and then colorize to generate a tinted effect on the image, and saves the result to the image cache.Given the following unprocessed image:The example code produces these images: .
Generates a solid color border around the image.Given the following unprocessed image: The example code produces the images below:.
Generates an upside down reflection underneath the image, giving the appearance of the image resting on a glossy surface, and caches the result in the image cache.Given the following unprocessed image: The example code produces these images:.
A powerful method to apply another image as a watermark on top of this image, and then cache the result in the image cache. Given the following two images (marked $play and $cat in the example code respectively): The example code produces the following images:.
Gets co-ordinates to use for the anchoring points usable by the WOOF_Image::watermark method to determine where the watermark is placed.Note: this method is intended for internal use.
Copy and merge part of an image, while respecting alpha channels. .
Parses a color string into an array containing an RGB array and a hex string representing the color.
Parses an x,y coordinate string into an array made up of an x and y integer components.
Creates a thumbnail link to the fullsize image which is intended to be augmented with the JavaScript fancyzoom plugin bundled with MasterPress (mp_thumb abbreviates MasterPress Thumbnail).
An alias for the WOOF_Image::mp_thumb to create a thumbnail link to the fullsize image which is intended to be augmented with the JavaScript fancyzoom plugin bundled with MasterPress (mt abbreviates “MasterPress Thumbnail”).
Returns an associative array describing the path and URL of an output image, given the arguments passed.
A utility method that handles all of the code to call a PHP image filter via the imagefilter function.
Gets co-ordinates to use for the anchoring points usable by the WOOF_Image::watermark method to determine where the watermark is placed.Note: this method is intended for internal use.
Gets offset co-ordinates for the anchoring points usable by the WOOF_Image::watermark method to determine where the watermark is placed.Note: this method is intended for internal use.
A utility method used by this class to save an image resource to disk, auto-detecting the correct format and required PHP function needed to do so.Note: this method is intended for internal use.
Retrieves size and other info for the image via PHP’s getimagesize function. Note: this method is intended for internal use.
Implements the __toString PHP magic method to convert this object to an HTML tag when it is echoed.
Gets or sets the attributes stored inside this image object, which are used to output HTML attributes.
Retrieves the bit-depth of the image.
A more concise alias for the WOOF_Image::selective_blur filter to apply a selective blur to the image, and cache the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Generates a solid color border around the image.Given the following unprocessed image: The example code produces the images below:.
Adjusts the brightness of the image, and caches the result in the image cache.
Returns an associative array describing the path and URL of an output image, given the arguments passed.
Colorizes the image, with a given color (while retaining the other colors in the image), and caches the result in the image cache.Given the following unprocessed image:The example code produces these images:A more useful function might be the WOOF_Image::tint method, which applies a grayscale filter before colorizing the image, which produces a generally nicer effect.
Adjusts the brightness of the image, and caches the result in the image cache.
Applies a convolution filter to the image, using the imageconvolution PHP function.
A preset on the WOOF_Image::resize method which uses the argument “c=2” which will crop the image to a specified width and height without scaling the image.
Creates an image based on edge detection of the source, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Creates an embossed-look version of the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Retrieves a WOOF_EXIF object representing the EXIF data in the image, if available.
A utility method that handles all of the code to call a PHP image filter via the imagefilter function.
Returns an image tag that removes the width and height attributes, for use with responsive image techniques.
Applies a gaussian blur to the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
A more concise alias for the WOOF_Image::gaussian_blur method (“gaussian” is rather annoying to type), to apply a gaussian blur to the image, and cache the result in the image cache.Given the following unprocessed image: The example code produces this image:.
An alias for the WOOF_Image::resize method to resize an image, with various cropping options.
Gets co-ordinates to use for the anchoring points usable by the WOOF_Image::watermark method to determine where the watermark is placed.Note: this method is intended for internal use.
Gets offset co-ordinates for the anchoring points usable by the WOOF_Image::watermark method to determine where the watermark is placed.Note: this method is intended for internal use.
Removes the color from the image, and caches the result in the image cache.Given the following unprocessed image:The example code produces this image:.
Retrieves the height of the image in pixels.
An alias for the WOOF_Image::tag method to generate an HTML tag for the image.
Copy and merge part of an image, while respecting alpha channels. .
Retrieves an associative array of info about this image file.
Returns true if the image is a landscape orientation (width is larger than height).
Returns true if the image is a portrait orientation (height is larger than width).
Returns true if the image is square (width equals height).
Applies a laplace effect to the image via convolution.Given the following unprocessed image: The example code produces this image:.
Applies a laplace diagonal effect to the image via convolution.Given the following unprocessed image: The example code produces this image:.
Applies a mean removal effect (giving a “sketched” appearance) to the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Creates a thumbnail link to the fullsize image which is intended to be augmented with the JavaScript fancyzoom plugin bundled with MasterPress (mp_thumb abbreviates MasterPress Thumbnail).
An alias for the WOOF_Image::mp_thumb to create a thumbnail link to the fullsize image which is intended to be augmented with the JavaScript fancyzoom plugin bundled with MasterPress (mt abbreviates “MasterPress Thumbnail”).
Returns a string representing the orientation of the image:“landscape” – if the image is wider than it is tall“portrait” – if the image is taller than it is wide“square” – if the image is of equal width and height.
Parses a color string into an array containing an RGB array and a hex string representing the color.
Parses an x,y coordinate string into an array made up of an x and y integer components.
Outputs markup for use with the picturefill responsive images library by Scott Jehl, which allows you to specify a number of images to use at different media query breakpoints, as well as images for high-resolution displays. This method accepts a number of shorthand argument keys to quickly output the necessary media query min-width, max-width, and min-device-pixel ratio media query declarations, as well as smart values for these keys to define either separate image files to use, or a resize operation on this image. Note: MasterPress includes the picturefill.js and matchmedia.js libraries which can be enqueued with the following identifiers, anytime before wp_head().wp_enqueue_script(‘mp-matchmedia’);wp_enqueue_script(‘mp-picturefill’);.
A preset on the WOOF_Image::picture method to output markup for use with the picturefill responsive images library by Scott Jehl.
Generates a pixelated version of the image, and caches the result in the image cache.Given the following unprocessed image: The example code produces these images:.
Generates an upside down reflection underneath the image, giving the appearance of the image resting on a glossy surface, and caches the result in the image cache.Given the following unprocessed image: The example code produces these images:.
A convenience method to retrieve the GD image resource for the image this file represents.
An alias for woof-image which is a more appropriate method name when we just want to change the jpeg quality without resizing.
A highly useful method to resize an image, and cache the result in the image cache.
A utility method used by this class to save an image resource to disk, auto-detecting the correct format and required PHP function needed to do so.Note: this method is intended for internal use.
The WOOF_Image::selective_blur filter to apply a selective blur to the image, and cache the result in the image cache.Given the following unprocessed image: The example code produces this image:.
A specialisation of the WOOF_Image::tint method, to create a sepia-tone effect on the image, and save the result to the image cache.Colorizes the image, with a given color (while retaining the other colors in the image), and caches the result in the image cache.Given the following unprocessed image:The example code produces this image: .
Sharpens an image via convolution, and caches the result.Given the following unprocessed image: The example code produces this image:.
Retrieves size and other info for the image via PHP’s getimagesize function. Note: this method is intended for internal use.
An alias for the WOOF_Image::mean_removal to give the image a “sketched” appearance, and caches the result in the image cache.Given the following unprocessed image: The example code produces this image:.
Smooths the image, and caches the result in the image cache. Given the following unprocessed image: The example code produces these images:.
Applies a sobel effect to the image via convolution.Given the following unprocessed image: The example code produces this image:.
Retrieves an HTML tag for the image.
An alias for WOOF_Image::resize to resize an image, and cache the result in the image cache.
Creates a thumbnail link to a larger full size image, which is highly useful for lightbox plugins and so on.
Applies a grayscale filter and then colorize to generate a tinted effect on the image, and saves the result to the image cache.Given the following unprocessed image:The example code produces these images: .
A powerful method to apply another image as a watermark on top of this image, and then cache the result in the image cache. Given the following two images (marked $play and $cat in the example code respectively): The example code produces the following images:.
Retrieves the width of the image in pixels.
View method list from the base class WOOF_File.
MasterPress 1.3.8 is a bugfix release. Fixed a bug where MB, KB, and GB were being converted to bytes incorrectly via WOOF file functions. Fixed a bug where transparent images were losing their transparency on resize.
MasterPress requires a minimum of WordPress version 4.9, MySQL 5.6, and PHP version 5.6.20.
We also recommend that PHP is configured to use a memory limit of 64MB per request (128MB may be required for sites with higher complexity).
This plug-in is not compatible with the WordPress.com hosted service.
Copyright 2023 © Three AM All rights reserved.
