We advise against using the API unless you fully understand what the code does and implies and if you’re willing to check up on changes every major release. Use the options instead, or submit a feature request if you can’t find what you need.
The SEO Framework
The SEO Framework (TSF) is extensible, interpretable, and adjustable.
PHP API
The main facade object, accessible via tsf()*, can be accessed on or after actions the_seo_framework_admin_loaded and the_seo_framework_loaded. Those actions invoke on WordPress’s action plugins_loaded priority 5. You should never call the tsf() object before those actions.
* Before TSF v4.2.0, only tsf()‘s alias the_seo_framework() is available.
You can find examples on how to utilize this object at our filter reference guide. Our API resources are:
JS API
The JavaScript code brought with TSF does not have public API documentation because we have never received implementation requests. Please refer to the code, which is fully documented.
The Extension Manager
The Extension Manager is the epitome of extending TSF. It is why we must keep TSF’s API vast, open, and reliable.
PHP API
In the Extension Manager, the filters are used for debugging, and the actions are implemented for internal purposes only.
JS API
The JavaScript code delivered by the Extension Manager does not provide an API available to third parties.
Extension API
Some extensions in the Extension Manager have specific API functionality.