# Management of Objects

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/

## IPS_GetChildrenIDs

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getchildrenids/

`array IPS_GetChildrenIDs(int $ObjectID)`

returns a list of all children objects

**Parameters**

- `$ObjectID` (int): ID of the object

**Returns** (array): An array of integer values ​that contains the IDs ​of all child objects

ID of the object

**Example**

```php
print_r(IPS_GetChildrenIDs(32102));

/* returns, e.g.,:
Array
(
    [0] => 11650
    [1] => 25578
    [2] => 30202
    etc. ...
)
*/
```

## IPS_GetLocation

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getlocation/

`string IPS_GetLocation(int $ObjectID)`

returns the complete path to an object

**Parameters**

- `$ObjectID` (int): ID of the object

**Returns** (string): Path/ name of the object within the object tree

ID of the object

**Example**

```php
echo IPS_GetLocation(47359);
//returns, e.g., "FHT8b\LowBattery"
```

## IPS_GetName

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getname/

`string IPS_GetName(int $ObjectID)`

returns the name of the object

**Parameters**

- `$ObjectID` (int): ID for which the name should be returned

**Returns** (string): Name of the object in the logical object tree

ID for which the name should be returned

**Example**

```php
echo IPS_GetName(47359);
// Returns e.g.: "My Table Lamp"

// Special case for unnamed events (since version 4.0)
echo IPS_GetName(48864 /*[TestScript\Unknown Object (ID: 48864)]*/);
// Returns e.g.: "When changing the variable, the variable "Test Folder\IRTrans USB/LAN/WLAN\Remote Control"
```

## IPS_GetObject

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getobject/

`array IPS_GetObject(int $ObjectID)`

returns extensive information about an object

**Parameters**

- `$ObjectID` (int): The ID of the object

**Returns** (array): The following information are available as key => value pairs:

| Index                                  | Type    | Description                                                                                                                                      |
| -------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| __ChildrenIDs__                        | array   | Object IDs of the children. See: [IPS_GetChildrenIDs](management-objects.md)                                                        |
| __HasChildren__                        | boolean | TRUE if the object has child objects. See: [IPS_HasChildren](management-objects.md)                                                 |
| __ObjectID__                           | integer | ID of the object                                                                                                                                 |
| __ObjectIcon__                         | string  | File name of the icon without extension. See: [IPS_SetIcon](management-objects.md)                                                  |
| __ObjectIdent__                        | string  | Identifier of the Object. See: [IPS_SetIdent](management-objects.md)                                                                |
| __ObjectInfo__                         | string  | Description that can be provided by the user. See: [IPS_SetInfo](management-objects.md)                                             |
| __ObjectIsDisabled__ (since 4.0)       | boolean | TRUE if the object is disabled. See [IPS_SetDisabled](management-objects.md)                                                        |
| __ObjectIsHidden__                     | boolean | TRUE if the object is hidden in the visualization. See [IPS_SetHidden](management-objects.md)                                       |
| __ObjectIsHiddenMaximize__ (since 9.1) | boolean | TRUE if the maximize button of the object should be hidden in the visualization. See [IPS_SetHiddenMaximize](management-objects.md) |
| __ObjectIsHiddenTitle__ (since 9.1)    | boolean | TRUE if the title of the object should be hidden in the visualization. See [IPS_SetHiddenTitle](management-objects.md)              |
| __ObjectIsReadOnly__                   | boolean | TRUE if the object is read-only. (Currently only used for state variables)                                                                       |
| __ObjectName__                         | string  | Name of the Object. See: [IPS_SetName](management-objects.md)                                                                       |
| __ObjectPosition__                     | integer | Position of the object in the visualization. This value may not be unique. See: [IPS_SetPosition](management-objects.md)            |
| __ObjectType__                         | integer | Type of the object (0: Category, 1: Instance, 2: Variable, 3: Script, 4: Event, 5: Media, 6: Link)                                               |
| __ObjectSummary__                      | string  | Short description of an object, which is generated by the module if needed                                                                       |
| __ParentID__                           | integer | Parent object. 0 = No parent object. See: [IPS_SetParent](management-objects.md)                                                    |

The ID of the object

**Example**

