mirror of
https://codeberg.org/streams/streams.git
synced 2024-09-20 07:35:14 +00:00
some necessary doco for set_iconfig()
This commit is contained in:
parent
912ebfebff
commit
c107bcfbd9
1 changed files with 16 additions and 0 deletions
|
@ -5504,6 +5504,22 @@ function get_iconfig(&$item, $family, $key) {
|
|||
|
||||
}
|
||||
|
||||
/**
|
||||
* set_iconfig(&$item, $family, $key, $value, $sharing = false);
|
||||
*
|
||||
* $item - item array or item id. If passed an array the iconfig meta information is
|
||||
* added to the item structure (which will need to be saved with item_store eventually).
|
||||
* If passed an id, the DB is updated, but may not be federated and/or cloned.
|
||||
* $family - namespace of meta variable
|
||||
* $key - key of meta variable
|
||||
* $value - value of meta variable
|
||||
* $sharing - boolean (default false); if true the meta information is propagated with the item
|
||||
* to other sites/channels, mostly useful when $item is an array and has not yet been stored/delivered.
|
||||
* If the meta information is added after delivery and you wish it to be shared, it may be necessary to
|
||||
* alter the item edited timestamp and invoke the delivery process on the updated item. The edited
|
||||
* timestamp needs to be altered in order to trigger an item_store_update() at the receiving end.
|
||||
*/
|
||||
|
||||
|
||||
function set_iconfig(&$item, $family, $key, $value, $sharing = false) {
|
||||
|
||||
|
|
Loading…
Reference in a new issue