WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/09/2016 10:59:02 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Improve the documentation for parameters which accept OBJECT, ARRAY_A, and ARRAY_N as parameters.

See #37770

File:
1 edited

Legend:

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

    r38433 r39188  
    322322 *
    323323 * @param int|WP_Post $post   The post ID or object.
    324  * @param string      $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
     324 * @param string      $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
     325 *                            a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
    325326 * @param string      $filter Optional sanitation filter. See sanitize_post().
    326  * @return WP_Post|array|null Null if error or post object if success.
     327 * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
    327328 */
    328329function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
Note: See TracChangeset for help on using the changeset viewer.