```php
print_r(IPS_GetObject(19668));

/* returns, e.g.,:
Array
(
    [ParentID] => 26691
    [ObjectID] => 43502
    [ObjectType] => 1
    [ObjectIdent] =>
    [ObjectName] => MX FESLIM (ID: 1)
    [ObjectInfo] => This is a device instance
    [ObjectIcon] => IPS
    [ObjectSummary] =>
    [ObjectPosition] => 1
    [ObjectIsReadOnly] =>
    [ObjectIsHidden] =>
    [ObjectIsHiddenTitle] =>
    [ObjectIsHiddenMaximize] =>
    [ObjectIsDisabled] =>
    [ObjectIsLocked] =>
    [HasChildren] => 1
    [ChildrenIDs] => Array
    (
        [0] => 43430
        [1] => 55892
        [2] => 36597
        [3] => 18993
        [4] => 34524
        [5] => 12269
        [6] => 44450
        [7] => 23394
        [8] => 11693
        [9] => 13654
    )
)
*/
```

## IPS_GetObjectIDByIdent

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getobjectidbyident/

`int IPS_GetObjectIDByIdent(string $ObjectIdent, int $ParentID)`

_Requires Symcon >= 2.5_

returns the ID of an object by its ident

**Parameters**

- `$ObjectIdent` (string): The searched object identificator
- `$ParentID` (int): ID of the object whose children object are searched

**Returns** (int): ID of the found object, otherwise __FALSE__

ID of the object whose children object are searched

**Example**

```php
// This function can be used to replace IPS_StatusVariableExists
// Example for IPS_StatusVariableExists($id, "StatusVariable");
echo !(@IPS_GetObjectIDByIdent("StatusVariable", $id) === false);

// In addition, the function can be used to replace IPS_GetStatusVariableID
// Example for IPS_GetStatusVariableID($id, "StatusVariable");
echo IPS_GetObjectIDByIdent("StatusVariable", $id);

$id = IPS_GetObjectIDByIdent($VariableIdent, $InstanceID);
$v = IPS_GetVariable($id);

// Array since 4.0
$sv = Array(
    "VariableID" => $id,
    "VariableIdent" => $VariableIdent,
    "VariableName" => "N/A",
    "VariablePosition" => 0,
    "VariableProfile" => $v['VariableProfile'],
    "VariableType" => $v['VariableType'],
    "VariableHasAction" => ($v['VariableAction'] > 0),
    "VariableUseAction" => ($v['VariableAction'] > 0)
);

// Array until 3.4
$sv = Array(
    "VariableID" => $id,
    "VariableIdent" => $VariableIdent,
    "VariableName" => "N/A",
    "VariablePosition" => 0,
    "VariableProfile" => $v['VariableProfile'],
    "VariableType" => $v['VariableValue']['ValueType'],
    "VariableHasAction" => ($v['VariableAction'] > 0),
    "VariableUseAction" => ($v['VariableAction'] > 0)
);
```

## IPS_GetObjectIDByName

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getobjectidbyname/

`int IPS_GetObjectIDByName(string $ObjectName, int $ParentID)`

returns the ID of an object by its name

**Parameters**

- `$ObjectName` (string): The searched object name
- `$ParentID` (int): ID of the object whose children object are searched

**Returns** (int): ID of the found object, otherwise __FALSE__

ID of the object whose children object are searched

**Example**

```php
$ObjectID = @IPS_GetObjectIDByName("Rain sensing", $ParentID);
if ($ObjectID === false)
    echo "Object not found!";
else
    echo "The Object ID is: ". $ObjectID;
```

## IPS_GetObjectList

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getobjectlist/

`array IPS_GetObjectList()`

returns a list of all existing objects

**Returns** (array): An Array of integer that contains the IDs of all objects within IP Symcon

This function determines the IDs of all objects registered within IP Symcon. The IDs are listed in an array.

**Example**

```php
print_r(IPS_GetObjectList());

/* returns, e.g.,:
Array
(
    [0] => 0
    [1] => 10573
    [2] => 11363
    [3] => 11650
    [4] => 14114
    etc. ...
)
*/
```

## IPS_GetParent

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-getparent/

`int IPS_GetParent(int $ObjectID)`

returns the ID of the parent of the object

**Parameters**

- `$ObjectID` (int): The ID of the object

**Returns** (int): The ID of the parent of the object

The ID of the object

**Example**

```php
echo IPS_GetParent(47359);
//returns, e.g.,: 0 for the main category
```

## IPS_HasChildren

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-haschildren/

`bool IPS_HasChildren(int $ObjectID)`

checks if an object has child objects

**Parameters**

- `$ObjectID` (int): The ID of the object

**Returns** (bool): __TRUE__ if the object has child objects, otherwise __FALSE__

The ID of the object

**Example**

```php
if (IPS_IsHasChildren(0))
    echo "The root object has child objects!";
```

## IPS_IsChild

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-ischild/

`bool IPS_IsChild(int $ObjectID, int $ParentID, bool $Recursive)`

