Overview

Packages

  • admin
  • classes
    • media
  • CodeIgniter
    • Libraries
  • core
  • functions
  • JSMin
  • None
  • OpenID
  • PHP
  • PHPMailer
  • plugins
    • admin
    • development
    • feed
    • mail
    • media
    • misc
    • seo
    • spam
    • uploader
    • users
    • zenpage
    • zenphoto
      • news
  • Services
    • JSON

Classes

  • zpMutex

Functions

  • accessAllAlbums
  • adminToolbox
  • albumNumber
  • build_query
  • build_url
  • checkAccess
  • checkForGuest
  • checkInstall
  • checkPageValidity
  • debugLog
  • exitZP
  • exposeZenPhotoInformations
  • filterImageQuery
  • get_filterScript
  • getAlbumArray
  • getAlbumBreadcrumb
  • getAlbumCustomData
  • getAlbumData
  • getAlbumDate
  • getAlbumDesc
  • getAlbumFolder
  • getAlbumInherited
  • getAlbumLocation
  • getAlbumPage
  • getAlbumThumb
  • getAlbumTitle
  • getAlbumURL
  • getAllAccessibleAlbums
  • getAllAlbums
  • getAllDates
  • getAllowedTags
  • getAnnotatedAlbumTitle
  • getAnnotatedImageTitle
  • getBareAlbumDesc
  • getBareAlbumTitle
  • getBareGalleryDesc
  • getBareGalleryTitle
  • getBareImageDesc
  • getBareImageTitle
  • getCodeblock
  • getCurrentPage
  • getCurrentTheme
  • getCustomAlbumThumb
  • getCustomAlbumThumbMaxSpace
  • getCustomImageURL
  • getCustomPageURL
  • getCustomSizedImageMaxSpace
  • getCustomSizedImageThumbMaxSpace
  • getDefaultHeight
  • getDefaultSizedImage
  • getDefaultWidth
  • getFullHeight
  • getFullImageURL
  • getFullWidth
  • getGalleryDesc
  • getGalleryIndexURL
  • getGalleryTitle
  • getHeadTitle
  • getImageArgs
  • getImageCacheFilename
  • getImageCachePostfix
  • getImageCity
  • getImageCountry
  • getImageCustomData
  • getImageData
  • getImageDate
  • getImageDesc
  • getImageLocation
  • getImageMetaData
  • getImageParameters
  • getImageProcessorURI
  • getImageState
  • getImageThumb
  • getImageTitle
  • getImageURI
  • getImageURL
  • getMainSiteName
  • getMainSiteURL
  • getMaxSpaceContainer
  • getNextAlbum
  • getNextAlbumURL
  • getNextImageThumb
  • getNextImageURL
  • getNextPageURL
  • getNumAlbums
  • getNumImages
  • getOption
  • getOptionList
  • getPageNavList
  • getPageNumURL
  • getPageRedirect
  • getParentAlbums
  • getParentBreadcrumb
  • getPasswordProtectImage
  • getPrevAlbum
  • getPrevAlbumURL
  • getPrevImageThumb
  • getPrevImageURL
  • getPrevPageURL
  • getProtectedImageURL
  • getRandomImages
  • getRandomImagesAlbum
  • getRequestURI
  • getSearchDate
  • getSearchURL
  • getSearchWords
  • getSiteHomeURL
  • getSizeCustomImage
  • getSizeDefaultImage
  • getSizeDefaultThumb
  • getSizedImageURL
  • getSizeFullImage
  • getSuffix
  • getTags
  • getTotalImagesIn
  • getTotalPages
  • getUnprotectedImageURL
  • getVersion
  • getWatermarkParam
  • getWatermarkPath
  • hasDynamicAlbumSuffix
  • hasNextImage
  • hasNextPage
  • hasPrevImage
  • hasPrevPage
  • imageNumber
  • imgSrcURI
  • installSignature
  • instrument
  • isAlbumPage
  • isArchive
  • isHandledAlbum
  • isImagePage
  • isLandscape
  • js_encode
  • loadLocalOptions
  • makeAlbumCurrent
  • makeImageCurrent
  • makeSpecialImageName
  • next_album
  • next_image
  • parse_query
  • parse_size
  • pathurlencode
  • print404status
  • printAlbumBreadcrumb
  • printAlbumCustomData
  • printAlbumData
  • printAlbumDate
  • printAlbumDesc
  • printAlbumLocation
  • printAlbumThumbImage
  • printAlbumTitle
  • printAlbumURL
  • printAllDates
  • printAllTagsAs
  • printAnnotatedAlbumTitle
  • printAnnotatedImageTitle
  • printBareAlbumDesc
  • printBareAlbumTitle
  • printBareGalleryDesc
  • printBareGalleryTitle
  • printBareImageDesc
  • printBareImageTitle
  • printCodeblock
  • printCustomAlbumThumbImage
  • printCustomAlbumThumbMaxSpace
  • printCustomPageURL
  • printCustomSizedImage
  • printCustomSizedImageMaxSpace
  • printCustomSizedImageThumbMaxSpace
  • printDefaultSizedImage
  • printGalleryDesc
  • printGalleryIndexURL
  • printGalleryTitle
  • printHeadTitle
  • printHomeLink
  • printImageCustomData
  • printImageData
  • printImageDate
  • printImageDesc
  • printImageMetadata
  • printImageThumb
  • printImageTitle
  • printImageURL
  • printNextPageURL
  • printPageList
  • printPageListWithNav
  • printPageNav
  • printParentBreadcrumb
  • printPasswordForm
  • printPrevPageURL
  • printRandomImages
  • printSearchBreadcrumb
  • printSearchForm
  • printSiteHomeURL
  • printSizedImageURL
  • printTags
  • printVersion
  • printZenJavascripts
  • printZenphotoLink
  • purgeOption
  • rewrite_get_album_image
  • rewrite_path
  • safe_glob
  • secureServer
  • setOption
  • setOptionDefault
  • setThemeColumns
  • stripSuffix
  • switchLog
  • themeSetup
  • zp_apply_filter
  • zp_filter_slot
  • zp_filter_unique_id
  • zp_has_filter
  • zp_register_filter
  • zp_remove_filter
  • zp_session_start
  • Overview
  • Package
  • Function
  • Tree
  • Deprecated

