How can I add a custom header to a custom template in a plugin without using the theme folders

Question

How can I add a custom header to a custom template in a plugin without using the theme folders

Jbingy

2022年4月9日 08:05

There is a lot of documentation on how to create custom headers for a theme. For example, if I wanted to add a header named:

header-custom.php

I would add this to my template file:

get_header('custom');

If custom-header.php was in either the same directory as the page template or the 'root' theme directory, the header will load as expected.

I can't find anything for custom headers for page templates in a plugin. For example, I have a template file single-node.php located in my includes folder. How could I add something like:

get_header('custom');

and store that in my includes directory or somewhere else in my plugin?

Topic custom-header templates plugin-development plugins Wordpress

Category Web

Awais · Accepted Answer · 2020年10月16日 00:28

The get_header() functions is designed for themes. It usually look for header file in child theme first and then parent theme. You should be creating custom header under theme directory instead of in a plugin.

But if you really must have to load header file from plugin then you have to create a custom function.

Here is how you can do it.

Create a file header-custom.php in your plugin:

<?php
/**
 * PLUGIN_DIR/includes/header-custom.php
 * Header file in plugin
 */

?><!DOCTYPE html>

<html class="no-js" <?php language_attributes(); ?>>

    <head>

        <meta charset="<?php bloginfo( 'charset' ); ?>">
        <meta name="viewport" content="width=device-width, initial-scale=1.0" >

        <link rel="profile" href="https://gmpg.org/xfn/11">

        <?php wp_head(); ?>

    </head>

    <body <?php body_class(); ?>>
?>

Create custom function _get_header() which will first look for file in your plugin and then child theme and then parent theme. Change the values in below function according to your need. e.g. Plugin path

function _get_header($name, $args = array()) {

    $require_once = true;
    $templates = array();

    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "header-{$name}.php";
    } else {
        return false;
    }

    $templates[] = 'header.php';

    $located = '';
    foreach ($templates as $template_name) {

        if (!$template_name) {
            continue;
        }

        if (file_exists(WP_PLUGIN_DIR . '/PLUGIN_DIR/includes/' . $template_name)) {

            $located = WP_PLUGIN_DIR . '/PLUGIN_DIR/includes/' . $template_name;
            break;
        } elseif (file_exists(STYLESHEETPATH . '/' . $template_name)) {
            $located = STYLESHEETPATH . '/' . $template_name;
            break;
        } elseif (file_exists(TEMPLATEPATH . '/' . $template_name)) {
            $located = TEMPLATEPATH . '/' . $template_name;
            break;
        } elseif (file_exists(ABSPATH . WPINC . '/theme-compat/' . $template_name)) {
            $located = ABSPATH . WPINC . '/theme-compat/' . $template_name;
            break;
        }
    }

    if ('' !== $located) {
        load_template($located, $require_once, $args);
    }

    return $located;
}

And then in your regular theme file you can add _get_header() function like this:

// Check if plugin is active then load file from plugin
if(in_array('PLUGIN_DIR/PLUGIN.php', apply_filters('active_plugins', get_option('active_plugins')))){ 
    _get_header('custom'); //loads header-custom.php from plugin 

} else {
    get_header();
}

How can I add a custom header to a custom template in a plugin without using the theme folders

About