/sources/ocf_forums_action.php

Description
Functions
ocf_make_category (line 29)

Add a forum category.

  • return: The ID of the forum category just added.
AUTO_LINK ocf_make_category (SHORT_TEXT $title, SHORT_TEXT $description, [BINARY $expanded_by_default = 1])
  • SHORT_TEXT $title: The title of the forum category.
  • SHORT_TEXT $description: The description of the forum category.
  • BINARY $expanded_by_default: Whether the forum category will be shown expanded by default (as opposed to contracted, where contained forums will not be shown until expansion).
ocf_make_forum (line 59)

Make a forum.

  • return: The ID of the newly created forum.
AUTO_LINK ocf_make_forum (SHORT_TEXT $name, SHORT_TEXT $description, ?AUTO_LINK $category_id, ?array $access_mapping, ?AUTO_LINK $parent_forum, [integer $position = 1], [BINARY $post_count_increment = 1], [BINARY $order_sub_alpha = 0], [LONG_TEXT $intro_question = ''], [SHORT_TEXT $intro_answer = ''], [SHORT_TEXT $redirection = ''], [ID_TEXT $order = 'last_post'])
  • SHORT_TEXT $name: The name of the forum.
  • SHORT_TEXT $description: The description for the forum.
  • ?AUTO_LINK $category_id: What forum category the forum will be filed with (NULL: this is the root forum).
  • ?array $access_mapping: Permission map (NULL: do it the standard way, outside of this function). This parameter is for import/compatibility only and works upon an emulation of 'access levels' (ala ocPortal 2.5/2.6), and it is recommended to use the normal aed_module functionality for permissions setting.
  • ?AUTO_LINK $parent_forum: The ID of the parent forum (NULL: this is the root forum).
  • integer $position: The position of this forum relative to other forums viewable on the same screen (if parent forum hasn't specified automatic ordering).
  • BINARY $post_count_increment: Whether post counts will be incremented if members post in the forum.
  • BINARY $order_sub_alpha: Whether the ordering of subforums is done automatically, alphabetically).
  • LONG_TEXT $intro_question: The question that is shown for newbies to the forum (blank: none).
  • SHORT_TEXT $intro_answer: The answer to the question (blank: no specific answer.. if there's a 'question', it just requires a click-through).
  • SHORT_TEXT $redirection: Either blank for no redirection, the ID of another forum we are mirroring, or a URL to redirect to.
  • ID_TEXT $order: The order the topics are shown in, by default.

Documentation generated on Sun, 02 Jan 2011 23:19:39 +0000 by phpDocumentor 1.4.3