sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve inline documentation syntax throughout WP_Metadata_Lazyloader, introduced in [36566].

Browse Source 
See #35816. See #35986.


git-svn-id: https://develop.svn.wordpress.org/trunk@36898 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-09 16:54:45 +00:00
parent 32f8a9b345
commit 94ac53331d
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/wp-includes/class-wp-metadata-lazyloader.php
View File

@ -17,7 +17,7 @@
* *
* In cases where the given metadata may not even be used in the loop, we can improve performance * In cases where the given metadata may not even be used in the loop, we can improve performance
* even more by only priming the metadata cache for affected items the first time a piece of metadata * even more by only priming the metadata cache for affected items the first time a piece of metadata
* is requested - ie, by lazyloading it. So, for example, comment meta may not be loaded into the * is requested - ie, by lazy-loading it. So, for example, comment meta may not be loaded into the
* cache in the comments section of a post until the first time get_comment_meta() is called in the * cache in the comments section of a post until the first time get_comment_meta() is called in the
* context of the comment loop. * context of the comment loop.
* *
@ -33,6 +33,7 @@ class WP_Metadata_Lazyloader {
* Pending objects queue. * Pending objects queue.
* *
* @since 4.5.0 * @since 4.5.0
* @access protected
* @var array * @var array
*/ */
protected $pending_objects; protected $pending_objects;
@ -41,6 +42,7 @@ class WP_Metadata_Lazyloader {
* Settings for supported object types. * Settings for supported object types.
* *
* @since 4.5.0 * @since 4.5.0
* @access protected
* @var array * @var array
*/ */
protected $settings = array(); protected $settings = array();
@ -49,6 +51,7 @@ class WP_Metadata_Lazyloader {
* Constructor. * Constructor.
* *
* @since 4.5.0 * @since 4.5.0
* @access public
*/ */
public function __construct() { public function __construct() {
$this->settings = array( $this->settings = array(
@ -64,11 +67,12 @@ class WP_Metadata_Lazyloader {
} }
/** /**
* Add objects to the metadata lazyload queue. * Adds objects to the metadata lazy-load queue.
* *
* @since 4.5.0 * @since 4.5.0
* @access public
* *
* @param string $object_type Type of object whose meta is to be lazyloaded. Accepts 'term' or 'comment'. * @param string $object_type Type of object whose meta is to be lazy-loaded. Accepts 'term' or 'comment'.
* @param array $object_ids Array of object IDs. * @param array $object_ids Array of object IDs.
* @return bool|WP_Error True on success, WP_Error on failure. * @return bool|WP_Error True on success, WP_Error on failure.
*/ */
@ -93,21 +97,22 @@ class WP_Metadata_Lazyloader {
add_filter( $type_settings['filter'], $type_settings['callback'] ); add_filter( $type_settings['filter'], $type_settings['callback'] );
/** /**
* Fires after objects are added to the metadata lazyload queue. * Fires after objects are added to the metadata lazy-load queue.
* *
* @since 4.5.0 * @since 4.5.0
* *
* @param array $object_ids Object IDs. * @param array $object_ids Object IDs.
* @param string $object_type Type of object being queued. * @param string $object_type Type of object being queued.
* @param WP_Metadata_Lazyloader $lazyloader The lazyloader object. * @param WP_Metadata_Lazyloader $lazyloader The lazy-loader object.
*/ */
do_action( 'metadata_lazyloader_queued_objects', $object_ids, $object_type, $this ); do_action( 'metadata_lazyloader_queued_objects', $object_ids, $object_type, $this );
} }
/** /**
* Reset lazyload queue for a given object type. * Resets lazy-load queue for a given object type.
* *
* @since 4.5.0 * @since 4.5.0
* @access public
* *
* @param string $object_type Object type. Accepts 'comment' or 'term'. * @param string $object_type Object type. Accepts 'comment' or 'term'.
* @return bool|WP_Error True on success, WP_Error on failure. * @return bool|WP_Error True on success, WP_Error on failure.
@ -124,7 +129,7 @@ class WP_Metadata_Lazyloader {
} }
/** /**
* Lazyloads term meta for queued terms. * Lazy-loads term meta for queued terms.
* *
* This method is public so that it can be used as a filter callback. As a rule, there * This method is public so that it can be used as a filter callback. As a rule, there
* is no need to invoke it directly. * is no need to invoke it directly.
@ -148,7 +153,7 @@ class WP_Metadata_Lazyloader {
} }
/** /**
* Lazyload comment meta for queued comments. * Lazy-loads comment meta for queued comments.
* *
* This method is public so that it can be used as a filter callback. As a rule, there is no need to invoke it * This method is public so that it can be used as a filter callback. As a rule, there is no need to invoke it
* directly, from either inside or outside the `WP_Query` object. * directly, from either inside or outside the `WP_Query` object.