User Tools

Site Tools


uphp:functions:include

include

WMPRO, WMMINI FW >= 1.0 WMMEGA FW >= 2.0

Include a file within the current script at the current location

Description

include ( string $filename )

This function includes and evaluates the specified file. When a file is included, the code it contains inherits the variable scope of the line on which the include occurs. Any variables available at that line in the calling file will be available within the called file, from that point forward. If the include occurs inside a function within the calling file, then all of the code contained in the called file will behave as though it had been defined inside that function. So, it will follow the variable scope of that function.

Parameter

$filename: String containing the path and filename of the script to include and evaluate

Return Values

None

Notes

This function is very useful for including frequently repeated code in multiple scripts. It is also useful for including different code depending upon configuration or provided files (varying “modules” or “packages”).

The code contained in the included file is compiled into the script the first time the script is run. If changes are made to the contents of an included file without modifying the script that contains include then recompilation must be forced (by deleting the .cgc file). See The uPHP Compiler for more information (forced recompilation is discussed there in section Notes).

The included file is interpreted as HTML unless it contains the opening and closing uPHP Tags <? and ?>. See uPHP Language Basics for more information.

Also See

call_user_func() - Call a user defined function with optional parameters

exec() - Run a script with an optional delay

function_exists() - Check if a function exists (native or custom)

function - Define a function

uphp/functions/include.txt · Last modified: 2021/09/13 05:57 (external edit)