Function __global->find_theme_image_themewizard_preview

Definitions

sources/themewizard.php

  • Called by find_theme_image to allow on-the-fly previewing of what Theme Wizard output would look like.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id ID_TEXT No No required parameter N/A N/A The theme image ID
$silent_fail boolean No No False N/A N/A Whether to silently fail (i.e. not give out an error message when a theme image cannot be found)

Returns

  • URL to image (null: use standard one, this one is not Theme Wizard influenced)
  • Type: ?URLPATH
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Called by find_theme_image to allow on-the-fly previewing of what Theme Wizard output would look like.
 *
 * @param  ID_TEXT $id The theme image ID
 * @param  boolean $silent_fail Whether to silently fail (i.e. not give out an error message when a theme image cannot be found)
 * @return ?URLPATH URL to image (null: use standard one, this one is not Theme Wizard influenced)
 */
function find_theme_image_themewizard_preview(string $id, bool $silent_fail = false) : ?string