Skip to end of banner
Go to start of banner

admAddCustomFieldAlias

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Availability

This routine is available since katl-commons 2.5.19 / 2.6.11.

Syntax:

admAddCustomFieldAlias(customField, alias)

Description:

Adds a custom field alias in the sil.aliases file.

Parameters:

Parameter name

Type

Required

Description

customFieldstringyesThe custom field string id, name or existing alias
aliasstringyesThe new custom field alias to set

Return type:

boolean

True if the custom field alias was added successfully in the sil.aliases file or already exists, false otherwise.

Example:

Example 1:

Setting a custom field alias using custom field id:

admAddCustomFieldAlias("customfield_10000", "TestAlias");

Example 2:

Setting a custom field alias using custom field name:

admAddCustomFieldAlias("Text Field", "TestAlias");

See Also:

  • No labels