[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> class-wp-comment.php (summary)

Comment API: WP_Comment class

File Size: 368 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  get_instance()
  __construct()
  to_array()
  get_children()
  add_child()
  get_child()
  populated_children()
  __isset()
  __get()

Functions
Functions that are not part of a class:

get_instance( $id )   X-Ref
Retrieves a WP_Comment instance.

param: int $id Comment ID.
return: WP_Comment|false Comment object, otherwise false.

__construct( $comment )   X-Ref
Constructor.

Populates properties with object vars.

param: WP_Comment $comment Comment object.

to_array()   X-Ref
Convert object to array.

return: array Object as array.

get_children( $args = array()   X-Ref
Get the children of a comment.

param: array $args {
return: WP_Comment[] Array of `WP_Comment` objects.

add_child( WP_Comment $child )   X-Ref
Add a child to the comment.

Used by `WP_Comment_Query` when bulk-filling descendants.

param: WP_Comment $child Child comment.

get_child( $child_id )   X-Ref
Get a child comment by ID.

param: int $child_id ID of the child.
return: WP_Comment|bool Returns the comment object if found, otherwise false.

populated_children( $set )   X-Ref
Set the 'populated_children' flag.

This flag is important for ensuring that calling `get_children()` on a childless comment will not trigger
unneeded database queries.

param: bool $set Whether the comment's children have already been populated.

__isset( $name )   X-Ref
Check whether a non-public property is set.

If `$name` matches a post field, the comment post will be loaded and the post's value checked.

param: string $name Property name.
return: bool

__get( $name )   X-Ref
Magic getter.

If `$name` matches a post field, the comment post will be loaded and the post's value returned.

param: string $name
return: mixed



Generated: Sat Nov 23 20:47:33 2019 Cross-referenced by PHPXref 0.7