checks if an object is a child of a parent object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$ParentID` (int): The ID of the potential parent object
- `$Recursive` (bool): FALSE if only a direct parent-child relationship should be checked; TRUE if a relationship over multiple levels should also be checked

**Returns** (bool): __TRUE__ if the object is a child of the object with the ID ParentID, otherwise __FALSE__

FALSE if only a direct parent-child relationship should be checked; TRUE if a relationship over multiple levels should also be checked

**Example**

```php
if (IPS_IsChild(0, 12345, true))
    echo "The object 12345 is a descendent of the root object!";
```

## IPS_ObjectExists

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-objectexists/

`bool IPS_ObjectExists(int $ObjectID)`

checks if a specific object exists

**Parameters**

- `$ObjectID` (int): The ID of the object

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

The ID of the object

**Example**

```php
if (IPS_ObjectExists(34881))
    echo "An object with that ID exists!";
```

## IPS_SetDisabled

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-setdisabled/

`bool IPS_SetDisabled(int $ObjectID, bool $Disabled)`

_Requires Symcon >= 4.0_

set an object as disabled for the visualizations

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Disabled` (bool): TRUE if the object should be disabled; FALSE if it should be enabled

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

TRUE if the object should be disabled; FALSE if it should be enabled

**Example**

```php
IPS_SetDisabled(47381, true); // The object becomes disabled
```

## IPS_SetHidden

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-sethidden/

`bool IPS_SetHidden(int $ObjectID, string $Hidden)`

_Requires Symcon >= 2.1_

set the visibility for an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Hidden` (string): TRUE if invisible

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

TRUE if invisible

**Example**

```php
IPS_SetHidden(47381, true); //hide object
```

## IPS_SetHiddenMaximize

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-sethiddenmaximize/

`bool IPS_SetHiddenMaximize(int $ObjectID, bool $Hidden)`

_Requires Symcon >= 9.1_

sets the visibility of the maximize button of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Hidden` (bool): TRUE if maximize button is invisible

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

TRUE if maximize button is invisible

**Example**

```php
IPS_SetHiddenMaximize(47381, true); //hide maximize button
```

## IPS_SetHiddenTitle

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-sethiddentitle/

`bool IPS_SetHiddenTitle(int $ObjectID, bool $Hidden)`

_Requires Symcon >= 9.1_

sets the visibility of the title of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Hidden` (bool): TRUE if title is invisible

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

TRUE if title is invisible

**Example**

```php
IPS_SetHiddenTitle(47381, true); //hide title
```

## IPS_SetIcon

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-seticon/

`bool IPS_SetIcon(int $ObjectID, string $Icon)`

_Requires Symcon >= 2.1_

set the icon of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Icon` (string): Filename of the icon without path and extension

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Filename of the icon without path and extension

**Example**

```php
IPS_SetIcon(47381, "weather");
```

## IPS_SetIdent

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-setident/

`bool IPS_SetIdent(int $ObjectID, string $Ident)`

_Requires Symcon >= 2.5_

set the ident of an object

**Parameters**

- `$ObjectID` (int): ID of the object to be changed
- `$Ident` (string): New identifier for the object

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

New identifier for the object

**Example**

```php
IPS_SetIdent(47381, "TEMPERATURE");
```

## IPS_SetInfo

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-setinfo/

`bool IPS_SetInfo(int $ObjectID, string $Info)`

set extended information of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Info` (string): New description text for the object

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

New description text for the object

**Example**

```php
IPS_SetInfo(47381, "USB sound card - Port A, basement - Green cable");
```

## IPS_SetName

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-setname/

`bool IPS_SetName(int $ObjectID, string $Name)`

set the name of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Name` (string): New name for the object

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

New name for the object

**Example**

```php
IPS_SetName(47381, "Safety precautions");
```

## IPS_SetParent

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-setparent/

`bool IPS_SetParent(int $ObjectID, int $ParentID)`

set the parent of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$ParentID` (int): ID of the new parent object

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

ID of the new parent object

**Example**

```php
IPS_SetParent(47381, 15361);
```

## IPS_SetPosition

Source: https://www.symcon.de/en/service/documentation/command-reference/management-objects/ips-setposition/

`bool IPS_SetPosition(int $ObjectID, int $Position)`

_Requires Symcon >= 2.1_

set the position of an object

**Parameters**

- `$ObjectID` (int): The ID of the object
- `$Position` (int): Position value

**Returns** (bool): If the command succeeds, it returns __TRUE__, otherwise __FALSE__.

Position value

**Example**

```php
IPS_SetPosition(47381, 5);
```