ocf_make_boiler_custom_field (line 301)
Make a custom profile field from one of the predefined templates (this is often used by importers).
AUTO_LINK
ocf_make_boiler_custom_field
(ID_TEXT $type)
-
ID_TEXT
$type: The identifier of the boiler custom profile field.
ocf_make_custom_field (line 348)
Make a custom profile field.
AUTO_LINK
ocf_make_custom_field
(SHORT_TEXT $name, [BINARY $locked = 0], [SHORT_TEXT $description = ''], [LONG_TEXT $default = ''], [BINARY $public_view = 0], [BINARY $owner_view = 0], [BINARY $owner_set = 0], [BINARY $encrypted = 0], [ID_TEXT $type = 'long_text'], [BINARY $required = 0], [BINARY $show_in_posts = 0], [BINARY $show_in_post_previews = 0], [?integer $order = NULL], [LONG_TEXT $only_group = ''], [boolean $no_name_dupe = false], [BINARY $show_on_join_form = 0])
-
SHORT_TEXT
$name: Name of the field.
-
BINARY
$locked: Whether the field is locked (i.e. cannot be deleted from the system).
-
SHORT_TEXT
$description: Description of the field.
-
LONG_TEXT
$default: The default value for the field.
-
BINARY
$public_view: Whether the field is publically viewable.
-
BINARY
$owner_view: Whether the field is viewable by the owner.
-
BINARY
$owner_set: Whether the field may be set by the owner.
-
BINARY
$encrypted: Whether the field is encrypted.
-
ID_TEXT
$type: The type of the field.
-
BINARY
$required: Whether it is required that every member have this field filled in.
-
BINARY
$show_in_posts: Whether this field is shown in posts and places where member details are highlighted (such as an image in a member gallery).
-
BINARY
$show_in_post_previews: Whether this field is shown in preview places, such as in the teaser for a member gallery.
-
?integer
$order: The order of this field relative to other fields (NULL: next).
-
LONG_TEXT
$only_group: The usergroups that this field is confined to (comma-separated list).
-
boolean
$no_name_dupe: Whether to check that no field has this name already.
-
BINARY
$show_on_join_form: Whether the field is to be shown on the join form
ocf_make_member (line 64)
Add a member.
AUTO_LINK
ocf_make_member
(SHORT_TEXT $username, SHORT_TEXT $password, SHORT_TEXT $email_address, ?array $groups, ?integer $dob_day, ?integer $dob_month, ?integer $dob_year, array $custom_fields, [integer $timezone_offset = 0], [?GROUP $primary_group = NULL], [BINARY $validated = 1], [?TIME $join_time = NULL], [?TIME $last_visit_time = NULL], [ID_TEXT $theme = ''], [?URLPATH $avatar_url = NULL], [LONG_TEXT $signature = ''], [BINARY $is_perm_banned = 0], [BINARY $preview_posts = 0], [BINARY $reveal_age = 1], [SHORT_TEXT $title = ''], [URLPATH $photo_url = ''], [URLPATH $photo_thumb_url = ''], [BINARY $views_signatures = 1], [BINARY $track_contributed_topics = 1], [?LANGUAGE_NAME $language = NULL], [BINARY $allow_emails = 1], [LONG_TEXT $personal_notes = ''], [?IP $ip_address = NULL], [SHORT_TEXT $validated_email_confirm_code = ''], [boolean $check_correctness = true], [?ID_TEXT $password_compatibility_scheme = NULL], [SHORT_TEXT $salt = ''], [BINARY $zone_wide = 1], [?TIME $last_submit_time = NULL], [?AUTO_LINK $id = NULL], [BINARY $highlighted_name = 0], [SHORT_TEXT $pt_allow = '*'], [LONG_TEXT $pt_rules_text = ''])
-
SHORT_TEXT
$username: The username.
-
SHORT_TEXT
$password: The password.
-
SHORT_TEXT
$email_address: The e-mail address.
-
?array
$groups: A list of usergroups (NULL: default/current usergroups).
-
?integer
$dob_day: Day of date of birth (NULL: unknown).
-
?integer
$dob_month: Month of date of birth (NULL: unknown).
-
?integer
$dob_year: Year of date of birth (NULL: unknown).
-
array
$custom_fields: A map of custom field values (field-id=>value).
-
integer
$timezone_offset: The offset of the member's time zone relative to the server time zone.
-
?GROUP
$primary_group: The member's primary (NULL: default).
-
BINARY
$validated: Whether the profile has been validated.
-
?TIME
$join_time: When the member joined (NULL: now).
-
?TIME
$last_visit_time: When the member last visited (NULL: now).
-
ID_TEXT
$theme: The member's default theme.
-
?URLPATH
$avatar_url: The URL to the member's avatar (blank: none) (NULL: choose one automatically).
-
LONG_TEXT
$signature: The member's signature (blank: none).
-
BINARY
$is_perm_banned: Whether the member is permanently banned.
-
BINARY
$preview_posts: Whether posts are previewed before they are made.
-
BINARY
$reveal_age: Whether the member's age may be shown.
-
SHORT_TEXT
$title: The member's title (blank: get from primary).
-
URLPATH
$photo_url: The URL to the member's photo (blank: none).
-
URLPATH
$photo_thumb_url: The URL to the member's photo thumbnail (blank: none).
-
BINARY
$views_signatures: Whether the member sees signatures in posts.
-
BINARY
$track_contributed_topics: Whether the member tracks topics they post in automatically.
-
?LANGUAGE_NAME
$language: The member's language (NULL: auto detect).
-
BINARY
$allow_emails: Whether the member allows e-mails via the site.
-
LONG_TEXT
$personal_notes: Personal notes of the member.
-
?IP
$ip_address: The member's IP address (NULL: IP address of current user).
-
SHORT_TEXT
$validated_email_confirm_code: The code required before the account becomes active (blank: already entered).
-
boolean
$check_correctness: Whether to check details for correctness.
-
?ID_TEXT
$password_compatibility_scheme: The compatibility scheme that the password operates in (blank: none) (NULL: none [meaning normal ocPortal salted style] or plain, depending on whether passwords are encrypted).
-
SHORT_TEXT
$salt: The password salt (blank: password compatibility scheme does not use a salt / auto-generate).
-
BINARY
$zone_wide: Whether the member likes to view zones without menus, when a choice is available.
-
?TIME
$last_submit_time: The time the member last made a submission (NULL: set to now).
-
?AUTO_LINK
$id: Force an ID (NULL: don't force an ID)
-
BINARY
$highlighted_name: Whether the member username will be highlighted.
-
SHORT_TEXT
$pt_allow: Usergroups that may PT the member.
-
LONG_TEXT
$pt_rules_text: Rules that other members must agree to before they may start a PT with the member.