twentytwenty_get_post_meta( int $post_id = null, string $location = 'single-top' ): string|void

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_idintoptional

The ID of the post.Default: null

$locationstringoptional

The location where the meta is shown.Default: 'single-top'

Return value

string|void

Post meta HTML.

Performance profile

How much work a call to twentytwenty_get_post_meta() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

22–228

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 244.

Plugin surface

5 hooks

Third-party callbacks on 'twentytwenty_disallowed_post_types_for_meta_output', 'twentytwenty_post_meta_location_single_top', 'twentytwenty_post_meta_location_single_bottom' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below twentytwenty_get_post_meta()
• serializeserialisationmaybe_unserialize()one call below twentytwenty_get_post_meta()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 812 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost twentytwenty_get_post_meta() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 5

5 hooks fire while twentytwenty_get_post_meta() runs, in this order:

1. 1
   apply_filters( twentytwenty_disallowed_post_types_for_meta_output )filterline 271 (+17 into the body)

   Filters post types array.

2. 2
   apply_filters( twentytwenty_post_meta_location_single_top )filterline 297 (+43 into the body)

   Filters post meta info visibility.

3. 3
   apply_filters( twentytwenty_post_meta_location_single_bottom )filterline 322 (+68 into the body)

   Filters post tags visibility.

4. 4
   do_action( twentytwenty_start_of_post_meta_list )actionline 365 (+111 into the body)

   Fires before post meta HTML display.

5. 5
   do_action( twentytwenty_end_of_post_meta_list )actionline 512 (+258 into the body)

   Fires after post meta HTML display.

Uses · 28

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_post_type()Retrieves the post type of the current post or of a given post.
• get_post()Retrieves post data given a post ID or post object.
• setup_postdata()Set up global post data.
• esc_attr()Escaping for HTML attributes.
• do_action()Calls the callback functions that have been added to an action hook.
• post_type_supports()Checks a post type's support for a given feature.
• _e()Displays translated text.
• twentytwenty_the_theme_svg()Outputs the SVG markup for an icon in the TwentyTwenty_SVG_Icons class.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• get_author_posts_url()Retrieves the URL to the author page for the user with the ID provided.

Used by · 1

• twentytwenty_the_post_meta()Retrieves and displays the post meta.

Source code

View on Trac ↗View on GitHub ↗

254function twentytwenty_get_post_meta( $post_id = null, $location = 'single-top' ) {255 256	// Require post ID.257	if ( ! $post_id ) {258		return;259	}260 261	/**262	 * Filters post types array.263	 *264	 * This filter can be used to hide post meta information of post, page or custom post type265	 * registered by child themes or plugins.266	 *267	 * @since Twenty Twenty 1.0268	 *269	 * @param array $post_types Array of post types.270	 */271	$disallowed_post_types = apply_filters( 'twentytwenty_disallowed_post_types_for_meta_output', array( 'page' ) );272 273	// Check whether the post type is allowed to output post meta.274	if ( in_array( get_post_type( $post_id ), $disallowed_post_types, true ) ) {275		return;276	}277 278	$post_meta_wrapper_classes = '';279	$post_meta_classes         = '';280 281	// Get the post meta settings for the location specified.282	if ( 'single-top' === $location ) {283		/**284		 * Filters post meta info visibility.285		 *286		 * Use this filter to hide post meta information like Author, Post date, Comments, Is sticky status.287		 *288		 * @since Twenty Twenty 1.0289		 *290		 * @param array $args {291		 *     @type string $author292		 *     @type string $post-date293		 *     @type string $comments294		 *     @type string $sticky295		 * }296		 */297		$post_meta = apply_filters(298			'twentytwenty_post_meta_location_single_top',299			array(300				'author',301				'post-date',302				'comments',303				'sticky',304			)305		);306 307		$post_meta_wrapper_classes = ' post-meta-single post-meta-single-top';308 309	} elseif ( 'single-bottom' === $location ) {310 311		/**312		 * Filters post tags visibility.313		 *314		 * Use this filter to hide post tags.315		 *316		 * @since Twenty Twenty 1.0317		 *318		 * @param array $args {319		 *     @type string $tags320		 * }321		 */322		$post_meta = apply_filters(323			'twentytwenty_post_meta_location_single_bottom',324			array(325				'tags',326			)327		);328 329		$post_meta_wrapper_classes = ' post-meta-single post-meta-single-bottom';330 331	}332 333	// If the post meta setting has the value 'empty', it's explicitly empty and the default post meta shouldn't be output.

Changelog

Introduced in Twenty Twenty 1.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-content/themes/twentytwenty/inc/template-tags.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.