protected $mime_type = null;
protected $default_mime_type = 'image/jpeg';
protected $quality = false;
- protected $default_quality = 90;
+ protected $default_quality = 82;
/**
* Each instance handles a single file.
+ *
+ * @param string $file Path to the file to load.
*/
public function __construct( $file ) {
$this->file = $file;
* Must be overridden in a sub-class.
*
* @since 3.5.0
+ *
+ * @static
* @access public
* @abstract
*
* @param array $args
- * @return boolean
+ * @return bool
*/
public static function test( $args = array() ) {
return false;
* Must be overridden in a sub-class.
*
* @since 3.5.0
+ *
+ * @static
* @access public
* @abstract
*
* @param string $mime_type
- * @return boolean
+ * @return bool
*/
public static function supports_mime_type( $mime_type ) {
return false;
* @access protected
* @abstract
*
- * @return boolean|WP_Error True if loaded; WP_Error on failure.
+ * @return bool|WP_Error True if loaded; WP_Error on failure.
*/
abstract public function load();
*
* @param int|null $max_w Image width.
* @param int|null $max_h Image height.
- * @param boolean $crop
- * @return boolean|WP_Error
+ * @param bool $crop
+ * @return bool|WP_Error
*/
abstract public function resize( $max_w, $max_h, $crop = false );
* @param int $src_h The height to crop.
* @param int $dst_w Optional. The destination width.
* @param int $dst_h Optional. The destination height.
- * @param boolean $src_abs Optional. If the source crop points are absolute.
- * @return boolean|WP_Error
+ * @param bool $src_abs Optional. If the source crop points are absolute.
+ * @return bool|WP_Error
*/
abstract public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false );
* @abstract
*
* @param float $angle
- * @return boolean|WP_Error
+ * @return bool|WP_Error
*/
abstract public function rotate( $angle );
* @access public
* @abstract
*
- * @param boolean $horz Flip along Horizontal Axis
- * @param boolean $vert Flip along Vertical Axis
- * @return boolean|WP_Error
+ * @param bool $horz Flip along Horizontal Axis
+ * @param bool $vert Flip along Vertical Axis
+ * @return bool|WP_Error
*/
abstract public function flip( $horz, $vert );
* @abstract
*
* @param string $mime_type
- * @return boolean|WP_Error
+ * @return bool|WP_Error
*/
abstract public function stream( $mime_type = null );
* @access public
*
* @param int $quality Compression Quality. Range: [1,100]
- * @return boolean|WP_Error True if set successfully; WP_Error on failure.
+ * @return true|WP_Error True if set successfully; WP_Error on failure.
*/
public function set_quality( $quality = null ) {
if ( null === $quality ) {
/**
- * Filter the default image compression quality setting.
+ * Filters the default image compression quality setting.
*
* Applies only during initial editor instantiation, or when set_quality() is run
* manually without the `$quality` argument.
if ( 'image/jpeg' == $this->mime_type ) {
/**
- * Filter the JPEG compression quality for backward-compatibility.
+ * Filters the JPEG compression quality for backward-compatibility.
*
* Applies only during initial editor instantiation, or when set_quality() is run
* manually without the `$quality` argument.
}
}
- // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
+ // Allow 0, but squash to 1 due to identical images in GD, and for backward compatibility.
if ( 0 === $quality ) {
$quality = 1;
}
// If not, choose a default instead.
if ( ! $this->supports_mime_type( $mime_type ) ) {
/**
- * Filter default mime type prior to getting the file extension.
+ * Filters default mime type prior to getting the file extension.
*
* @see wp_get_mime_types()
*
$info = pathinfo( $filename );
$dir = $info['dirname'];
- if( isset( $info['extension'] ) )
+ if ( isset( $info['extension'] ) )
$ext = $info['extension'];
$filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}";
* @param string|stream $filename
* @param callable $function
* @param array $arguments
- * @return boolean
+ * @return bool
*/
protected function make_image( $filename, $function, $arguments ) {
if ( $stream = wp_is_stream( $filename ) ) {
* as mapped from wp_get_mime_types()
*
* @since 3.5.0
+ *
+ * @static
* @access protected
*
* @param string $extension
- * @return string|boolean
+ * @return string|false
*/
protected static function get_mime_type( $extension = null ) {
if ( ! $extension )
$mime_types = wp_get_mime_types();
$extensions = array_keys( $mime_types );
- foreach( $extensions as $_extension ) {
+ foreach ( $extensions as $_extension ) {
if ( preg_match( "/{$extension}/i", $_extension ) ) {
return $mime_types[$_extension];
}
* as mapped from wp_get_mime_types()
*
* @since 3.5.0
+ *
+ * @static
* @access protected
*
* @param string $mime_type
- * @return string|boolean
+ * @return string|false
*/
protected static function get_extension( $mime_type = null ) {
$extensions = explode( '|', array_search( $mime_type, wp_get_mime_types() ) );