get_sidebar

The timeline below displays how wordpress function get_sidebar has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 6.2

/**
 * Loads sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialized sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 * @since 5.5.0 A return value was added.
 * @since 5.5.0 The `$args` parameter was added.
 *
 * @param string $name The name of the specialized sidebar.
 * @param array  $args Optional. Additional arguments passed to the sidebar template.
 *                     Default empty array.
 * @return void|false Void on success, false if the template does not exist.
 */
function get_sidebar($name = null, $args = array())
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * @since 2.2.0
     * @since 2.8.0 The `$name` parameter was added.
     * @since 5.5.0 The `$args` parameter was added.
     *
     * @param string|null $name Name of the specific sidebar file to use. Null for the default sidebar.
     * @param array       $args Additional arguments passed to the sidebar template.
     */
    do_action('get_sidebar', $name, $args);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    if (!locate_template($templates, true, true, $args)) {
        return false;
    }
}

WordPress Version: 6.1

/**
 * Loads sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 * @since 5.5.0 A return value was added.
 * @since 5.5.0 The `$args` parameter was added.
 *
 * @param string $name The name of the specialised sidebar.
 * @param array  $args Optional. Additional arguments passed to the sidebar template.
 *                     Default empty array.
 * @return void|false Void on success, false if the template does not exist.
 */
function get_sidebar($name = null, $args = array())
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * @since 2.2.0
     * @since 2.8.0 The `$name` parameter was added.
     * @since 5.5.0 The `$args` parameter was added.
     *
     * @param string|null $name Name of the specific sidebar file to use. Null for the default sidebar.
     * @param array       $args Additional arguments passed to the sidebar template.
     */
    do_action('get_sidebar', $name, $args);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    if (!locate_template($templates, true, true, $args)) {
        return false;
    }
}

WordPress Version: 5.5

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 * @since 5.5.0 A return value was added.
 * @since 5.5.0 The `$args` parameter was added.
 *
 * @param string $name The name of the specialised sidebar.
 * @param array  $args Optional. Additional arguments passed to the sidebar template.
 *                     Default empty array.
 * @return void|false Void on success, false if the template does not exist.
 */
function get_sidebar($name = null, $args = array())
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * @since 2.2.0
     * @since 2.8.0 The `$name` parameter was added.
     * @since 5.5.0 The `$args` parameter was added.
     *
     * @param string|null $name Name of the specific sidebar file to use. Null for the default sidebar.
     * @param array       $args Additional arguments passed to the sidebar template.
     */
    do_action('get_sidebar', $name, $args);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    if (!locate_template($templates, true, true, $args)) {
        return false;
    }
}

WordPress Version: 4.9

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 *
 * @param string $name The name of the specialised sidebar.
 */
function get_sidebar($name = null)
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * @since 2.2.0
     * @since 2.8.0 $name parameter added.
     *
     * @param string|null $name Name of the specific sidebar file to use. null for the default sidebar.
     */
    do_action('get_sidebar', $name);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    locate_template($templates, true);
}

WordPress Version: 4.7

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 *
 * @param string $name The name of the specialised sidebar.
 */
function get_sidebar($name = null)
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * The hook allows a specific sidebar template file to be used in place of the
     * default sidebar template file. If your file is called sidebar-new.php,
     * you would specify the filename in the hook as get_sidebar( 'new' ).
     *
     * @since 2.2.0
     * @since 2.8.0 $name parameter added.
     *
     * @param string|null $name Name of the specific sidebar file to use. null for the default sidebar.
     */
    do_action('get_sidebar', $name);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    locate_template($templates, true);
}

WordPress Version: 4.5

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 *
 * @param string $name The name of the specialised sidebar.
 */
function get_sidebar($name = null)
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * The hook allows a specific sidebar template file to be used in place of the
     * default sidebar template file. If your file is called sidebar-new.php,
     * you would specify the filename in the hook as get_sidebar( 'new' ).
     *
     * @since 2.2.0
     * @since 2.8.0 $name parameter added.
     *
     * @param string $name Name of the specific sidebar file to use.
     */
    do_action('get_sidebar', $name);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    locate_template($templates, true);
}

WordPress Version: 4.1

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 *
 * @param string $name The name of the specialised sidebar.
 */
function get_sidebar($name = null)
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * The hook allows a specific sidebar template file to be used in place of the
     * default sidebar template file. If your file is called sidebar-new.php,
     * you would specify the filename in the hook as get_sidebar( 'new' ).
     *
     * @since 2.2.0
     * @since 2.8.0 $name parameter added.
     *
     * @param string $name Name of the specific sidebar file to use.
     */
    do_action('get_sidebar', $name);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    // Backward compat code will be removed in a future release
    if ('' == locate_template($templates, true)) {
        load_template(ABSPATH . WPINC . '/theme-compat/sidebar.php');
    }
}

WordPress Version: 3.9

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @since 1.5.0
 *
 * @uses locate_template()
 *
 * @param string $name The name of the specialised sidebar.
 */
function get_sidebar($name = null)
{
    /**
     * Fires before the sidebar template file is loaded.
     *
     * The hook allows a specific sidebar template file to be used in place of the
     * default sidebar template file. If your file is called sidebar-new.php,
     * you would specify the filename in the hook as get_sidebar( 'new' ).
     *
     * @since 2.2.0
     * @since 2.8.0 $name parameter added.
     *
     * @param string $name Name of the specific sidebar file to use.
     */
    do_action('get_sidebar', $name);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    // Backward compat code will be removed in a future release
    if ('' == locate_template($templates, true)) {
        load_template(ABSPATH . WPINC . '/theme-compat/sidebar.php');
    }
}

WordPress Version: 3.7

/**
 * Load sidebar template.
 *
 * Includes the sidebar template for a theme or if a name is specified then a
 * specialised sidebar will be included.
 *
 * For the parameter, if the file is called "sidebar-special.php" then specify
 * "special".
 *
 * @uses locate_template()
 * @since 1.5.0
 * @uses do_action() Calls 'get_sidebar' action.
 *
 * @param string $name The name of the specialised sidebar.
 */
function get_sidebar($name = null)
{
    do_action('get_sidebar', $name);
    $templates = array();
    $name = (string) $name;
    if ('' !== $name) {
        $templates[] = "sidebar-{$name}.php";
    }
    $templates[] = 'sidebar.php';
    // Backward compat code will be removed in a future release
    if ('' == locate_template($templates, true)) {
        load_template(ABSPATH . WPINC . '/theme-compat/sidebar.php');
    }
}