Home API td_api_footer_template::update_key

td_api_footer_template::update_key

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

Usage:

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

Parameters:

$id (string) (required)

  • the footer template id – has to match with one of the footer templates 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
img string the footer template icon, it appears on Theme Panel -> Footer
file string the path of the footer template file
text string the name of the footer template style

$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 Footer Template 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, ex:

td_api_footer_template::update_key('td_footer_template_1', 'file', $this->plugin_path . '/parts/footer/td_footer_template_1.php');