WordPress.org
Get WordPress

Make WordPress Core

Ticket #32139: 32139.diff

File 32139.diff, 7.4 KB (added by MikeSchinkel, 10 years ago)

Patch adds PHPDoc for all global $wp_query in /wp-includes/query.php plus fixes return statements+PHPDoc on three (3) void functions.

  • wp-includes/query.php 

    IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
     
    2323 * @return mixed
    2424 */
    2525function get_query_var( $var, $default = '' ) {
     26        /**
     27         * @var WP_Query $wp_query
     28         */
    2629        global $wp_query;
    2730
    2831        return $wp_query->get( $var, $default );
    … …  
    3942 * @return object
    4043 */
    4144function get_queried_object() {
     45        /**
     46         * @var WP_Query $wp_query
     47         */
    4248        global $wp_query;
    4349        return $wp_query->get_queried_object();
    4450}
    … …  
    5460 * @return int
    5561 */
    5662function get_queried_object_id() {
     63        /**
     64         * @var WP_Query $wp_query
     65         */
    5766        global $wp_query;
    5867        return $wp_query->get_queried_object_id();
    5968}
    … …  
    6776 *
    6877 * @param string $var Query variable key.
    6978 * @param mixed $value
    70  * @return null
    7179 */
    7280function set_query_var($var, $value) {
     81        /**
     82         * @var WP_Query $wp_query
     83         */
    7384        global $wp_query;
    7485
    75         return $wp_query->set($var, $value);
     86        $wp_query->set($var, $value);
    7687}
    7788
    7889/**
    … …  
    115126 * @uses $wp_query
    116127 */
    117128function wp_reset_postdata() {
     129        /**
     130         * @var WP_Query $wp_query
     131         */
    118132        global $wp_query;
    119133
    120134        if ( isset( $wp_query ) ) {
    … …  
    138152 * @return bool
    139153 */
    140154function is_archive() {
     155        /**
     156         * @var WP_Query $wp_query
     157         */
    141158        global $wp_query;
    142159
    143160        if ( ! isset( $wp_query ) ) {
    … …  
    159176 * @return bool
    160177 */
    161178function is_post_type_archive( $post_types = '' ) {
     179        /**
     180         * @var WP_Query $wp_query
     181         */
    162182        global $wp_query;
    163183
    164184        if ( ! isset( $wp_query ) ) {
    … …  
    180200 * @return bool
    181201 */
    182202function is_attachment( $attachment = '' ) {
     203        /**
     204         * @var WP_Query $wp_query
     205         */
    183206        global $wp_query;
    184207
    185208        if ( ! isset( $wp_query ) ) {
    … …  
    204227 * @return bool
    205228 */
    206229function is_author( $author = '' ) {
     230        /**
     231         * @var WP_Query $wp_query
     232         */
    207233        global $wp_query;
    208234
    209235        if ( ! isset( $wp_query ) ) {
    … …  
    228254 * @return bool
    229255 */
    230256function is_category( $category = '' ) {
     257        /**
     258         * @var WP_Query $wp_query
     259         */
    231260        global $wp_query;
    232261
    233262        if ( ! isset( $wp_query ) ) {
    … …  
    252281 * @return bool
    253282 */
    254283function is_tag( $tag = '' ) {
     284        /**
     285         * @var WP_Query $wp_query
     286         */
    255287        global $wp_query;
    256288
    257289        if ( ! isset( $wp_query ) ) {
    … …  
    281313 * @return bool
    282314 */
    283315function is_tax( $taxonomy = '', $term = '' ) {
     316        /**
     317         * @var WP_Query $wp_query
     318         */
    284319        global $wp_query;
    285320
    286321        if ( ! isset( $wp_query ) ) {
    … …  
    301336 * @return bool
    302337 */
    303338function is_comments_popup() {
     339        /**
     340         * @var WP_Query $wp_query
     341         */
    304342        global $wp_query;
    305343
    306344        if ( ! isset( $wp_query ) ) {
    … …  
    321359 * @return bool
    322360 */
    323361function is_date() {
     362        /**
     363         * @var WP_Query $wp_query
     364         */
    324365        global $wp_query;
    325366
    326367        if ( ! isset( $wp_query ) ) {
    … …  
    341382 * @return bool
    342383 */
    343384function is_day() {
     385        /**
     386         * @var WP_Query $wp_query
     387         */
    344388        global $wp_query;
    345389
    346390        if ( ! isset( $wp_query ) ) {
    … …  
    362406 * @return bool
    363407 */
    364408function is_feed( $feeds = '' ) {
     409        /**
     410         * @var WP_Query $wp_query
     411         */
    365412        global $wp_query;
    366413
    367414        if ( ! isset( $wp_query ) ) {
    … …  
    382429 * @return bool
    383430 */
    384431function is_comment_feed() {
     432        /**
     433         * @var WP_Query $wp_query
     434         */
    385435        global $wp_query;
    386436
    387437        if ( ! isset( $wp_query ) ) {
    … …  
    410460 * @return bool True, if front of site.
    411461 */
    412462function is_front_page() {
     463        /**
     464         * @var WP_Query $wp_query
     465         */
    413466        global $wp_query;
    414467
    415468        if ( ! isset( $wp_query ) ) {
    … …  
    439492 * @return bool True if blog view homepage.
    440493 */
    441494function is_home() {
     495        /**
     496         * @var WP_Query $wp_query
     497         */
    442498        global $wp_query;
    443499
    444500        if ( ! isset( $wp_query ) ) {
    … …  
    459515 * @return bool
    460516 */
    461517function is_month() {
     518        /**
     519         * @var WP_Query $wp_query
     520         */
    462521        global $wp_query;
    463522
    464523        if ( ! isset( $wp_query ) ) {
    … …  
    486545 * @return bool
    487546 */
    488547function is_page( $page = '' ) {
     548        /**
     549         * @var WP_Query $wp_query
     550         */
    489551        global $wp_query;
    490552
    491553        if ( ! isset( $wp_query ) ) {
    … …  
    506568 * @return bool
    507569 */
    508570function is_paged() {
     571        /**
     572         * @var WP_Query $wp_query
     573         */
    509574        global $wp_query;
    510575
    511576        if ( ! isset( $wp_query ) ) {
    … …  
    526591 * @return bool
    527592 */
    528593function is_preview() {
     594        /**
     595         * @var WP_Query $wp_query
     596         */
    529597        global $wp_query;
    530598
    531599        if ( ! isset( $wp_query ) ) {
    … …  
    546614 * @return bool
    547615 */
    548616function is_robots() {
     617        /**
     618         * @var WP_Query $wp_query
     619         */
    549620        global $wp_query;
    550621
    551622        if ( ! isset( $wp_query ) ) {
    … …  
    566637 * @return bool
    567638 */
    568639function is_search() {
     640        /**
     641         * @var WP_Query $wp_query
     642         */
    569643        global $wp_query;
    570644
    571645        if ( ! isset( $wp_query ) ) {
    … …  
    595669 * @return bool
    596670 */
    597671function is_single( $post = '' ) {
     672        /**
     673         * @var WP_Query $wp_query
     674         */
    598675        global $wp_query;
    599676
    600677        if ( ! isset( $wp_query ) ) {
    … …  
    622699 * @return bool
    623700 */
    624701function is_singular( $post_types = '' ) {
     702        /**
     703         * @var WP_Query $wp_query
     704         */
    625705        global $wp_query;
    626706
    627707        if ( ! isset( $wp_query ) ) {
    … …  
    642722 * @return bool
    643723 */
    644724function is_time() {
     725        /**
     726         * @var WP_Query $wp_query
     727         */
    645728        global $wp_query;
    646729
    647730        if ( ! isset( $wp_query ) ) {
    … …  
    662745 * @return bool
    663746 */
    664747function is_trackback() {
     748        /**
     749         * @var WP_Query $wp_query
     750         */
    665751        global $wp_query;
    666752
    667753        if ( ! isset( $wp_query ) ) {
    … …  
    726812                _doing_it_wrong( __FUNCTION__, $message, '3.7' );
    727813        }
    728814
     815        /**
     816         * @var WP_Query $wp_query
     817         */
    729818        global $wp_query;
    730819        return $wp_query->is_main_query();
    731820}
    … …  
    744833 * @return bool
    745834 */
    746835function have_posts() {
     836        /**
     837         * @var WP_Query $wp_query
     838         */
    747839        global $wp_query;
    748840
    749841        return $wp_query->have_posts();
    … …  
    758850 * @return bool True if caller is within loop, false if loop hasn't started or ended.
    759851 */
    760852function in_the_loop() {
     853        /**
     854         * @var WP_Query $wp_query
     855         */
    761856        global $wp_query;
    762857
    763858        return $wp_query->in_the_loop;
    … …  
    769864 * @see WP_Query::rewind_posts()
    770865 * @since 1.5.0
    771866 * @uses $wp_query
    772  *
    773  * @return null
    774867 */
    775868function rewind_posts() {
     869        /**
     870         * @var WP_Query $wp_query
     871         */
    776872        global $wp_query;
    777873
    778         return $wp_query->rewind_posts();
     874        $wp_query->rewind_posts();
    779875}
    780876
    781877/**
    … …  
    786882 * @uses $wp_query
    787883 */
    788884function the_post() {
     885        /**
     886         * @var WP_Query $wp_query
     887         */
    789888        global $wp_query;
    790889
    791890        $wp_query->the_post();
    … …  
    805904 * @return bool
    806905 */
    807906function have_comments() {
     907        /**
     908         * @var WP_Query $wp_query
     909         */
    808910        global $wp_query;
    809911        return $wp_query->have_comments();
    810912}
    … …  
    815917 * @see WP_Query::the_comment()
    816918 * @since 2.2.0
    817919 * @uses $wp_query
    818  *
    819  * @return object
    820920 */
    821921function the_comment() {
     922        /**
     923         * @var WP_Query $wp_query
     924         */
    822925        global $wp_query;
    823         return $wp_query->the_comment();
     926        $wp_query->the_comment();
    824927}
    825928
    826929/*
    … …  
    39694072         * @access public
    39704073         *
    39714074         * @param string|array $query URL query string or array of vars.
     4075         * @return WP_Query
    39724076         */
    39734077        public function __construct($query = '') {
    39744078                if ( ! empty($query) ) {
    … …  
    46584762 * @return null If no link is found, null is returned.
    46594763 */
    46604764function wp_old_slug_redirect() {
     4765        /**
     4766         * @var WP_Query $wp_query
     4767         */
    46614768        global $wp_query;
    46624769        if ( is_404() && '' != $wp_query->query_vars['name'] ) :
    46634770                global $wpdb;
    … …  
    47154822 * @return bool True when finished.
    47164823 */
    47174824function setup_postdata( $post ) {
     4825        /**
     4826         * @var WP_Query $wp_query
     4827         */
    47184828        global $wp_query;
    47194829
    47204830        if ( ! empty( $wp_query ) && $wp_query instanceof WP_Query ) {