setFilePath( $file_path );
if ( $args )
$this->setArgs( $args );
if ( ( $this->getFilePath() && $this->getArgs() ) && ! $this->errored() ) {
if ( ! $this->isRemote() ) {
$dimensions = array_slice( (array) @getimagesize( $this->getFilePath() ), 0, 2 );
if ( ( $this->getArg( 'width' ) != $dimensions[0] || $this->getArg( 'height' ) != $dimensions[1] ) && ( ! file_exists( $this->getCacheFilePath() ) || ! $this->args['cache'] ) )
$this->generateCacheFile();
} elseif ( ! file_exists( $this->getCacheFilePath() ) || ! $this->args['cache'] ) {
$this->generateCacheFile();
}
}
}
/**
* Set the file path of the original image
*
* Will convert URLS to paths.
*
* @param string $file_path
*/
public function setFilePath( $file_path ) {
$upload_dir = self::uploadDir();
if ( strpos( $file_path, self::get_home_path() ) === 0 ) {
$this->file_path = $file_path;
return;
}
// If it's an uploaded file
if ( strpos( $file_path, $upload_dir['baseurl'] ) !== false )
$this->file_path = str_replace( $upload_dir['baseurl'], $upload_dir['basedir'], $file_path );
else
$this->file_path = str_replace( trailingslashit( home_url() ), self::get_home_path(), $file_path );
// if it's a local path, lets check it now
if ( strpos( $this->file_path , '/' ) === 0 && strpos( $this->file_path , '//' ) !== 0 && ! file_exists( $this->file_path ) )
$this->error = new WP_Error( 'file-not-found' );
}
/**
* Parse the args and merge with defaults
*
* @param array $args
*/
public function setArgs( $args ) {
$arg_defaults = array(
'width' => 0,
'height' => 0,
'crop' => false,
'crop_from_position' => 'center,center',
'resize' => true,
'watermark_options' => array(),
'cache' => true,
'skip_remote_check' => false,
'default' => null,
'jpeg_quality' => 90,
'resize_animations' => true,
'return' => 'url',
'custom' => false,
'background_fill' => null,
'output_file' => false,
'cache_with_query_params' => false
);
$args = wp_parse_args( $args, $arg_defaults );
$new_args = array();
if ( $args['width'] === 'thumbnail' )
$new_args = array( 'width' => get_option('thumbnail_size_w'), 'height' => get_option('thumbnail_size_h'), 'crop' => get_option('thumbnail_crop') );
elseif ( $args['width'] === 'medium' )
$new_args = array( 'width' => get_option('medium_size_w'), 'height' => get_option('medium_size_h') );
elseif ( $args['width'] === 'large' )
$new_args = array( 'width' => get_option('large_size_w'), 'height' => get_option('large_size_h') );
elseif ( is_string( $args['width'] ) && $args['width'] )
$new_args = apply_filters( 'wpthumb_create_args_from_size', $args );
elseif ( is_array( $args['width'] ) )
$new_args = $args;
$args = wp_parse_args( $new_args, $args );
// Cast some args
$args['crop'] = (bool) $args['crop'];
$args['resize'] = (bool) $args['resize'];
$args['cache'] = (bool) $args['cache'];
$args['width'] = (int) $args['width'];
$args['height'] = (int) $args['height'];
// Format the crop from position arg
if ( is_string( $args['crop_from_position'] ) )
$args['crop_from_position'] = explode( ',', $args['crop_from_position'] );
// Sort out the watermark args
if ( ! empty( $args['watermark_options']['mask'] ) ) {
$wpthumb_wm_defaults = array( 'padding' => 0, 'position' => 'cc', 'pre_resize' => false );
$args['watermark_options'] = wp_parse_args( $args['watermark_options'], $wpthumb_wm_defaults );
}
if ( $args['background_fill'] === 'solid' && $args['background_fill'] = 'auto' )
_deprecated_argument( __FUNCTION__, '0.8.3', 'Use "auto" instead.' );
$this->args = $args;
}
/**
* Return the file path to the original image
*
* @return string
*/
public function getFilePath() {
if ( strpos( $this->file_path, '/' ) === 0 && ! file_exists( $this->file_path ) && $this->args['default'] )
$this->file_path = $this->args['default'];
if ( $this->getArg( 'cache_with_query_params' ) )
return $this->file_path;
return reset( explode( '?', $this->file_path ) );
}
/**
* Return the array of args
*
* @return array
*/
public function getArgs() {
return (array) $this->args;
}
/**
* Get a specific arg
*
* @access public
* @param string $arg
* @return bool
*/
public function getArg( $arg ) {
if ( isset( $this->args[$arg] ) )
return $this->args[$arg];
return false;
}
/**
* Get the extension of the original image
*
* @return string
*/
public function getFileExtension() {
$ext = pathinfo( $this->getFilePath(), PATHINFO_EXTENSION );
if ( ! $ext ) {
// Seems like we dont have an ext, lets guess at JPG
$ext = 'jpg';
}
return $ext;
}
/**
* Get the filepath to the cache file
*
* @access public
* @return string
*/
public function getCacheFilePath() {
$path = $this->getFilePath();
if ( ! $path )
return '';
return apply_filters( 'wpthumb_cache_file_path', trailingslashit( $this->getCacheFileDirectory() ) . $this->getCacheFileName(), $this );
}
/**
* Get the directory that the cache file should be saved too
*
* @return string
*/
public function getCacheFileDirectory() {
if ( $this->getArg( 'output_file' ) )
return dirname( $this->getArg( 'output_file' ) );
$path = $this->getFilePath();
if ( ! $path )
return '';
$original_filename = basename( $this->getFilePath() );
// If the image was remote, we want to store them in the remote images folder, not it's name
if ( strpos( $original_filename, '0_0_resize' ) === 0 )
$original_filename = end( explode( '/', str_replace( '/' . $original_filename, '', $this->getFilePath() ) ) );
// TODO use pathinfo
$parts = explode( '.', $original_filename );
array_pop( $parts );
$filename_nice = implode( '_', $parts );
$upload_dir = self::uploadDir();
if ( strpos( $this->getFilePath(), $upload_dir['basedir'] ) === 0 ) :
$new_dir = $upload_dir['basedir'] . '/cache' . $upload_dir['subdir'] . '/' . $filename_nice;
elseif ( strpos( $this->getFilePath(), self::get_home_path() ) === 0 ) :
$new_dir = $upload_dir['basedir'] . '/cache/local';
else :
$parts = parse_url( $this->getFilePath() );
if ( ! empty( $parts['host'] ) )
$new_dir = $upload_dir['basedir'] . '/cache/remote/' . sanitize_title( $parts['host'] );
else
$new_dir = $upload_dir['basedir'] . '/cache/remote';
endif;
// TODO unit test for whether this is needed or not
$new_dir = str_replace( '/cache/cache', '/cache', $new_dir );
return $new_dir;
}
/**
* Get the filename of the cache file
*
* @return string
*/
public function getCacheFileName() {
if ( $this->getArg( 'output_file' ) )
return basename( $this->getArg( 'output_file' ) );
$path = $this->getFilePath();
if ( ! $path )
return '';
// Generate a short unique filename
$serialize = crc32( serialize( array_merge( $this->getArgs(), array( $this->getFilePath() ) ) ) );
// Gifs are converted to pngs
if ( $this->getFileExtension() == 'gif' )
return $serialize . '.png';
return $serialize . '.' . $this->getFileExtension();
}
public function isRemote() {
return strpos( $this->getFilePath(), self::get_home_path() ) !== 0;
}
/**
* Generate the new cache file using the original image and args
*
* @return string new filepath
*/
public function generateCacheFile() {
// Performance testing
do_action( 'start_operation', 'generateCacheFile' );
do_action( 'add_event', $this->getFilePath() );
$new_filepath = $this->getCacheFilePath();
$file_path = $this->getFilePath();
// Up the php memory limit
@ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', '256M' ) );
// Create the image
try {
$thumb = phpThumbFactory::create( $file_path, array( 'jpegQuality' => $this->args['jpeg_quality'] ) );
} catch ( Exception $e ) {
$this->error = $e;
do_action( 'end_operation', 'generateCacheFile' );
return $this->returnImage();
}
$thumb = apply_filters( 'wpthumb_image_filter', $thumb, $this->args );
extract( $this->args );
wp_mkdir_p( $this->getCacheFileDirectory() );
// Convert gif images to png before resizing
if ( $this->getFileExtension() == 'gif' ) :
// Don't resize animated gifs as the animations will be broken
if ( ! empty( $resize_animations ) !== true && $this->isAnimatedGif() ) {
$this->error = new WP_Error( 'animated-gif' );
do_action( 'end_operation', 'generateCacheFile' );
return $this->returnImage();
}
// Save the converted image
$thumb->save( $new_filepath, 'png' );
// tell everyone
do_action( 'wpthumb_save_file', $new_filepath, $this );
unset( $thumb );
do_action( 'end_operation', 'generateCacheFile' );
// Pass the new file back through the function so they are resized
return new WP_Thumb( $new_filepath, array_merge( $this->args, array( 'output_file' => $new_filepath, 'cache' => false ) ) );
endif;
// Watermarking (pre resizing)
if ( isset( $watermark_options['mask'] ) && $watermark_options['mask'] && isset( $watermark_options['pre_resize'] ) && $watermark_options['pre_resize'] === true ) {
// TODO why?
$thumb->resize( 99999, 99999 );
$thumb->createWatermark( $watermark_options['mask'], $watermark_options['position'], $watermark_options['padding'] );
}
// Cropping
if ( $crop === true && $resize === true ) :
if ( $crop_from_position && count( $crop_from_position ) == 2 && method_exists( $thumb, 'adaptiveResizeFromPoint' ) && empty( $background_fill ) ) {
$thumb->adaptiveResizeFromPoint( $width, $height, $crop_from_position[0], $crop_from_position[1] );
}
// Background file auto
elseif ( $background_fill === 'auto' && $thumb->canBackgroundFillSolidColorWithResize( $width, $height ) ) {
$thumb->resize( $width, $height );
$thumb->backgroundFillAutoColor( $width, $height );
}
// Background fill with color
elseif ( ! empty( $background_fill ) && $background_fill !== 'auto' ) {
$thumb->resize( $width, $height );
$thumb->backgroundFillWithColor( $width, $height, $background_fill );
}
elseif ( $crop_from_position && count( $crop_from_position ) == 2 ) {
$thumb->adaptiveResizeFromPoint( $width, $height, $crop_from_position[0], $crop_from_position[1] );
} else {
$thumb->adaptiveResize( $width, $height );
}
elseif ( $crop === true && $resize === false ) :
$thumb->cropFromCenter( $width, $height );
else :
$thumb->resize( $width, $height );
endif;
// Watermarking (post resizing)
if ( isset( $watermark_options['mask'] ) && $watermark_options['mask'] && isset( $watermark_options['pre_resize'] ) && $watermark_options['pre_resize'] === false )
$thumb->createWatermark($watermark_options['mask'], $watermark_options['position'], $watermark_options['padding']);
$thumb->save( $new_filepath );
// Destroy the image
unset( $thumb );
do_action( 'end_operation', 'generateCacheFile' );
}
/**
* Is there an error
*
* @access public
* @return null
*/
public function errored() {
return ! empty( $this->error );
}
/**
* Return the finished image
*
* If there was an error, return the original
*
* @access public
* @return null
*/
public function returnImage() {
if ( $this->errored() ) {
$path = $this->getFilePath();
} else {
if ( ! $this->isRemote() ) {
if ( ( $dimensions = array_slice( (array) @getimagesize( $this->getFilePath() ), 0, 2 ) ) && $this->getArg( 'width' ) == $dimensions[0] && $this->getArg( 'height' ) == $dimensions[1] )
$path = $this->getFilePath();
else
$path = $this->getCacheFilePath();
} else {
$path = $this->getCacheFilePath();
}
}
if ( $this->args['return'] == 'path' )
return $path;
return $path ? $this->getFileURLForFilePath( $path ) : $path;
}
/**
* Get the url for the cache file
*
* @return string
*/
public function getCacheFileURL() {
return $this->getFileURLForFilePath( $this->getCacheFilePath() );
}
/**
* Get the url for the original file
*
* @access public
* @return null
*/
public function getFileURL() {
return $this->getFileURLForFilePath( $this->getFilePath() );
}
/**
* Convert a path into a url
*
* @param string $path
* @return string url
*/
private function getFileURLForFilePath( $path ) {
$upload_dir = self::uploadDir();
if ( strpos( $path, $upload_dir['basedir'] ) !== false ) {
return str_replace( $upload_dir['basedir'], $upload_dir['baseurl'], $path );
} else {
return str_replace( self::get_home_path(), trailingslashit( home_url() ), $path );
}
}
/**
* Check if an image is an animated gif
*
* @access private
* @return bool
*/
private function isAnimatedGif() {
$filename = $this->getFilePath();
$filecontents = file_get_contents( $filename );
$str_loc = $count = 0;
while ( $count < 2 ) {
$where1 = strpos( $filecontents, "\x00\x21\xF9\x04" , $str_loc );
if ( $where1 === false ) {
break;
} else {
$str_loc = $where1 + 1;
$where2 = strpos( $filecontents, "\x00\x2C", $str_loc );
if ( $where2 === false ) {
break;
} else {
if ( $where1 + 8 == $where2 )
$count++;
$str_loc=$where2+1;
}
}
}
if ( $count > 1 )
return true;
return false;
}
}
/**
* wpthumb_media_form_crop_position function.
*
* Adds a back end for selecting the crop position of images.
*
* @access public
* @param array $fields
* @param array $post
* @return $post
*/
function wpthumb_media_form_crop_position( $fields, $post ) {
if ( ! wp_attachment_is_image( $post->ID ) )
return $fields;
$current_position = get_post_meta( $post->ID, 'wpthumb_crop_pos', true );
if ( ! $current_position )
$current_position = 'center,center';
$html = '';
$html .= '';
$html .= '';
$html .= '';
$html .= '
';
$html .= '';
$html .= '';
$html .= '
';
$html .= '';
$html .= '';
$html .= '';
$html .= '
';
$fields['crop-from-position'] = array(
'label' => __( 'Crop Position', 'wpthumb' ),
'input' => 'html',
'html' => $html
);
return $fields;
}
add_filter( 'attachment_fields_to_edit', 'wpthumb_media_form_crop_position', 10, 2 );
/**
* wpthumb_media_form_crop_position_save function.
*
* Saves crop position in post meta.
*
* @access public
* @param array $post
* @param array $attachment
* @return $post
*/
function wpthumb_media_form_crop_position_save( $post, $attachment ){
if ( $attachment['wpthumb_crop_pos'] == 'center,center' )
delete_post_meta( $post['ID'], 'wpthumb_crop_pos' );
else
update_post_meta( $post['ID'], 'wpthumb_crop_pos', $attachment['wpthumb_crop_pos'] );
return $post;
}
add_filter( 'attachment_fields_to_save', 'wpthumb_media_form_crop_position_save', 10, 2);
/**
* Resizes a given image (local).
*
* @param mixed absolute path to the image
* @param int $width.
* @param int $height.
* @param bool $crop. (default: false)
* @return (string) url to the image
*/
function wpthumb( $url, $args = array() ) {
do_action( 'start_operation', 'wpthumb()' );
// Check if is using legacy args
if ( is_numeric( $args ) )
$legacy_args = array_combine( array_slice( array( 'width', 'height', 'crop', 'resize' ), 0, count( array_slice( func_get_args(), 1 ) ) ), array_slice( func_get_args(), 1, 4 ) );
if ( isset( $legacy_args ) && $legacy_args )
$args = $legacy_args;
$thumb = new WP_Thumb( $url, $args );
do_action( 'end_operation', 'wpthumb()' );
$return = $thumb->returnImage();
return $return;
}
/**
* Hook WP Thumb into the WordPress image functions
*
* Usage `the_post_thumbnail( 'width=100&height=200&crop=1' );`
*
* @param null $null
* @param int $id
* @param array $args
* @return null
*/
function wpthumb_post_image( $null, $id, $args ) {
if ( ( ! strpos( (string) $args, '=' ) ) && ! ( is_array( $args ) && isset( $args[0] ) && $args[0] == $args[1] ) ) {
global $_wp_additional_image_sizes;
// Convert keyword sizes to heights & widths. Will still use file wordpress saved unless you change the thumbnail dimensions.
// TODO Might be ok to delete as I think it has been duplicated. Needs testing.
if ( $args == 'thumbnail' )
$new_args = array( 'width' => get_option('thumbnail_size_w'), 'height' => get_option('thumbnail_size_h'), 'crop' => get_option('thumbnail_crop') );
elseif ( $args == 'medium' )
$new_args = array( 'width' => get_option('medium_size_w'), 'height' => get_option('medium_size_h') );
elseif ( $args == 'large' )
$new_args = array( 'width' => get_option('large_size_w'), 'height' => get_option('large_size_h') );
elseif( is_string( $args ) && isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) && array_key_exists( $args, $_wp_additional_image_sizes ) )
$new_args = array( 'width' => $_wp_additional_image_sizes[$args]['width'], 'height' => $_wp_additional_image_sizes[$args]['height'], 'crop' => $_wp_additional_image_sizes[$args]['crop'], 'image_size' => $args );
elseif ( is_string( $args ) && ( $args != ( $new_filter_args = apply_filters( 'wpthumb_create_args_from_size', $args ) ) ) )
$new_args = $new_filter_args;
elseif ( is_array( $args ) )
$new_args = $args;
else
$new_args = null;
if ( ! $new_args )
return $null;
$args = $new_args;
}
$args = wp_parse_args( $args );
if ( isset( $args[0] ) && $args[0] )
$args['width'] = $args[0];
elseif ( isset( $args['width'] ) )
$args['width'] = $args['width'];
else
$args['width'] = null;
if ( isset( $args[1] ) && $args[1] )
$args['height'] = $args[1];
elseif ( isset( $args['height'] ) )
$args['height'] = $args['height'];
else
$args['height'] = null;
$args['original_size'] = ( isset( $args['original_size'] ) && $args['original_size'] ) ? $args['original_size'] : 'thumbnail';
if ( empty( $args['crop_from_position'] ) )
$args['crop_from_position'] = get_post_meta( $id, 'wpthumb_crop_pos', true );
if ( empty( $path ) )
$path = get_attached_file( $id );
$path = apply_filters( 'wpthumb_post_image_path', $path, $id, $args );
$image = new WP_Thumb( $path, $args );
$args = $image->getArgs();
extract( $args );
if ( file_exists( $path ) ) {
$image_src = $image->returnImage();
$crop = (bool) ( empty( $crop ) ) ? false : $crop;
if ( ! $image->errored() && $image_meta = @getimagesize( $image->getCacheFilePath() ) ) :
$html_width = $image_meta[0];
$html_height = $image_meta[1];
else :
$html_width = $html_height = false;
endif;
} else {
$html_width = $width;
$html_height = $height;
$image_src = $image->getFileURL();
}
return array( $image_src, $html_width, $html_height, true );
}
add_filter( 'image_downsize', 'wpthumb_post_image', 99, 3 );
/**
* Returns all images attached to a given post
*
* @param object $post. (default: global $post)
* @param string $return. (default: 'file' [file, array])
* @return array
*/
function wpthumb_get_attached_images( $post_id = null, $return = 'file' ) {
if ( is_null( $post_id ) )
$post_id = get_the_id();
if ( is_object( $post ) && ! empty( $post->ID ) )
$post_id = $post->ID;
if ( ! is_numeric( $post_id ) )
return false;
$images = array();
foreach( (array) get_children( array( 'post_parent' => $post_id, 'post_type' => 'attachment', 'orderby' => 'menu_order', 'order' => 'ASC' ) ) as $attachment ) {
if ( ! wp_attachment_is_image( $attachment->ID ) || ! file_exists( get_attached_file( $attachment->ID ) ) )
continue;
if ( $return === 'file' )
$images[] = get_attached_file( $attachment->ID );
elseif ( $return === 'array' )
$images[] = $attachment;
}
return $images;
}
/**
* Checks if an image is smaller than the especified dimentions
*
* @param string $path
* @param int $width
* @param int $height
* @param bool $both. (default: true)
* @return void
*/
function wpthumb_is_image_smaller_than_dimensions( $path, $width, $height, $both = true ) {
if ( ! file_exists( $path ) )
return false;
$dimensions = @getimagesize( $path );
if ( $both == true && ( $dimensions[0] < $width || $dimensions[1] < $height ) )
return true;
return false;
}
/**
* Hook into wp_delete_file and delete the assocated cache files
*
* @param string $file
* @return string
*/
function wpthumb_delete_cache_for_file( $file ) {
$upload_dir = wp_upload_dir();
$wpthumb = new WP_Thumb( $upload_dir['basedir'] . $file );
wpthumb_rmdir_recursive( $wpthumb->getCacheFileDirectory() );
return $file;
}
add_filter( 'wp_delete_file', 'wpthumb_delete_cache_for_file' );
/**
* Removes a dir tree. I.e. recursive rmdir
*
* @param string $dir
* @return bool - success / failure
*/
function wpthumb_rmdir_recursive( $dir ) {
if ( ! is_dir( $dir ) )
return false;
$dir = trailingslashit( $dir );
$handle = opendir( $dir );
while ( false !== ( $file = readdir( $handle ) ) ) {
if ( $file == '.' || $file == '..' )
continue;
$path = $dir . $file;
if ( is_dir( $path ) )
wpthumb_rmdir_recursive( $path );
else
unlink( $path );
}
closedir( $handle );
rmdir( $dir );
}
/**
* wpthumb_errors function.
*
* @access public
* @return null
*/
function wpthumb_errors() {
$dir_upload = wp_upload_dir();
$dir_upload = $dir_upload['path'];
if ( file_exists( $dir_upload ) && !is_writable( $dir_upload ) )
echo '' . __( 'WPThumb has detected a problem.', 'wpthumb' ) . ' ' . sprintf( __( 'The directory %s is not writable.', 'wpthumb' ), $dir_upload ) . '
 ?>)
 ?>)
Auto Background Fill
| Original Image |
Non-Padded Adaptive Resize |
Padded Resize |
Arguments |
 ?>)
Memory Usage: MB
|
 ?>)
Memory Usage: MB
|
 ?>)
Memory Usage: MB
|
 ?>)
Memory Usage: MB
|
 ?>)
Memory Usage: MB
|
 ?>)
Memory Usage: MB
|
 ?>) |
 ?>) |
 ?>) |
 ?>) |
 ?>) |
 ?>) |
 ?>) |
 ?>) |
 ?>) |