comment.module

Version 1.617.2.14 (checked in on 2010/03/01 at 09:44:31 by goba)

Enables users to comment on published content.

When enabled, the Drupal comment module creates a discussion board for each Drupal node. Users can post comments to discuss a forum topic, weblog post, story, collaborative book page, etc.

Constants

Name	Description
COMMENT_ANONYMOUS_MAYNOT_CONTACT	Anonymous posters may not enter their contact information.
COMMENT_ANONYMOUS_MAY_CONTACT	Anonymous posters may leave their contact information.
COMMENT_ANONYMOUS_MUST_CONTACT	Anonymous posters must leave their contact information.
COMMENT_CONTROLS_ABOVE	Comment controls should be shown above the comment list.
COMMENT_CONTROLS_ABOVE_BELOW	Comment controls should be shown both above and below the comment list.
COMMENT_CONTROLS_BELOW	Comment controls should be shown below the comment list.
COMMENT_CONTROLS_HIDDEN	Comment controls are hidden.
COMMENT_FORM_BELOW	Comment form should be shown below post or list of comments.
COMMENT_FORM_SEPARATE_PAGE	Comment form should be displayed on a separate page.
COMMENT_MODE_FLAT_COLLAPSED	Comments are displayed in a flat list - collapsed.
COMMENT_MODE_FLAT_EXPANDED	Comments are displayed in a flat list - expanded.
COMMENT_MODE_THREADED_COLLAPSED	Comments are displayed as a threaded list - collapsed.
COMMENT_MODE_THREADED_EXPANDED	Comments are displayed as a threaded list - expanded.
COMMENT_NODE_DISABLED	Comments for this node are disabled.
COMMENT_NODE_READ_ONLY	Comments for this node are locked.
COMMENT_NODE_READ_WRITE	Comments are enabled on this node.
COMMENT_NOT_PUBLISHED	Comment is awaiting approval.
COMMENT_ORDER_NEWEST_FIRST	Comments are ordered by date - newest first.
COMMENT_ORDER_OLDEST_FIRST	Comments are ordered by date - oldest first.
COMMENT_PREVIEW_OPTIONAL	Comment preview is optional.
COMMENT_PREVIEW_REQUIRED	Comment preview is required.
COMMENT_PUBLISHED	Comment is published.

Functions

Name	Description
comment_access	This is *not* a hook_access() implementation. This function is called to determine whether the current user has access to a particular comment.
comment_action_info	Implementation of hook_action_info().
comment_block	Implementation of hook_block().
comment_controls	Build a comment control form.
comment_controls_submit	Process comment_controls form submissions.
comment_form	Generate the basic commenting form, for appending to a node or display on a separate page.
comment_form_add_preview	Form builder; Generate and validate a comment preview form.
comment_form_alter	Implementation of hook_form_alter().
comment_form_box	Theme the comment form box.
comment_form_submit	Process comment form submissions; prepare the comment, store it, and set a redirection target.
comment_form_validate	Validate comment form submissions.
comment_get_recent	Find a number of recent comments. This is done in two steps. 1. Find the n (specified by $number) nodes that have the most recent comments. This is done by querying node_comment_statistics which has an index on last_comment_timestamp, and is thus a...
comment_help	Implementation of hook_help().
comment_hook_info	Implementation of hook_hook_info().
comment_invoke_comment	Invoke a hook_comment() operation in all modules.
comment_link	Implementation of hook_link().
comment_links	Build command links for a comment (e.g.\ edit, reply, delete) with respect to the current user's access permissions.
comment_menu	Implementation of hook_menu().
comment_new_page_count	Calculate page number for first new comment.
comment_nodeapi	Implementation of hook_nodeapi().
comment_node_type	Implementation of hook_node_type().
comment_node_url	A simple helper function.
comment_num_all	Get comment count for a node.
comment_num_new	Get number of new comments for current user and specified node.
comment_num_replies	Get replies count for a comment.
comment_operations	Comment operations. We offer different update operations depending on which comment administration page we're on.
comment_perm	Implementation of hook_perm().
comment_render	Renders comment(s).
comment_save	Accepts a submission of new or changed comment content.
comment_theme	Implementation of hook_theme().
comment_unpublish_action	Drupal action to unpublish a comment.
comment_unpublish_by_keyword_action	Implementation of a configurable Drupal action. Unpublish a comment if it contains a certain string.
comment_unpublish_by_keyword_action_form	Form builder; Prepare a form for blacklisted keywords.
comment_unpublish_by_keyword_action_submit	Process comment_unpublish_by_keyword_action_form form submissions.
comment_user	Implementation of hook_user().
comment_validate	Validate comment data.
int2vancode	Generate vancode.
template_preprocess_comment	Process variables for comment.tpl.php. See alsocomment.tpl.php
template_preprocess_comment_folded	Process variables for comment-folded.tpl.php. See alsocomment-folded.tpl.php
template_preprocess_comment_wrapper	Process variables for comment-wrapper.tpl.php. See alsocomment-wrapper.tpl.php
theme_comment_block	Returns a formatted list of recent comments to be displayed in the comment block.
theme_comment_controls	Theme comment controls box where the user can change the default display mode and display order of comments.
theme_comment_flat_collapsed	Theme comment flat collapsed view.
theme_comment_flat_expanded	Theme comment flat expanded view.
theme_comment_post_forbidden	Theme a "you can't post comments" notice.
theme_comment_submitted	Theme a "Submitted by ..." notice.
theme_comment_thread_collapsed	Theme comment thread collapsed view.
theme_comment_thread_expanded	Theme comment thread expanded view.
theme_comment_view	Themes a single comment and related items.
vancode2int	Decode vancode back to an integer.
_comment_form_submit	Prepare a comment for submission.
_comment_get_display_setting	Return a current comment display setting
_comment_get_modes	Return an array of viewing modes for comment listings.
_comment_get_orders	Return an array of viewing orders for comment listings.
_comment_load	Load the entire comment by cid.
_comment_per_page	Return an array of "comments per page" settings from which the user can choose.
_comment_update_node_statistics	Updates the comment statistics for a given node. This should be called any time a comment is added, deleted, or updated.