Function getCustomImageURL

Returns the url to the image with the dimensions you define with this function.

Package: functions
Located at template-functions.php
Parameters summary
integer $size the size of the image to have
integer $width = NULL width
integer $height = NULL height
integer $cropw = NULL crop width
integer $croph = NULL crop height
integer $cropx = NULL crop part x axis
integer $cropy = NULL crop part y axis
boolean $thumbStandin = false set true to inhibit watermarking
boolean $effects = NULL image effects (e.g. set gray to force to grayscale)
Return value summary
string

$size, $width, and $height are used in determining the final image size. At least one of these must be provided. If $size is provided, $width and $height are ignored. If both $width and $height are provided, the image will have those dimensions regardless of the original image height/width ratio. (Yes, this means that the image may be distorted!)

The $crop* parameters determine the portion of the original image that will be incorporated into the final image.

$cropw and $croph "sizes" are typically proportional. That is you can set them to values that reflect the ratio of width to height that you want for the final image. Typically you would set them to the final height and width. These values will always be adjusted so that they are not larger than the original image dimensions.

The $cropx and $cropy values represent the offset of the crop from the top left corner of the image. If these values are provided, the $croph and $cropw parameters are treated as absolute pixels not proportions of the image. If cropx and cropy are not provided, the crop will be "centered" in the image.

When $cropx and $cropy are not provided the crop is offset from the top left proportionally to the ratio of the final image size and the crop size.

Some typical croppings:

$size=200, $width=NULL, $height=NULL, $cropw=200, $croph=100, $cropx=NULL, $cropy=NULL produces an image cropped to a 2x1 ratio which will fit in a 200x200 pixel frame.

$size=NULL, $width=200, $height=NULL, $cropw=200, $croph=100, $cropx=100, $cropy=10 will will take a 200x100 pixel slice from (10,100) of the picture and create a 200x100 image

$size=NULL, $width=200, $height=100, $cropw=200, $croph=120, $cropx=NULL, $cropy=NULL will produce a (distorted) image 200x100 pixels from a 1x0.6 crop of the image.

$size=NULL, $width=200, $height=NULL, $cropw=180, $croph=120, $cropx=NULL, $cropy=NULL will produce an image that is 200x133 from a 1.5x1 crop that is 5% from the left and 15% from the top of the image.

Zenphoto doc API documentation generated by ApiGen