Function __global->syndicate_described_activity
Definitions
sources/syndication.php
- Syndicate human-intended descriptions of activities performed to the internal feed, and external listeners.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $language_string_code | string | No | No | Blank (empty string) | N/A | N/A | Language string codename |
| $label_1 | string | No | No | Blank (empty string) | N/A | N/A | Label 1 (given as a parameter to the language string codename) |
| $label_2 | string | No | No | Blank (empty string) | N/A | N/A | Label 2 (given as a parameter to the language string codename) |
| $label_3 | string | No | No | Blank (empty string) | N/A | N/A | Label 3 (given as a parameter to the language string codename) |
| $page_link_1 | string | No | No | Blank (empty string) | N/A | N/A | Page-link 1 |
| $page_link_2 | string | No | No | Blank (empty string) | N/A | N/A | Page-link 2 |
| $page_link_3 | string | No | No | Blank (empty string) | N/A | N/A | Page-link 3 |
| $addon | string | No | No | Blank (empty string) | N/A | N/A | Addon that caused the event |
| $is_public | BINARY | No | No | 1 | N/A | N/A | Whether this post should be public or friends-only |
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | Member being written for (null: current member) |
| $sitewide_too | boolean | No | No | False | N/A | N/A | Whether to push this out as a site event if user requested |
| $also_involving | ?MEMBER | No | No | Null | N/A | N/A | Member also 'intimately' involved, such as a content submitter who is a friend (null: none) |
| $syndication_context | ?array | No | No | Null | N/A | N/A | A serialisable representation of data set via get_syndication_option_fields (null: read from environment) |
Preview
Code (PHP)
/**
* Syndicate human-intended descriptions of activities performed to the internal feed, and external listeners.
*
* @param string $language_string_code Language string codename
* @param string $label_1 Label 1 (given as a parameter to the language string codename)
* @param string $label_2 Label 2 (given as a parameter to the language string codename)
* @param string $label_3 Label 3 (given as a parameter to the language string codename)
* @param string $page_link_1 Page-link 1
* @param string $page_link_2 Page-link 2
* @param string $page_link_3 Page-link 3
* @param string $addon Addon that caused the event
* @param BINARY $is_public Whether this post should be public or friends-only
* @param ?MEMBER $member_id Member being written for (null: current member)
* @param boolean $sitewide_too Whether to push this out as a site event if user requested
* @param ?MEMBER $also_involving Member also 'intimately' involved, such as a content submitter who is a friend (null: none)
* @param ?array $syndication_context A serialisable representation of data set via get_syndication_option_fields (null: read from environment)
*/
function syndicate_described_activity(string $language_string_code = '', string $label_1 = '', string $label_2 = '', string $label_3 = '', string $page_link_1 = '', string $page_link_2 = '', string $page_link_3 = '', string $addon = '', int $is_public = 1, ?int $member_id = null, bool $sitewide_too = false, ?int $also_involving = null, ?array $syndication_context = null)
* Syndicate human-intended descriptions of activities performed to the internal feed, and external listeners.
*
* @param string $language_string_code Language string codename
* @param string $label_1 Label 1 (given as a parameter to the language string codename)
* @param string $label_2 Label 2 (given as a parameter to the language string codename)
* @param string $label_3 Label 3 (given as a parameter to the language string codename)
* @param string $page_link_1 Page-link 1
* @param string $page_link_2 Page-link 2
* @param string $page_link_3 Page-link 3
* @param string $addon Addon that caused the event
* @param BINARY $is_public Whether this post should be public or friends-only
* @param ?MEMBER $member_id Member being written for (null: current member)
* @param boolean $sitewide_too Whether to push this out as a site event if user requested
* @param ?MEMBER $also_involving Member also 'intimately' involved, such as a content submitter who is a friend (null: none)
* @param ?array $syndication_context A serialisable representation of data set via get_syndication_option_fields (null: read from environment)
*/
function syndicate_described_activity(string $language_string_code = '', string $label_1 = '', string $label_2 = '', string $label_3 = '', string $page_link_1 = '', string $page_link_2 = '', string $page_link_3 = '', string $addon = '', int $is_public = 1, ?int $member_id = null, bool $sitewide_too = false, ?int $also_involving = null, ?array $syndication_context = null)
