Jump to Content

Objective HTML

Photo Frame

Fieldtype Settings

Photo Frame fieldtype has a lot of various settings. This will outline the various settings to give a clear understanding of what they actually do and how they are used.

File Upload Group

You must select upload group. This is the only required setting. If you wish to add to this list, use the native file upload manager and create a new upload group.

Delete Files

By default, Photo Frame will not delete any photos when entries or photos are deleted in the control panel. However, if you want the raw files to be deleted along with database records, set this option to True. Do not use this option if you intend to use the native file browser or Assets, as the photos will get deleted and will break existing records.

Image Compression (JPEG Only)

Photo Frame has the ability to compress images at the time they are uploaded. Currently, image compression is JPEG only. If you want to compress JPEG photos, enter a value of 1 ‐ 100 with 100 being the best quality (no compression).

Resize Uploaded Photo (Max Width)

This setting allows you to resize photos to a maximum width at the time they are uploaded before the user ever sees it. This is great for images that exceed the users browsers window (viewport) and you want to resize them so they can be properly cropped. Photos will only be cropped if the width exceeds the value that is defined.

Resize Uploaded Photo (Max Height)

This setting allows you to resize photos to a maximum height at the time they are uploaded before the user ever sees it. This is great for images that exceed the users browsers window (viewport) and you want to resize them so they can be properly cropped. Photos will only be cropped if the height exceeds the value that is defined.

Resize Cropped Photo Sizes

This setting allows you to resize the cropped photos to various sizes. These sizes of course are accessible in the template as needed. If a height or width isn't defined, the photo will be scaled down to the defined size. So if you define a height and width of 100, it will create a square. If you define a width of 100 and don't define a height, the image will be scaled down to a width of a 100 while maintaining the ratio.

Filename Format

This setting is required if you intent on resizing cropped photos. Creating solid filenames is important, and this field allows you to create filenames any way you desire. You can simply define variables the same way as EE variables. The following variables are available:


{entry_id}
{field_id}
{channel_id}
{col_id}
{row_id}
{order}
{file_name}
{original_file_name}
{height}
{width}
{random_alpha}
{random_alnum}
{random_numeric}
{random_string}
{random_nozero}
{random_unique}
{random_sha1}


Minimum Number of Photos

This is the minimum number of photos one is allowed to upload in the field. If there is a minimum number of photos set then the field will always be required.

Maximum Number of Photos

This is the maximum number of photos one is allowed to upload in the field.

Photo Min Width

This is the minimum width of the photos allowed to be uploaded.

Photo Min Height

This is the minimum height of the photos allowed to be uploaded.

Photo Max Width

This is the maximum width of the photos allowed to be uploaded.

Photo Max Height

This is the maximum height of the photos allowed to be uploaded.

Maximum File Size (MB)

This is the maximum file size of the photos allowed to be uploaded.

Photo Aspect Ratio

This is the aspect ratio that is forced on all images that are cropped. Example: W:H | 16:9

Default Crop Location

If you want to make the crop window appear automatically at specific coordinates, define them as a comma delimeted string. Example: x,y,x2,y2 | 0,200,200,400

Default Crop Size

This setting is similar to the Default Crop Location but instead of coordinates defined, you will define a crop size that is automatically centered in the photo each time the crop is initiated. Define a width and height. Example: WxH | 400x300


Control Panel Theme

Select the desired theme you wish to use to output your photos in the field. Photo Frame is themable so you can customize the appearance. Any installed theme will appear in this list.

Enable Assets Browsing?

If you want to use Pixel & Tonic Assets, you must enable this setting. If this setting is not set to True, then the native file browser will be used.

Photo of Assets

Show File Upload Button?

Photo of Browse Button

If this setting is set to True, there will be a file upload button appear. By setting this to False, file uploads would only be possible throught file browser or using Assets.

Show File Browser Button?

Photo of Browse Button

If this setting is set to True, there will be a file browser button appear. If the native file manager is used, the file browser button will not appear in Safecracker due to limitations imposed by ExpressionEngine®.

Force Users to Crop Photos?

If this setting is set to True, you will force the user to crop the photo according to the field settings. Otherwise, the photo is just uploaded and user must edit it to crop it.

Disable Photo?

If this setting is set to True, you prevent the user from cropping the photos entirely. The edit button will be removed, and when photos are uploaded they will be added directly to the field skipping the cropping process entirely.

Enable Drag/Drop Uploads?

If this setting is set to True, you will be able to upload one or more photos using drag and drop. Simply drag the photos from your OS into the Photo Frame field in your browser. If this setting is set to False then photos must be uploaded using the button, file browser, or Assets.

Photo of Drag/Drop

Enable Photo Sorting

If this setting is set to True, photos will be able to be re-ordered using drag and drop. If this setting is set to False then the photo order will not be able to be changed.

Photo of Sorting

Display Meta on Save

You may assign a title and a description to the photo. The meta data can displayed each time a cropped photo is saved.

Photo of Browse Button

Display Info Panel

Photo of Info Panel

If this setting is set to True, then an information panel is visible in while the photo is being cropped.

Upload Button Text

Photo of Upload Text

This setting allows you to change the upload button text to whatever you want. If you don't enter anything it will use the default.

Browse Button Text

Photo of Upload Text

This setting allows you to change the browse button text to whatever you want. If you don't enter anything it will use the default.

Instructions

The photo upload instructions will appear before the user has cropped a photo. Once they start to crop the photo, the instructions will disappear. You may override the default value with anything you desire.

Photo of Instructions

Upload Helper

The photo helper will give users some additional information before they upload. This is great for displaying the required photo sizes and/or dimensions.

Photo of Upload Text