Support » Theme: Twenty Twenty » Filtering meta on CPT

  • Resolved Pawel Slabiak

    (@pawelslabiak)


    One of the Twenty Twenty template tags defined in template-tags.php is a filter that controls which post types ought to omit the display of associated meta.

    Starting on line 235:

    	/**
    	 * Filters post types array
    	 *
    	 * This filter can be used to hide post meta information of post, page or custom post type registerd by child themes or plugins
    	 *
    	 * @since Twenty Twenty 1.0
    	 *
    	 * @param array Array of post types
    	 */
    	$disallowed_post_types = apply_filters( 'twentytwenty_disallowed_post_types_for_meta_output', array( 'page' ) );
    	// Check whether the post type is allowed to output post meta.
    	if ( in_array( get_post_type( $post_id ), $disallowed_post_types, true ) ) {
    		return;
    	}
    
    	$post_meta_wrapper_classes = '';
    	$post_meta_classes         = '';
    

    But how to use this filter?

    Let’s say I have registered a custom post type called ‘qualia’ and would like to use this filter to prevent meta from displaying. I can add ‘qualia’ to the array in the filter definition, like so:

    $disallowed_post_types = apply_filters( 'twentytwenty_disallowed_post_types_for_meta_output', array( 'page', 'qualia' ) );

    This is effective but seems wrong because the next theme update will overwrite template-tags.php.

    My question is, how to make use of this filter in the child theme? Where to place the filter and how to correctly pass ‘qualia’ to it?

    The page I need help with: [log in to see the link]

Viewing 7 replies - 1 through 7 (of 7 total)
  • stilman davis

    (@stilman-davis)

    In your child theme folder, copy the inc folder from the parent theme. Make your changes there and it should be preserved if there is an upgrade. That is how I understand to keep changes in the child theme.

    Pawel Slabiak

    (@pawelslabiak)

    Thank you, @stilman-davis—I neglected to say in the original post that copying the inc folder (and the template-tags.php file it contains) to the child theme and adding an element to the array in the filter definition has no effect on the meta display.

    Two things are clear: 1. modifying the array in the filter definition in the parent theme does work and 2. these changes will be lost when the theme updates.

    Therefore, it seems that the proper use of the filter is to hook into it from a child-theme location (e.g. functions.php or a template or a template part) or from a plugin and pass a custom post type to its array, which in the original definition has only one element, ‘page’.

    But I don’t yet know how to do so.

    Pawel Slabiak

    (@pawelslabiak)

    My understanding of the code lines referenced in the original post is that
    the first argument of apply_filters() creates a filter hook.

    Hence, twentytwenty_disallowed_post_types_for_meta_output is a filter hook.

    The apply_filters() function creates an array of disallowed post types and stores the array in $disallowed_post_types, I think.

    To add additional post types, such as my registered custom post type called ‘qualia’, it seems one should be able to use a custom function hooked into the filter hook, like so:

    function be_my_function($disallowed_post_types) {
    $disallowed_post_types[] = 'qualia'; // add 'qualia' to the array
    return $disallowed_post_types;
    }
    add_filter('twentytwenty_disallowed_post_types_for_meta_output', 'be_my_function');

    The above code has no effect when placed in the child theme’s functions.php. The code is likely wrong or in the wrong file, or both.

    Any hints or tips on whether this is the right direction or how to correctly use the filter would be appreciated. This would be useful for all kinds of custom post types where displaying meta does not make much sense.

    stilman davis

    (@stilman-davis)

    I had not realised that the inc does not work like the template-parts folder. I had a look around and came across this page
    http://wp101.net/support/topic/include-files-child-theme/
    where the plugin author wrote:
    “template-tags.php is called directly from functions.php so you can not override it. BUT you can override each and every function inside template-tags.php.”

    Does this help?

    Pawel Slabiak

    (@pawelslabiak)

    Thank you, @stilman-davis. In the thread you reference, the advice seems to be to modify functions directly in template-tags.php (if I’m reading correctly). Doing so definitely works but also seems to be a sure way to lose changes whenever the theme updates.

    My question here is motivated by the assumption that modifying template-tags.php in the parent theme is not a sustainable way to use a filter defined therein. Any help in understanding how to correctly use the filter from the child theme or explanation of why doing so is impossible would be welcome.

    stilman davis

    (@stilman-davis)

    No, I think you need to place your template-tags.php changes in the functions.php of your child theme.

    In that thread the fellow wrote “template-tags.php is called directly from functions.php so you can not override it. BUT you can override each and every function inside template-tags.php.”

    I read this as overriding the functions in the template-tags.php Inn other words placing your new code (which you placed in template-tags.php) in the functions.php file. I imagine this overriding is like overriding a css declaration. Because it is closer to the function, it is implemented.

    At least that is how I read it. That means you keep your changes when there is any update of the theme. Does this work for you?

    Thanks again, @stilman-davis.
    The code I describe in a previous post in this thread actually does work when placed in functions.php.

    I have no idea why the code did not work for me when I first wrote it. Perhaps a typo snuck in.

    I only realized this after using other methods for blocking meta output (like CSS or the ‘twentytwenty_post_meta_location_single_top’ hook) and not liking them in the end, even though they worked.

    So I looked at the template-tags.php again and wrote the bit below into functions.php in the child theme. Works perfectly.

    function bemy_cpt_without_meta_output($disallowed_post_types) {
    	$disallowed_post_types[] = 'qualia';
    	return $disallowed_post_types;
    } //do not output meta on custom posts of type 'qualia'
    add_filter( 'twentytwenty_disallowed_post_types_for_meta_output', 'bemy_cpt_without_meta_output' );

    Apart from the arbitrary name of the callback function, this seems to be identical to what I had written before to seemingly no effect. ¯\_(ツ)_/¯

Viewing 7 replies - 1 through 7 (of 7 total)
  • You must be logged in to reply to this topic.