Home API td_api_header_style::update_key

td_api_header_style::update_key

Available on: Newsmag V1.8+, Newspaper V5+
This api call is used to update only one of the parameters of an existing header style.

Usage:

<?php td_api_header_style::update_key( $id, $key, $value ) ?>

Parameters:

$id (string) (required)

  • the header style id – has to match with one of the header styles which are already registered in the theme

$key (string) (required)

  • parameter to be replaced, in the following table you can see all parameters but only one can be used because via this method you can update only one parameter:
Key name
Type
Description
text string the title of the header style, it appears in Theme Panel -> Header -> Header Style
file string the path of the template file

$value (mixed) (required)

  • the data which will replace the parameter existing one, it’s type depends on the selected parameter.

Examples:

In the following example we’ll update the existing Header Style 1 ,  the ‘file’ key data will be replaced, 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:

td_api_header_style::update_key('1', 'file', $this->plugin_path . '/parts/header/header-style-1.php');