In this blog, we’ll explore how to expand the Schema.org Metatags module step-by-step. This will allow us to customize and use the module to meet specific needs that aren’t covered by its default settings.<\/p>\n
For an introduction to using the Schema.org module, you can refer to our previous blog “Boost Your Drupal Site\u2019s Visibility with Schema Markup<\/strong><\/a>“. This will provide a foundational understanding of how to implement Schema.org markup effectively.<\/p>\n To start implementing, it’s important to understand why creating custom fields in the Drupal Schema.org Metatags module is necessary. The module comes with predefined schemas containing default fields and properties for specific types of schema. However, there are often cases where additional fields are needed that aren’t available in the module’s default schemas. In such situations, custom fields allow us to add the required metadata to existing schema groups, ensuring our content meets both Schema.org standards and specific project needs.<\/p>\n Let’s start creating and adding custom fields in Drupal’s Schema.org Metatags module.<\/p>\n To proceed with the implementation, ensure the following prerequisites are met:<\/p>\n Before starting the implementation, review the current snapshot of the organizational schema without any custom fields incorporated:<\/p>\n Organization Schema without custom field<\/p><\/div>\n To define your custom meta tag, create a PHP class in your custom module under the directory custom_module\/src\/Plugin\/metatag\/Tag.<\/p>\n Custom field folder structure<\/p><\/div>\n <\/li>\n Note: Here we have used schema_organization as a group, any other group can be used according to the requirement.<\/li>\n<\/ul>\n To make your new meta tag available, declare it in your module’s configuration.<\/p>\n config file folder structure<\/p><\/div>\n <\/li>\n<\/ul>\n Custom Field Addition to the Organization type schema<\/p><\/div><\/li>\n Custom Field Addition<\/p><\/div><\/li>\n<\/ul>\n Conclusion<\/b><\/p>\n Following these steps, you’ve successfully extended the schema_metatag module to include a custom meta tag within your existing Drupal module. This approach can be tailored for various types of metadata, enhancing your Drupal site’s SEO and metadata management. For more information on the schema metatag Drupal module, you may also refer to the official documentation<\/a> of the module.<\/p>\n","protected":false},"excerpt":{"rendered":" Introduction Schema.org is a system designed to enhance how search engines interpret your website’s content. The Schema.org Metatags module in Drupal simplifies the process of incorporating this information, thereby improving your site’s search engine rankings and increasing the likelihood of displaying rich, informative snippets in search results. In this blog, we’ll explore how to expand […]<\/p>\n","protected":false},"author":1637,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":581},"categories":[3602],"tags":[4862,5253,5152,2003,5994,404],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/62312"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1637"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=62312"}],"version-history":[{"count":15,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/62312\/revisions"}],"predecessor-version":[{"id":62657,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/62312\/revisions\/62657"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=62312"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=62312"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=62312"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Use Case<\/h2>\n
Implement Custom Fields in Drupal’s Schema.org Metatags<\/h2>\n
Prerequisites<\/h3>\n
\n
![\"Schema](\"https:\/\/www.tothenew.com\/blog\/wp-ttn-blog\/uploads\/2024\/06\/Screenshot-from-2024-06-13-14-05-43.png\")
\nStep 1: Define the Meta Tag Plugin<\/b><\/h3>\n\n
![\"Folder](\"https:\/\/www.tothenew.com\/blog\/wp-ttn-blog\/uploads\/2024\/06\/Screenshot-from-2024-06-13-14-51-42.png\")
<?php\r\n\r\nnamespace Drupal\\custom_module\\Plugin\\metatag\\Tag;\r\n\r\nuse Drupal\\schema_metatag\\Plugin\\metatag\\Tag\\SchemaNameBase;\r\n\r\n\/**\r\n* Provides a plugin for the 'custom_field' meta tag.\r\n*\r\n* @MetatagTag(\r\n* id = \"custom_field\",\r\n* label = @Translation(\"Custom Field\"),\r\n* description = @Translation(\"A custom field for demo purposes.\"),\r\n* name = \"custom_field\",\r\n* group = \"schema_organization\",\r\n* weight = 1,\r\n* type = \"string\",\r\n* secure = FALSE,\r\n* multiple = FALSE,\r\n* property_type = \"text\",\r\n* tree_parent = {},\r\n* tree_depth = -1,\r\n* )\r\n*\/\r\nclass CustomField extends SchemaNameBase {\r\n}<\/pre>\nStep 2: Declare the Field in Configuration<\/b><\/h3>\n
\n
![\"config](\"https:\/\/www.tothenew.com\/blog\/wp-ttn-blog\/uploads\/2024\/06\/Screenshot-from-2024-06-13-16-12-06.png\")
\n
# The 'type' should be \"label\" for short meta tags and \"text\" for ones which\r\n# could get longer, especially ones which use a textarea field instead of a\r\n# textfield.\r\nmetatag.metatag_tag.custom_field:\r\ntype: string\r\nlabel: 'Custom Field'<\/pre>\n<\/div>\n<\/li>\n<\/ul>\n
\n
Step 3: Test your custom field<\/b><\/h3>\n
\n
![\"Custom](\"https:\/\/www.tothenew.com\/blog\/wp-ttn-blog\/uploads\/2024\/06\/Screenshot-from-2024-06-13-16-26-52.png\")
![\"Custom](\"https:\/\/www.tothenew.com\/blog\/wp-ttn-blog\/uploads\/2024\/06\/Screenshot-from-2024-06-13-14-03-35.png\")