sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix phpDoc for Comment Meta functions to refer to comments not posts. See #11462 props sirzooro. 

git-svn-id: https://develop.svn.wordpress.org/trunk@12420 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Westwood 2009-12-16 22:13:53 +00:00
parent aa3d3a73aa
commit 0d2d7cc5a9
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
wp-includes/comment.php
View File

@ -371,13 +371,11 @@ function get_comment_count( $post_id = 0 ) {
/** /**
* Add meta data field to a comment. * Add meta data field to a comment.
* *
* Post meta data is called "Custom Fields" on the Administration Panels.
*
* @since 2.9 * @since 2.9
* @uses add_metadata * @uses add_metadata
* @link http://codex.wordpress.org/Function_Reference/add_comment_meta * @link http://codex.wordpress.org/Function_Reference/add_comment_meta
* *
* @param int $comment_id Post ID. * @param int $comment_id Comment ID.
* @param string $key Metadata name. * @param string $key Metadata name.
* @param mixed $value Metadata value. * @param mixed $value Metadata value.
* @param bool $unique Optional, default is false. Whether the same key should not be added. * @param bool $unique Optional, default is false. Whether the same key should not be added.
@ -414,7 +412,7 @@ function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {
* @uses get_metadata * @uses get_metadata
* @link http://codex.wordpress.org/Function_Reference/get_comment_meta * @link http://codex.wordpress.org/Function_Reference/get_comment_meta
* *
* @param int $comment_id Post ID. * @param int $comment_id Comment ID.
* @param string $key The meta key to retrieve. * @param string $key The meta key to retrieve.
* @param bool $single Whether to return a single value. * @param bool $single Whether to return a single value.
* @return mixed Will be an array if $single is false. Will be value of meta data field if $single * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
@ -436,7 +434,7 @@ function get_comment_meta($comment_id, $key, $single = false) {
* @uses update_metadata * @uses update_metadata
* @link http://codex.wordpress.org/Function_Reference/update_comment_meta * @link http://codex.wordpress.org/Function_Reference/update_comment_meta
* *
* @param int $comment_id Post ID. * @param int $comment_id Comment ID.
* @param string $key Metadata key. * @param string $key Metadata key.
* @param mixed $value Metadata value. * @param mixed $value Metadata value.
* @param mixed $prev_value Optional. Previous value to check before removing. * @param mixed $prev_value Optional. Previous value to check before removing.