[ class tree: plugins ] [ index: plugins ] [ all elements ]

Procedural File: comment_form.php

Source Location: /zp-extensions/comment_form.php

Page Details

Provides a unified comment handling facility

Place a call on the function printCommentForm() in your script where you wish the comment items to appear.

Normally the plugin uses the form plugins/comment_form/comment_form.php. However, you may override this form by placing a script of the same name in your theme folder. This will allow you to customize the appearance of the comments on your site.

There are several options to tune what the plugin will do.

Classes
Class Description
comment_form
Functions
comment_form_comment_post  [line 430]

Processes the address parts of a comment post

Parameters:
object   $commentobj:  the comment object
object   $receiver:  the object receiving the comment


object comment_form_comment_post( object $commentobj, object $receiver  )

[ Top ]
comment_form_edit_admin  [line 479]

Returns table row(s) for edit of an admin user's custom data

Parameters:
string   $html:  always empty
string   $i:  prefix for the admin
string   $background:  background color for the admin row
bool   $current:  true if this admin row is the logged in admin
$userobj   $userobj:  Admin user object


string comment_form_edit_admin( string $html, $userobj $userobj, string $i, string $background, bool $current  )

[ Top ]
comment_form_edit_comment  [line 286]

Returns table row(s) for edit of a comment's custom data

Parameters:
string   $discard:  always empty
   $raw: 


string comment_form_edit_comment( string $discard, $raw  )

[ Top ]
comment_form_options  [line 464]

Supplies comment form options on the options/comments tab


void comment_form_options( )

[ Top ]
comment_form_PaginationJS  [line 41]

void comment_form_PaginationJS( )

[ Top ]
comment_form_print10Most  [line 192]

Admin overview summary

Parameters:
   $side: 


void comment_form_print10Most( $side  )

[ Top ]
comment_form_register_save  [line 357]
Parameters:
   $user: 


void comment_form_register_save( $user  )

[ Top ]
comment_form_register_user  [line 352]
Parameters:
   $html: 


void comment_form_register_user( $html  )

[ Top ]
comment_form_save_admin  [line 397]

Saves admin custom data Called when an admin is saved

Parameters:
string   $updated:  true if data has changed
object   $userobj:  admin user object
string   $i:  prefix for the admin
bool   $alter:  will be true if critical admin data may be altered


bool comment_form_save_admin( string $updated, object $userobj, string $i, bool $alter  )

[ Top ]
comment_form_save_comment  [line 185]

Returns a processed comment custom data item Called when a comment edit is saved

Parameters:
string   $discard:  always empty


string comment_form_save_comment( string $discard  )

[ Top ]
getCommentErrors  [line 527]

Returns an error message if a comment posting was not accepted


string getCommentErrors( )

[ Top ]
getUserInfo  [line 412]

Processes the post of an address

Parameters:
int   $i:  sequence number of the comment


array getUserInfo( int $i  )

[ Top ]
printCommentErrors  [line 535]

Tool to output an error message if a comment posting was not accepted


void printCommentErrors( )

[ Top ]
printCommentForm  [line 576]

Prints a form for posting comments

Parameters:
bool   $showcomments:  defaults to true for showing list of comments
string   $addcommenttext:  alternate text for "Add a comment:"
bool   $addheader:  set true to display comment count header
string   $comment_commententry_mod:  use to add styles, classes to the comment form div
bool   $desc_order:  default false, set to true to change the comment order to descending ( = newest to oldest)


void printCommentForm( [bool $showcomments = true], [string $addcommenttext = NULL], [bool $addheader = true], [string $comment_commententry_mod = ''], [bool $desc_order = false]  )

[ Top ]


Documentation generated on Tue, 20 Dec 2011 16:07:04 +0100 by phpDocumentor 1.4.3