Changeset 34732

Timestamp:

10/01/2015 04:00:48 AM (9 years ago)

Author:

boonebgorges

Message:

Correct some WP_Query metadata lazyloading docs.

Props dlh.
Fixes #34047.

File:

• trunk/src/wp-includes/query.php (modified) (3 diffs)

trunk/src/wp-includes/query.php

@@ -4769 +4769 @@
      * @access public
      *
-     * @param null $check   The `$check` param passed from the 'pre_term_metadata' hook.
+     * @param mixed $check  The `$check` param passed from the 'get_term_metadata' hook.
      * @param int  $term_id ID of the term whose metadata is being cached.
      * @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
@@ -4777 +4777 @@
         /*
          * We only do this once per `WP_Query` instance.
-         * Can't use `remove_action()` because of non-unique object hashes.
+         * Can't use `remove_filter()` because of non-unique object hashes.
          */
         if ( $this->updated_term_meta_cache ) {
@@ -4840 +4840 @@
      * @since 4.4.0
      *
-     * @param null $check      The `$check` param passed from the 'pre_comment_metadata' hook.
+     * @param mixed $check     The `$check` param passed from the 'get_comment_metadata' hook.
      * @param int  $comment_id ID of the comment whose metadata is being cached.
-     * @return null In order not to short-circuit `get_metadata()`.
+     * @return mixed The original value of `$check`, to not affect 'get_comment_metadata'.
      */
     public function lazyload_comment_meta( $check, $comment_id ) {
         /*
          * We only do this once per `WP_Query` instance.
-         * Can't use `remove_action()` because of non-unique object hashes.
+         * Can't use `remove_filter()` because of non-unique object hashes.
          */
         if ( $this->updated_comment_meta_cache ) {