WordPress.org

Make WordPress Core


Ignore:
Timestamp:
03/25/2018 07:32:24 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Document more parameters and properties using typed array notation.

See #41756

File:
1 edited

Legend:

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

    r42772 r42876  
    518518 * @since 4.5.0
    519519 *
    520  * @param array $comments Array of comment objects.
     520 * @param WP_Comment[] $comments Array of comment objects.
    521521 */
    522522function wp_queue_comments_for_comment_meta_lazyload( $comments ) {
     
    919919 * @since 2.7.0
    920920 *
    921  * @param array $comments Array of comments
    922  * @return array Array of comments keyed by comment_type.
     921 * @param WP_Comment[] $comments Array of comments
     922 * @return WP_Comment[] Array of comments keyed by comment_type.
    923923 */
    924924function separate_comments( &$comments ) {
     
    953953 * @global WP_Query $wp_query
    954954 *
    955  * @param array $comments Optional array of WP_Comment objects. Defaults to $wp_query->comments
    956  * @param int   $per_page Optional comments per page.
    957  * @param bool  $threaded Optional control over flat or threaded comments.
     955 * @param WP_Comment[] $comments Optional. Array of WP_Comment objects. Defaults to $wp_query->comments.
     956 * @param int          $per_page Optional. Comments per page.
     957 * @param bool         $threaded Optional. Control over flat or threaded comments.
    958958 * @return int Number of comment pages.
    959959 */
     
    27412741     * @since 2.0.0
    27422742     *
    2743      * @param array $post_links An array of post links to be checked (passed by reference).
    2744      * @param array $pung       Whether a link has already been pinged (passed by reference).
    2745      * @param int   $post_ID    The post ID.
     2743     * @param string[] $post_links Array of link URLs to be checked (passed by reference).
     2744     * @param string[] $pung       Array of link URLs already pinged (passed by reference).
     2745     * @param int      $post_ID    The post ID.
    27462746     */
    27472747    do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post->ID ) );
     
    29332933 * @since 4.4.0 Introduced the `$update_meta_cache` parameter.
    29342934 *
    2935  * @param array $comments          Array of comment row objects
    2936  * @param bool  $update_meta_cache Whether to update commentmeta cache. Default true.
     2935 * @param WP_Comment[] $comments          Array of comment objects
     2936 * @param bool         $update_meta_cache Whether to update commentmeta cache. Default true.
    29372937 */
    29382938function update_comment_cache( $comments, $update_meta_cache = true ) {
     
    29602960 * @global wpdb $wpdb WordPress database abstraction object.
    29612961 *
    2962  * @param array $comment_ids       Array of comment IDs.
     2962 * @param int[] $comment_ids       Array of comment IDs.
    29632963 * @param bool  $update_meta_cache Optional. Whether to update the meta cache. Default true.
    29642964 */
     
    29982998     * @since 3.2.0
    29992999     *
    3000      * @param array $post_types An array of registered post types. Default array with 'post'.
     3000     * @param string[] $post_types An array of post type names.
    30013001     */
    30023002    $post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
Note: See TracChangeset for help on using the changeset viewer.