sc_unset_property
Prototype
$node->sc_unset_property(key)
Parameters
| Parameter | Type | M/O | Description |
|---|---|---|---|
key |
string |
M | The property to remove. |
M/O = Mandatory/Optional
Return Type
None
Description
sc_unset_property deletes the key property of the node, if it exists.
Note that a property can exist with a value of undef, which effectively
makes the property an existance boolean that is tested with
sc_has_property.
This means you can’t remove a property by setting it’s value to undef,
which means you need another way to remove the property. This API
does just that.
Example
$field->sc_set_property('example');
printf "example? %s", $field->sc_has_property('example') ? 'Yes' : 'No';
$field->sc_unset_property('example');
printf "example? %s", $field->sc_has_property('example') ? 'Yes' : 'No';
This would output:
example? Yes
example? No