Home API td_api_top_bar_template::update

td_api_top_bar_template::update

Available on: Newsmag V1.8+, Newspaper V5+
This API call is used to update the parameters of an existing top bar template.

Usage:

<?php td_api_top_bar_template::update( $id, $params_array ) ?>

Parameters:

$id (string) (required)

  • the top bar template id – has to match with one of the top bar templates which are already registered in the theme

$params_array (array) (required)

  • an array which contains the parameters of the top bar template
Key name
Type
Description
img string the top bar template icon, appears in Theme Panel -> Header section
file string the path of the top bar template file

Examples:

In the following example we’ll update Top Bar Template 1 , you can see how the code looks on plugin, you have to modify the file path to match with the plugin current folder, we use the variables which were introduced in the Plugin Method section, ex:

td_api_top_bar_template::update('td_top_bar_template_1',
    array(
        'img' => $this->plugin_url . '/images/panel/top_bar_templates/icon-top-bar-1.png.png',
        'file' => $this->plugin_path . '/parts/header/td_top_bar_template_1.php'
    )
);