WordPress.org

Make WordPress Core


Ignore:
Timestamp:
12/18/2019 12:17:54 AM (2 years ago)
Author:
SergeyBiryukov
Message:

Docs: Various documentation fixes for unit test factories.

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php

    r46586 r46985  
    3737     * Updates a comment.
    3838     *
    39      * @param int   $comment_id The comment id.
     39     * @param int   $comment_id The comment ID.
    4040     * @param array $fields     The comment details.
    4141     *
     
    4848
    4949    /**
    50      * Creates multiple comments on given post.
     50     * Creates multiple comments on a given post.
    5151     *
    52      * @param int   $post_id                The post id to create comments for.
     52     * @param int   $post_id                ID of the post to create comments for.
    5353     * @param int   $count                  Total amount of comments to create.
    5454     * @param array $args                   The comment details.
    5555     * @param null  $generation_definitions Default values.
    5656     *
    57      * @return int[] Array with the comment ids.
     57     * @return int[] Array with the comment IDs.
    5858     */
    5959    public function create_post_comments( $post_id, $count = 1, $args = array(), $generation_definitions = null ) {
     
    6363
    6464    /**
    65      * Returns a comment.
     65     * Retrieves a comment by a given ID.
    6666     *
    67      * @param int $comment_id The comment id.
     67     * @param int $comment_id ID of the comment to retrieve.
    6868     *
    69      * @return null|WP_Comment WP_Comment when found, null when not found.
     69     * @return WP_Comment|null WP_Comment object on success, null on failure.
    7070     */
    7171    public function get_object_by_id( $comment_id ) {
Note: See TracChangeset for help on using the changeset viewer.