Home API td_api_smart_list::update

td_api_smart_list::update

Available on: Newsmag V1.8+, Newspaper V5+
This api call is used to update the parameters of an smart list style.

Usage:

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

Parameters:

$id (string) (required)

  • the smart list id – has to match with one of the smart lists which are already registered in the theme

$params_array (array) (required)

  • an array which contains the parameters of the smart list
Key name
Type
Description
file string the path for the smart list template file
text string the title, it appears on post editing -> Smart List section
img string the smart list icon, it appears on post editing -> Smart List section

Examples:

In the following example we’ll update Smart List 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_smart_list::update('td_smart_list_1',
    array(
        'file' => $this->plugin_path . '/includes/smart_lists/td_smart_list_1.php',
        'text' => 'Smart list 1',
        'img' => $this->plugin_url . '/images/panel/smart_lists/td_smart_list_1.png'
    )
);