sybrew
commented
4 months ago We currently have no intention to expose TSF's data for display other than aimed at search engines. The breadcrumbs shortcode was postponed by a few years for this reason.
Bricks's Dynamic Data could interpret existing meta fields, for example, via {term_meta:my_term_meta_key}. However, because we use a key-value store, the data we store is an array. So, you cannot call {term_meta:autodescription-term-settings}, for you'll get an array-to-string conversion error.
For now, the same doesn't apply to TSF's post metadata (their documentation doesn't say how to access post meta). But I'm planning to convert this data to a key-value store as well: https://github.com/sybrew/the-seo-framework/issues/185. Bricks does have something to access array values; however, it is unclear to me if this could be applied to what we currently offer.
I think if we were to implement this, we'd indeed need to create custom dynamic data. Here's an example (untested, based on their documentation):
add_filter(
'bricks/dynamic_tags_list',
/**
* @param array $tags
*/
function ( $tags ) {
$tags[] = [
'name' => '{tsf_post_meta}',
'label' => 'The SEO Framework post metadata',
'group' => 'The SEO Framework',
];
return $tags;
},
);
add_filter(
'bricks/dynamic_data/render_tag',
/**
* @param string $tag
* @param WP_Post $post
*/
function ( $tag, $post ) {
if ( ! str_starts_with( $tag, 'tsf_post_meta:' ) )
return $tag;
if ( ! function_exists( 'tsf' ) )
return '';
$tag_parts = explode( ':', $tag );
switch ( $tag_parts[1] ?? '' ) {
case 'title':
return tsf()->get_title( [ 'id' => $tag_parts[2] ?? $post->ID ] );
case 'description':
return tsf()->get_description( [ 'id' => $tag_parts[2] ?? $post->ID ] );
case 'canonical_url':
return tsf()->get_canonical_url( [ 'id' => $tag_parts[2] ?? $post->ID ] );
}
return '';
},
10,
2,
);With that, here's how you get the title for post ID 42:
{tsf_post_meta:title:42}You can also omit the :42 part to get it for the current page. For example, here's how to get the description for the current page:
{tsf_post_meta:description}I hope this helps :)
datgausaigon
touchdowntech
I currently use Bricks Builder and The SEO Framework (TSF) for many of my Websites. Bricks Builder, TFS both have very good api support and documentation.
Therefore, I have no difficulty creating Dynamic Data (DD) links between Bricks Builder and TFS.
One of the DDs I find very necessary and use is to call The social image URL (_social_image_url), The social image ID (_social_image_id). My Post/Page/CPT will have the Featured Image as a square and the Social Image as a horizontal rectangle. It will be very convenient for me to reuse Social Image for display on PC, Desktop, Featured Image for Mobile, or somewhere it will be Social Image or Featured Image in a flexible way.
I created this Feature Request to ask for your feedback on Bricks Builder Dynamic Data (DD) for TSF? It is very useful. Like my Social Image DD as an example.
https://kb.theseoframework.com/kb/data-stored-in-your-database/
https://academy.bricksbuilder.io/article/dynamic-data/
https://academy.bricksbuilder.io/article/create-your-own-dynamic-data-tag/
Thanks 🐻