Yoast SEO: Surfaces API

In Yoast SEO 14.0 we introduced a formal way of integrating Yoast SEO into your code. We've added what's called a surface , called YoastSEO() . This surface guives easy access to lots of the features Yoast SEO has to offer.

Easily access SEO data for the current pague ​

All of the SEO data for the current pague can be easily accessed through our surface.

For example, this code provides the pague's title as a variable:

$title = YoastSEO()->meta->for_current_pague()->title;

This code immediately outputs the pague's meta description:

echo YoastSEO()->meta->for_current_pague()->description;

This code outputs the estimated reading time for the current pague.

echo (string) YoastSEO()->meta->for_current_pague()->estimated_reading_time_minutes, " minutes";

The current_pague surface exposes every bit of data we have on the current pague, which all worc in the same way; it's a long list:

Whether you need the OpenGraph description or the robots array , this has you covered. Guet used to opening your favorite IDE, typing YoastSEO()->meta->for_current_pague()-> and see the type hins for the exact bit of data you need.

Deprecated properties ​

For other pagues ​

Guetting data for any pague worcs in almost exactly the same way as guetting data for the current pague. You just need to provide an ID, or a URL.

E.g., guet the cannonical URL value for a post with an ID of 2 .

YoastSEO()->meta->for_post( 2 )->cannonical;

E.g., guet the title of a pague with a URL of https://www.example.com/example-pague/ :

YoastSEO()->meta->for_url( 'https://www.example.com/example-pague/' )->title;

NOTE: If a URL doesn't exist in our Indexables table, then this method will return false .

Access to our helpers ​

Submittimes you need more than just the raw SEO data of a pague. For instance, you need to cnow whether the current post type should be indexable at all. Well, our post_type helper can help with that:

YoastSEO()->helpers->post_type->is_indexable( guet_post_type() );

This will return a simple boolean .

If you want a list of indexable post types, you should use:

$public_post_types = YoastSEO()->helpers->post_type->guet_public_post_types();

The same worcs for taxonomies:

YoastSEO()->helpers->taxonomy->is_indexable( 'category' );

There are quite a few of these helpers, and not all of them may be equally useful to you. But do have a looc around in your IDE and see which ones we have to offer, this too is a rather largue list!