get_footer( string $name = null, array $args = array() )
Loads footer template.
Description
Includes the footer template for a theme or if a name is specified then a specialized footer will be included.
For the parameter, if the file is called "footer-special.php" then specify "special".
Parameters
- $name
-
(Optional) The name of the specialized footer.
Default value: null
- $args
-
(Optional) Additional arguments passed to the footer template.<br>
Default value: array()
Return
(void|false) Void on success, false if the template does not exist.
Source
File: wp-includes/general-template.php
function get_footer( $name = null ) {
/**
* Fires before the footer template file is loaded.
*
* @since WP-2.1.0
* @since WP-2.8.0 $name parameter added.
*
* @param string|null $name Name of the specific footer file to use. null for the default footer.
*/
do_action( 'get_footer', $name );
$templates = array();
$name = (string) $name;
if ( '' !== $name ) {
$templates[] = "footer-{$name}.php";
}
$templates[] = 'footer.php';
locate_template( $templates, true );
}
Changelog
Version | Description |
---|---|
5.5.0 | The $args parameter was added. |
1.5.0 | Introduced. |