Ref #2012 – Update skipping get_post_meta() to match behavior in 2.0 by gchtr · Pull Request #2014 · timber/timber

gchtr · 2019-05-30T19:40:00Z

Ticket: #2012

Issue

In #2012 @aj-adl proposed a way to skip Timber from fetching meta values through get_post_meta() via the timber_post_get_meta_pre filter. Turns out that in 2.x, I added pretty much the same behavior, just with a new filter:

timber/lib/Post.php

Lines 574 to 624 in 35279e5

    
           	protected function get_meta_values( $post_id ) { 
        
           		$post_meta = array(); 
        
           		/** 
        
           		 * Filters post meta data before it is fetched from the database. 
        
           		 * 
        
           		 * Timber loads all meta values into the post object on initialization. With this filter, 
        
           		 * you can disable fetching the meta values through the default method, which uses 
        
           		 * `get_post_meta()`, by returning `false` or an non-empty array. 
        
           		 * 
        
           		 * @example 
        
           		 * ```php 
        
           		 * // Disable fetching meta values. 
        
           		 * add_filter( 'timber/post/pre_get_meta_values', '__return_false' ); 
        
           		 * 
        
           		 * // Add your own meta data. 
        
           		 * add_filter( 'timber/post/pre_get_meta_values', function( $post_meta, $post_id, $post ) { 
        
               	 *     $post_meta = array( 
        
           		 *         'custom_data_1' => 73, 
        
           		 *         'custom_data_2' => 274, 
        
           		 *     ); 
        
           		 * 
        
           		 *     return $post_meta; 
        
           		 * }, 10, 3 ); 
        
           		 * ``` 
        
           		 * @since 2.0.0 
        
           		 * 
        
           		 * @param array        $post_meta An array of custom meta values. Passing false or a non-empty 
        
           		 *                                array will skip fetching the values from the database and 
        
           		 *                                will use the filtered values instead. Default `array()`. 
        
           		 * @param int          $post_id   The post ID. 
        
           		 * @param \Timber\Post $post      The post object. 
        
           		 */ 
        
           		$post_meta = apply_filters( 'timber/post/pre_get_meta_values', $post_meta, $post_id, $this ); 
        
           		/** 
        
           		 * Filters post meta data before it is fetched from the database. 
        
           		 * 
        
           		 * @deprecated 2.0.0, use `timber/post/pre_get_meta_values` 
        
           		 */ 
        
           		do_action_deprecated( 
        
           			'timber_post_get_meta_pre', 
        
           			array( $post_meta, $post_id, $this ), 
        
           			'2.0.0', 
        
           			'timber/post/pre_get_meta_values' 
        
           		); 
        
           		// Load all meta data when it wasn’t filtered before. 
        
           		if ( false !== $post_meta && empty( $post_meta ) ) { 
        
           			$post_meta = get_post_meta( $post_id ); 
        
           		}

I wasn’t sure whether this was over-optimization, but hey, here we have a use case already 😎.

Solution

This pull request builds on #2012 to replicate the behavior that we’re going to add in 2.0 in the master branch so that this feature can be used now.

Impact

None.

Usage Changes

See #2012.

Considerations

None.

Testing

None.

- Allow the user to stop eager loading by returning `null` or `false` via timber_post_get_meta_pre filter. - Allow the user to choose what to eager load by returning an array of k/v meta

- Test for 'short circuit' where no meta should be eager loaded - Test for custom list of eager-loaded post meta

codecov · 2019-05-30T20:01:34Z

Codecov Report

Merging #2014 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #2014      +/-   ##
============================================
+ Coverage     94.98%   94.99%   +<.01%     
- Complexity     1566     1567       +1     
============================================
  Files            49       49              
  Lines          3692     3694       +2     
============================================
+ Hits           3507     3509       +2     
  Misses          185      185

Impacted Files	Coverage Δ	Complexity Δ
lib/Post.php	`95.68% <100%> (+0.01%)`	`246 <0> (+1)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6f3ccaf...3744e6a. Read the comment docs.

jarednova

Yup, this seems to do it! Just 🤞 that we're not gonna see a big merge conflict here with 2.0

jarednova · 2019-05-31T01:27:03Z

Thanks @aj-adl and @gchtr — I added a note to the readme so this can go out with all the info in the next version

aj-adl and others added 3 commits May 24, 2019 11:44

Changes to \Timber\Post::get_post_custom() and meta behaviour

3463b0d

- Allow the user to stop eager loading by returning `null` or `false` via timber_post_get_meta_pre filter. - Allow the user to choose what to eager load by returning an array of k/v meta

Add tests for modifying the eager-loaded post meta

0ef9f04

- Test for 'short circuit' where no meta should be eager loaded - Test for custom list of eager-loaded post meta

Ref #2012 – Update skipping get_post_meta() to match behavior in 2.0

bb2613b

gchtr requested review from jarednova and palmiak as code owners May 30, 2019 19:40

Merge branch 'master' into pr/2012

b49d1cb

gchtr mentioned this pull request May 30, 2019

Conditional eager-loading of post meta values #2012

Closed

jarednova previously approved these changes May 30, 2019

View reviewed changes

jarednova and others added 2 commits May 30, 2019 19:44

Merge branch 'master' into pr/2012

27f448c

tiny tiny spacing fix

ee5dd44

jarednova dismissed their stale review via ee5dd44 May 31, 2019 00:02

Update the readme!

3744e6a

jarednova approved these changes May 31, 2019

View reviewed changes

jarednova merged commit 2e0418c into master May 31, 2019

jarednova deleted the pr/2012 branch May 31, 2019 01:26

jarednova mentioned this pull request May 31, 2019

Allow timber_post_get_meta_pre filter to short circuit or alter Timber\Post::get_post_custom() #2011

Closed

gchtr mentioned this pull request May 31, 2019

Streamline get_meta_values functions across objects #2019

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ref #2012 – Update skipping get_post_meta() to match behavior in 2.0#2014

Ref #2012 – Update skipping get_post_meta() to match behavior in 2.0#2014
jarednova merged 7 commits intomasterfrom
pr/2012

gchtr commented May 30, 2019

Uh oh!

codecov bot commented May 30, 2019 •

edited

Loading

Uh oh!

jarednova left a comment

Uh oh!

jarednova commented May 31, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	protected function get_meta_values( $post_id ) {
	$post_meta = array();

	/**
	* Filters post meta data before it is fetched from the database.
	*
	* Timber loads all meta values into the post object on initialization. With this filter,
	* you can disable fetching the meta values through the default method, which uses
	* `get_post_meta()`, by returning `false` or an non-empty array.
	*
	* @example
	* ```php
	* // Disable fetching meta values.
	* add_filter( 'timber/post/pre_get_meta_values', '__return_false' );
	*
	* // Add your own meta data.
	* add_filter( 'timber/post/pre_get_meta_values', function( $post_meta, $post_id, $post ) {
	* $post_meta = array(
	* 'custom_data_1' => 73,
	* 'custom_data_2' => 274,
	* );
	*
	* return $post_meta;
	* }, 10, 3 );
	* ```
	* @since 2.0.0
	*
	* @param array $post_meta An array of custom meta values. Passing false or a non-empty
	* array will skip fetching the values from the database and
	* will use the filtered values instead. Default `array()`.
	* @param int $post_id The post ID.
	* @param \Timber\Post $post The post object.
	*/
	$post_meta = apply_filters( 'timber/post/pre_get_meta_values', $post_meta, $post_id, $this );

	/**
	* Filters post meta data before it is fetched from the database.
	*
	* @deprecated 2.0.0, use `timber/post/pre_get_meta_values`
	*/
	do_action_deprecated(
	'timber_post_get_meta_pre',
	array( $post_meta, $post_id, $this ),
	'2.0.0',
	'timber/post/pre_get_meta_values'
	);

	// Load all meta data when it wasn’t filtered before.
	if ( false !== $post_meta && empty( $post_meta ) ) {
	$post_meta = get_post_meta( $post_id );
	}

Uh oh!

Conversation

gchtr commented May 30, 2019

Issue

Solution

Impact

Usage Changes

Considerations

Testing

Uh oh!

codecov bot commented May 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jarednova left a comment

Choose a reason for hiding this comment

Uh oh!

jarednova commented May 31, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented May 30, 2019 •

edited

Loading