WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/21/2013 12:45:11 PM (8 years ago)
Author:
SergeyBiryukov
Message:

PHPDoc fixes and additions. fixes #24616.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/comment.php

    r24480 r24490  
    540540 * @param mixed $meta_value Metadata value.
    541541 * @param bool $unique Optional, default is false. Whether the same key should not be added.
    542  * @return bool False for failure. True for success.
     542 * @return int|bool Meta ID on success, false on failure.
    543543 */
    544544function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false) {
     
    560560 * @param string $meta_key Metadata name.
    561561 * @param mixed $meta_value Optional. Metadata value.
    562  * @return bool False for failure. True for success.
     562 * @return bool True on success, false on failure.
    563563 */
    564564function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {
     
    599599 * @param mixed $meta_value Metadata value.
    600600 * @param mixed $prev_value Optional. Previous value to check before removing.
    601  * @return bool False on failure, true if success.
     601 * @return bool True on success, false on failure.
    602602 */
    603603function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {
     
    995995 * @param int $comment_id Comment ID
    996996 * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
    997  * @return bool False if delete comment query failure, true on success.
     997 * @return bool True on success, false on failure.
    998998 */
    999999function wp_delete_comment($comment_id, $force_delete = false) {
     
    10451045 *
    10461046 * @param int $comment_id Comment ID.
    1047  * @return mixed False on failure
     1047 * @return bool True on success, false on failure.
    10481048 */
    10491049function wp_trash_comment($comment_id) {
     
    10741074 *
    10751075 * @param int $comment_id Comment ID.
    1076  * @return mixed False on failure
     1076 * @return bool True on success, false on failure.
    10771077 */
    10781078function wp_untrash_comment($comment_id) {
     
    11041104 *
    11051105 * @param int $comment_id Comment ID.
    1106  * @return mixed False on failure
     1106 * @return bool True on success, false on failure.
    11071107 */
    11081108function wp_spam_comment($comment_id) {
     
    11291129 *
    11301130 * @param int $comment_id Comment ID.
    1131  * @return mixed False on failure
     1131 * @return bool True on success, false on failure.
    11321132 */
    11331133function wp_unspam_comment($comment_id) {
     
    14241424 * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
    14251425 * @param bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false.
    1426  * @return bool False on failure or deletion and true on success.
     1426 * @return bool|WP_Error True on success, false or WP_Error on failure.
    14271427 */
    14281428function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) {
     
    16021602 *
    16031603 * @param int $post_id Post ID
    1604  * @return bool False on '0' $post_id or if post with ID does not exist. True on success.
     1604 * @return bool True on success, false on '0' $post_id or if post with ID does not exist.
    16051605 */
    16061606function wp_update_comment_count_now($post_id) {
Note: See TracChangeset for help on using the changeset viewer.