MasterPress

Menu

WOOF :: theme_image( String $path, String $base_dir = "images", Boolean $parent = "auto" )

Returns:

  • WOOF_Image An object representing the image, whether the file exists or not. (Check existence by calling "exists" on the image file object).

Retrieves a WOOF_Image object representing an image file at the path given, relative to the directory of the active theme appended to a default base directory of “images” inside your theme. This method is also child-theme aware, in that it is configured by default to first look for the image file in an active child-theme, and if not found there will then look in the parent theme. See the $parent argument for more details.

This can be really useful for displaying images stored inside your theme folder, opening up the rich image processing API of the WOOF_Image object to those images. 

Example:

Parameters:

  • String $path

    The path of the file relative to the directory of the active theme, plus the base directory in the second argument.

  • String $base_dir = "images"

    The base directory of the image file inside the active directory. This defaults to “images” to reflect a common folder name for images in your theme.

  • Boolean $parent = "auto"

    Specifies where to look for the file, in the case of the current theme being a child-theme. If the active theme is not a child theme, this argument is essentially ignored. The following values are supported:

    • “auto” – Will look for the file first in the child theme folder and if not found will then check the folder of the parent theme.
    • false – Will only check for the file in the child theme. This will always return a URL as if the file exists, even if it does not.
    • true – Will only check for the file in the parent theme. This will always return a URL as if the file exists, even if it does not.

Related Methods:

WOOF::parent_theme_image, WOOF::parent_theme_img, WOOF::theme_file, WOOF::theme_img

Latest From the Blog

MasterPress 1.3.8 is now available

16th December 2022

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.

Plugin Requirements

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.

Three AM