WordPress.org
Get WordPress

Make WordPress Core

Changeset 32587


Ignore:
Timestamp:
05/24/2015 09:03:42 PM (10 years ago)
Author:
wonderboymusic
Message:

Add missing doc blocks to comment.php.

See #32444.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/comment.php

    r32547 r32587  
    162162 * @since 2.0.0
    163163 *
    164  * @global wpdb $wpdb WordPress database abstraction object.
     164 * @global wpdb   $wpdb WordPress database abstraction object.
     165 * @global object $comment
    165166 *
    166167 * @param object|string|int $comment Comment to retrieve.
    … …  
    298299     * @param callable $name      Method to call.
    299300     * @param array    $arguments Arguments to pass when calling.
    300      * @return mixed|bool Return value of the callback, false otherwise.
     301     * @return mixed|false Return value of the callback, false otherwise.
    301302     */
    302303    public function __call( $name, $arguments ) {
    … …  
    378379     *     @type int          $user_id             Include comments for a specific user ID. Default empty.
    379380     * }
    380      * @return WP_Comment_Query WP_Comment_Query instance.
    381381     */
    382382    public function __construct( $query = '' ) {
    … …  
    470470     * @global wpdb $wpdb WordPress database abstraction object.
    471471     *
    472      * @return array The list of comments.
     472     * @return int|array The list of comments.
    473473     */
    474474    public function get_comments() {
    … …  
    902902     * Used internally to generate an SQL string for searching across multiple columns
    903903     *
     904     * @since 3.1.0
    904905     * @access protected
    905      * @since 3.1.0
     906     *
     907     * @global wpdb $wpdb
    906908     *
    907909     * @param string $string
    … …  
    931933     *
    932934     * @param string $orderby Alias for the field to order by.
    933      * @return string|bool Value to used in the ORDER clause. False otherwise.
     935     * @return string|false Value to used in the ORDER clause. False otherwise.
    934936     */
    935937    protected function parse_orderby( $orderby ) {
    … …  
    10331035 *
    10341036 * @global wpdb $wpdb WordPress database abstraction object.
     1037 * @staticvar array $cache_lastcommentmodified
    10351038 *
    10361039 * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',
    … …  
    12951298 *
    12961299 * @param array $commentdata Contains information on the comment
    1297  * @return mixed Signifies the approval status (0|1|'spam')
     1300 * @return int|string Signifies the approval status (0|1|'spam')
    12981301 */
    12991302function wp_allow_comment( $commentdata ) {
    … …  
    14831486 * @uses Walker_Comment
    14841487 *
     1488 * @global WP_Query $wp_query
     1489 *
    14851490 * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments
    14861491 * @param int $per_page Optional comments per page.
    … …  
    15271532 *
    15281533 * @since 2.7.0
     1534 *
     1535 * @global wpdb $wpdb
    15291536 *
    15301537 * @param int $comment_ID Comment ID.
    … …  
    16501657 * @since 2.5.0
    16511658 *
     1659 * @global wpdb $wpdb
     1660 *
    16521661 * @param int $post_id Optional. Post ID.
    1653  * @return object Comment stats.
     1662 * @return object|array Comment stats.
    16541663 */
    16551664function wp_count_comments( $post_id = 0 ) {
    … …  
    21122121 *     @type int        $user_id              ID of the user who submitted the comment. Default 0.
    21132122 * }
    2114  * @return int|bool The new comment's ID on success, false on failure.
     2123 * @return int|false The new comment's ID on success, false on failure.
    21152124 */
    21162125function wp_insert_comment( $commentdata ) {
    … …  
    22612270 * @see wp_insert_comment()
    22622271 *
     2272 * @global wpdb $wpdb
     2273 *
    22632274 * @param array $commentdata Contains information on the comment. See wp_insert_comment()
    22642275 *                           for information on accepted arguments.
    … …  
    23612372 *
    23622373 * @since 1.0.0
     2374 *
     2375 * global wpdb $wpdb
    23632376 *
    23642377 * @param int $comment_id Comment ID.
    … …  
    25482561 * @param int $post_id Post ID
    25492562 * @param bool $do_deferred Whether to process previously deferred post comment counts
    2550  * @return bool|null True on success, false on failure
     2563 * @return bool|void True on success, false on failure
    25512564 */
    25522565function wp_update_comment_count($post_id, $do_deferred=false) {
    … …  
    27912804 *
    27922805 * @since 0.71
    2793  * @uses $wp_version
     2806 *
     2807 * @global string $wp_version
    27942808 *
    27952809 * @param string $content Post content to check for links.
    … …  
    29042918 * @param string $excerpt Excerpt of post.
    29052919 * @param int $ID Post ID.
    2906  * @return mixed Database query from update.
     2920 * @return int|false|void Database query from update.
    29072921 */
    29082922function trackback($trackback_url, $title, $excerpt, $ID) {
    … …  
    29342948 *
    29352949 * @since 1.2.0
    2936  * @uses $wp_version
     2950 *
     2951 * @global string $wp_version
    29372952 *
    29382953 * @param string $server Host of blog to connect to.
    … …  
    30313046 * @since 2.7.0
    30323047 *
    3033  * @param object $posts Post data object.
    3034  * @param object $query Query object.
    3035  * @return object
     3048 * @param WP_Post $posts Post data object.
     3049 * @param WP_Query $query Query object.
     3050 * @return array
    30363051 */
    30373052function _close_comments_for_old_posts( $posts, $query ) {
Note: See TracChangeset for help on using the changeset viewer.