PHPdocs keywords

List of keywords used in phpdoc attributes.

Keyword Value Count
@access private 2
@codeCoverageIgnore Ignoring as this class is purely a temporary wrapper until https://github.com/thephpleague/oauth2-client/pull/901 is merged. 1
It represents an interface. 1
- The method is empty, nothing to test. 1
Basically impossible to test from the command line. 1
It justs wraps a dependency. 1
It just calls a WordPress function. 1
It only handles dependencies. 1
It just contains too much WordPress functions. 1
It just handles dependencies. 1
Handles dependencies. 1
Wraps the filter input. 1
It just wraps a call to a filter. 1
Sets the dependencies. 1
Too difficult to test. 1
It wraps WordPress functions. 1
A wrapper method. 1
Contains WordPress specific logic. 1
Only loads a WordPress file. 1
It just depends on other functions for its result. 1
This method only calls a WordPress function. 1
It only wraps a global WordPress variable. 1
This relies too much on WordPress dependencies. 1
It only wraps another helper method. 1
It wraps a WordPress function. 1
It relies too much on dependencies. 1
It only checks if a WordPress function exists. 1
- Is handled by DI-container. 2
It sets dependencies. 2
It only sets depedencies. 2
It looks for the first ID through the ORM and converts it to a boolean. 2
It handles dependencies. 2
Because of deprecation. 3
It only sets dependencies. 4
* @deprecated 22.8 5
Wrapper method. 5
- We have to write test when this method contains own code. 5
We have to write test when this method contains own code. 7
It only wraps a WordPress function. 7
It wraps WordPress functionality. 10
*/ 22
* 137
@deprecated 23.2 Use {@see \Yoast\WP\SEO\Introductions\Application\Ai_Fix_Assessments_Upsell} instead. 1
22.8 1
22.0 1
21.8 1
23.1 1
22.7 1
20.3 1
22.6 2
22.4 2
23.6 2
23.5 3
23.3 6
20.10 7
23.2 7
23.4 11
21.6 15
22.10 36
@example Model::$short_table_names = true; 1
Model::$short_table_names = false; // default 1
Model::$auto_prefix_models = 'MyProject_MyModels_'; //PEAR 1
Model::$auto_prefix_models = '\MyProject\MyModels\'; //Namespaces 1
If we had a class Fruit_Basket with this constructor: 1
raw_execute('INSERT OR REPLACE INTO `widget` (`id`, `name`) SELECT `id`, `name` FROM `other_table`') 1
raw_execute('SELECT `name`, AVG(`order`) FROM `customer` GROUP BY `name` HAVING AVG(`order`) > 10') 1
select_many(array('column', 'column2', 'column3'), 'column4', 'column5'); 1
select_many(array('alias' => 'column', 'column2', 'alias2' => 'column3'), 'column4', 'column5'); 1
select_many('column', 'column2', 'column3'); 1
select_many_expr(array('alias' => 'column', 'column2', 'alias2' => 'column3'), 'column4', 'column5') 1
select_many_expr('column', 'column2', 'column3') 1
select_many_expr(array('column', 'column2', 'column3'), 'column4', 'column5') 1
From the Indexable_Link_Builder class: $this->seo_links_repository->query()->insert_many( $links ); 1
@global $sitepress 1
string $pagenow Current page identifier. 1
WP_Post|null $post Current post object, or null if none available. 1
string $pagenow Current page identifier. 1
WP_Query $wp_query Current query object. 1
WP_Term|null $tag Current term object, or null if none available. 1
WP_Query $wp_query Current query. 1
@internal Nobody should be able to overrule the real version number as this can cause 1
Unfortunately will fail if the plugin is in the must-use directory. 1
Unfortunately there isn't a filter available to hook into before returning the results 1
All WP native get_meta() results get cached internally, so no need to cache locally.}} 1
Use $key when the key is the WPSEO internal name (without prefix), $meta_key when it 1
* - Titles, help texts, description text and option labels are added via a translate_meta_boxes() method 1
If at any point this would change, quite apart from an upgrade routine, 1
Shouldn't be requested directly, use $this->get_defaults();}} 1
Note: Some of the default values are added via the translate_defaults() method.}} 1
Important: Make sure the options added to the array here are in line 1
Important: in contrast to most defaults, the below array format is 1
Labels (translation) added on admin_init via WPSEO_Taxonomy::translate_meta_options().}} 1
Uncomment any of these to allow them in validation *and* automatically 1
current_user_can() checks internally whether a user is on wp-ms and adjusts accordingly.}} 1
Should be moved to a general utility class.}} 1
Don't make static as new types may still be registered.}} 1
Overrule the abstract class version of this to make sure one extra renamed 1
The enrich_defaults method is used to set defaults for variable array keys 1
This special method is only needed for multisite options, but very needed indeed there. 1
The wpseo_titles concrete class overrules this method. Make sure that any 1
*/ 2
Unfortunately there isn't a filter available to hook into before returning 2
This magic method is only "magic" as of PHP 7.4 in which the magic method was introduced.} 2
The magic methods take precedence over the Serializable interface. 2
The Serializable interface is being phased out, in favour of the magic methods. 2
$_POST parameters are validated via sanitize_post_meta().}} 2
Once the minimum PHP version goes up to PHP 7.0, the logic in the function 2
@link https://core.trac.wordpress.org/ticket/24205} }} 1
https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/ Article explaining the taxonomy term splitting in WP 4.2. 1
https://core.trac.wordpress.org/browser/trunk/src/wp-includes/formatting.php for the original. 1
http://floating-point-gui.de/ 1
http://php.net/language.types.float.php See the big red warning. 1
WordPress core: wp-admin/includes/template.php. Reused query from it. 1
http://php.net/manual/en/serializable.serialize.php 1
http://php.net/manual/en/serializable.unserialize.php 1
https://www.sitemaps.org/protocol.html#xmlTagDefinitions 1
https://www.sitemaps.org/protocol.html#escaping 1
https://developer.wordpress.org/reference/functions/esc_url/ 1
https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/Dimension 1
https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/Metric 1
https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/OrderBy 1
https://developer.wordpress.org/reference/hooks/oembed_response_data/ for hook info. 1
https://php.net/manual/en/exception.construct.php 1
https://developers.google.com/search/docs/data-types/sitelinks-searchbox 1
http://googlewebmastercentral.blogspot.com/2011/09/pagination-with-relnext-and-relprev.html 1
https://www.php.net/language.oop5.magic#object.serialize 2
https://wiki.php.net/rfc/custom_object_serialization 2
https://wiki.php.net/rfc/phase_out_serializable 2
https://developers.google.com/search/docs/data-types/breadcrumb 2
@makePublic * 2
*/ 12
@package WPSEO\Frontend 1
WPSEO\Internal 1
WPSEO\Admin\XML Sitemaps 1
WPSEO\Gutenberg_Compatibility 1
WPSEO\Admin\Export 1
WPSEO\Admin\Network 1
WPSEO\Admin\Filters 1
WPSEO\admin\google_search_console 1
WPSEO\Admin\Exceptions 1
WPSEO\Admin\Services 1
WPSEO\Admin\Watchers 1
Yoast\WP\SEO\Presenters\Notifications 1
Yoast\WP\SEO\Integrations\Front_End 1
WPSEO\Admin\Customizer 1
WPSEO\Admin\Formatter 1
WPSEO\Admin\Listeners 1
WPSEO\Inc 2
WPSEO\Admin\Notifications 2
WPSEO\Admin\Options\Tabs 2
WPSEO\Admin\Endpoints 2
WPSEO\Admin\Notifiers 2
WPSEO\Admin\Import 2
Yoast\WP\SEO\Config 2
Yoast\WP\SEO\Integrations\Third_Party 2
WPSEO\Admin\Bulk Editor 3
WPSEO\Admin\Statistics 3
WPSEO\Admin\Ajax 3
Yoast\WP\SEO\Presenters\Admin 3
Yoast\WP\SEO\Integrations\Admin 4
WPSEO\Admin\Roles 5
WPSEO\Admin\Tracking 5
WPSEO\Internals\Options 6
WPSEO\Admin\Menu 6
WPSEO\Admin\Metabox 6
WPSEO 7
WPSEO\Admin\Capabilities 8
WPSEO\Internals 10
WPSEO\XML_Sitemaps 10
WPSEO\Admin\Import\Plugins 19
WPSEO\Admin 49
@param string $class_name Class name. 1
bool $networkwide Whether the plugin is being activated network-wide. 1
bool $networkwide Whether the plugin is being de-activated network-wide. 1
bool $activate True for plugin activation, false for de-activation. 1
int|WP_Site $blog_id Blog ID. 1
array $required_capabilities Capabilities that must all be true to allow action. 1
array $capabilities Array of capabilities to be checked, unused here. 1
array $args List of arguments for the specific capabilities to be checked. 1
string $before What to show before the breadcrumb. 1
string $after What to show after the breadcrumb. 1
bool $display Whether to display the breadcrumb (true) or return it (false). 1
string $taxonomy Optional. The taxonomy to get the primary term ID for. Defaults to category. 1
int|WP_Post|null $post Optional. Post to get the primary term ID for. 1
string $taxonomy Optional. The taxonomy to get the primary term for. Defaults to category. 1
int|WP_Post|null $post Optional. Post to get the primary term for. 1
object $args The object some of the replacement values might come from, 1
string $replacevar_name The name of the variable to replace, i.e. '%%var%%'. 1
array $config WPML configuration data to filter. 1
string $text String input to validate. 1
string $old_term_id Old term id of the taxonomy term that was splitted. 1
string $new_term_id New term id of the taxonomy term that was splitted. 1
string $term_taxonomy_id Term taxonomy id for the taxonomy that was affected. 1
string $taxonomy The taxonomy that the taxonomy term was splitted for. 1
array $results Results array for encoding. 1
string $what Type of item to save (title, description). 1
int $post_id Post ID. 1
string $new_meta_value New meta value to record. 1
string $orig_meta_value Original meta value. 1
string $meta_key Meta key string. 1
string $return_key Return key string to use in results. 1
string $what Type of item so save. 1
string $what Item type (such as title). 1
int $post_id Post ID. 1
string $new_value New value to record. 1
string $original Original value. 1
WPSEO_Bulk_List_Table $table The table to render. 1
string $id The id for the tab. 1
array $notifications_list List of notifications. 1
string $status Status of the notifications (active/dismissed). 1
string $name Name field for the select field. 1
array $plugins An array of plugins and classes. 1
int $post_id Post ID for the term. 1
int $new_primary_term New primary term ID. 1
WPSEO_Admin_Asset_Manager|null $asset_manager Optional. Asset manager to use. 1
Indexable_Repository|null $indexable_repository Optional. The Indexable_Repository. 1
Score_Icon_Helper|null $score_icon_helper Optional. The Score_Icon_Helper. 1
Product_Helper|null $product_helper Optional. The product helper. 1
WPSEO_Shortlinker|null $shortlinker The shortlinker. 1
WP_Post $post Post object to get its focus keyword. 1
WP_Post $post Post object to get its score. 1
WP_Term $term Term object to get its score. 1
int $notification_count Number of notifications. 1
array $submenu_items Submenu items array. 1
WP_Admin_Bar $wp_admin_bar Admin bar object. 1
string $parent_id Parent menu item ID. 1
int $rank The actual rank. 1
int $score The score to determine a rank for. 1
string $rank SEO Rank. 1
string $link Term link, overridden by the function for categories. 1
WP_Term $term Unused, term object. 1
string $taxonomy Taxonomy slug. 1
array $query_vars Main query vars to filter. 1
array $query_vars Query vars to check for existence of redirect var. 1
array $rules Rewrite rules generated for the current permastruct, keyed by their regex pattern. 1
array $rewrites The current set of rules. 1
string $category_name Category nicename. 1
string $blog_prefix Multisite blog prefix. 1
string $pagination_base WP_Query pagination base. 1
string $name The encoded category URI string. 1
string $encoded The encoded string. 1
string $category_redirect The category page to redirect to. 1
mixed $value Value to trim or array of values to trim. 1
array|string $value The value to sanitize and encode. 1
mixed $number1 Scalar (string/int/float/bool). 1
string $action Calculation action to execute. Valid input: 1
mixed $number2 Scalar (string/int/float/bool). 1
bool $round Whether or not to round the result. Defaults to false. 1
int $decimals Decimals for rounding operation. Defaults to 0. 1
int $precision Calculation precision. Defaults to 10. 1
string $text String input to trim. 1
string $url URL string. 1
string $current_page The current page the user is on. 1
string $minimum_version The minimum version the API should be. 1
string|null $post_type Optional. The post type to check the visibility of the metabox for. 1
string|null $taxonomy Optional. The post type to check the visibility of the metabox for. 1
string $identifier The identifier to check for. 1
string $type The type to check for. 1
array $data The data to format. 1
string $variable The variable that is replaced. 1
string $label The label of the replacement variable. 1
string $description The description of the replacement variable. 1
string|null $option_name Optional. Custom option to use to store/retrieve history from. 1
string $old_version The version we are upgrading from. 1
string $new_version The version we are upgrading to. 1
array $option_names The options that need to be stored. 1
array $option_names The option names to retrieve. 1
array> $data The data to store. 1
int $post_id The post ID. 1
WP_Post|null $post The post object. 1
string $content The post content string. 1
string $content The content to search for image tags. 1
string $image Image HTML element. 1
int $post_id The post ID. 1
WP_Post|array|null $post The post. 1
string $tab Tab for which to retrieve the field definitions. 1
string $post_type Post type of the current post. 1
mixed $meta_value The new value. 1
array|string $meta_value The value to validate. 1
bool $check The current status to allow updating metadata for the given type. 1
int $object_id ID of the current object for which the meta is being updated. 1
string $prev_value The old meta value. 1
bool $check The current status to allow adding metadata for the given type. 1
int $object_id ID of the current object for which the meta is being added. 1
mixed $meta_value The value to check. 1
string $key The internal key of the meta value to change (without prefix). 1
mixed $meta_value The value to set the meta to. 1
int $post_id The ID of the post to change the meta for. 1
string $old_metakey The old key of the meta value. 1
string $new_metakey The new key, usually the WPSEO meta key (including prefix). 1
bool $delete_old Whether to delete the old meta key/value-sets. 1
string $keyword The keyword to be counted. 1
int $post_id The id of the post to which the keyword belongs. 1
array $post_ids The post ids to get the post types for. 1
string $routine The method to call. 1
string $version The new version. 1
string $current_version The current set version. 1
string $current_version The old version from which we are upgrading. 1
string $new_version The version we are upgrading to. 1
string|null $previous_version The previous version. 1
string $version Current plugin version. 1
Yoast_Notification[] $notifications The notifications to filter. 1
string $meta_key The meta key. 1
string $option_name Option to retrieve. 1
string $option_name Option name save. 1
int|string|bool|float|array $source_data The option containing the value to be migrated. 1
string $source_setting Name of the key in the "from" option. 1
string|null $target_setting Name of the key in the "to" option. 1
string $object_type The object type to deduplicate. 1
string|array> $duplicates The result of the duplicate query. 1
wpdb $wpdb The wpdb object. 1
string $url The request url. 1
array $args The request arguments. 1
string $url The request URL. 1
array $request_arguments The request arguments. 1
string $response The response to decode. 1
array $request_arguments The arguments to enrich. 1
WP_Rewrite|null $rewrite Optional. WP_Rewrite instance to use. Default is the $wp_rewrite global. 1
string $regex Regular expression to match request against. 1
string|array $query The corresponding query vars for this rewrite rule. 1
string $priority Optional. Priority of the new rule. Accepts 'top' 1
array|string $rewrite_rules Array of rewrite rule $regex => $query pairs, or empty string 1
array|string $rewrite_rules Array pf rewrite rule $regex => $query pairs, or empty string 1
string $url The URL to find the attachment for. 1
string $url The attachment URL for which we want to know the Post ID. 1
string $url The URL of the image. 1
array $image Image array with URL and metadata. 1
array $image Image to check the file size of. 1
int $attachment_id Attachment ID. 1
string|array $size Size name, or array of width and height in pixels (e.g [800,400]). 1
string $path The relative file path. 1
string $img Image URL. 1
array $image An image array object. 1
int $attachment_id The attachment to return the variations for. 1
array $usable_dimensions { 1
array $variations The variations that should be considered. 1
array $variations The variations to consider. 1
int $attachment_id The attachment ID. 1
array $dimensions The image values. 1
array $usable_dimensions The parameters to check against. 1
int|null $post_id The post id. 1
array $images The array to extract image url from. 1
array $post_types The array to filter the attachment post type from. 1
WP_Post_Type $post_type The post type object. 1
string $post_type The post type name. 1
string $plugin_slug The plugin slug to search. 1
stdClass|false $data The result object. Default false. 1
string $action The type of information being requested from the Plugin Installation API. 1
stdClass $args Plugin API arguments. 1
stdClass|mixed $data The current data for update_plugins. 1
object $data The wp.org API response. 1
array $plugin_data The data for the plugin in this row. 1
string $slug The class' slug. 1
string $product_name The product to create the notification for. 1
string $short_link The short link for the addon notification. 1
stdClass $subscription Plugin subscription. 1
stdClass $subscription The subscription to convert. 1
stdClass|null $yoast_free_data The Yoast Free's data. 1
bool $plugin_info Whether we're in the plugin information modal. 1
string $plugin_file The plugin filename. 1
string $plugin_file Path to the plugin. 1
stdClass $site_information The site information to save. 1
object $site_information Site information as received from the API. 1
object $subscription Subscription information as received from the API. 1
string|null $locale The locale to get the language of. 1
WPSEO_Rank $rank The SEO rank to get the post count for. 1
array $args The object some of the replacement values might come from, 1
string $replacement_variable The replacement variable to check, including the variable delimiter (e.g. `%%var%%`). 1
array $matches Variables found in the original string - regex result. 1
array $omit Variables that should not be replaced by this function. 1
string $request Either 'nr'|'max' - whether to return the page number or the max number of pages. 1
string $request Either 'single'|'plural' - whether to return the single or plural form. 1
bool $single Whether to retrieve only the first or all values for the taxonomy. 1
string $type Type of variable: 'basic' or 'advanced'. 1
WPSEO_Replacement_Variable $replacement_variable The replacement variable to register. 1
string $label The replacement variable. 1
string $replacement_variable The replacement variable to format. 1
string $text Variable string to be cleaned. 1
string $text Variable string to be delimited. 1
int $id ID of the post to get the terms for. 1
string $taxonomy The taxonomy to get the terms for this post from. 1
bool $return_single If true, return the first term. 1
string $field The field to prefix. 1
mixed $options Value of the option to be returned. Typically an array. 1
string[] $dirty New value for the option. 1
string[] $clean Clean value for the option, normally the defaults. 1
string[] $old Old value of the option. 1
string[] $option_value Old (not merged with defaults or filtered) option value to clean according to the rules for this option. 1
string[]|null $current_version Optional. Version from which to upgrade, if not set, version specific upgrades will be disregarded. 1
string[]|null $all_old_option_values Optional. Only used when importing old options to have access to the real old values, in contrast to the saved ones. 1
string[] $dirty Original option as retrieved from the database. 1
string[] $clean Filtered option where any options which shouldn't be in our option 1
WPSEO_Option $option_instance Instance of the option. 1
string $option_name The option for which you want to retrieve the option group name. 1
string $option_name The option name of the option to save. 1
mixed $value The new value for the option. 1
string $option_name The option for which you want to retrieve the instance. 1
array $specific_options The option groups of the option you want to get. 1
array $option_names An array of option names of the options you want to get. 1
string $option_name The name of the option you want to get. 1
string $key The key it should return. 1
mixed $default_value The default value that should be returned if the key isn't set. 1
array $option_groups The option groups to retrieve the option from. 1
array $option_groups The option groups to prime the cache with. 1
string $option The option to retrieve. 1
mixed $default_value A default value to return. 1
array|string|null $option_name Optional. the option you want to clean or an array of 1
string|null $current_version Optional. Version from which to upgrade, if not set, 1
bool $force_init Whether to always do the initialization routine (title/desc test). 1
int|string $blog_id Blog id of the blog for which to reset the options. 1
string $wpseo_options_group_name The name for the wpseo option group in the database. 1
string $option_name The name for the option to set. 1
mixed $option_value The value for the option. 1
array $option The currently present options settings. 1
string $option_group The option_group where the key is stored. 1
array $meta_data New values. 1
array $old_meta The original values. 1
string $meta The meta field that is needed. 1
int $term_id ID of the term to save data for. 1
string $taxonomy The taxonomy the term belongs to. 1
array $meta_values The values that will be saved. 1
int $term_id ID of the term to save data for. 1
string $taxonomy The taxonomy the term belongs to. 1
string $meta_key The target meta key to store the value in. 1
string $meta_value The value of the target meta key. 1
string $keyword The keyword to look for. 1
string $current_term_id The current term id. 1
string $current_taxonomy The current taxonomy name. 1
array $clean Array with clean values. 1
array $tax_meta Array with the meta values for taxonomy. 1
int $term_id The id of the term. 1
string $taxonomy Name of the taxonomy to which the term is attached. 1
string $url The url to be validated. 1
string $twitter_id The twitter id to be validated. 1
bool $strip_at_sign Whether or not to strip the `@` sign. 1
mixed $value The current value. 1
mixed $old_value The old value. 1
string $key Key to check, by type of service. 1
string $key Key to check, by type of URL setting. 1
mixed $options Option value. 1
mixed $option_value The unvalidated new value for the option. 1
string $key Option key. 1
mixed $value The new value for the option. 1
string|null $current_version Optional. Version from which to upgrade, if not set, 1
array $option_value Option value to be imported. 1
array|null $all_old_option_values Optional. Only used when importing old options to 1
array|null $options Optional. Current options. If not set, the option defaults 1
array $updated Updated option value. 1
array $old Old option value. 1
array $dirty Original option as retrieved from the database. 1
array $clean Filtered option where any options which shouldn't be in our option 1
string $key Array key to check. 1
string|null $type The type to get the key for. Null or self::SITEMAP_INDEX_TYPE for index cache. 1
int $page The page of cache to get the key for. 1
string $type The type of sitemap to be used. 1
string $prefix The part before the type in the cache key. Only the length is used. 1
string $postfix The part after the type in the cache key. Only the length is used. 1
string|null $type The type to get the key for. Null for all caches. 1
string|null $type The type of sitemap to clear cache for. 1
string|null $validator The validator to clear cache of. 1
int $base10 The number that has to be converted to base 61. 1
string $type Sitemap type. 1
int $page Page number to store. 1
string $sitemap Sitemap body to store. 1
bool $usable Is this a valid sitemap or a cache of an invalid sitemap. 1
string $type Sitemap type to invalidate. 1
int $unused Unused term ID value. 1
string $type Taxonomy to invalidate. 1
int $post_id Post ID to invalidate type for. 1
array $types Set of sitemap types to delete cache transients for. 1
string $type Sitemap type. 1
string $option The option name that's being updated. 1
string $name The name of the sitemap. 1
callback $building_function Function to build your sitemap. 1
string $name The name of the XSL file. 1
callback $building_function Function to build your XSL file. 1
int $current_page The part that should be generated. 1
string $sitemap The generated sitemap to output. 1
bool $is_bad Is this a bad request. True or false. 1
WP_Query $query Main query instance. 1
int $page_number The page number to retrieve. 1
int $page_number The page number to save to. 1
string $type The requested sitemap's identifier. 1
string $type Type to output. 1
string|array $post_types Post type or array of types. 1
bool $return_all Flag to return array of values. 1
array $post_types Post types to get the last modification date for. 1
string $type Provide a type for a post_type sitemap, SITEMAP_INDEX_TYPE for the root sitemap. 1
string $sitemap XML Content of the sitemap. 1
bool|string $usable Is the sitemap usable or not. 1
array $data The unserialized data to use to (re)construct the object. 1
string $data The string representation of the object in C or O-format. 1
array $links Set of sitemaps index links. 1
array $links Set of sitemap links. 1
string $type Sitemap type. 1
int $current_page Current sitemap page number. 1
string $sitemap Sitemap XML. 1
string $stylesheet Full XML-stylesheet declaration. 1
string $url URL to encode and escape. 1
string $url URL to encode. 1
Yoast_Dynamic_Rewrites $dynamic_rewrites Dynamic rewrites handler instance. 1
array $query_vars List of query variables to filter. 1
string $redirect The redirect URL currently determined. 1
string $page Page to append to the base URL. 1
string $taxonomy_name Taxonomy name to check. 1
string $sitemap The XML content of the sitemap. 1
bool|string $usable True/False or 'ok'/'error' for status. 1
object $post Post object to get images for. 1
object $term Term to get images from description for. 1
string $content Content string to parse. 1
string $content Content string. 1
int $post_id Optional. ID of post being parsed. 1
string $content Content to parse for shortcodes. 1
WP_Post $post Post object for the context. 1
string $src Image URL. 1
string $src URL to process. 1
array $included_ids Array with IDs to include. 1
array $args Array with query args. 1
int $post_id Post ID to possibly invalidate for. 1
string $post_type Post type string to check for. 1
string $post_type Post type to retrieve count for. 1
string $post_type Post type to produce links for. 1
string $post_type Post type. 1
int $archive_page_id The page id. 1
string $post_type Post type to retrieve. 1
int $count Count of posts to retrieve. 1
int $offset Starting offset. 1
string $post_type Post type slug. 1
object $post Post object to get URL parts for. 1
array $arguments Arguments to add. 1
array $users Array of user objects to filter. 1
array $files List of files. 1
string $extension Extension to filter on. 1
string $fully_qualified_class_name The fully qualified class name of the class to generate a unit test for. 1
string $file_path The path to the class for which to generate a unit test. 1
string $fully_qualified_class_name The fully qualified class name of the class under test. 1
string $path The path of the class under test. 1
string $path The path to the class. 1
string $fully_qualified_class_name The fully qualified class name of the class that is tested. 1
string $name The name of the class that is tested. 1
string $class_namespace The namespace of the test class. 1
string $use_statements The use statements, one for each mocked constructor argument. 1
string $groups The unit test groups. 1
string $property_statements The property statements, one for each mocked constructor argument. 1
string $create_mock_statements The creation statements, one for each mocked constructor argument. 1
string $instance_argument_statements The arguments given to the instance constructor, 1
array $constructor_arguments The constructor arguments. 1
string $class_name The class for which to generate a property. 1
string $property_name The name of the property. 1
mixed $value The value being processed. 1
bool $is_root Whether or not the value is the root. 1
array $method_call The method call, a pair of the method and arguments. 1
Definition $definition The definition the method belongs to. 1
ReflectionParameter $parameter The parameter. 1
ReflectionFunctionAbstract $reflection_method The method the parameter belongs to. 1
string $type The type to add a definition for. 1
Definition $definition The class definition we are inspecting. 1
Definition[] $all_definitions The list of all definitions in the container. 1
Constructor_Details $definition_class The class we're looking to inject. 1
bool $debug If false the container will only be re-compiled if it does not yet already exist. 1
string $generated_container_path The path the generated container should be written to. 1
string $services_path The path of the services.php. 1
string $class_map_path The path of the class map. 1
string $target_namespace The namespace the generated container should be in. 1
Definition $definition The definition to process. 1
Definition $loader_definition The loader definition. 1
Definition $definition The definition to make public. 1
Definition $definition The definition to parse. 1
ContainerBuilder $container The ContainerBuilder to load classes for. 1
string $class_map_path The class map path. 1
string $path The path of the class. 1
Definition $prototype A definition to use as template. 1
string $namespace The namespace prefix of classes in the scanned directory. 1
string $resource The directory to look for classes, glob-patterns allowed. 1
string|null $exclude A globed path of files to exclude. 1
string $namespace The namespace prefix of classes in the scanned directory. 1
string $pattern The directory to look for classes, glob-patterns allowed. 1
string $excludePattern A globed path of files to exclude. 1
bool $form Whether or not the form start tag should be included. 1
string $option The short name of the option to use for the current page. 1
bool $contains_files Whether the form should allow for file uploads. 1
bool $option_long_name Group name of the option. 1
string $option_name Option key. 1
bool $submit Whether or not a submit button and form end tag should be shown. 1
bool $show_sidebar Whether or not to show the banner sidebar - used by premium plugins to disable it. 1
string $text Label text string, which can contain escaped html. 1
string $text Legend text string. 1
string $variable The variable within the option to create the checkbox for. 1
string $label The label to show for the variable. 1
bool $label_left Whether the label should be left (true) or right (false). 1
array $attr Extra attributes to add to the checkbox. 1
string $variable The variables within the option to create the checkbox list for. 1
string $labels The labels to show for the variable. 1
array $attr Extra attributes to add to the checkbox list. 1
string $variable The variable within the option to create the checkbox for. 1
string $label The visual label text for the toggle. 1
array $buttons Array of two visual labels for the buttons (defaults Disabled/Enabled). 1
bool $reverse Reverse order of buttons (default true). 1
string $help Inline Help that will be printed out before the toggle. 1
bool $strong Whether the visual label is displayed in strong text. Default is false. 1
array $attr Extra attributes to add to the light switch. 1
string $variable The variable within the option to create the text input field for. 1
array $attr Extra attributes to add to the input field. 1
string $variable The variable within the option to create the textarea for. 1
string|array $attr The CSS class or an array of attributes to assign to the textarea. 1
string $variable The variable within the option to create the hidden input for. 1
string $id The ID of the element. 1
mixed $val Optional. The value to set in the input field. Otherwise the value from the options will be used. 1
string $variable The variable within the option to create the select for. 1
string $label The label to show for the variable. 1
array $select_options The select options to choose from. 1
string $styled The select style. Use 'styled' to get a styled select. Default 'unstyled'. 1
bool $show_label Whether or not to show the label, if not, it will be applied as an aria-label. 1
array $attr Extra attributes to add to the select. 1
string $help Optional. Inline Help HTML that will be printed after the label. Default is empty. 1
string $variable The variable within the option to create the file upload field for. 1
array $attr Extra attributes to add to the file upload input. 1
string $variable Option name. 1
string $label Label message. 1
array $attr Extra attributes to add to the media input and buttons. 1
string $variable The variable within the option to create the radio button for. 1
array $values The radio options to choose from. 1
string $legend Optional. The legend to show for the field set, if any. 1
array $legend_attr Optional. The attributes for the legend, if any. 1
array $attr Extra attributes to add to the radio button. 1
array $values Associative array of on/off keys and their values to be used as 1
array $attr Extra attributes to add to the toggle switch. 1
array $attr Extra attributes to add to the index switch. 1
string $variable The variable within the option to create the radio buttons for. 1
string $label The visual label for the radio buttons group, used as the fieldset legend. 1
bool $inverse_keys Whether or not the option keys need to be inverted to support older functions. 1
string $help Inline Help that will be printed out before the visible toggles text. 1
array $attr Extra attributes to add to the show-hide switch. 1
string $field_name The field name to retrieve the value for. 1
string|null $default_value The default value, when field has no value. 1
string $variable The variable within the option to check whether its control should be disabled. 1
string $variable The variable within the option to print a disabled note for. 1
string $custom_note An optional custom note to print instead. 1
string $feature_setting The feature setting. 1
string $variable The variable within the option of the related form element. 1
array $attr Extra attributes added to the form element. 1
string $id Unique identifier of the element the inline help refers to, used as 1
string $help_button_text The Help Button text. Needs a properly escaped string. 1
string $help_content The Help Panel content. Needs a properly escaped string (might contain HTML). 1
string $wrapper Optional Whether to print out a container div element for the Help Panel, 1
array $args The arguments for this asset. 1
array $recommended_replace_vars The recommended replace vars 1
string $page_type The page type to check. 1
WP_Post $post The WordPress global post object. 1
string $flat_version The flat version of the asset. 1
string $name The name of the analysis worker asset. 1
int $status Status value to pass through. 1
int $value Count value to check. 1
array $links Array of links for the plugins, adapted when the current plugin is found. 1
string $file The filename for the current plugin, which the filter loops through. 1
string $slug The slug to create an install link for. 1
string $slug The slug to create an activation link for. 1
array $plugin The plugin to create the link for. 1
WPSEO_Statistics|null $statistics WPSEO_Statistics instance. 1
string $hook Hook to display the block on. 1
string $argument The argument to format. 1
array $input The array to add shortlinks to. 1
string $title The title of the paper. 1
string|null $view_file Optional. The path to the view file. Use the content setting 1
array $settings Optional. Settings for the paper. 1
array $dependency The information about the dependency to look for. 1
string $plugin The plugin slug to check. 1
string $plugin The plugin to search for. 1
array $dependency The information about the dependency to look for. 1
array $plugin The plugin to get the dependency names from. 1
array $plugin The plugin to check. 1
WPSEO_Collection $collection The collection object to add. 1
array $args The arguments. 1
int $total_items Total items counts. 1
string $orderby The column by which we want to order. 1
string $order Whether we want to sort ascending or descending. 1
string $query SQL query to use. 1
string $column_name Column name string. 1
array $hidden Set of hidden columns. 1
string $classes Additional CSS classes. 1
string $column_display_name Column display name string. 1
WP_Post $rec Post object. 1
string $column_name Column name. 1
WP_Post $rec Post object. 1
int $record_id Record ID. 1
string $attributes HTML attributes. 1
bool|array $values Optional values data array. 1
array $post_ids Post IDs for SQL IN part. 1
array $meta_data Meta data set. 1
array $columns Optional columns set. 1
WPSEO_Option_Tabs $option_tabs Option Tabs to get base from. 1
WPSEO_Option_Tab $tab Tab to get name from. 1
WPSEO_Option_Tabs $option_tabs Option Tabs to get tabs from. 1
string $line Line string. 1
bool $newline_first Boolean flag whether to prepend with new line. 1
string $opt_group Option group name. 1
string $key Key string. 1
string $val Value string. 1
string $name Name of the tab. 1
string $label Localized label of the tab. 1
array $arguments Optional arguments. 1
string $variable Variable to retrieve. 1
string|mixed $default_value Default to use when variable not found. 1
bool $include_empty Optional. Whether to include an initial placeholder choice. 1
bool $show_title Optional. Whether to show the title for each site. This requires 1
WP_Site $site Site object. 1
string $option_group Option group name for the current page. 1
string $action Nonce action. 1
string $query_arg Optional. Nonce query argument. Default '_wpnonce'. 1
array $query_args Optional. Query arguments to add to the redirect URL. Default none. 1
string $plugin_file The plugin file string. 1
bool $add_suffix Optional. Whether or not a file suffix should be added. 1
WPSEO_Admin_Asset $asset The asset to determine the path for. 1
string $class_name Optional class name. 1
string|bool $plugin Optional plugin basename to check. 1
WPSEO_Plugin_Availability $availability_checker The availability checker to use. 1
Yoast_Notification_Center $notification_center The notification center to add notifications to. 1
string $notification_id The id of the notification to be created. 1
array> $plugin The plugin to retrieve the data from. 1
array $suggested_plugin The suggested plugin. 1
string $url The URL to the plugin's page. 1
string $name The name of the plugin. 1
wpdb $database The database object. 1
string $table_name The table name that is represented. 1
bool $suppress_errors Should the errors be suppressed. 1
bool $is_multisite_table Should the table be global in multisite. 1
array $data Data to insert. 1
array $where Where condition as key => value array. 1
array|null $where Unused. Where condition as key => value array. 1
array $where Where clauses for the query. 1
string $query The query to execute. 1
array $columns The columns to create. 1
array $indexes The indexes to use. 1
string $content The metabox content. 1
int|null $post_id Default current post ID. 1
array $taxonomies The taxononmies that should be mapped. 1
stdClass $taxonomy The taxonomy to map. 1
string $option_group The group the network option is part of. 1
string $option_name The name of the network option to sanitize and save. 1
array $args { 1
string $option_group Option group. 1
string $value The sanitized option value. 1
string $option The option name. 1
mixed $default_value Existing default value to return. 1
string $option The option name. 1
string $identifier An unique identifier for the popup. 1
string $heading_level The heading level for the title of the popup. 1
string $title The title of the popup. 1
string $content The content of the popup. 1
string $url The URL for where the button should link to. 1
bool $popup Show this message as a popup show it straight away. 1
string|null $url Where the dev server is located. 1
WPSEO_Admin_Asset_Location|null $asset_location The provider of the asset location. 1
string $prefix The prefix for naming assets. 1
string $script The name of the script to enqueue. 1
string $style The name of the style to enqueue. 1
WPSEO_Admin_Asset $script The script to register. 1
WPSEO_Admin_Asset $style The style to register. 1
array $scripts The scripts passed to it. 1
array $styles Styles that need to be registered. 1
string $handle The script handle. 1
string $object_name The object name. 1
array $data The l10n data. 1
string $handle The script handle. 1
string $data The l10n data. 1
string $position Optional. Whether to add the inline script before the handle or after. 1
string $version The original version number. 1
string $script The script to check. 1
string $endpoint The endpoint to send the request to. 1
array $args The arguments to use in this request. 1
mixed $body The body to set. 1
string $method The type of request to send. 1
mixed $response The response to process. 1
array $options Set of options. 1
string $capability Capability to test. 1
string $message The message to wrap. 1
array $options Options to normalize. 1
string $value Attribute value. 1
string $key Attribute name. 1
WP_Post $post The current post object. 1
string $base Base of the tabs. 1
string $active_tab Currently active tab. 1
WPSEO_Option_Tab $tab Tab to add. 1
WPSEO_Option_Tab $tab Tab to check for active tab. 1
Yoast_Form $yform Yoast Form needed in the views. 1
array $columns Already existing columns. 1
array $columns Appended with their orderby variable. 1
array $hidden The hidden columns. 1
string $value The option's value. 1
string $label The option's label. 1
string $selected HTML selected attribute for an option. 1
string $seo_filter The SEO filter to use to determine what further filter to apply. 1
string $readability_filter The Readability filter to use to determine what further filter to apply. 1
string $keyword_filter The keyword filter to use. 1
mixed $filter The filter to check against. 1
array $vars Query variables that need to be modified based on the filters. 1
array $score_filters Array containing the score filters. 1
array $vars Array containing the variables that will be used in the meta query. 1
array $filters Array containing the filters that we need to apply in the meta query. 1
string $post_id The post ID to check. 1
int $post_id The post ID to check. 1
string $order_by The ID of the column by which to order the posts. 1
int $post_id The ID of the post for which to show the score. 1
int $post_id The ID of the post for which to show the readability score. 1
string|null $post_type Optional. The post type to test, defaults to the current post post_type. 1
Yoast_Notification $notification Notification to check dismissal of. 1
string $meta_value Value to set the meta value to if dismissed. 1
Yoast_Notification $notification Notification to dismiss. 1
string $meta_value Value to save in the dismissal. 1
Yoast_Notification $notification Notification to restore. 1
string|Yoast_Notification $notification Notification to clear the dismissal of. 1
Yoast_Notification $notification Notification object instance. 1
string $notification_id The ID of the notification to search for. 1
int|null $user_id The ID of the user. 1
bool $echo_as_json True when notifications should be printed directly. 1
Yoast_Notification $notification Notification to remove. 1
bool $resolve Resolve as fixed. 1
string $notification_id The notification id. 1
bool $resolve Resolve as fixed. 1
bool $dismissed Count dismissed notifications. 1
int $user_id The user ID to check. 1
array|Yoast_Notification[] $notifications The notifications to split. 1
array|Yoast_Notification[] $notifications The notifications to store. 1
int $user_id The ID of the user for which to store the notifications. 1
int $user_id The id of the user to check. 1
string $key Key to retrieve. 1
int $user_id The ID of the user to retrieve notifications for. 1
Yoast_Notification $a Compare with B. 1
Yoast_Notification $b Compare with A. 1
Yoast_Notification $notification Notification to test for persistent. 1
Yoast_Notification $notification Notification to check. 1
Yoast_Notification $notification Notification to convert. 1
array $notification_data Array to convert to Notification. 1
Yoast_Notification $notification The notification to check. 1
string $url The url to load. 1
string $group_name The option group name. 1
string $admin_title The page title, with extra context added. 1
string $error_code Must be the same slug-name used for the field variable and for `add_settings_error()`. 1
array $descriptions An associative array of error descriptions. 1
string $error_code Code of the error set via `add_settings_error()`, normally the variable name. 1
string $dirty_value The submitted invalid value. 1
string $class_name Give the classname to initialize. If classname is 1
string $plugin_section Type of plugin conflict (such as Open Graph or sitemap). 1
array $plugin_sections Set of sections. 1
string $plugin_section Type of conflict group (such as Open Graph or sitemap). 1
string $readable_plugin_section This is the value for the translation. 1
string $plugin_file Clear the optional notification for this plugin. 1
array $plugins Set of plugins. 1
string $plugin Plugin basename string. 1
string $plugin Plugin path relative to plugins directory. 1
string $plugin_file Plugin file to get Identifier from. 1
int $meta_id The ID of the meta option changed. 1
int $object_id The ID of the user. 1
string $meta_key The key of the meta field changed. 1
array $replacement_variables Possibly generic replacement variables. 1
array $page_types Page types to add variables for. 1
array $replacement_variables_to_add The variables to add. 1
array $replacement_variables Replacement variables to extract the name from. 1
string $page_type The page type to check. 1
array $wp_settings_error The settings object. 1
WPSEO_Statistics $statistics The statistics class to retrieve statistics from. 1
array $statistics The statistics results. 1
array $transient The current stored transient with the cached data. 1
int $user The user's ID to assign the retrieved values to. 1
array $scores The SEO scores. 1
WPSEO_Rank $rank The rank to map. 1
WPSEO_Rank $rank The rank to return a label for. 1
array $item The item to potentially filter out. 1
WPSEO_Rank $rank The rank to return a link for. 1
array $views Array with the views. 1
string $post_type Post type to check against. 1
WPSEO_Statistics_Service $service Service to use. 1
WPSEO_File_Size_Service $service The service provider. 1
array $role_capabilities List of all roles with their capabilities. 1
string $capability Capability to filter roles for. 1
array $roles List of default roles. 1
array $allcaps An array of all the user's capabilities. 1
array $caps Actual capabilities being checked. 1
array $args Optional parameters passed to has_cap(), typically object ID. 1
WP_User $user The user object. 1
string[] $caps Primitive capabilities required of the user. 1
string[] $cap Capability being checked. 1
WPSEO_Capability_Manager $manager The capability manager to use. 1
array $caps Optional existing capability list. 1
array $groups Current groups. 1
array $groups Current capability groups. 1
string $cap_id Capability identifier. 1
array $roles Roles to retrieve the objects for. 1
string $capability Capability to filter roles for. 1
array $roles List of roles which can be filtered. 1
string $plugin_type Whether it's Free or Premium. 1
string $capability Capability to check against. 1
string $role Role to fetch capabilities from. 1
WP_Role $role Role to check capability against. 1
string $capability Capability to check. 1
string $role The role to check against. 1
array $capabilities The capabilities that should be set. 1
array $capabilities Capabilities to format. 1
bool $enabled Whether these capabilities should be enabled or not. 1
stdClass $taxonomy Taxonomy. 1
WP_Term|stdClass $term Term. 1
WP_Post|array $post Post object. 1
array $options Title options to use. 1
string $structure The permalink to follow. 1
WPSEO_Metabox_Formatter_Interface $formatter Object that provides the formatted values. 1
array $columns Current set columns. 1
string $content The current content of the column. 1
string $column_name The name of the column. 1
int $term_id ID of requested taxonomy. 1
int $term_id ID of requested term. 1
int $term_id ID of the requested term. 1
mixed $term The current term. 1
string|null $taxonomy Optional. The taxonomy to test, defaults to the current taxonomy. 1
string $field_group The field group. 1
array $fields Array with the form fields that has will be filtered. 1
string $taxonomy The taxonomy. 1
stdClass $term The term. 1
stdClass|WP_Term $term Term to show the edit boxes for. 1
int $tt_id The taxonomy_term_id for the term. 1
int $term_id The ID of the term to localize the script for. 1
string $page The string to check for the term overview page. 1
string $page The string to check for the term edit page. 1
stdClass $term The current term. 1
array $fields Array with the fields that will be displayed. 1
string $field_name Variable the row controls. 1
array $field_configuration Array with the field configuration. 1
string $field_type The fieldtype, e.g: text, checkbox, etc. 1
string $field_name The name of the field. 1
string $field_value The value of the field. 1
array $options Array with additional options. 1
string $field_name The fieldname to get the value for. 1
array $options The array with field options. 1
string $label The label value. 1
string $field_name The target field. 1
string $label The html for the label if there was a label set. 1
WPSEO_Admin_Help_Panel $help The help panel to render in this row. 1
string $field The html for the field. 1
array $submenu_pages List of subpages to convert. 1
Yoast_Form $yform Yoast forms. 1
array $arguments { 1
array $arguments The arguments to validate. 1
string $page Page to display. 1
Yoast_Form $yform Yoast forms. 1
string $field_id The field id. 1
string $label The field label. 1
string $page_type_recommended The page type for the context of the recommended replace vars. 1
string $page_type_specific The page type for the context of the editor specific replace vars. 1
WPSEO_Menu $menu Menu to use. 1
string $page_title Page title to use. 1
string $page_slug Page slug to use. 1
callable|null $callback Optional. Callback which handles the page request. 1
callable[]|null $hook Optional. Hook to trigger when the page is registered. 1
string $hook_suffix Admin page hook suffix, as returned by `add_menu_page()` 1
array $callbacks Callbacks to add. 1
bool $base64 Whether or not to return base64'd output. 1
string[] $classes An array of postbox CSS classes. 1
string[] $meta_field_def Contains the vars based on which output is generated. 1
string $key Internal key (without prefix). 1
string $page The page to check for the post overview page. 1
string $page The page to check for the post edit page. 1
array $collapsibles The metabox collapsibles (`WPSEO_Metabox_Collapsible[]`) to be included in the section. 1
string $css_files The CSS files that WordPress wants to load inside the editor. 1
array $tinymce_config The tinyMCE config as configured by WordPress. 1
array $plugin The plugin details. 1
WP_Theme $theme The theme object. 1
string $post_type The post type return the count for. 1
string $endpoint The endpoint to send the data to. 1
int $threshold The limit for the option. 1
bool|WP_Upgrader $upgrader Optional. WP_Upgrader instance or false. 1
array $data Array of update data. 1
bool $force Whether to send the tracking data ignoring the two 1
bool $ignore_time_treshhold Whether to send the tracking data ignoring 1
int $seconds The amount of seconds to check. 1
string $action The type of import action. 1
bool $status The status of the import. 1
string $msg Extra messages about the status. 1
string $action The type of action to set as import action. 1
string $msg The message to set. 1
bool $status The status to set. 1
string $raw_options The content to parse. 1
string $name Name string. 1
array $option_group Option group data. 1
array $options Options data. 1
array $options The options parsed from the provided settings. 1
WPSEO_Plugin_Importer $importer The importer that needs to perform this action. 1
string $action The action to perform. 1
string $msg Message string. 1
int $post_id The post id of the current post. 1
string $wpseo_robots The value in wpSEO that needs to be converted to the Yoast format. 1
int $post_id Post ID. 1
string $key The meta key to import. 1
string $key The meta key to search for. 1
mixed $post_identifier Post identifier, can be ID or string. 1
int $post_identifier Post ID. 1
string $key The meta_key to delete. 1
array $replace_values Key value pair of values to replace with other values. This is only used in the base class but not here. 1
string[] $meta_values An array of all the meta values that 1
string $aioseo_prefix The AiOSEO prefix to use 1
string[] $unique_custom_fields_or_taxonomies An array of unique custom fields to replace the replace vars of. 1
wpdb $wpdb The WordPress database object. 1
string $aioseo_prefix The AiOSEO prefix to use 1
string $yoast_prefix The Yoast prefix to use (e.g. `cf` for custom fields). 1
wpdb $wpdb The WordPress database object. 1
string $aioseo_prefix The AiOSEO prefix to use 1
string $value The meta robots value to find posts for. 1
array $metas The meta field(s) to save. 1
string $meta_value Robots meta value. 1
string $old_key The existing meta key. 1
string $new_key The new meta key. 1
array $replace_values An array, keys old value, values new values. 1
array $clone_keys The keys to clone. 1
string $plugin_key The key in the $data array to check. 1
string $yoast_key The identifier we use in our meta settings. 1
array $data The array of data for this post to sift through. 1
int $post_id The post ID. 1
string $new_key The key to save. 1
mixed $value The value to set the key to. 1
int $post_id The Post to save the meta for. 1
array $replace_values Key value pair of values to replace with other values. 1
string $meta_rules The meta rules taken from the SEOpressor settings array. 1
int $post_id The post id of the current post. 1
array $seopressor_robots The value in SEOpressor that needs to be converted to the Yoast format. 1
string $select_id ID for the select. 1
string $select_name Name for the select. 1
array $select_options Array with the options to parse. 1
string $selected_option The current selected option. 1
string $attribute The name of the attribute to add. 1
string $attribute The attribute to look for. 1
string $key Key to check whether a value for it is set. 1
string $key Key to get the value for. 1
WP_REST_Request $request The request to retrieve file url from. 1
string $file_url The file url to get the size for. 1
string $file_url The file to retrieve the size for. 1
string $notice_name The name for the hook to catch the notice. 1
string $notice_type The notice type. 1
string $plugin_section Plugin conflict type (such as Open Graph or sitemap). 1
array $posted_plugins Plugin set to check. 1
string $posted_plugin Plugin to check against dismissed conflicts. 1
int $term_taxonomy_id The term taxonomy ID that will be deleted. 1
string $post_id The post id to check. 1
int $term_taxonomy_id The term taxonomy ID to check. 1
int $term_id The term ID. 1
string $post_type Post type to retrieve label from. 1
string $post_status The post status to check. 1
string $first_sentence The first sentence of the notification. 1
string $second_sentence The second sentence of the notification. 1
string $message The message to add to the notification. 1
string $class_name Type of Model to load. 1
string $class_name Type of Model to load. 1
string $table_name Simple table name. 1
string $class_name The class to set the table name for. 1
string $class_name The target class name. 1
string $property The property to get the value for. 1
mixed|null $default_value Default value when property does not exist. 1
string $class_name The class name to get short name for. 1
string $class_name The class name to get the ID column for. 1
string $specified_foreign_key_name The keyname to build. 1
string $table_name The table name to build the key name for. 1
string $class_name The target class name. 1
string $associated_class_name The associated class name. 1
string|null $foreign_key_name The foreign key in the current models table. 1
string|null $foreign_key_name_in_associated_models_table The foreign key in the associated table. 1
string $associated_class_name The associated class name. 1
string|null $join_class_name The class name to join. 1
string|null $key_to_base_table The key to the the current models table. 1
string|null $key_to_associated_table The key to the associated table. 1
string|null $key_in_base_table The key in the current models table. 1
string|null $key_in_associated_table The key in the associated table. 1
ORM $orm The ORM instance to set. 1
string $property The property to set. 1
string $value The value to set. 1
string $property The property to unset. 1
array $data The data to pass to the ORM. 1
string $method The method to call. 1
array $arguments The arguments to use. 1
string $table_name The table to create instance for. 1
string $query The raw SQL query. 1
array $parameters Optional bound parameters. 1
string $query The query. 1
array $parameters An array of parameters to be bound in to the query. 1
string $table_name Table name. 1
array $data Data to populate table. 1
string $class_name The classname to set. 1
array|null $data Data to populate table. 1
string $id_column The ID column. 1
array $row A row from the database. 1
int|null $id An (optional) ID. 1
ORM $orm The ORM used by model. 1
string $sql_function The aggregate function to call eg. MIN, COUNT, etc. 1
string $column The column to execute the aggregate query against. 1
array $data Data to populate table. 1
array $query The query. 1
array $parameters The parameters. Defaults to an empty array. 1
string $alias The alias. 1
string|null $alias The alias to return the expression as. Defaults to null. 1
string $column The column. Defaults to '*'. 1
string|null $alias The alias to return the column as. Defaults to null. 1
string|null $alias The alias to return the column as. Defaults to null. 1
array $columns The columns. 1
string $join_operator The join_operator should be one of INNER, LEFT OUTER, CROSS etc - this will be 1
string $table The table should be the name of the table to join to. 1
string $constraint The constraint. 1
string|null $table_alias The alias for the joined table. Defaults to null. 1
string $table The table name. 1
string $constraint The constraint. 1
string $table_alias The table alias. 1
array $parameters The parameters. Defaults to an empty array. 1
string $column_name The table column. 1
string $separator The separator. 1
mixed $value The value. 1
string $type The type. 1
array $values The values. Defaults to empty array. 1
string $type The type. 1
array $fields Fields to create placeholder for. 1
mixed $value The value. 1
array $values The values. 1
array $values The values. 1
string $operator The operator. 1
string[] $ids The IDs. 1
int $limit The limit. 1
int $offset The offset. 1
string $ordering The ordering. DESC or ASC. 1
string $clause The clause. 1
string $expr The expression. 1
mixed $value The value. Defaults to null. 1
string $type Where or having. 1
string $glue Glue. 1
string[] $pieces Pieces to join. 1
string $part The part to quote. 1
string|array $key Key. 1
bool $disallow_null Whether to allow null IDs. 1
bool $expr Expression. 1
array $models Array of model instances to be inserted. 1
array $dirty_column_names Array of dirty fields to be used in INSERT. 1
string|int $offset Key. 1
mixed $value Value. 1
string|int $key Key. 1
mixed $value Value. 1
string $text Table name. 1
string $column_name The column name. 1
string $type The type of the column. 1
array|null $options Column options. 1
string $database The database name. 1
string $ddl The query to run. 1
array $options The options. 1
string $name The current table name. 1
string $new_name The new table name. 1
string $table_name The table name. 1
string $table The table name. 1
string $column The column name. 1
string $name The name of the column. 1
string $type The type of the column. 1
array $options The column options. 1
string $name The table name. 1
array $options The options. 1
array $options The options. 1
bool $wants_sql Whether or not to return SQL or execute the query. Defaults to false. 1
string $name The name. 1
Adapter $adapter The adapter to set. 1
string $name The name of the database. 1
array|null $options The options. 1
string $name The name of the database. 1
string $table_name The name of the table. 1
string $name The name of the table. 1
string $new_name The new name of the table. 1
string $table_name The name of the table. 1
string $table_name The name of the table. 1
string $table_name The name of the table. 1
array|string $options The options. 1
string $str The string to quote. 1
string $name The name of the container. 1
ContainerInterface $container The container. 1
string $name The name of the container. 1
string $id The ID of the service. 1
int $invalid_behaviour The behaviour when the service could not be found. 1
string $id The service ID. 1
string $integration_class The class name of the integration to be loaded. 1
string $initializer_class The class name of the initializer to be loaded. 1
string $route_class The class name of the route to be loaded. 1
string $command_class The class name of the command to be loaded. 1
string $plugin The plugin the migration belongs to. 1
string $version The version of the migration. 1
string $migration_class The class name of the migration to be loaded. 1
string $plugin The plugin to get the migrations for. 1
string $loadable_class The class name of the loadable. 1
WP_Query $wp_query The WP Query. 1
RequestInterface $request The request. 1
array $options The request options. 1
Blocks_Helper $blocks The blocks helper. 1
Current_Page_Helper $current_page The current page helper. 1
Indexable_Repository $repository Indexable repository. 1
Meta_Tags_Context $context_prototype The meta tags context prototype. 1
Presentation_Memoizer $presentation_memoizer Memoizer for the presentation. 1
string $page_type The page type. 1
Indexable|int|string|null $indexable Optional. The indexable or indexable id to clear the memoization of. 1
ContainerInterface $service_container The service container. 1
Indexable $indexable The indexable to get a presentation of. 1
Meta_Tags_Context $context The current meta tags context. 1
string $page_type The page type. 1
Indexable|int|null $indexable Optional. The indexable or indexable id to clear the memoization of. 1
Front_End_Conditional $front_end_conditional The front end conditional. 1
Wincher_Client $client The Wincher client. 1
User_Can_Manage_Wpseo_Options_Conditional $user_can_manage_wpseo_options_conditional The User_Can_Manage_Wpseo_Options_Conditional. 1
Post_Conditional $post_conditional The post conditional. 1
mixed $level The log level. 1
string $message The log message. 1
array $context The log context. 1
Url_Helper $url The url helper. 1
Image_Helper $image The image helper. 1
ID_Helper $id_helper The schema id helper. 1
WPSEO_Replace_Vars $replace_vars The replace vars helper. 1
Site_Helper $site The site helper. 1
User_Helper $user The user helper. 1
Permalink_Helper $permalink_helper The permalink helper. 1
int $id Post ID. 1
Indexable_Builder_Versions $versions The indexable builder versions. 1
Meta_Helper $meta The meta helper. 1
int $post_id The post ID to use. 1
int $post_id The post ID. 1
int $value Meta value to convert. 1
object $post The post object. 1
WP_Post $post The post for which an indexable should be built. 1
Options_Helper $options The options helper. 1
Indexable_Builder_Versions $versions The latest version of each Indexable builder. 1
string $post_type The post type to build the indexable for. 1
string $post_type The post type to get the fallback breadcrumb title for. 1
Author_Archive_Helper $author_archive The author archive helper. 1
Indexable_Builder_Versions $versions The Indexable version manager. 1
Options_Helper $options_helper The options helper. 1
Post_Helper $post_helper The post helper. 1
int $user_id The user to retrieve the indexable for. 1
int $user_id The user to retrieve the meta data for. 1
int $user_id The user to retrieve the indexable for. 1
string $key The meta entry to retrieve. 1
Indexable_Author_Builder $author_builder The author builder for creating missing indexables. 1
Indexable_Post_Builder $post_builder The post builder for creating missing indexables. 1
Indexable_Term_Builder $term_builder The term builder for creating missing indexables. 1
Indexable_Home_Page_Builder $home_page_builder The front page builder for creating missing indexables. 1
Indexable_Post_Type_Archive_Builder $post_type_archive_builder The post type archive builder for creating missing indexables. 1
Indexable_Date_Archive_Builder $date_archive_builder The date archive builder for creating missing indexables. 1
Indexable_System_Page_Builder $system_page_builder The search result builder for creating missing indexables. 1
Indexable_Hierarchy_Builder $hierarchy_builder The hierarchy builder for creating the indexable hierarchy. 1
Primary_Term_Builder $primary_term_builder The primary term builder for creating primary terms for posts. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Indexable_Version_Manager $version_manager The indexable version manager. 1
Indexable_Link_Builder $link_builder The link builder for creating missing SEO links. 1
Indexable $indexable The Indexable to copy. 1
int $object_id The indexable object ID. 1
string $object_type The indexable object type. 1
Indexable|bool $indexable Optional. An existing indexable to overwrite. 1
string $post_type The post type. 1
string $page_type The type of system page. 1
Indexable|false $indexable The indexable. 1
array $defaults The initial properties of the Indexable. 1
int $author_id The author id. 1
string $type The type of the indexable. 1
Indexable $indexable The Indexable to (re)build. 1
array|null $defaults The object type of the Indexable. 1
Primary_Term_Repository $primary_term_repository The primary term repository. 1
Options_Helper $options The options helper. 1
Post_Helper $post The post helper. 1
int $post_id The post id, this is the id of the post currently being evaluated. 1
int $term_id The term id, this is the id of the term currently being evaluated. 1
array $terms Terms set. 1
WP_Term $term Term to get the parents for. 1
Indexable $ancestor The ancestor (presumed indexable) to check. 1
int $indexable_id The indexable id we're adding ancestors for. 1
int[] $parents The indexable ids of the parents already added. 1
Taxonomy_Helper $taxonomy_helper The taxonomy helper. 1
Indexable_Builder_Versions $versions The latest version of each Indexable Builder. 1
Post_Helper $post_helper The post helper. 1
int $term_id ID of the term to save data for. 1
string $meta_value Term meta to base the value on. 1
string $meta_key The key to extract. 1
array $term_meta The meta data. 1
int $term_id The term ID. 1
Indexable_Builder_Versions $versions The latest version for all indexable builders. 1
Indexable_Builder_Versions $versions The latest version of each Indexable Builder. 1
string $object_sub_type The object sub type of the system page. 1
Indexable $indexable The indexable to format. 1
Open_Graph_Image_Helper $open_graph_image The Open Graph image helper. 1
Twitter_Image_Helper $twitter_image The Twitter image helper. 1
array $alternative_image The alternative image to set. 1
Indexable $indexable The indexable to set image for. 1
Indexable $indexable The indexable to handle. 1
Indexable $indexable The indexable to set images for. 1
Options_Helper $options The options helper. 1
Url_Helper $url_helper The url helper. 1
Indexable_Builder_Versions $versions Knows the latest version of each Indexable type. 1
Post_Helper $post_helper The post helper. 1
Primary_Term_Repository $repository The primary term repository. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Primary_Term_Helper $primary_term The primary term helper. 1
Meta_Helper $meta The meta helper. 1
int $post_id Post ID to save primary term for. 1
string $taxonomy Taxonomy to save primary term for. 1
SEO_Links_Repository $seo_links_repository The SEO links repository. 1
Post_Helper $post_helper The post helper. 1
Image_Helper $image_helper The image helper. 1
string $content The content. Expected to be unfiltered. 1
Indexable $indexable The indexable to be the target of SEO Links. 1
string[] $links The link URLs. 1
int[] $images The image sources. 1
string $type The type of link (either SEO_Links::TYPE_INTERNAL or SEO_Links::TYPE_INTERNAL_IMAGE). 1
string $permalink The permalink of the link's target. 1
string $url The url of the link. 1
array $home_url The home url, as parsed by wp_parse_url. 1
Indexable $indexable The indexable of the post containing the link. 1
bool $is_image Whether or not the link is an image. 1
int $image_id The ID of the internal image. 1
SEO_Links $model The link's model. 1
string $permalink The link's permalink. 1
string $url The url of the link. 1
array $home_url The home url, as parsed by wp_parse_url. 1
SEO_Links $link The link. 1
array $current_url The url of the page the link is on, as parsed by wp_parse_url. 1
SEO_Links[] $links The link models. 1
SEO_Links[] $links_a The array to compare. 1
SEO_Links[] $links_b The array to compare against. 1
SEO_Links[] $links The link models. 1
string $link The raw URL. 1
array $home_url The home URL, as parsed by wp_parse_url. 1
int[] $related_indexable_ids The IDs of all related indexables. 1
Indexable $indexable The indexable to change. 1
array $images The image array. 1
Content_Type_Visibility_Dismiss_Notifications $dismiss_notifications The options helper. 1
string $post_type_name The post type name from the request. 1
string $taxonomy_name The taxonomy name from the request. 1
array $new_content_types The new content types. 1
Options_Helper $options The options helper. 1
Yoast_Notification_Center $notification_center The notification center. 1
Content_Type_Visibility_Dismiss_Notifications $content_type_dismiss_notifications The content type dismiss notifications. 1
array $newly_made_public_post_types The newly made public post types. 1
array $newly_made_non_public_post_types The newly made non public post types. 1
array $newly_made_public_taxonomies The newly made public post types. 1
array $newly_made_non_public_taxonomies The newly made non public post types. 1
string $version The version to check, defaults to the latest version. 1
string $message Message explaining the reason for the error. 1
string $name The name of the migration. 1
array $migration_status The migration status. 1
string|null $version Optional: the current plugin version. 1
string $group One of the GROUP_* constants. 1
string|null $current_version The current version of the plugin that's being checked. 1
string $token_option The option's name to save the token as. 1
Wincher_PKCE_Provider|GenericProvider $provider The provider. 1
Options_Helper $options_helper The Options_Helper instance. 1
mixed $body The data to send along in the request's body. 1
OAuth_Token $token The token to store. 1
OAuth_Token $tokens The outdated tokens. 1
string $pkce_code The value for the pkceCode. 1
int $length Length of the random string to be generated. 1
array $options The options to use in the authorization parameters. 1
mixed $grant The grant to request access for. 1
array $options The options to use with the current request. 1
RequestInterface $request The request interface. 1
string $indexable_table_name The name of the indexable table. 1
string $classes The classes assigned to the image. 1
WPSEO_Admin_Asset_Manager $asset_manager The WPSEO_Admin_Asset_Manager. 1
Current_Page_Helper $current_page_helper The Current_Page_Helper. 1
Product_Helper $product_helper The Product_Helper. 1
Short_Link_Helper $shortlink_helper The Short_Link_Helper. 1
Notification_Helper $notification_helper The Notification_Helper. 1
Alert_Dismissal_Action $alert_dismissal_action The alert dismissal action. 1
Promotion_Manager $promotion_manager The promotion manager. 1
Dashboard_Configuration $dashboard_configuration The dashboard configuration. 1
array> $pages The pages. 1
WPSEO_Admin_Asset_Manager $asset_manager The WPSEO_Admin_Asset_Manager. 1
Product_Helper $product_helper The Product_Helper. 1
Product_Helper $product_helper The product helper. 1
Wincher_Helper $wincher_helper The Wincher helper. 1
WooCommerce_Conditional $woocommerce_conditional The WooCommerce conditional. 1
WPML_Conditional $wpml_conditional The wpml conditional. 1
Polylang_Conditional $polylang_conditional The polylang conditional. 1
TranslatePress_Conditional $translate_press_conditional The translate press conditional. 1
WP_Term|string|false $term The term. 1
Alert_Dismissal_Action $alert_dismissal_action The alert dismissal action. 1
bool $fallback Whether to return the hardcoded fallback if the template value is empty. Default true. 1
Meta_Helper $meta_helper The meta helper. 1
array> $post_ids_per_keyphrase An associative array with keyphrase as keys and an array of post ids where those keyphrases are used. 1
string $keyphrase The keyphrase to check the usage of. 1
Date_Helper $date_helper The date helper. 1
Integration_Data_Provider_Interface ...$plugin_integrations All integrations. 1
Analysis_Feature_Interface ...$plugin_features All analysis objects. 1
array $feature_names The feature names to include. 1
Post_Site_Information $post_site_information The post specific wrapper. 1
Term_Site_Information $term_site_information The term specific wrapper. 1
Abstract_Term_Seo_Data_Provider ...$seo_data_providers The providers. 1
Abstract_Post_Seo_Data_Provider ...$seo_data_providers The providers. 1
bool $is_enabled If the feature is enabled. 1
string $name What the identifier of the feature is. 1
string $legacy_key What the identifier is for the old script data array. 1
Analysis_Feature $feature The analysis feature to add. 1
string $title_template The title template. 1
string $title_template_no_fallback The title template without the fallback. 1
array $keyphrase_usage_count The keyphrase and the associated posts that use it. 1
array $keyphrase_usage_per_type The post types for the given post IDs. 1
string $description_date The description date. 1
string $description_template The description template. 1
string $social_title_template The Social title template. 1
string $social_description_template The Social description template. 1
string $social_image_template The Social image template. 1
string $social_first_content_image The first content image for the social preview. 1
Image_Helper $image The image helper. 1
Url_Helper $url The url helper. 1
string $image_meta JSON encoded image meta. 1
string $url The given URL. 1
string|array $image Image array. 1
Twitter_Image_Helper $twitter_image Image helper for twitter. 1
string $access_token The access token. 1
string $refresh_token The refresh token. 1
int $expires The date and time at which the token will expire. 1
bool $has_expired Whether or not the token has expired. 1
int $created_at The timestamp of when the token was created. 1
int $error_count The number of times we've gotten an error trying to refresh this token. 1
AccessTokenInterface $response The response object to create a new instance from. 1
string $object_type The Indexable type for which you want to know the most recent version. 1
string $path The path to add to the disallow directive. 1
string $path The path to add to the allow directive. 1
string $path A path to add in the path list. 1
Indexable_Builder $builder The indexable builder. 1
Current_Page_Helper $current_page The current post helper. 1
Indexable_Hierarchy_Repository $hierarchy_repository The hierarchy repository. 1
wpdb $wpdb The WordPress database instance. 1
Indexable_Version_Manager $version_manager The indexable version manager. 1
string $permalink The indexable permalink. 1
string $object_type The object type. 1
string $object_sub_type The object subtype. 1
string $post_type The post type. 1
string $object_sub_type The type of system page. 1
bool $auto_create Optional. Create the indexable if it does not exist. 1
int $object_id The indexable object ID. 1
int[] $object_ids The array of indexable object id's. 1
array $indexable_ids The indexable id's. 1
Indexable $indexable The indexable to find the ancestors of. 1
int $post_parent The post parent. 1
array $exclude_ids The id's to exclude. 1
int $count The incoming link count. 1
string|null $type The type of the indexable. Can be null. 1
int $post_id The post the indexable is based upon. 1
string $taxonomy The taxonomy the indexable belongs to. 1
bool $auto_create Optional. Creates an indexable if it does not exist yet. 1
string $url The SEO Link's url. 1
string $target_post_id The SEO Link's target post ID. 1
int $link_id The ID of the link to be updated. 1
int $target_indexable_id The ID of the target indexable. 1
array $post_ids The post IDs. 1
array $indexable_ids The indexable IDs. 1
int[] $ids The seo link ids. 1
SEO_Links[] $links The seo links to be inserted. 1
Taxonomy_Helper $taxonomy A helper for taxonomies. 1
Post_Type_Helper $post_type A helper for post types. 1
Author_Archive_Helper $author_archive A helper for author archives. 1
string $object_type The object type to query. 1
string $object_sub_type The object subtype to query. 1
int $limit The limit we'll apply to the delete query. 1
string $object_type The object type to check. 1
string $object_sub_type The object sub type to check. 1
string $post_status The post status to query. 1
int $limit The limit we'll apply to the delete query. 1
string $post_status The post status to count. 1
string $source_table The source table which we need to check the indexables against. 1
string $source_identifier The identifier which the indexables are matched to. 1
string $object_type The indexable object type. 1
int $limit The limit we'll apply to the delete query. 1
int $limit The limit we'll apply to the delete query. 1
string $source_table The source table. 1
string $source_identifier The source identifier. 1
string $object_type The object type. 1
int $limit The limit we'll apply to the queries. 1
array $reassigned_authors_objs The array of objects with shape [ old_id => [ old_id, new_id ] ]. 1
int $limit The limit we'll apply to the queries. 1
Indexable_Hierarchy_Builder $builder The indexable hierarchy builder. 1
int $ancestor_id The ancestor id. 1
int $depth The depth. 1
Indexable $indexable The indexable to get the ancestors for. 1
Indexable $indexable The indexable to find the children for. 1
array $object_ids List of id's to get the children for. 1
string $class_name The class name of the extension to load. 1
string $method The method that does not exist. 1
Exception $original_exception The original exception. 1
string $reason The reason why token storage failed. Optional. 1
string $property The property that is empty. 1
int $term_id ID of the term. 1
string $reason The reason given by WordPress why the term is invalid. 1
int $object_id The invalid object id. 1
Cleanup_Service $cleanup_service The cleanup service. 1
Closure[] $tasks Array of tasks to be added. 1
bool|null $check Whether to allow updating metadata for the given type. 1
int $object_id ID of the object metadata is for. 1
string $meta_key Metadata key. 1
mixed $meta_value Metadata value. Must be serializable if non-scalar. 1
Custom_Meta_Collector $custom_meta_collector The custom meta collector. 1
Custom_Meta_Collector $custom_meta_collector The custom meta collector. 1
Cleanup_Repository $cleanup_repository The cleanup repository. 1
int $limit The limit we'll apply to the cleanups. 1
Additional_Contactmethod_Interface ...$additional_contactmethods All additional contactmethods. 1
Custom_Meta_Interface ...$custom_meta All custom meta. 1
array $meta_keys The meta to be potentially deleted. 1
int $limit The number of maximum deletions. 1
string $replacevar_string The string with replacement variables. 1
string $output The HTML output. 1
array $breadcrumb Link info array containing the keys: 1
int $index Index for the current breadcrumb. 1
int $total The total number of breadcrumbs. 1
string $title The title and screen reader text. 1
string $css_class The CSS class. 1
array $links A list of arrays containing titles and urls. 1
string $class_name Classname for the url list. 1
bool $target_blank If the url should be target blank. 1
string $value The desired method of escaping; 'html', 'url' or 'attribute'. 1
array $user_agents The list if available user agents. 1
string $robots_txt_content The current working robots txt string. 1
array $paths The list of paths for which to add a txt entry. 1
string $directive_identifier The identifier for the directives. (Disallow of Allow). 1
bool $output_tag Optional. Whether or not to output the HTML tag. Defaults to true. 1
string $id Twitter ID or url. 1
string $content Content of the Alert. 1
string $type Type of the Alert (error/info/success/warning), default is warning. 1
string $link Help link. 1
string $link_text Help link visually hidden text. 1
bool $opens_in_new_browser_tab Whether the link opens in a new browser tab. Default true. 1
Product_Helper $product_helper The product helper. 1
Short_Link_Helper $short_link_helper The addon manager. 1
WPSEO_Addon_Manager $class_addon_manager The addon manager. 1
int $total_unindexed Total number of unindexed objects. 1
string $reason The reason to show in the notification. 1
string $reason The reason identifier. 1
int $total_unindexed The total number of unindexed objects. 1
Short_Link_Helper $short_link_helper Represents the short link helper. 1
string $id Id of the badge. 1
string $link Optional link of the badge. 1
string $group Optional group which the badge belongs to. 1
Badge_Group_Names|null $badge_group_names Optional object storing the group names. 1
WP_Post $post The metabox post. 1
string $field_group The key under which a group of fields is grouped. 1
string $post_type The post type. 1
array $migration_error The migration error. 1
string $title Title of the admin notice. 1
string $content Content of the admin notice. 1
string|null $image_filename Optional. The filename of the image of the admin notice, 1
string|null $button Optional. An HTML string to be displayed after the main content, 1
bool $is_dismissible Optional. Whether the admin notice should be dismissible. 1
string $id Optional. The id of the notice. 1
string $variable The variable to create the checkbox for. 1
string $label The visual label text for the toggle. 1
array $buttons Array of two visual labels for the buttons (defaults Disabled/Enabled). 1
string $name The name of the underlying checkbox. 1
string|bool $value The variable current value, to determine the checked attribute. 1
bool $reverse Optional. Reverse order of buttons (default true). 1
string $help Optional. Inline Help HTML that will be printed out before the toggle. Default is empty. 1
bool $strong Optional. Whether the visual label is displayed in strong text. Default is false. 1
string $disabled_attribute Optional. The disabled HTML attribute. Default is empty. 1
Short_Link_Helper $short_link_helper Represents the short link helper. 1
Product_Helper $product_helper The product helper. 1
WPSEO_Addon_Manager $addon_manager The addon manager. 1
array $image The image. 1
Site_Kit_Consent_Repository_Interface $site_kit_consent_repository The repository. 1
Permanently_Dismissed_Site_Kit_Configuration_Repository_Interface $permanently_dismissed_site_kit_configuration_repository The repository. 1
Top_Page_Repository $top_page_repository The data provider for page based search rankings. 1
Top_Query_Repository $top_query_repository The data provider for query based search rankings. 1
Organic_Sessions_Repository $organic_sessions_repository The data provider for organic session traffic. 1
SEO_Score_Results_Repository $seo_score_results_repository The SEO score results repository. 1
Readability_Score_Results_Repository $readability_score_results_repository The readability score results repository. 1
Content_Types_Collector $content_types_collector The content type collector. 1
Taxonomies_Repository $taxonomies_repository The taxonomies repository. 1
Indexable_Repository $indexable_repository The indexable repository. 1
string $taxonomy The taxonomy. 1
Content_Type $content_type The content type that the taxonomy is filtering. 1
int|null $term_id The term ID to be validated. 1
Taxonomy|null $taxonomy The taxonomy. 1
Site_Kit_Analytics_4_Adapter $site_kit_analytics_4_adapter The adapter. 1
Parameters $parameters The parameter to use for getting the organic sessions' data. 1
SEO_Score_Groups_Interface ...$seo_score_groups All SEO score groups. 1
int $seo_score The SEO score to be assigned into a group. 1
Content_Types_Repository $content_types_repository The content types repository. 1
Indexable_Helper $indexable_helper The indexable helper 1
User_Helper $user_helper The user helper. 1
Enabled_Analysis_Features_Repository $enabled_analysis_features_repository The analysis feature. 1
Endpoints_Repository $endpoints_repository The endpoints repository. 1
Nonce_Repository $nonce_repository The nonce repository. 1
Site_Kit $site_kit_integration_data The Site Kit integration data. 1
Endpoint_Interface ...$endpoints The endpoints to add to the repository. 1
Current_Scores_Repository $current_scores_repository The current scores repository. 1
Content_Type $content_type The content type. 1
Taxonomy|null $taxonomy The taxonomy of the term we're filtering for. 1
int|null $term_id The ID of the term we're filtering for. 1
bool|null $is_troubleshooting Whether we're in troubleshooting mode. 1
Score_Group_Link_Collector $score_group_link_collector The score group link collector. 1
Score_Groups_Interface[] $score_groups The score groups. 1
array $score_results The score results. 1
Content_Type $content_type The content type. 1
Taxonomy|null $taxonomy The taxonomy of the term we're filtering for. 1
int|null $term_id The ID of the term we're filtering for. 1
Score_Groups_Interface $score_group The scoure group. 1
Taxonomy|null $taxonomy The taxonomy of the term we're filtering for. 1
int|null $term_id The ID of the term we're filtering for. 1
Cached_SEO_Score_Results_Collector $seo_score_results_collector The cached SEO score results collector. 1
SEO_Score_Groups_Interface ...$seo_score_groups All SEO score groups. 1
Cached_Readability_Score_Results_Collector $readability_score_results_collector The cached readability score results collector. 1
Readability_Score_Groups_Interface ...$readability_score_groups All readability score groups. 1
Parameters $parameters The parameter to use for getting the top queries. 1
Top_Page_Indexable_Collector $top_page_indexable_collector The top page indexable collector. 1
Parameters $parameters The parameter to use for getting the top pages. 1
Taxonomies_Collector $taxonomies_collector The taxonomies collector. 1
Filter_Pairs_Interface ...$filter_pairs All filter pairs. 1
Content_Types_Collector $content_types_collector The post type helper. 1
Taxonomies_Repository $taxonomies_repository The taxonomies repository. 1
Taxonomies_Collector $taxonomies_collector The taxonomies collector. 1
Filter_Pairs_Repository $filter_pairs_repository The filter pairs repository. 1
string $content_type The content type that the taxonomy filters. 1
Score_Groups_Interface $score_group The score group. 1
Taxonomy|null $taxonomy The taxonomy of the term we might be filtering. 1
int|null $term_id The ID of the term we might be filtering. 1
bool $consent The consent value. 1
bool $consent The consent status. 1
array> $dimension_filters The dimension filters. 1
array $metrics The metrics. 1
string $key The key to order by. 1
string $name The name to order by. 1
Score_Groups_Interface[] $score_groups All score groups. 1
Content_Type $content_type The content type. 1
int|null $term_id The ID of the term we're filtering for. 1
bool|null $is_troubleshooting Whether we're in troubleshooting mode. 1
SEO_Score_Results_Collector $seo_score_results_collector The collector implementation to use. 1
SEO_Score_Groups_Interface[] $score_groups All SEO score groups. 1
Readability_Score_Results_Collector $readability_score_results_collector The collector implementation to 1
Readability_Score_Groups_Interface[] $score_groups All readability score groups. 1
Content_Type $content_type The content type. 1
int|null $term_id The ID of the term we're filtering for. 1
bool|null $is_troubleshooting Whether we're in troubleshooting mode. 1
Content_Type $content_type The content type. 1
int|null $term_id The ID of the term we're filtering for. 1
Search_Console_Parameters $parameters The parameters. 1
ApiDataRow[] $response The response to parse. 1
Site_Kit_Consent_Repository_Interface $site_kit_consent_repository The 1
Permanently_Dismissed_Site_Kit_Configuration_Repository_Interface $permanently_dismissed_site_kit_configuration_repository The 1
SEO_Score_Groups_Repository $seo_score_groups_repository The SEO score groups repository. 1
Data_Container $top_pages The top pages. 1
string $url The URL of the top page. 1
Indexable $indexable The top page's indexable. 1
WP_Taxonomy|false|null $taxonomy The taxonomy to check. 1
string $content_type The name of the content type to check. 1
Taxonomy_Validator $taxonomy_validator The taxonomy validator. 1
string $content_type The content type we're hooking for. 1
string $taxonomy_name The name of the taxonomy we're going to build the object for. 1
string $content_type The content type that the taxonomy object is filtering. 1
WP_Taxonomy $taxonomy The taxonomy we want to build the REST API URL for. 1
string $date The date of the traffic data, in YYYYMMDD format. 1
Traffic_Data $traffic_data The traffic data for the date. 1
int $sessions The sessions. 1
int $total_users The total users. 1
Traffic_Data $current_traffic_data The current traffic data. 1
Traffic_Data $current_traffic_data The current traffic data. 1
string $error_message The error message of the request. 1
string $name The name of the current score. 1
int $amount The amount of the current score. 1
string $ids The ids of the current score. 1
array $links The links of the current score. 1
Current_Score $current_score The current score to add. 1
int $position The position to add the current score. 1
Current_Scores_List $current_scores_list The list of the current scores of the score result. 1
float $query_time The time the query took to get the score results. 1
bool $is_cached_used Whether cache was used to get the score results. 1
int $clicks The clicks. 1
float $ctr The ctr. 1
int $impressions The impressions. 1
float $position The position. 1
string $subject The subject of the data. 1
Search_Ranking_Data $search_ranking_data The search ranking data for the top page. 1
SEO_Score_Groups_Interface $seo_score_group The SEO score group the top page belongs to. 1
string $edit_link The edit link of the top page. 1
Endpoint_Interface $endpoint An endpoint. 1
Content_Type $content_type The content type to add. 1
string $name The name of the content type. 1
string $label The label of the content type. 1
string $name The name of the taxonomy. 1
string $label The label of the taxonomy. 1
string $rest_url The REST URL of the taxonomy. 1
Data_Interface $data The data. 1
string $start_date The start date. 1
string $end_date The end date. 1
int $limit The result limit. 1
string $compare_start_date The compare start date. 1
string $compare_end_date The compare end date. 1
Parameters $parameters The parameter to get the dashboard data for. 1
array $field_defs The $fields_defs. 1
Indexable_Cleanup_Repository $cleanup_repository The cleanup repository. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Closure[] $additional_tasks The additional tasks to validate. 1
string $task_name The task name of the next cleanup task to run. 1
int $schedule_time The time in seconds to wait before running the first cron job. Default is 1 hour. 1
array $methods The methods. 1
stdClass $category The category that is now used for the post link. 1
array|null $categories This parameter is not used. 1
WP_Post|null $post The post in question. 1
WP_Post $post The post in question. 1
Meta_Tags_Context_Memoizer $context_memoizer The meta tags context memoizer. 1
ContainerInterface $service_container The DI container. 1
Options_Helper $options The options helper. 1
Helpers_Surface $helpers The helpers surface. 1
WPSEO_Replace_Vars $replace_vars The replace vars helper. 1
string $html The HTML output. 1
array $block The block. 1
array $presenters The presenters for current page. 1
string $page_type The page type. 1
Meta_Tags_Context|null $context The meta tags context for the current page. 1
string $page_type The page type we're retrieving presenters for. 1
string[] $presenters The presenters. 1
WPSEO_Admin_Asset_Manager $asset_manager The WPSEO_Admin_Asset_Manager. 1
WPSEO_Replace_Vars $replace_vars The WPSEO_Replace_Vars. 1
Schema_Types $schema_types The Schema_Types. 1
Current_Page_Helper $current_page_helper The Current_Page_Helper. 1
Post_Type_Helper $post_type_helper The Post_Type_Helper. 1
Language_Helper $language_helper The Language_Helper. 1
Taxonomy_Helper $taxonomy_helper The Taxonomy_Helper. 1
Product_Helper $product_helper The Product_Helper. 1
Woocommerce_Helper $woocommerce_helper The Woocommerce_Helper. 1
Article_Helper $article_helper The Article_Helper. 1
User_Helper $user_helper The User_Helper. 1
Options_Helper $options The options helper. 1
Content_Type_Visibility_Dismiss_Notifications $content_type_visibility The Content_Type_Visibility_Dismiss_Notifications instance. 1
array $policies The existing policy data. 1
int $policy The policy id to check. 1
string $key The option key name. 1
array $defaults The settings defaults. 1
array $default_setting_values The default setting values. 1
array $post_types The post types. 1
WP_Post_Type[] $post_types The WP_Post_Type array to transform. 1
array $a The first post type. 1
array $b The second post type. 1
WP_Taxonomy[] $taxonomies The WP_Taxonomy array to transform. 1
string[] $post_type_names The post type names. 1
string $name The name. 1
array $rewrite The rewrite data. 1
string $rest_base The rest base. 1
Helpers_Surface $helpers The helpers. 1
WPSEO_Replace_Vars $replace_vars The replace vars. 1
WPSEO_Admin_Asset_Manager $asset_manager The admin asset manager. 1
Feature_Flag_Conditional ...$feature_flags All of the known feature flag conditionals. 1
string[] $enabled_features The list of currently enabled feature flags. 1
array $excluded_post_types The excluded post types. 1
Image_Helper $image_helper The image helper. 1
number $days Number of days. 1
number $hours Number of hours. 1
number $minutes Number of minutes. 1
array $attributes The attributes. 1
array $elements The list of elements from the block attributes. 1
string $key The key in the data to iterate over. 1
string $content The content. 1
string $src The attachment src. 1
int $post_id The post ID. 1
array $elements The elements. 1
string $key The key in the elements we should loop over. 1
array $categories The categories. 1
array $attributes The block attributes. 1
Meta_Tags_Context_Memoizer $context_memoizer The context. 1
WPSEO_Replace_Vars $replace_vars The replace variable helper. 1
Helpers_Surface $helpers The Helpers surface. 1
WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager. 1
WPSEO_Addon_Manager $addon_manager The addon manager. 1
WPSEO_Shortlinker $shortlinker The shortlinker. 1
Options_Helper $options_helper The options helper. 1
Social_Profiles_Helper $social_profiles_helper The social profile helper. 1
Product_Helper $product_helper The product helper. 1
Meta_Tags_Context $meta_tags_context The meta tags context helper. 1
WPSEO_Options_Tabs $dashboard_tabs Object representing the tabs of the General sub-page. 1
string $company_name The given company name by the user, default empty string. 1
string $website_name The given website name by the user, default empty string. 1
string $company_logo The given company logo by the user, default empty. 1
string $person_logo The given person logo by the user, default empty. 1
Options_Helper $options_helper The options helper. 1
First_Time_Configuration_Notice_Helper $first_time_configuration_notice_helper The first time configuration notice helper. 1
WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager. 1
WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager. 1
Options_Helper $options_helper The options helper. 1
Woocommerce_Helper $woocommerce_helper The WooCommerce helper. 1
Elementor_Activated_Conditional $elementor_conditional The elementor conditional. 1
Jetpack_Conditional $jetpack_conditional The Jetpack conditional. 1
Site_Kit $site_kit_integration_data The site kit integration 1
Site_Kit_Consent_Management_Endpoint $site_kit_consent_management_endpoint The site kit consent 1
Post_Type_Helper $post_type_helper The post type helper. 1
wpdb $wpdb The wpdb object. 1
Post_Link_Indexing_Action $post_link_indexing_action The post link indexing action. 1
Admin_Columns_Cache_Integration $admin_columns_cache The admin columns cache. 1
array $columns Array with columns. 1
string $field The field in the table to JOIN on. 1
array $columns Array with sortable columns. 1
Indexable_Indexing_Complete_Action $complete_indexation_action The complete indexing action. 1
Indexing_Helper $indexing_helper The indexing helper. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Yoast_Admin_And_Dashboard_Conditional $yoast_admin_and_dashboard_conditional An object that checks if we are on the Yoast admin or on the dashboard page. 1
Get_Request_Conditional $get_request_conditional An object that checks if we are handling a GET request. 1
WP_CRON_Enabled_Conditional $wp_cron_enabled_conditional An object that checks if WP_CRON is enabled. 1
Indexation_Action_Interface ...$indexing_actions A list of all available indexing actions. 1
array $schedules The existing schedules. 1
int $indexation_limit The current limit (filter input). 1
int $link_indexation_limit The current limit (filter input). 1
int $shutdown_limit The shutdown limit used to determine whether indexation should be run. 1
string $method_name The name of the method on the current instance to register. 1
WPSEO_Shortlinker $shortlinker The shortlinker. 1
Yoast_Form $yform The yoast form object. 1
Yoast_Form $yform The Yoast form class. 1
array $settings The settings being displayed. 1
Yoast_Form $yform The Yoast form class. 1
string $title Optional title for the settings being displayed. 1
array $toggles Optional naming of the toggle buttons. 1
string $warning Optional warning to be displayed above the toggles. 1
Health_Check ...$health_checks The available health checks implementations. 1
mixed $tests Array to check. 1
Options_Helper $options The options helper. 1
WPSEO_Admin_Asset_Manager $asset_manager The asset manager. 1
Migration_Status $migration_status The migrations status. 1
object $plugin The plugin. 1
WPSEO_Admin_Asset_Manager $asset_manager The asset manager. 1
array $available_actions The array of actions that we want to sort. 1
bool $is_import Wether it's an import or not. 1
string $source File source location. 1
string $remote_source Remote file source location. 1
WP_Upgrader $upgrader WP_Upgrader instance. 1
string $table The output table with Name, Version, Author, RequiresWP, and RequiresPHP info. 1
array $current_plugin_data Array with current plugin data. 1
array $new_plugin_data Array with uploaded plugin data. 1
string|bool $required_version The required version. 1
Current_Page_Helper $page_helper The current page helper. 1
Short_Link_Helper $short_link_helper The short link helper. 1
Environment_Helper $environment_helper The environment helper. 1
string $reason The reason for the notification. 1
WPSEO_Admin_Asset_Manager $asset_manager The admin asset manager. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Short_Link_Helper $short_link_helper The short link helper. 1
Indexing_Helper $indexing_helper The indexing helper. 1
WPSEO_Addon_Manager $addon_manager The addon manager. 1
Product_Helper $product_helper The product helper. 1
Date_Helper $date_helper The date helper. 1
array $excluded_taxonomies The excluded taxonomies. 1
string $premium_file The premium file. 1
string $current_page The current page. 1
string $target Extra table navigation location which is triggered. 1
array $pages The pages, each containing an ID and post_parent. 1
array $children_pages The full map of child pages. 1
int $count The number of pages already processed. 1
int $parent_id The id of the parent that's currently being processed. 1
int $start The number at which the current overview starts. 1
int $end The number at which the current overview ends. 1
int $to_display The page IDs to be shown. 1
int $pages_map A map of page ID to an object with ID and post_parent. 1
WPSEO_Addon_Manager $addon_manager The addon manager. 1
Addon_Activate_Action $addon_activate_action The addon activate action. 1
Addon_Install_Action $addon_install_action The addon install action. 1
string $addon_slug The addon to activate. 1
string $addon_slug The slug of the addon to install. 1
string $addon_download The download URL of the addon. 1
string[] $allowed_dismissable_alerts The allowed dismissable alerts. 1
Indexable_Helper $indexable_helper Indexable Helper. 1
array $old_value The old value. 1
array $new_value The new value. 1
array $values Key-value map of variables we enqueue in the JavaScript of the post editor. 1
WP_Post $post The post currently opened in the editor. 1
Wincher_Enabled_Conditional $wincher_enabled The WPML WPSEO conditional. 1
Options_Helper $options_helper The options helper. 1
Wincher_Keyphrases_Action $keyphrases_action The keyphrases action class. 1
Wincher_Account_Action $account_action The account action class. 1
WP_Post $post The post to extract the keyphrases from. 1
WP_Post $post The copy's post object. 1
int $post_id The copy's post ID. 1
WP_Post $post The copy's post object. 1
array $presenters The presenters. 1
Meta_Tags_Context $context The meta tags context for the current page. 1
string $description The description sentence. 1
Indexable_Presentation $presentation The presentation of an indexable. 1
string|string[] $type The Article type. 1
Indexable $indexable The indexable. 1
Options_Helper $options The options helper. 1
WPSEO_Replace_Vars $replace_vars The replace vars helper. 1
Meta_Tags_Context_Memoizer $context_memoizer The meta tags context memoizer. 1
Indexable_Repository $repository The indexable repository. 1
Pagination_Helper $pagination_helper The paginataion helper. 1
Woocommerce_Helper $woocommerce_helper The WooCommerce helper. 1
string $canonical The current canonical. 1
Indexable[] $indexables The array with indexables. 1
int $page_id The page id. 1
string $title The title. 1
string $description The title. 1
string $option_name The option name to get the template for. 1
string $shop_page_id The page id to retrieve template for. 1
string $rel Link relationship, prev or next or curr. 1
string $home_url The filtered home URL. 1
string $home_url The url altered by WPML. Unused. 1
string $url The url that isn't altered by WPML. 1
array $input The array to add the isWebStoriesIntegrationActive to. 1
Short_Link_Helper $short_link_helper The short link helper. 1
Yoast_Notification_Center $notification_center The notification center. 1
WPML_WPSEO_Conditional $wpml_wpseo_conditional The WPML WPSEO conditional. 1
Options_Helper $options The options helper. 1
Capability_Helper $capability The capability helper. 1
Request_Post $request_post The Request_Post. 1
Meta_Surface $meta The meta surface. 1
string $show The output so far. 1
string $what What is being shown. 1
bool $for_comments If the RRS feed is meant for a comment feed. 1
bool $for_comments If the RSS feed is meant for a comment feed. 1
string $separator The separator from WordPress. 1
string $url The URL determined so far. 1
string $content Feed item excerpt. 1
string $context The context of the RSS content. 1
string $content The RSS content that should have the variables replaced. 1
string $link_template The link template. 1
mixed $post The post to use. 1
Options_Helper $options_helper Options helper. 1
Robots_Txt_Helper $robots_txt_helper Robots txt helper. 1
Robots_Txt_Presenter $robots_txt_presenter Robots txt presenter. 1
string $robots_txt The robots.txt output from WordPress. 1
string $robots_txt Input robots.txt. 1
Options_Helper $options Options helper. 1
WP_Query_Wrapper $wp_query WP query wrapper. 1
string $content The content to remove the titles from. 1
array $parts_with_title The parts containing a title. 1
string $part_with_title The part with the title that needs to be replaced. 1
string $content The entire content. 1
WP_Query_Wrapper $query_wrapper The query wrapper. 1
bool $handled Whether we've handled the request. 1
string $description String to add shortcodes in. 1
array $robots The current robots data. 1
array $robots Our robots value. 1
array $robots The robots. 1
array $robots The robots array. 1
Meta_Surface $meta The meta surface. 1
array $data The oEmbed data. 1
WP_Post $post The current Post object. 1
Options_Helper $options_helper The option helper. 1
Redirect_Helper $redirect_helper The redirect helper. 1
WP_Query $query The main query. 1
WP_Query $query The main WordPress query. 1
string $reason The reason for redirecting away. 1
string $to_url The URL to redirect to. 1
string $text The text string to detect emoji in. 1
Robots_Helper $robots The robots helper. 1
string $link The comment link as a string. 1
array $piece The graph piece. 1
Meta_Tags_Context $context The context. 1
Abstract_Schema_Piece $the_generator The current schema generator. 1
Abstract_Schema_Piece[] $generators The schema generators. 1
array $piece The schema piece. 1
Robots_Helper $robots The robots helper. 1
string $input The link element as a string. 1
int $expiration The expiration time. 1
string $url The location we're redirecting to. 1
string $reason The reason we're redirecting. 1
array $hints The hints we're adding to. 1
Options_Helper $options Options helper. 1
Meta_Helper $meta Meta helper. 1
Redirect_Helper $redirect The redirect helper. 1
array $query_vars The query variables in the current URL. 1
string $base_url The base URL without query string. 1
Options_Helper $options_helper The options helper. 1
Primary_Term_Repository $primary_term_repository The primary term repository. 1
Post_Type_Helper $post_type_helper The post type helper. 1
Indexable_Hierarchy_Builder $indexable_hierarchy_builder The indexable hierarchy repository. 1
int $object_id Object ID. 1
array $terms Unused. An array of object terms. 1
array $tt_ids An array of term taxonomy IDs. 1
string $taxonomy Taxonomy slug. 1
int $post_id The post id to set primary taxonomy for. 1
string $main_taxonomy Name of the taxonomy that is set to be the primary one. 1
array $old_value The old `wpseo_titles` option value. 1
array $new_value The new `wpseo_titles` option value. 1
Indexable_Builder $builder The date archive builder to use. 1
Post_Type_Helper $post_type The post type helper. 1
Options_Helper $options The options helper. 1
Indexable_Helper $indexable The indexable helper. 1
Taxonomy_Helper $taxonomy_helper The taxonomy helper. 1
string $post_type The post type to reset. 1
string $old_value Unused. The old option value. 1
string $new_value Unused. The new option value. 1
string $type The option name. 1
array $post_types The post types to get taxonomies for. 1
Indexable_Repository $repository The repository to use. 1
Indexable_Builder $builder The post builder to use. 1
Indexable_Link_Builder $link_builder The lint builder to use. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Site_Helper $site The site helper. 1
int $term_id The Term ID to delete. 1
int $term_id ID of the term to save data for. 1
Post_Type_Helper $post_type_helper The post_typehelper. 1
string $integration_option The intergration option name. 1
string $target_option The target option to remove the tokens from. 1
array $new_value The new value of the option. 1
string $old_html The old HTML. 1
string $plugin The plugin. 1
string $option The name of the option that is being created. 1
array|mixed $value The new (and first) value of the option that is being created. 1
string $option The name of the option that has been updated. 1
array $new_value The new value of the `auto_update_plugins` option. 1
array $old_value The old value of the `auto_update_plugins` option. 1
string $plugin The plugin that is activated. 1
string $plugin_id The plugin ID. 1
array $auto_updated_plugins The array of auto updated plugins. 1
Current_Page_Helper $current_page_helper The current page helper. 1
Taxonomy_Helper $taxonomy_helper The taxonomy helper. 1
string $old_value The previous homepage's ID. 1
int $value The new homepage's ID. 1
int $page_id The page's id. 1
Indexable_Repository $repository The repository to use. 1
Indexable_Builder $builder The post builder to use. 1
Indexable_Hierarchy_Repository $hierarchy_repository The hierarchy repository to use. 1
Indexable_Link_Builder $link_builder The link builder. 1
Author_Archive_Helper $author_archive The author archive helper. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Post_Helper $post The post helper. 1
WP_Post $post The post. 1
Indexable $author_indexable The author indexable. 1
WP_Post $post The post that has been updated. 1
WP_Post $post The post to get the indexables for. 1
Indexable_Builder $builder The builder to use. 1
int $user_id User ID to delete the metadata of. 1
int $user_id User ID. 1
int|null $new_user_id The ID of the user the old author's posts are reassigned to. 1
int $user_id The user ID. 1
int $new_user_id The user ID to reassign the indexables to. 1
Indexable_Repository $indexable_repository The indexable repository. 1
Indexable_Hierarchy_Builder $indexable_hierarchy_builder The indexable hierarchy builder. 1
Permalink_Helper $permalink_helper The permalink helper. 1
Post_Type_Helper $post_type_helper The post type helper. 1
Indexable $indexable The indexable. 1
Indexable $indexable_before The old indexable. 1
int $term_id Term to fetch the indexable for. 1
array $child_indexables The already known child indexables. 1
Indexable $indexable The indexable to update the hierarchy and permalink for. 1
int $term_id The term to get the object id's for. 1
array $child_indexables The child indexables. 1
array $old_value The old value of the option. 1
array $new_value The new value of the option. 1
string $option The name of the option. 1
Attachment_Cleanup_Helper $attachment_cleanup The attachment cleanup helper. 1
Post_Type_Helper $post_type The post type helper. 1
Options_Helper $options The options helper. 1
Indexable_Helper $indexable The indexable helper. 1
Indexable_Post_Watcher $post_watcher The post watcher. 1
int|string $meta_id The meta ID. 1
int|string $post_id The post ID. 1
string $meta_key The meta key. 1
int|string $post_id The post ID. 1
Primary_Term_Repository $repository The primary term repository. 1
Site_Helper $site The site helper. 1
Primary_Term_Helper $primary_term The primary term helper. 1
Primary_Term_Builder $primary_term_builder The primary term builder. 1
int $post_id Post ID to save primary terms for. 1
int $post_id Post ID to save primary term for. 1
WP_Term $taxonomy Taxonomy to save primary term for. 1
int $post_id The post to delete the terms of. 1
Yoast_Notification_Center $notification_center The notification center. 1
Notification_Helper $notification_helper The notification helper. 1
Short_Link_Helper $short_link_helper The short link helper. 1
WooCommerce_Conditional $woocommerce_conditional The WooCommerce conditional. 1
Indexable_Builder $builder The post builder to use. 1
string $type The type of no index page. 1
array $old_value The old value of the option. 1
array $new_value The new value of the option. 1
array $post_types The post types to remove hierarchy for. 1
WP_Query_Wrapper $wp_query_wrapper The wp query wrapper. 1
Taxonomy_Helper $taxonomy The Taxonomy helper. 1
Post_Type_Helper $post_type The post type helper. 1
Author_Archive_Helper $author_archive The author archive helper. 1
array $data The data that this is a presentation of. 1
Schema_Generator $schema_generator The schema generator. 1
Open_Graph_Locale_Generator $open_graph_locale_generator The Open Graph locale generator. 1
Open_Graph_Image_Generator $open_graph_image_generator The Open Graph image generator. 1
Twitter_Image_Generator $twitter_image_generator The Twitter image generator. 1
Breadcrumbs_Generator $breadcrumbs_generator The breadcrumbs generator. 1
Image_Helper $image The image helper. 1
User_Helper $user The user helper. 1
Indexable_Helper $indexable The indexable helper. 1
Permalink_Helper $permalink The permalink helper. 1
Values_Helper $values The values helper. 1
array $robots The meta robots values to filter. 1
Post_Type_Helper $post_type The post type helper. 1
Date_Helper $date The date helper. 1
Post_Helper $post The post helper. 1
Promotion_Interface ...$promotions List of promotions. 1
int $time_start Interval start time. 1
int $time_end Interval end time. 1
int $time The time to check. 1
int $time_start The interval start time. 1
int $time_end The interval end time. 1
string $promotion_name The promotion name. 1
Time_Interval $time_interval The time interval in which the promotion is active. 1
User_Helper $user User helper. 1
string $integration_name The name of the integration to activate/deactivate. 1
bool $value The value to store. 1
Options_Helper $options_helper The WPSEO options helper. 1
Social_Profiles_Helper $social_profiles_helper The social profiles helper. 1
int $user_id The person ID. 1
int $user_id The id of the user to be edited. 1
array $fields_names The fields to get the old values for. 1
Wincher_Client $client The API client. 1
string|array $keyphrases One or more keyphrases that should be tracked. 1
Object $limits The limits API call response data. 1
int $keyphrase_id The ID of the keyphrase to untrack. 1
array|null $used_keyphrases The currently used keyphrases. Optional. 1
string|null $permalink The current permalink. Optional. 1
string|null $start_at The position start date. Optional. 1
WP_Post $post The post object. 1
array $results The results to filter. 1
array $used_keyphrases The used keyphrases. 1
string|array $keyphrases The keyphrases to be added. 1
object $limits The current account limits. 1
string $code The authentication code to use to request a token with. 1
string $website_id The website id associated with the code. 1
string $code The authentication code to use to request a token with. 1
string $country_code The country code to store. 1
string $keyphrase The keyphrase to search for. 1
string $database The database's country code. 1
Require_File_Helper $require_file_helper A helper that can require files. 1
string $plugin_slug The plugin slug to install. 1
string $download_url The plugin download URL. 1
string $plugin_slug The plugin to check. 1
string $plugin_download The url to the download. 1
Require_File_Helper $require_file_helper A file helper. 1
string $plugin_slug The plugin slug to get download url for. 1
Taxonomy_Helper $taxonomy_helper The taxonomy helper. 1
int|false $limit The maximum number of term link IDs to return. 1
Taxonomy_Helper $taxonomy The taxonomy helper. 1
Indexable_Builder_Versions $builder_versions The latest versions of all indexable builders. 1
bool $limit The maximum number of term IDs to return. 1
Indexable_Builder_Versions $builder_versions The latest versions for each Indexable type. 1
Indexable_Repository $repository The indexable repository. 1
Indexable_Builder $builder The indexable builder. 1
Post_Type_Helper $post_type The post type helper. 1
Indexable_Builder_Versions $versions The current versions of all indexable builders. 1
int $limit Limit the number of counted objects. 1
int|false $limit Limit the number of retrieved indexables to this number. 1
int|false $limit The maximum number of post link IDs to return. 1
Indexable_Link_Builder $link_builder The indexable link builder. 1
Indexable_Helper $indexable_helper The indexable repository. 1
Indexable_Repository $repository The indexable repository. 1
wpdb $wpdb The WordPress database instance. 1
int|bool $limit Unused. 1
Meta_Surface $meta_surface The meta surface. 1
string $url The url to get the head for. 1
int $type The id. 1
object $head The calculated Yoast head. 1
Meta|false $meta The meta object. 1
string $type The type of value to retrieve. 1
string $argument Optional. The argument for the value. 1
Import_Cursor_Helper $import_cursor The import cursor helper. 1
Options_Helper $options The options helper. 1
Sanitization_Helper $sanitization The sanitization helper. 1
Aioseo_Replacevar_Service $replacevar_handler The replacevar handler. 1
Aioseo_Robots_Provider_Service $robots_provider The robots provider service. 1
Aioseo_Robots_Transformer_Service $robots_transformer The robots transfomer service. 1
Conflicting_Plugins_Service $conflicting_plugins_service The Conflicting plugins Service. 1
int $limit The maximum. 1
string|null $plugin The name of the plugin being imported. 1
string|null $type The component of the plugin being imported. 1
string|null $plugin The plugin to import from. 1
string|null $type The type of data to import. 1
bool $completed Whether the importer is completed. 1
string $redirect_attachment The redirect_attachment setting. 1
wpdb $wpdb The WordPress database instance. 1
wpdb $wpdb The WordPress database instance. 1
Options_Helper $options The options helper. 1
Aioseo_Custom_Archive_Settings_Importing_Action $custom_archive_action The Custom Archive Settings importing action. 1
Aioseo_Default_Archive_Settings_Importing_Action $default_archive_action The Default Archive Settings importing action. 1
Aioseo_General_Settings_Importing_Action $general_settings_action The General Settings importing action. 1
Aioseo_Posttype_Defaults_Settings_Importing_Action $posttype_defaults_settings_action The Posttype Defaults Settings importing action. 1
Aioseo_Taxonomy_Settings_Importing_Action $taxonomy_settings_action The Taxonomy Settings importing action. 1
Aioseo_Posts_Importing_Action $post_importing_action The Post importing action. 1
int $limit The maximum number of unimported objects to be returned. Not used, exists to comply with the interface. 1
Import_Helper $import_helper The import helper. 1
string $aioseo_settings The AIOSEO option. 1
array $importable_data All of the available AIOSEO settings. 1
int $limit The maximum number of unimported objects to be returned. 1
string|array $setting_value The value of the AIOSEO setting at hand. 1
string $setting The setting at hand, eg. post or movie-category, separator etc. 1
string $setting The name of the setting. 1
string $setting_value The values of the setting. 1
array $setting_mapping The mapping of the setting to Yoast formats. 1
bool $meta_data The boolean meta data to be imported. 1
bool $noindex The noindex of the type, without taking into consideration whether the type defers to global defaults. 1
Indexable_Repository $indexable_repository The indexables repository. 1
wpdb $wpdb The WordPress database instance. 1
Import_Cursor_Helper $import_cursor The import cursor helper. 1
Indexable_Helper $indexable_helper The indexable helper. 1
Indexable_To_Postmeta_Helper $indexable_to_postmeta The indexable_to_postmeta helper. 1
Options_Helper $options The options helper. 1
Image_Helper $image The image helper. 1
Sanitization_Helper $sanitization The sanitization helper. 1
Aioseo_Replacevar_Service $replacevar_handler The replacevar handler. 1
Aioseo_Robots_Provider_Service $robots_provider The robots provider service. 1
Aioseo_Robots_Transformer_Service $robots_transformer The robots transfomer service. 1
Aioseo_Social_Images_Provider_Service $social_images_provider The social images provider service. 1
array $aioseo_indexable The AIOSEO indexable. 1
string $transform_method The method that is going to be used for transforming the data. 1
array $aioseo_indexable The data of the AIOSEO indexable data that is being imported. 1
string $aioseo_key The name of the specific set of data that is going to be transformed. 1
array $yoast_mapping Extra details for the import of the specific data that is going to be transformed. 1
Indexable $indexable The Yoast indexable that we are going to import the transformed data into. 1
int $limit The maximum number of unimported objects to be returned. 1
bool $just_detect Whether we want to just detect if there are unimported objects. If false, we want to actually import them too. 1
string $aioseo_key The AIOSEO key that contains the setting we're working with, aka keyphrases. 1
bool $aioseo_robots_settings AIOSEO's set of robot settings for the post. 1
bool $aioseo_robots_settings AIOSEO's set of robot settings for the post. 1
string $aioseo_key The AIOSEO key that contains the robot setting we're working with. 1
array $mapping The mapping of the setting we're working with. 1
bool $aioseo_social_image_settings AIOSEO's set of social image settings for the post. 1
string $aioseo_key The AIOSEO key that contains the robot setting we're working with. 1
array $mapping The mapping of the setting we're working with. 1
Indexable $indexable The Yoast indexable we're importing into. 1
Post_Type_Helper $post_type The post type helper. 1
Image_Helper $image The image helper. 1
string $logo_url The company logo url coming from AIOSEO settings. 1
string $logo_url The person logo url coming from AIOSEO settings. 1
string $site_represents The site represents setting. 1
string $separator The separator setting. 1
Introductions_Seen_Repository $introductions_seen_repository The repository. 1
User_Helper $user_helper The user helper. 1
Introductions_Collector $introductions_collector The introduction collector. 1
WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager. 1
Introductions_Collector $introductions_collector The introductions' collector. 1
string[] $capabilities The required capabilities. 1
User_Helper $user_helper The user helper. 1
Introduction_Interface ...$introductions All the introductions. 1
Introduction_Interface ...$introductions The introductions. 1
string $name The name. 1
string[] $metadata The metadata. 1
string $introduction_id The introduction ID to check. 1
string[] $pages The applicable pages. 1
string $version The version to compare. 1
string $min_version The minimum version. 1
string $max_version The maximum version. 1
int $user_id User ID. 1
int $user_id The user ID. 1
bool $is_seen Whether the introduction is seen. Defaults to true. 1
int $user_id The user ID. 1
bool $value The value. 1
string $message Optional. The Exception message to throw. 1
int $code Optional. The Exception code. 1
Throwable|null $previous Optional. The previous throwable used for the exception chaining. 1
string $id The ID. 1
int $priority The priority. 1
Introduction_Item $introduction The introduction. 1
Indexable_Post_Indexation_Action $post_indexation_action The post indexation 1
Indexable_Term_Indexation_Action $term_indexation_action The term indexation 1
Indexable_Post_Type_Archive_Indexation_Action $post_type_archive_indexation_action The post type archive 1
Indexable_General_Indexation_Action $general_indexation_action The general indexation 1
Indexable_Indexing_Complete_Action $complete_indexation_action The complete indexation 1
Indexing_Prepare_Action $prepare_indexing_action The prepare indexing 1
Post_Link_Indexing_Action $post_link_indexing_action The post link indexation 1
Term_Link_Indexing_Action $term_link_indexing_action The term link indexation 1
Indexable_Helper $indexable_helper The indexable helper. 1
array $assoc_args The associative arguments. 1
string $name The name of the object to be indexed. 1
Indexation_Action_Interface $indexation_action The indexation action. 1
int $interval Number of microseconds (millionths of a second) to wait between index actions. 1
Cleanup_Integration $cleanup_integration The integration that cleans up on cron. 1
ContainerInterface $container The DI container. 1
Meta_Tags_Context_Memoizer $context_memoizer The meta tags context memoizer. 1
WP_Rewrite_Wrapper $wp_rewrite_wrapper The WP rewrite wrapper. 1
Indexable_Helper $indexable_helper The indexable helper. 1
string|null $post_type Optional. The post type to get the archive meta for. Defaults to the current post type. 1
int $id The ID of the post. 1
int[] $ids The IDs of the posts. 1
int $id The ID of the term. 1
int $id The ID of the author. 1
string|null $page_type Optional. The page type if already known. 1
Indexable[] $indexables The indexables. 1
string|null $page_type Optional. The page type if already known. 1
string $url The url of the page. Required to be relative to the site url. 1
string $url The url. 1
string $class_name The class to get the instance of. 1
ContainerInterface $container The dependency injection container. 1
Open_Graph_Helpers_Surface $open_graph The OpenGraph helpers surface. 1
Schema_Helpers_Surface $schema The Schema helpers surface. 1
Twitter_Helpers_Surface $twitter The Twitter helpers surface. 1
Meta_Tags_Context $context The indexable presentation. 1
ContainerInterface $container The DI container. 1
Abstract_Indexable_Presenter $presenter The presenter. 1
Abstract_Indexable_Presenter $presenter The presenter whose key and value are to be converted to JSON. 1
Indexable_Repository $repository The repository. 1
Options_Helper $options The options helper. 1
Current_Page_Helper $current_page_helper The current page helper. 1
Post_Type_Helper $post_type_helper The post type helper. 1
Url_Helper $url_helper The URL helper. 1
Pagination_Helper $pagination_helper The pagination helper. 1
Indexable $ancestor The ancestor indexable. 1
string[] $crumb The crumb. 1
int $page_for_posts The page for posts ID. 1
Meta_Tags_Context $context The meta tags context. 1
string[] $crumbs The array of breadcrumbs. 1
Indexable $current_indexable The current indexable. 1
Options_Helper $options The options helper. 1
Url_Helper $url The url helper. 1
Images $image_container The image container. 1
Meta_Tags_Context $context The context. 1
Images $image_container The image container. 1
Image_Helper $image The image helper. 1
Url_Helper $url The url helper. 1
Twitter_Image_Helper $twitter_image The Twitter image helper. 1
Helpers_Surface $helpers The helpers surface. 1
Replace_Vars_Helper $schema_replace_vars_helper The replace vars helper. 1
array $graph_pieces The current list of graph pieces that we want to generate. 1
array $graph_piece_generators The schema graph pieces to generate. 1
Meta_Tags_Context $context The meta tags context to use. 1
array $graph_piece The WebPage graph piece that should be adapted for password-protected posts. 1
array $graph_piece The graph piece we're filtering. 1
string $identifier The identifier of the graph piece that is being filtered. 1
Meta_Tags_Context $context The meta tags context. 1
Abstract_Schema_Piece $graph_piece_generator A value object with context variables. 1
Abstract_Schema_Piece[] $graph_piece_generators A value object with context variables. 1
array> $data The WebPage schema. 1
WP_Post $post The post the context is representing. 1
array> $data WebPage schema data. 1
array> $data The WebPage data. 1
string[] $same_as_urls Array of SameAs URLs. 1
int $user_id User ID. 1
int $user_id The user ID to use. 1
bool $add_hash Wether or not the person's image url hash should be added to the image id. 1
bool $add_hash Whether or not the person's image url hash should be added to the image id. 1
string $social_site The social site to retrieve the URL for. 1
int|false $user_id The user ID to use function outside of the loop. 1
array $data The Person schema data. 1
WP_User $user_data The user data object. 1
int $user_id The user ID to use. 1
int $index The position in the list. 1
array $breadcrumb The breadcrumb to test. 1
array $question The question to generate schema for. 1
int $position The position of the question. 1
array $question The question to add the acceptedAnswer to. 1
array $data Our How-To schema data. 1
array $attributes The block data attributes. 1
array $data Our How-To schema data. 1
array $steps Our How-To block's steps. 1
array $schema_step Our Schema output for the Step. 1
string $json_text The step text. 1
array $schema_step Our Schema output for the Step. 1
array $step The step block data. 1
array $graph Our Schema data. 1
array $block The How-To block content. 1
int $index The index of the current block. 1
string $url Attachment url. 1
array $data The Person schema. 1
string $schema_id The string used in the `@id` for the schema. 1
bool $add_hash Whether or not the person's image url hash should be added to the image id. 1
array $data Article data. 1
string $key The key in data to save the terms in. 1
string $taxonomy The taxonomy to retrieve the terms from. 1
string $post_content The post content. 1
string $post_title The post title. 1
Alert_Dismissal_Action $alert_dismissal_action The alert dismissal action. 1
SEMrush_Login_Action $login_action The login action. 1
SEMrush_Options_Action $options_action The options action. 1
SEMrush_Phrases_Action $phrases_action The phrases action. 1
WP_REST_Request $request The request. This request should have a country code param set. 1
string $keyphrase The keyphrase to check. 1
WP_REST_Request $request The request. This request should have a keyphrase and country_code param set. 1
string $country_code The country code to check. 1
Wincher_Login_Action $login_action The login action. 1
Wincher_Account_Action $account_action The account action. 1
Wincher_Keyphrases_Action $keyphrases_action The keyphrases action. 1
int $website_id The website_id to check. 1
Integrations_Action $integrations_action The integrations action. 1
WP_REST_Request $request The REST request. 1
Indexable_Head_Action $head_action The head action. 1
WP_REST_Request $request The request. This request should have a url param set. 1
string $url The url to check. 1
Indexable_Post_Indexation_Action $post_indexation_action The post indexing action. 1
Indexable_Term_Indexation_Action $term_indexation_action The term indexing action. 1
Indexable_Post_Type_Archive_Indexation_Action $post_type_archive_indexation_action The post type archive indexing action. 1
Indexable_General_Indexation_Action $general_indexation_action The general indexing action. 1
Indexable_Indexing_Complete_Action $indexable_indexing_complete_action The complete indexing action. 1
Indexing_Complete_Action $indexing_complete_action The complete indexing action. 1
Indexing_Prepare_Action $prepare_indexing_action The prepare indexing action. 1
Post_Link_Indexing_Action $post_link_indexing_action The post link indexing action. 1
Term_Link_Indexing_Action $term_link_indexing_action The term link indexing action. 1
Options_Helper $options_helper The options helper. 1
Indexing_Helper $indexing_helper The indexing helper. 1
Post_Type_Helper $post_type_helper The post type helper. 1
Taxonomy_Helper $taxonomy_helper The taxonomy helper. 1
Post_Helper $post_helper The post helper. 1
Indexable_Head_Action $head_action The head action. 1
string $callback The function name of the callback. 1
stdObject $head The Yoast head. 1
string $format The format to return. 1
First_Time_Configuration_Action $first_time_configuration_action The first-time configuration action. 1
array $objects The objects that have been indexed. 1
string $next_url The url that should be called to continue reindexing. False if done. 1
Importable_Detector_Service $importable_detector The importable detector service. 1
Importing_Action_Interface ...$importers All available importers. 1
mixed $data The request parameters. 1
string $date Date string to convert. 1
bool $translate Whether the return date should be translated. Default false. 1
WP_Post_Type|string $post_type The name of the post type to check. 1
array $included_post_types The post types that are included to be indexed. 1
string $post_type The post type that is checked. 1
SEO_Links_Repository $seo_links_repository The SEO Links repository. 1
int $attachment_id The attachment ID to get the attachment by. 1
string $image_extension The image extension. 1
string $mime_type The detected mime type. 1
int $attachment_id The attachment. 1
string $image_size The image size to retrieve. 1
int $post_id The post id to get featured image id for. 1
int $post_id Post ID to use. 1
int $term_id The term id to extract the images from. 1
string $size The size to get. 1
string $size Size name. 1
string $url The URL to find the attachment for. 1
string $setting The setting name. Should be company or person. 1
string $url The URL to get the path from. 1
string $url The URL to get the host from. 1
string $url The URL. 1
string $url The url that needs to be absolute. 1
string|null $path Optional path string. 1
array $url The URL, as parsed by wp_parse_url. 1
array|null $home_url Optional. The home URL, as parsed by wp_parse_url. Used to avoid reparsing the home_url. 1
bool $is_image Whether or not the link is an image. 1
bool $with_request_uri Whether we want the REQUEST_URI appended. 1
string $parsed_url The URL to parse. 1
wpdb $wpdb The WordPress database instance. 1
Wpdb_Helper $wpdb_helper The wpdb helper. 1
string $key Internal key of the value to set (without prefix). 1
mixed $meta_value The value to set the meta value to. 1
int $post_id Post ID of the post to set the value for. 1
string $key The key it should return. 1
mixed $default_value The default value that should be returned if the key isn't set. 1
string $option_titles_key The key of the option title you wish to get. 1
string $url The url to be checked. 1
string $twitter_id The twitter id to be checked. 1
int $user_id User ID. 1
string $key Optional. The meta key to retrieve. By default, returns data for all keys. 1
bool $single Whether to return a single value. 1
int $user_id User ID. 1
array|string $post_type Optional. Single post type or array of post types to count the number of posts 1
string $field The user field to retrieve. 1
string $meta_key Metadata key. 1
mixed $meta_value Metadata value. Must be serializable if non-scalar. 1
mixed $prev_value Optional. Previous value to check before updating. 1
string $meta_key Metadata name. 1
mixed $meta_value Optional. Metadata value. If provided, 1
Robots_Helper $robots_helper The Robots_Helper. 1
int $score The readability analysis score. 1
int $score The inclusive language analysis score. 1
Indexable|false $indexable The Indexable. 1
string $extra_class Optional. Any extra class. 1
string $no_index_title Optional. Override the title when not indexable. 1
Options_Helper $options_helper The options helper. 1
Environment_Helper $environment_helper The environment helper. 1
Indexing_Helper $indexing_helper The indexing helper. 1
string|null $type The type of the indexable. 1
string $reason The reason that the permalink has been changed. 1
array $fields The Yoast indexable fields that we're checking against. 1
string $field The field that we're checking. 1
Indexable $indexable The indexable. 1
Indexable|null $indexable_before The indexable before possible changes. 1
int $person_id The id of the person. 1
int $person_id The id of the person to edit. 1
array $social_profiles The array of the person's social profiles to be set. 1
array $social_profiles An array with the social profiles values to be saved in the db. 1
string|array $social_field The social field to sanitize. 1
string $url The url to be validated. 1
string $url_setting The name of the setting to be updated with the url. 1
array $urls The urls to be validated. 1
string $urls_setting The name of the setting to be updated with the urls. 1
array $twitter_site The twitter value to be validated. 1
string $twitter_setting The name of the twitter setting to be updated with the value. 1
string $header The header to remove. 1
WP_Rewrite_Wrapper $wp_rewrite_wrapper The rewrite wrapper. 1
WP_Query_Wrapper $wp_query_wrapper The query wrapper. 1
string $url The un-paginated URL of the current archive. 1
string $page The page number to add on to $url for the $link tag. 1
bool $add_pagination_base Optional. Whether to add the pagination base (`page`) to the url. 1
string $pagination_query_name Optional. The name of the query argument that holds the current page. 1
wpdb $wpdb The WordPress database instance. 1
string $table The table to be checked. 1
string $user_id The user ID. 1
string $path The path to the required file. 1
array $array_to_flatten The array to be flattened. 1
string $key_prefix The key to be used as a prefix. 1
string $user_agent The user agent to add the disallow rule to. 1
string $path The path to add as a disallow rule. 1
string $user_agent The user agent to add the allow rule to. 1
string $path The path to add as a allow rule. 1
string $absolute_path The absolute path to the sitemap to add. 1
string $text The text to strip the tags from. 1
string $text Text input to standardize. 1
string $text Input string that might contain shortcodes. 1
Post_Type_Helper $post_type_helper The Post_Type_Helper. 1
Taxonomy_Helper $taxonomy_helper The Taxonomy_Helper. 1
Indexable $indexable The Indexable. 1
array $robots The current robots value. 1
WP_Query_Wrapper $wp_query_wrapper The wrapper for WP_Query. 1
string $handle The handle of the asset. 1
Options_Helper $options_helper The option helper. 1
Url_Helper $url_helper The URL helper. 1
Redirect_Helper $redirect_helper The Redirect Helper. 1
Options_Helper $options The options helper. 1
String_Helper $string_helper The string helper. 1
string $taxonomy The taxonomy slug. 1
int $term_id Term ID. 1
WP_Term $term Term to get the meta value for. 1
string $taxonomy The name of the taxonomy. 1
string $taxonomy The taxonomy to check. 1
Date_Helper $date_helper The date helper. 1
Indexable_Post_Indexation_Action $post_indexation The post indexing action. 1
Indexable_Term_Indexation_Action $term_indexation The term indexing action. 1
Indexable_Post_Type_Archive_Indexation_Action $post_type_archive_indexation The posttype indexing action. 1
Indexable_General_Indexation_Action $general_indexation The general indexing (homepage etc) action. 1
Post_Link_Indexing_Action $post_link_indexing_action The post crosslink indexing action. 1
Term_Link_Indexing_Action $term_link_indexing_action The term crossling indexing action. 1
string $reason The indexing reason. 1
int|bool $timestamp The start time when the indexing process has started but not completed, false otherwise. 1
bool $is_first_time_indexing Whether or not a site still has to be indexed for the first time. 1
int $unindexed_count The number of unindexed objects. 1
int $limit Limit the number of unindexed objects that are counted. 1
Indexation_Action_Interface[]|Limited_Indexing_Action_Interface[] $actions The actions whose counts will be calculated. 1
String_Helper $string_helper The string helper. 1
Post_Type_Helper $post_type_helper The string helper. 1
string $content Content to remove all the shortcode tags from. 1
WP_Post|null $post The post. 1
int $post_id Optional. Post ID. 1
int $post_parent Post ID. 1
int $has_public_posts Whether the parent is public. 1
int $post_id Post ID to check. 1
Yoast_Notification $notification The notification to restore. 1
string $language The used language. 1
string $language The language to check. 1
string $language The language to check if inclusive language is supported. 1
string $cursor_id The cursor id. 1
mixed $default_value The default value if no cursor has been set yet. 1
string $cursor_id The cursor id. 1
int $last_imported_id The id of the lastly imported entry. 1
Post_Helper $post The post helper. 1
int $post_id The post id. 1
WP_Block_Parser_Block[] $blocks The blocks. 1
array $collection The collection. 1
Meta_Helper $meta The Meta helper. 1
Indexable $indexable The Yoast indexable. 1
int $image_id The image id. 1
string|null $post_type Post type to check. 1
string $object_sub_type The sub type of the object to check author support for. 1
HTML_Helper $html The HTML helper. 1
Language_Helper $language The language helper. 1
Main_Image_Helper $image The 'main' image helper. 1
string $schema_id The `@id` to use for the returned image. 1
string $url The image URL to base our object on. 1
string $caption An optional caption. 1
bool $add_hash Whether a hash will be added as a suffix in the @id. 1
string $schema_id The `@id` to use for the returned image. 1
int $attachment_id The attachment to retrieve data from. 1
bool $add_hash Whether a hash will be added as a suffix in the @id. 1
string $schema_id The `@id` to use for the returned image. 1
array $attachment_meta The attachment metadata. 1
string $caption The caption string, if there is one. 1
bool $add_hash Whether a hash will be added as a suffix in the @id. 1
string $schema_id The `@id` to use for the returned image. 1
string $url The image URL. 1
string $caption A caption, if set. 1
bool $add_hash Whether a hash will be added as a suffix in the @id. 1
array $data An ImageObject Schema array. 1
array $data An ImageObject Schema array. 1
int $user_id The ID of the User you need a Schema ID for. 1
Meta_Tags_Context $context A value object with context variables. 1
WPSEO_Replace_Vars $replace_vars The replace vars. 1
ID_Helper $id_helper The Schema ID helper. 1
Date_Helper $date_helper The date helper. 1
array $schema_data The Schema data. 1
string $variable The replace variable. 1
string $value The value that the variable should be replaced with. 1
mixed $value The value that the function should return. 1
array $data The Schema piece data. 1
Url_Helper $url The url helper. 1
array> $image The image array. 1
string $title The default title. 1
string $description The default description. 1
int $image_id The default image ID. 1
string $image The default image URL. 1
Default_Tagline_Runner $runner The object that implements the actual health check. 1
Default_Tagline_Reports $reports The object that generates WordPress-friendly results. 1
string $test_identifier The test identifier as a string. 1
Postname_Permalink_Runner $runner The object that implements the actual health check. 1
Postname_Permalink_Reports $reports The object that generates WordPress-friendly results. 1
string $label The label that the user can see. 1
string $test_identifier The identifier for the health check. 1
string $description The description for the test result. 1
string $actions The descriptive text. 1
Runner_Interface $runner The health check runner. 1
string $test_identifier The identifier. 1
Migration_Status $migration_status Object used to determine whether the links table is accessible. 1
Options_Helper $options_helper Object used to determine whether the health check should run. 1
Links_Table_Runner $runner The object that implements the actual health check. 1
Links_Table_Reports $reports The object that generates WordPress-friendly results. 1
string $url The URL for the request. 1
array $args Optional arguments for the request. 1
WPSEO_Shortlinker $shortlinker Object used to add short links to the report description. 1
Page_Comments_Runner $runner The object that implements the actual health check. 1
Page_Comments_Reports $reports The object that generates WordPress-friendly results. 1
Indexable_Builder_Versions $indexable_builder_versions The current versions of all indexable builders. 1
Indexable $indexable The Indexable to check. 1
string $object_type The Indexable's object type. 1
int $indexable_version The Indexable's version. 1
Indexable $indexable The Indexable to update. 1
string|array|false $plugins Optional. The plugin filename, or array of plugin filenames, to deactivate. 1
array $all_active_plugins All plugins loaded by WordPress. 1
array $all_active_plugins All plugins currently loaded by WordPress. 1
Importing_Action_Interface ...$importers All of the known importers. 1
string|null $plugin The plugin name of the importer. 1
string|null $type The type of the importer. 1
string|null $plugin The plugin name of the cleanup. 1
Importing_Action_Interface[] $all_actions The complete list of actions. 1
string|null $plugin The Plugin name whose actions to keep. 1
string|null $type The type of actions to keep. 1
Aioseo_Robots_Provider_Service $robots_provider The robots provider service. 1
string $setting_name The name of the robot setting, eg. noindex. 1
bool $setting_value The value of the robot setting. 1
array $mapping The mapping of the setting we're working with. 1
Image_Helper $image The image helper. 1
string $setting The setting we want, eg. source or custom image. 1
string $aioseo_var The AIOSEO replacevar. 1
string $yoast_var The Yoast replacevar. 1
string $aioseo_replacevar The AIOSEO replacevar. 1
string $setting_name The name of the robot setting, eg. noindex. 1
string $indexable_name The name of the indexable that is being checked. 1
Indexable_Cleanup_Repository $indexable_cleanup_repository The Indexable cleanup repository. 1
To_Be_Cleaned_Indexable_Bucket $to_be_cleaned_indexable_bucket The current bucket with data. 1
Indexation_Action_Interface ...$indexation_actions All the Indexation actions. 1
string $indexable_type The indexable type that is represented by this. 1
Missing_Indexable_Count $missing_indexable_count The missing indexable count object. 1
To_Be_Cleaned_Indexable_Count $to_be_cleaned_indexable_counts The to be cleaned indexable count object. 1
string $cleanup_name The indexable type that is represented by this. 1
int $count The amount of missing indexables. 1
Options_Helper $options_helper The option helper. 1
Redirect_Helper $redirect_helper The Redirect Helper. 1
Crawl_Cleanup_Helper $crawl_cleanup_helper The Crawl_Cleanup_Helper. 1
array $headers The headers. 1
Options_Helper $options The options helper. 1
string $path The original path. 1
Migration_Status $migration_status The migration status. 1
Loader $loader The loader. 1
Adapter $adapter The migrations adapter. 1
string $version The version. 1
string $migration_class The migration class. 1
string $before Optional string to prepend. 1
string $after Optional string to append. 1
bool $display Echo or return flag. 1
string $method The called method. 1
array $arguments The given arguments. 1
bool $echo Whether or not to output the canonical element. 1
bool $un_paged Whether or not to return the canonical with or without pagination added to the URL. 1
bool $no_override Whether or not to return a manually overridden canonical. 1
array $robots Robots data array. 1
int $post_id The post ID for which to determine the $robots values, defaults to current post. 1
object|null $object If filled, object to get the title for. 1
string $title The title to append the paging info to. 1
string $title The title to append the title_part to. 1
string $title_part The part to append to the title. 1
bool $echo Echo or return output flag. 1
WP_Customize_Manager $wp_customize Manager class instance. 1
Wordproof_Helper $wordproof The options helper. 1
array $meta_excludelist The current excludelist of meta fields. 1
Wincher_Helper $wincher The Wincher helper instance. 1
Wordproof_Helper $wordproof The WordProof helper instance. 1
array $defaults Array containing default wpseo options. 1
Wordproof_Helper $wordproof The WordProof helper instance. 1
WPSEO_Admin_Asset_Manager $asset_manager The WPSEO admin asset manager instance. 1
int $old_post_id The old post id. 1
int $new_post_id The new post id. 1
array $meta_keys The array containing meta keys that should be used. 1
array $post_types The array containing post types that should be automatically timestamped. 1
bool $value If the certificate should be shown. 1
WP_Post $post The post object of the post for which to determine the certificate should be shown. 1
array $fields The currently registered meta fields. 1
string $tag The script tag for the enqueued script. 1
string $handle The script's registered handle. 1
string $src The script's source URL. 1
Options_Helper $options_helper The options' helper. 1
Woocommerce_Helper $woocommerce The woocommerce helper. 1
bool $return_conditional If the conditional class name that was unmet should be returned. 1
string $message Message string. 2
string $text The string to replace the variables in. 2
array $omit Variables that should not be replaced by this function. 2
string $filePath The path of the current file. 2
string $prefix The prefix to be used. 2
string $content The content of the specific file. 2
int $timestamp The timestamp to use for the formatting. 2
string $format The format that the passed date should be in. 2
string $taxonomy_name Taxonomy name for the term. 2
string $url URL string to check. 2
string $value String value to sanitize. 2
string $value String URL value to sanitize. 2
array $allowed_protocols Optional set of allowed protocols. 2
mixed $value Value to validate. 2
mixed $value Value to cast. 2
string $path Path relative to home URL. 2
string|null $scheme Scheme to apply. 2
array $allowed_post_tags The allowed post tags. 2
string $meta_value New meta value. 2
string $key Internal key of the value to get (without prefix). 2
int $postid Post ID of the post to get the value for. 2
string $key The internal key of the meta value to change (without prefix). 2
int $post_id The ID of the post to delete the meta for. 2
string $taxonomy The taxonomy to prefix. 2
int $attachment_id Attachment ID. 2
int $term_id The term id. 2
string $setting The setting the image is stored in. 2
string $slug The plugin slug to retrieve. 2
string $slug The plugin slug. 2
string $plugin_file The file path to the plugin. 2
string $var_to_replace The name of the variable to replace, i.e. '%%var%%'. 2
string $option_name The option for which you want to retrieve a default. 2
string $key The key within the option who's default you want. 2
string $key The key to set. 2
mixed $value The value to set. 2
string $option_group The lookup table which represents the option_group where the key is stored. 2
mixed $term Term to get the meta value for 2
string $taxonomy Name of the taxonomy to which the term is attached. 2
string|null $meta Optional. Meta value to get (without prefix). 2
int $term_id ID of the term to save data for. 2
string $taxonomy The taxonomy the term belongs to. 2
array $dirty Dirty data with the new values. 2
array $old Old data. 2
array $clean Clean data by reference, normally the default values. 2
string $type Sitemap type. 2
int $page Page number to retrieve. 2
string $option Option name. 2
string $rewrite Optional. Regular expression to match your sitemap with. 2
string $type Sitemap type. 2
string $new_status New post status. 2
string $old_status Old post status. 2
WP_Post $post Post object. 2
array $url Array of parts that make up this entry. 2
int $id The post ID. 2
array $gallery The gallery config. 2
string $post_type Post type. 2
string $post_type Post type to retrieve dates for. 2
int $max_entries Maximum number of entries to retrieve. 2
Event $event Composer event. 2
string $compare The git reference. 2
ContainerBuilder $container The container. 2
string $path File path. 2
array $attr HTML attributes set. 2
string $variable The variable within the option to create the text input field for. 2
array|string $attr Extra attributes to add to the input field. Can be class, disabled, autocomplete. 2
string $label The label to show for the variable. 2
string $variable The variable within the option to create the radio buttons for. 2
string $label The visual label for the radio buttons group, used as the fieldset legend. 2
string $help Inline Help that will be printed out before the visible toggles text. 2
array $classes An array of postbox CSS classes. 2
string $taxonomy The taxonomy name. 2
WP_Post $post A WordPress post instance. 2
string $post_type The name of the post_type. 2
string $fallback The page type to fall back to. 2
string $name The name of the archive. 2
string $fallback The page type to fall back to. 2
string $page_type The page type. 2
array $contactmethods Currently set contactmethods. 2
string $which Table nav location (such as top). 2
string $subquery SQL FROM part. 2
string $all_states SQL IN part. 2
string $post_type_clause SQL post type part. 2
string $type Notification type. 2
string $type The type of asset. 2
array|string|null $format Formats for the data. 2
array $data Data to update on the table. 2
array|string|null $format Optional. Data prepare format. 2
array|string|null $where_format Optional. Where prepare format. 2
stdClass $taxonomy Taxonomy object. 2
string $column_name Column name. 2
object $record Data object. 2
string $attributes HTML attributes. 2
array $args { 2
string $column_name Column to display the content for. 2
int $post_id Post to display the column content for. 2
number $low The lower boundary of the score. 2
number $high The higher boundary of the score. 2
Yoast_Notification $notification The notification to check for dismissal. 2
int|null $user_id User ID to check on. 2
callable $callback Callback that performs the transaction. 2
array $args Arguments to pass to the callback. 2
string $header The header to set. 2
string $plugin Plugin basename string. 2
int $user_id User ID of the updated user. 2
string $where Query variables. 2
array $post_types The post types to filter. 2
string $capability Capability to register. 2
array $roles Roles to add the capability to. 2
bool $overwrite Optional. Use add or overwrite as registration method. 2
string $capability Capability to check. 2
array $capabilities Capabilities to check against. 2
string $role Role to register. 2
string $display_name Display name to use. 2
string|null $template Optional. Role to base the new role on. 2
string $role Role to add. 2
string $display_name Name to display for the role. 2
array $capabilities Capabilities to add to the role. 2
string $role Role to remove. 2
array $submenu_pages List of submenu pages to register. 2
array $submenu_page { 2
string|null $identifier The identifier to check. 2
string $type The type of object to check. Defaults to post_type. 2
WP_Post $post The post to check for custom taxonomies and fields. 2
WP_Post $post The post to check for custom taxonomies. 2
WP_Post $post The post to check for custom fields. 2
string $content Optional. Content to use above the React root element. 2
string $name The name of the tab, used as an identifier in the html. 2
string $content The tab content. 2
string $link_content The text content of the tab link. 2
array $addon_settings The current list of addon settings. 2
string $source_name The option key of the addon. 2
string $slug The addon slug. 2
array $option_include_list All the options to be included in tracking. 2
Yoast_Notification_Center $notification_center The notification center object. 2
array $tax_meta The array with the current metadata. 2
Yoast_Feature_Toggle|object|array $toggle_data Feature toggle instance, or raw object or array 2
Yoast_Feature_Toggle $feature_a Feature A. 2
Yoast_Feature_Toggle $feature_b Feature B. 2
string $value The value of the attribute. 2
int $post_id The current post ID. 2
bool $yoast_prefix Optional. True to prefix the table name with the Yoast prefix. 2
string $class_name The class name to get the table name for. 2
string $property The property to get. 2
string $property The property to check. 2
string|array $property The property to set. 2
string|null $value The value to give. 2
string $expr The expression. 2
array $values The values. Defaults to an empty array. 2
string $operator The operator. 2
string $id The ID. 2
string $clause The clause that should contain question mark placeholders. 2
array $parameters The parameters to include in the query. 2
string|null $value The value. 2
array|null $values The values. Defaults to null. 2
string|string[] $identifier One or more identifiers. 2
array $models Array of model instances to be inserted. 2
string $property The property to retrieve. 2
string $db The database name. 2
string $table_name The table name. 2
array $options Column options. 2
string $column_name The column name. 2
string $new_column_name The new column name. 2
string $table_name The table name. 2
string $type The native type. 2
string $version The version. 2
string $column_name The column name. 2
string $type The column type. 2
array|string $column_name The column name. 2
string $table_name The name of the table. 2
string $class_name The class name. 2
Migration_Status $migration_status The migration status object. 2
Current_Page_Helper $current_page_helper The current page helper. 2
Options_Helper $options The options helper. 2
Indexable_Helper $indexable_helper The indexable helper. 2
string $keyword The focus keyword that is set. 2
int $score The score saved on the meta data. 2
Indexable_Hierarchy_Repository $indexable_hierarchy_repository The indexable hierarchy repository. 2
Indexable_Helper $indexable_helper The indexable helper. 2
Indexable $indexable The indexable to check. 2
int $indexable_id The indexable id, this is the id of the original indexable. 2
int[] $parents The indexable IDs of all parents. 2
int $post_id The post ID. 2
string $main_taxonomy The main taxonomy. 2
string $taxonomy The taxonomy. 2
Options_Helper $options The options helper. 2
Image_Helper $image The image helper. 2
Options_Helper $options_helper The options helper. 2
Indexable $indexable The indexable. 2
string $param The parameter. 2
WP_REST_Request $request Full details about the request. 2
string $key The key. 2
Options_Helper $options_helper The Options_Helper instance. 2
WP_Remote_Handler $wp_remote_handler The request handler. 2
string $code The code to send. 2
Options_Helper $options_helper The options helper. 2
Language_Helper $language_helper The language helper. 2
Wistia_Embed_Permission_Repository $wistia_embed_permission_repository The wistia embed permission 2
Meta_Surface $meta The meta surface. 2
Options_Helper $options_helper The options helper. 2
Promotion_Manager $promotion_manager The promotion manager. 2
string $permalink The permalink. 2
Image_Helper $image_helper The image helper. 2
bool $fallback Whether to return the hardcoded fallback if the template value is empty. 2
WP_Term $term The term. 2
Open_Graph_Image_Helper $open_graph_image Image helper for Open Graph. 2
Logger $logger The logger. 2
string $object_type The object type. 2
bool $auto_create Optional. Create the indexable if it does not exist. 2
string $object_type The indexable object type. 2
string|null $subtype The subtype. Can be null. 2
int $indexable_id The indexable ID. 2
string $table The table to clean up. 2
string $column The table column the cleanup will rely on. 2
string $property_name The name of the immutable property. 2
Additional_Contactmethods_Collector $additional_contactmethods_collector The additional contactmethods collector. 2
string $id Id of the badge. 2
string $link Optional link of the badge. 2
Short_Link_Helper $short_link_helper The short link helper. 2
bool $is_premium Whether WordPress SEO Premium is currently active. 2
bool $has_valid_premium_subscription Whether WordPress SEO Premium currently has a valid subscription. 2
Content_Type $content_type The content type. 2
Site_Kit_Search_Console_Adapter $site_kit_search_console_adapter The adapter. 2
bool $is_dismissed The dismissal status. 2
Analytics_4_Parameters $parameters The parameters. 2
RunReportResponse $response The response. 2
array $dimensions The dimensions. 2
SEO_Score_Groups_Interface[] $seo_score_groups All SEO score groups. 2
Content_Type $content_type The content type. 2
int|null $term_id The ID of the term we're filtering for. 2
Readability_Score_Groups_Interface[] $readability_score_groups All readability score groups. 2
bool|null $is_troubleshooting Whether we're in troubleshooting mode. 2
Indexable_Repository $indexable_repository The indexable repository. 2
Traffic_Data $previous_traffic_data The previous traffic data. 2
string $error_message The error message of the request. 2
int $error_status_code The error status code of the request. 2
Taxonomy|null $taxonomy The taxonomy that filters the content type. 2
WPSEO_Admin_Asset_Manager $asset_manager The WPSEO_Admin_Asset_Manager. 2
Product_Helper $product_helper The Product_Helper. 2
Short_Link_Helper $shortlink_helper The Short_Link_Helper. 2
string $link The current link. 2
string $rel Link relationship, prev or next. 2
Meta_Tags_Context_Memoizer $context_memoizer The meta tags context memoizer. 2
Indexable_Repository $indexable_repository The indexable repository. 2
array $attributes The block attributes. 2
int $person_id The id of the person to edit. 2
Options_Helper $options_helper The options helper. 2
string $setting The setting to be displayed. 2
string[] $tests Array containing WordPress site status tests. 2
Importable_Detector_Service $importable_detector The importable detector. 2
Importing_Route $importing_route The importing route. 2
Notification_Helper $notification_helper The notification helper. 2
WPSEO_Addon_Manager $addon_manager The addon manager. 2
Front_End_Integration $front_end The front end integration. 2
Indexable_Presentation $presentation The indexable presentation. 2
string $content Feed item content. 2
int $blog_id The blog ID. 2
Options_Helper $options_helper The option helper. 2
Url_Helper $url The URL helper. 2
Options_Helper $options The options helper. 2
string[] $auto_updated_plugins The current list of auto-updated plugins. 2
Capability_Helper $capability_helper The capability helper. 2
Indexable_Builder $builder The post builder to use. 2
array $old_value The old value of the wpseo_titles option. 2
array $new_value The new value of the wpseo_titles option. 2
Options_Helper $options The options helper. 2
string $url The un-paginated URL of the current archive. 2
string $page The page number to add on to $url for the $link tag. 2
string $promotion_name The name of the promotion. 2
Indexable_Repository $indexable_repository The indexables repository. 2
array $result The result dataset to convert to an object. 2
Wincher_Client $client The API client. 2
SEMrush_Client $client The API client. 2
WPSEO_Addon_Manager $addon_manager The addon manager. 2
bool $limit The maximum number of post IDs to return. 2
Indexable_Repository $repository The indexable repository. 2
wpdb $wpdb The WordPress database instance. 2
string $meta_data The meta data to be imported. 2
int|null $limit The maximum number of unimported objects to be returned. 2
string $aioseo_key The AIOSEO key that contains the setting we're working with. 2
Wistia_Embed_Permission_Repository $wistia_embed_permission_repository The repository. 2
User_Helper $user_helper The user helper. 2
int $user_id The user ID. 2
array $introductions The introductions. 2
User_Helper $user_helper The User_Helper. 2
string $introduction_id The introduction ID. 2
array|null $args The arguments. 2
Indexable $indexable The indexable. 2
Images $image_container The image container. 2
array $piece The graph piece. 2
array $data The website data array. 2
bool $add_hash Wether or not the person's image url hash should be added to the image id. 2
string $schema_id The string used in the `@id` for the schema. 2
WP_User $user_data User data. 2
array $breadcrumb The position in the list. 2
array $breadcrumb The breadcrumb array. 2
array $data Article data. 2
array $data The Article data. 2
string $code The code to check. 2
Indexation_Action_Interface $indexation_action The indexing action. 2
string $url The url of the indexing route. 2
string $plugin The plugin to import from. 2
string $type The type of entity to import. 2
int $post_id The post id to extract the images from. 2
int $attachment_id The attachment id. 2
bool $use_link_table Whether the SEO Links table will be used to retrieve the id. 2
int|false $user_id User ID. 2
int $user_id User ID. 2
string $extra_class Optional. Any extra class. 2
Indexable_Repository $repository The indexable repository. 2
Indexable $indexable The Yoast indexable that we're checking. 2
string $location The path to redirect to. 2
int $status The status code to use. 2
string $reason The reason for the redirect. 2
string $handle The handle. 2
string $current_url The current URL. 2
int $limit Limit the number of unindexed objects that are counted. 2
bool $suppress_errors Whether to suppress db errors when running the cleanup query. 2
string $post_meta_key The post_meta key that will be populated. 2
string $indexable_column The indexable data that will be mapped to post_meta. 2
Base_Image_Helper $image The image helper. 2
string $caption The caption string, if there is one. 2
int $count The amount of missing indexables. 2
string $sep Separator used in the title. 2
string $seplocation Whether the separator should be left or right. 2
array $integration_toggles The integration toggles array. 2
mixed $replace_function Function or method to call to retrieve the replacement value for the variable. 3
string $type Type of variable: 'basic' or 'advanced', defaults to 'advanced'. 3
string $help_text Help text to be added to the help tab for this variable. 3
string $datetime String input to check as valid input for DateTime class. 3
int $attachment_id Attachment ID. 3
string $post_type_name The name of the post type to lookup. 3
string $var_to_replace The complete variable to replace which includes the name of 3
array $option_value Old (not merged with defaults or filtered) option value to 3
array|null $all_old_option_values Optional. Only used when importing old options to have 3
string $type Provide a type for a specific type validator, empty for global validator. 3
array $constructor_arguments The array of constructor arguments. 3
string $label The label to show for the variable. 3
string $taxonomy_name The taxonomy's slug. 3
string $plugin_section Type of conflict group (such as Open Graph or sitemap). 3
WP_User $user User instance to output for. 3
string $file_url The file url. 3
string $key The key of the meta value. 3
string $taxonomy String with the name of the taxonomy. 3
string $term_id The ID of the current term. 3
string $associated_class_name The associated class name. 3
string|null $foreign_key_name The foreign key name in the associated table. 3
string|null $foreign_key_name_in_current_models_table The foreign key in the current models table. 3
string $fragment The fragment. 3
mixed|null $value The value. 3
string|array $key Key. 3
string|null $value Value. 3
mixed $offset Key. 3
string $table The table name. 3
string $type The column type. 3
string $table_name The table name. 3
array|string $column_name The column name(s). 3
array $options Index options. 3
array $options The options. 3
Adapter $adapter The current adapter. 3
string $sql The query to run. 3
Post_Helper $post_helper The post helper. 3
Post_Type_Helper $post_type_helper The post type helper. 3
Url_Helper $url_helper The URL helper. 3
WP_REST_Request $request The request. This request should have a key param set. 3
string $method The HTTP method to use. 3
string $name The name of the migration. 3
WPSEO_Addon_Manager $addon_manager The addon manager. 3
Short_Link_Helper $short_link_helper The short link helper. 3
Product_Helper $product_helper The product helper. 3
int $image_id The image ID to add. 3
string $user_agent The user agent identifier. 3
bool $auto_create Optional. Create the indexable if it does not exist. 3
int $indexable_id The indexable id. 3
string $robots_txt_content The current working robots txt string. 3
string $content_type The content type. 3
RunReportResponse $response The response to parse. 3
bool|null $is_troubleshooting Whether we're in troubleshooting mode. 3
Post_Type_Helper $post_type_helper The post type helper. 3
Current_Page_Helper $current_page_helper The Current_Page_Helper. 3
WPSEO_Admin_Asset_Manager $asset_manager The asset manager. 3
array $attributes The attributes. 3
string $content The content. 3
array $pieces Array of Query pieces. 3
WP_Query $query The Query on which to apply. 3
Product_Helper $product_helper The product helper. 3
Redirect_Helper $redirect The redirect helper. 3
Indexable_Repository $repository The repository to use. 3
Indexable_Helper $indexable_helper The indexable helper. 3
Indexable_Repository $repository The repository to use. 3
Indexable_Helper $indexable_helper The indexable helper. 3
Pagination_Helper $pagination The pagination helper. 3
Options_Helper $options_helper The WPSEO options helper. 3
Indexing_Helper $indexing_helper The indexing helper. 3
int $id The id. 3
Import_Cursor_Helper $import_cursor The import cursor helper. 3
Options_Helper $options The options helper. 3
Sanitization_Helper $sanitization The sanitization helper. 3
Aioseo_Replacevar_Service $replacevar_handler The replacevar handler. 3
Aioseo_Robots_Provider_Service $robots_provider The robots provider service. 3
Aioseo_Robots_Transformer_Service $robots_transformer The robots transfomer service. 3
Aioseo_Helper $aioseo_helper The AIOSEO helper. 3
int $limit The maximum number of unimported objects to be returned. 3
array $mapping The mapping of the setting we're working with. 3
Indexable $indexable The Yoast indexable. 3
array $aioseo_data All of the AIOSEO data to be imported. 3
array $graph The current schema graph. 3
array $data The Person schema. 3
WP_User $user_data User data. 3
string $output The output type to use. 3
int $attachment_id Attachment ID. 3
string $proper_url The proper URL. 3
Indexable $indexable The Yoast indexable. 3
string $post_meta_key The post_meta key that will be populated. 3
string $html The original HTML. 3
string $social_setting The social settings we're working with, eg. open-graph or twitter. 3
string $date String representing the date / time. 4
string $format The format that the passed date should be in. 4
string $meta_key The full meta key (including prefix). 4
string $post_type The post type to check. 4
string $replacement_variable The replacement variable. 4
string|null $current_version Optional. Version from which to upgrade, if not set, 4
string $option_name The option name. 4
string $type Type string to check for. 4
int $max_entries Entries per sitemap. 4
string $type Sitemap type. 4
int $max_entries Entries per sitemap. 4
int $current_page Current page of the sitemap. 4
Yoast_Notification $notification Notification to test. 4
string $capability The name of the capability. 4
string $name The name of the section, used as an identifier in the html. 4
string $link_content The text content of the section link. 4
string $separator The separator. 4
array $values The values. 4
mixed $key Key. 4
string $text The string. 4
string $table_name The table name. 4
string $table_name The name of the table. 4
array|string $options The options. 4
Current_Page_Helper $current_page The current page helper. 4
string $post_type The post type. 4
int $author_id The author ID. 4
string $user_id The user id. 4
Indexable|bool $indexable Optional. An existing indexable to overwrite. 4
WP_Post $post The post. 4
string $version The current version. 4
Indexable_Helper $indexable_helper The indexable helper. 4
Robots_Txt_Helper $robots_txt_helper The robots txt helper. 4
array $pages The pages. 4
Product_Helper $product_helper The product helper. 4
WPSEO_Admin_Asset_Manager $admin_asset_manager The admin asset manager. 4
Indexing_Helper $indexing_helper The indexing helper. 4
string $name The property to get. 4
string $alert_identifier Alert identifier. 4
int $limit Limit the maximum number of unindexed posts that are counted. 4
array|null $assoc_args The associative arguments. 4
string $helper The name of the helper. 4
array $params The rest request params. 4
string $format The desired output format. 4
string $object_type The object type. 4
string $object_subtype The object subtype. 4
Report_Builder_Factory $report_builder_factory The factory for result builder objects. 4
int $post_id The post id to extract the image from. 4
Yoast_Feature_Toggle $integration The integration toggle class. 4
array $dirty New value for the option. 5
array $clean Clean value for the option, normally the defaults. 5
array $old Old value of the option. 5
int $user_id User ID. 5
int $post_id ID of the post. 5
Event $event Composer event that triggered this script. 5
string $type The type of asset. Usually JS or CSS. 5
array $options Optional link attributes. 5
string $column The table column. 5
string $table The table name. 5
string $constraint The constraint. 5
string|null $table_alias The table alias. Defaults to null. 5
mixed $value The value. 5
string $query The query to run. 5
string $created_column_name Created at column name. 5
string $updated_column_name Updated at column name. 5
ContainerInterface $container The dependency injection container. 5
string $content The content. 5
string $name The name of the migration. 5
string $template_option_name The name of the option in which the template you want to get is saved. 5
Options_Helper $options_helper The options helper. 5
Meta_Tags_Context $context The context. 5
array $params The values to store. 5
string[] $crumb The crumb. 5
Indexable $ancestor The indexable. 5
WP_REST_Request $request The request. This request should have a code param set. 5
string $url The URL to build upon. 6
WPSEO_Admin_Asset $asset The asset to determine the URL for. 6
array $plugin The information available about the plugin. 6
string $error_code Code of the error set via `add_settings_error()`, normally the variable name. 6
array $settings The settings. 6
string $name The property name. 6
mixed $value The property value. 6
string $name The property name. 6
Indexable $indexable The indexable to format. 6
string $url The URL to send the request to. 6
array $options The options to pass along to the request. 6
Indexable_Presentation|null $presentation The indexable presentation. 6
array $submenu_pages The Yoast SEO submenu pages. 6
int $post_id The post ID. 7
int $limit The limit we'll apply to the queries. 7
Yoast_Notification_Center $notification_center The notification center. 7
array $old_value The old value of the option. 7
array $new_value The new value of the option. 7
WP_REST_Request $request The request object. 8
Indexable_Repository $indexable_repository The indexable repository. 8
string $helper The helper to get. 8
WP_REST_Request $request The request. 8
WP_Admin_Bar $wp_admin_bar Admin bar instance to add the menu to. 9
int $post_id Post ID. 9
string $column_name The column name. 9
mixed|null $value The value. Defaults to null. 9
Meta_Tags_Context $context The meta tags context. 9
Options_Helper $options The options helper. 14
int $user_id The user ID. 16
Indexable $indexable The indexable. 20
Options_Helper $options_helper The options helper. 26
string|array $column_name The table column. 33
@property Classes_Surface $classes The classes surface. 1
Meta_Surface $meta The meta surface. 1
Helpers_Surface $helpers The helpers surface. 1
string $canonical 1
string $permalink 1
string $title 1
string $description 1
string $id 1
string $site_name 1
string $alternate_site_name 1
string $wordpress_site_name 1
string $site_url 1
string $company_name 1
string $company_alternate_name 1
int $company_logo_id 1
array $company_logo_meta 1
int $person_logo_id 1
array $person_logo_meta 1
int $site_user_id 1
string $site_represents 1
array|false $site_represents_reference 1
string|string[] $schema_page_type 1
string|string[] $schema_article_type Represents the type of article. 1
string $main_schema_id 1
string|array $main_entity_of_page 1
bool $open_graph_enabled 1
string $open_graph_publisher 1
string $twitter_card 1
string $page_type 1
bool $has_article 1
bool $has_image 1
int $main_image_id 1
string $main_image_url 1
string $url 1
int $post_id 1
int $target_post_id 1
string $type 1
int $indexable_id 1
int $target_indexable_id 1
int $height 1
int $width 1
int $size 1
int $object_id 1
int $internal_link_count 1
int $incoming_link_count 1
int $object_id 1
string $object_type 1
string $object_sub_type 1
int $author_id 1
int $post_parent 1
string $permalink 1
string $permalink_hash 1
string $canonical 1
bool $is_robots_noindex 1
bool $is_robots_nofollow 1
bool $is_robots_noarchive 1
bool $is_robots_noimageindex 1
bool $is_robots_nosnippet 1
string $title 1
string $description 1
string $breadcrumb_title 1
bool $is_cornerstone 1
string $primary_focus_keyword 1
int $primary_focus_keyword_score 1
int $readability_score 1
int $inclusive_language_score 1
int $link_count 1
int $incoming_link_count 1
int $number_of_pages 1
string $open_graph_title 1
string $open_graph_description 1
string $open_graph_image 1
string $open_graph_image_id 1
string $open_graph_image_source 1
string $open_graph_image_meta 1
string $twitter_title 1
string $twitter_description 1
string $twitter_image 1
string $twitter_image_id 1
string $twitter_image_source 1
string $twitter_card 1
int $prominent_words_version 1
bool $is_public 1
bool $is_protected 1
string $post_status 1
bool $has_public_posts 1
int $blog_id 1
string $schema_page_type 1
string $schema_article_type 1
bool $has_ancestors 1
int $estimated_reading_time_minutes 1
string $object_last_modified 1
string $object_published_at 1
int $version 1
int $id Identifier. 1
int $post_id Post ID. 1
int $term_id Term ID. 1
string $taxonomy Taxonomy. 1
int $blog_id Blog ID. 1
int $indexable_id The ID of the indexable. 1
int $ancestor_id The ID of the indexable's ancestor. 1
int $depth The depth of the ancestry. 1 being a parent, 2 being a grandparent etc. 1
int $blog_id Blog ID. 1
WP_Term $source 1
string $title 1
string $meta_description 1
array $robots 1
string $canonical 1
string $rel_next 1
string $rel_prev 1
string $open_graph_type 1
string $open_graph_title 1
string $open_graph_description 1
array $open_graph_images 1
int $open_graph_image_id 1
string $open_graph_image 1
string $open_graph_url 1
string $open_graph_site_name 1
string $open_graph_article_publisher 1
string $open_graph_article_author 1
string $open_graph_article_published_time 1
string $open_graph_article_modified_time 1
string $open_graph_locale 1
string $open_graph_fb_app_id 1
string $permalink 1
array $schema 1
string $twitter_card 1
string $twitter_title 1
string $twitter_description 1
string $twitter_image 1
string $twitter_creator 1
string $twitter_site 1
object|array $source 1
array $breadcrumbs 1
int $estimated_reading_time_minutes 1
array $googlebot 1
array $bingbot 1
Schema\Article_Helper $article 1
Schema\HTML_Helper $html 1
Schema\ID_Helper $id 1
Schema\Image_Helper $image 1
Schema\Language_Helper $language 1
Twitter\Image_Helper $image 1
Helpers\Asset_Helper $asset 1
Helpers\Author_Archive_Helper $author_archive 1
Helpers\Blocks_Helper $blocks 1
Helpers\Capability_Helper $capability 1
Helpers\Current_Page_Helper $current_page 1
Helpers\Date_Helper $date 1
Helpers\Environment_Helper $environment 1
Helpers\First_Time_Configuration_Notice_Helper $first_time_configuration_notice 1
Helpers\Home_Url_Helper $home_url 1
Helpers\Image_Helper $image 1
Helpers\Indexable_Helper $indexable 1
Helpers\Indexing_Helper $indexing 1
Helpers\Input_Helper $input 1
Helpers\Language_Helper $language 1
Helpers\Meta_Helper $meta 1
Helpers\Notification_Helper $notification 1
Helpers\Options_Helper $options 1
Helpers\Pagination_Helper $pagination 1
Helpers\Permalink_Helper $permalink 1
Helpers\Post_Helper $post 1
Helpers\Post_Type_Helper $post_type 1
Helpers\Primary_Term_Helper $primary_term 1
Helpers\Product_Helper $product 1
Helpers\Redirect_Helper $redirect 1
Helpers\Require_File_Helper $require_file 1
Helpers\Robots_Helper $robots 1
Helpers\Short_Link_Helper $short_link 1
Helpers\Site_Helper $site 1
Helpers\String_Helper $string 1
Helpers\Social_Profiles_Helper $social_profiles 1
Helpers\Taxonomy_Helper $taxonomy 1
Helpers\Url_Helper $url 1
Helpers\User_Helper $user 1
Helpers\Woocommerce_Helper $woocommerce 1
Helpers\Wordpress_Helper $wordpress 1
Open_Graph\Image_Helper $image 1
array $breadcrumbs The breadcrumbs array for the current page. 1
string $canonical The canonical URL for the current page. 1
string $company_name The company name from the Knowledge graph settings. 1
int $company_logo_id The attachment ID for the company logo. 1
string $description The meta description for the current page, if set. 1
int $estimated_reading_time_minutes The estimated reading time in minutes for posts. 1
Indexable $indexable The indexable object. 1
string $main_schema_id Schema ID that points to the main Schema thing on the page, usually the webpage or article Schema piece. 1
string $meta_description The meta description for the current page, if set. 1
string $open_graph_article_author The article:author value. 1
string $open_graph_article_modified_time The article:modified_time value. 1
string $open_graph_article_published_time The article:published_time value. 1
string $open_graph_article_publisher The article:publisher value. 1
string $open_graph_description The og:description. 1
bool $open_graph_enabled Whether OpenGraph is enabled on this site. 1
string $open_graph_fb_app_id The Facebook App ID. 1
array $open_graph_images The array of images we have for this page. 1
string $open_graph_locale The og:locale for the current page. 1
string $open_graph_publisher The OpenGraph publisher reference. 1
string $open_graph_site_name The og:site_name. 1
string $open_graph_title The og:title. 1
string $open_graph_type The og:type. 1
string $open_graph_url The og:url. 1
string $page_type The Schema page type. 1
array $robots An array of the robots values set for the current page. 1
string $rel_next The next page in the series, if any. 1
string $rel_prev The previous page in the series, if any. 1
array $schema The entire Schema array for the current page. 1
string $schema_page_type The Schema page type. 1
string $site_name The site name from the Yoast SEO settings. 1
string $site_represents Whether the site represents a 'person' or a 'company'. 1
array|false $site_represents_reference The schema reference ID for what this site represents. 1
string $site_url The site's main URL. 1
int $site_user_id If the site represents a 'person', this is the ID of the accompanying user profile. 1
string $title The SEO title for the current page. 1
string $twitter_card The Twitter card type for the current page. 1
string $twitter_creator The Twitter card author for the current page. 1
string $twitter_description The Twitter card description for the current page. 1
string $twitter_image The Twitter card image for the current page. 1
string $twitter_site The Twitter card site reference for the current page. 1
string $twitter_title The Twitter card title for the current page. 1
string $wordpress_site_name The site name from the WordPress settings. 1
Indexable $model The indexable. 1
int $id 2
string $language 2
string $region 2
string $created_at 2
string $updated_at 2
@required * 23
@return array Filtered capabilities. 1
bool|int 1
string Name of the primary term. 1
bool Whether the replacement function was successfully registered. 1
array The sanitized fields. 1
string The output to render. 1
Main The main instance. 1
bool True when datatime is valid. 1
bool True if SEO score is enabled, false otherwise. 1
bool True if readability is enabled, false otherwise. 1
string Admin bar title markup. 1
WP_Post|null Post object, or null if not in singular context. 1
string Focus keyword, or empty string if none available. 1
WP_Term|null Term object, or null if not in singular context. 1
string The score icon, or empty string. 1
string Admin settings page URL. 1
string Notification counter markup, or empty string if not available. 1
string Notification popup markup, or empty string if not available. 1
string The readability rank label. 1
string The inclusive language rank label. 1
int The start score. 1
int The end score. 1
WPSEO_Rank 1
array The added set of rules. 1
string The convered URI string. 1
string The uppercased string. 1
mixed Trimmed value or array of trimmed values. 1
array|string The sanitized value. 1
int|bool Int or false in case of failure to convert to int. 1
mixed Calculation Result or false if either or the numbers isn't scalar or 1
bool Returns true if the API is available. 1
bool Whether or not the metabox is active. 1
bool Whether the plugin is network-active. 1
string The post type, or an empty string. 1
string Returns 'post' if the current page is a post edit page. Taxonomy in other cases. 1
array The Adminl10n array. 1
string The log level to use. 1
false|string The prepared JSON string. 1
array The allowed tags including post tags, input tags and select tags. 1
array The allowed tags including post tags, input tags, select tags and option tags. 1
array> The contents of the history option. 1
array> The retrieved data. 1
wpdb The WPDB object to use. 1
string The option name to store the history in. 1
array An array of images found in this post. 1
array An array of image URLs. 1
array An array of `` tags. 1
string|bool The image URL on success, false on failure. 1
string The content of the supplied post. 1
array Array containing the meta box field definitions. 1
string Validated meta value. 1
string Clean value. 1
array The custom taxonomy prefixed names. 1
Yoast_Notification[] The filtered list of notifications. Excluding the wpseo-dismiss-about notification. 1
int|string|bool|float|array The content of the option if exists, otherwise an empty array. 1
string The query that removes all but one duplicate for each object of the object type. 1
bool True when request is successful. 1
string The set error message. 1
stdClass The response object. 1
string The retrieved body. 1
stdClass The json decoded response. 1
array The enriched arguments. 1
array The request body. 1
int The user id. 1
array The installed addon versions. 1
self Dynamic rewrites main instance. 1
array|string Filtered value of $rewrite_rules. 1
array|string Filtered value of $rewrite_rules before writing the option. 1
int The Post ID belonging to the attachment, 0 if not found. 1
int|false The ID of the image or false for failure. 1
false|array { 1
bool True when the image is within limits, false if not. 1
array|false Array when there is a full size image. False if not. 1
string The full file path. 1
string The expanded image URL. 1
int The file size in bytes. 1
array The different variations possible for this attachment ID. 1
array Whether a variation is fit for display or not. 1
array The validations that pass the required file size limits. 1
array An array of image sizes. 1
string The image alt text. 1
bool True if the image has usable measurements, false if not. 1
string|null The extracted image url when found, null when not found. 1
bool Whether or not the post type is considered accessible. 1
array The filtered array. 1
bool Whether or not the post type is available in the REST API. 1
bool True whether the post type has an archive. 1
bool True whether the metabox is enabled. 1
stdClass The subscriptions. 1
string[] List of addon filenames with their slugs. 1
bool|string Plugin file when installed, False when plugin isn't installed. 1
stdClass|false Subscription data when found, false when not found. 1
array The slugs. 1
array The addon versions. 1
object Extended plugin data. 1
stdClass The list of addons activated for this site. 1
bool True when the subscription is valid. 1
stdClass Extended data for update_plugins. 1
object Yoast Free's data from wp.org. 1
bool True when there are installed Yoast addons. 1
bool True when installed and activated. 1
Yoast_Notification The created notification. 1
bool Has the plugin expired. 1
stdClass The converted subscription. 1
string The icon URL for this plugin. 1
bool True when plugin file is for a Yoast addon. 1
string The slug when found or empty string when not. 1
array The active addons. 1
bool|stdClass Object when request is successful. False if not. 1
stdClass|false The transient value. 1
array The plugins. 1
bool True when plugin is active. 1
stdClass Site information. 1
stdClass Mapped site information. 1
stdClass Mapped subscription. 1
stdClass The site information. 1
string The support section content. 1
string The language part of the locale. 1
string The language name. 1
bool Whether the replacement function was succesfully registered. 1
bool `true` if the replace var has been registered, `false` if not. 1
bool `true` if the replacement variable has already been registered. 1
string[] The list of hidden replace vars. 1
array Retrieved replacements - this might be a smaller array as some variables 1
string Retrieves the title separator. 1
bool|int|null 1
string The formatted current date. 1
string The current day. 1
string The current month. 1
string The formatted current time. 1
string The current year. 1
array Array with the replacement variables. 1
bool True when the replacement variable is not prefixed. 1
string The replacement variable name without the prefix. 1
string The prefix of the replacement variable. 1
string The altered replacement variable name. 1
string The replacement variable label. 1
array The formatted replacement variable. 1
string Either a single term or a comma delimited string of terms. 1
string|null The term ancestors hierarchy. 1
array The custom fields. 1
string The prefixed field. 1
mixed Filtered $options value. 1
string[] Array with the separator options aria-labels. 1
string[] Validated clean value for the option to be saved to the database. 1
string[] Cleaned option. 1
string[] An array of the separator options. 1
object|bool 1
array Array of option names. 1
array Array combining the values of all the options. 1
array Array combining the values of the requested options. 1
array Array containing the requested option. 1
mixed Returns value if found, $default_value if not. 1
mixed|null Returns value if found, $default if not. 1
bool Returns true if the option is successfully saved in the database. 1
array Options possibly including multisite. 1
bool True when is multisite. 1
array Validated and filtered value. 1
mixed Value for the $meta if one is given, might be the default. 1
void|array 1
string|false The validated URL or false if the URL is not valid. 1
string|false The validated twitter id or false if it is not valid. 1
string The current value. 1
mixed Option merged with the defaults for that option. 1
array Validated new value for the option. 1
bool True if option key is disabled, false otherwise. 1
array|bool The original option value (which can be false if the option doesn't exist). 1
string The set option name. 1
array Combined and filtered options array. 1
array Updated option value, with all disabled variables set to their old values. 1
array Override option value, or empty array if unavailable. 1
string Pattern if it conforms, original array key if it doesn't or if the option 1
bool|string The key where the cache is stored on. False if the key could not be generated. 1
string The type with a safe length to use 1
string|null The validator for the supplied type. 1
string Validator to be used to generate the cache key. 1
bool True if validator key has been saved as option. 1
string Base 61 converted string. 1
WPSEO_Sitemap_Cache_Data|null Null on no cache found otherwise object containing sitemap and meta data. 1
bool True if the sitemap was properly invalidated. False otherwise. 1
bool If the sitemap has been retrieved from cache. 1
string|array|false 1
int The maximum number of entries. 1
array List of post statuses. 1
bool True if usable, False if bad or unknown. 1
string The content of the sitemap. 1
string Status of the sitemap, 'ok'/'error'/'unknown'. 1
array The data to be serialized. 1
string The string representation of the object or null in C-format. 1
string The XSL URL that needs to be used. 1
array Filtered query variables. 1
bool True if redirect is needed, false otherwise. 1
string base URL (incl page) 1
string The XML content of the sitemap. 1
string Status 'ok', 'error' or 'unknown'. 1
bool True if the sitemap is usable, False if not. 1
array Set of attachment objects. 1
array A list of arrays, each containing gallery data. 1
array The home url, as parsed by wp_parse_url. 1
array Array with post ids to exclude. 1
string|bool URL or false if it should be excluded. 1
bool True when post type archive is indexable. 1
object[] 1
array|bool 1
int Count of users updated. 1
int Exit code from the lint command. 1
int Exit code passed from the coding standards check. 1
array Filtered list of files. 1
string The path to the generated unit test. 1
false|int returns 1 if the unit test is in Premium, 0 if it does not, or FALSE if an error occurred. 1
string The namespace of the test class. 1
string The file name of the test class. 1
string The groups. 1
string The generated unit test scaffold. 1
string The generated use statements. 1
string The generated property statements. 1
string The generated property statement. 1
string The generated created mock statements. 1
string The generated arguments to give the instance. 1
mixed The processed value. 1
Constructor_Details|null 1
Definition[] The definitions that should be injected. 1
string The doc block. 1
bool|string The classname. 1
array The found classes. 1
Yoast_Form 1
mixed|null The retrieved value. 1
bool True if control should be disabled, false otherwise. 1
string Explanation note HTML string, or empty string if no note necessary. 1
bool True if we are dealing with the Usage tracking feature on a multisite subsite. 1
string The disabled attribute HTML. 1
bool Whether or not Gutenberg is installed. 1
bool True if the currently installed version is below the minimum supported version. False otherwise. 1
string The currently installed version. 1
bool Whether or not the currently installed version is fully compatible. 1
string The latest release. 1
string The minumum supported release. 1
string The currently installed Gutenberg version. Empty if the version couldn't be detected. 1
array|string 1
bool True if there are associated recommended replace vars. 1
bool True if the given post is the homepage. 1
WPSEO_Admin_Asset The analysis worker asset. 1
string The capability to use. 1
WPSEO_WordPress_Integration[] The integrations to initialize. 1
string The install URL. Empty string if the current user doesn't have the proper capabilities. 1
string The activation URL. Empty string if the current user doesn't have the proper capabilities. 1
string The link to the plugin install. Returns the title if the plugin is deemed a Premium product. 1
string The visually hidden accessible message. 1
string Formatted argument in HTML. 1
string The HTML base class. 1
array The passed array with the additional shortlinks. 1
array The shortlinks. 1
bool True when page is term edit. 1
string The rendered paper. 1
array The view variables. 1
array The config. 1
bool Whether there is a dependency present. 1
array Array containing all the dependencies associated with the plugin. 1
bool Whether or not the dependencies are satisfied. 1
bool Whether or not the plugin is properly installed. 1
bool Whether or not the plugin is available. 1
bool Whether or not the dependency is active. 1
array Array of the plugins that have dependencies. 1
bool Whether or not the plugin is active. 1
array Array containing the information about the plugins. 1
array The plugin properties. 1
string The version associated with the plugin. 1
bool Whether or not the dependency is available. 1
array Array containing the names of the associated dependencies. 1
bool Whether or not the plugin is a Premium product. 1
array The collected data. 1
false|string The encode string. 1
string The subquery, which should always be used in $wpdb->prepare(), 1
array The views. 1
string SQL order string (ASC, DESC). 1
Yoast_Notification|null A Yoast_Notification on success, null on failure. 1
string The label. 1
bool True whether the tabs needs a save button. 1
bool True whether the tab hosts beta functionalities. 1
bool True whether the tab hosts premium functionalities. 1
string The option group. 1
mixed|string The retrieved variable. 1
array Choices as $site_id => $site_label pairs. 1
array Array of $state_slug => $state_label pairs. 1
bool Whether the linking columns are shown 1
string The path to the asset file. 1
Yoast_Notification The notification containing the suggested plugin. 1
string The install suggested plugin message. 1
string The more information link. 1
false|int Total amount of inserted rows or false on error. 1
false|int False when the update request is invalid, int on number of rows changed. 1
false|int False when the upsert request is invalid, int on number of rows changed. 1
array|object|null The resultset 1
bool True when creation is successful. 1
bool Returns true when there is an error. 1
string Full table name including prefix. 1
string The table prefix depending on the database context. 1
bool True if the table is registered, false otherwise. 1
string The shortlink for the Webinar. 1
string The HTML content. 1
string The HTML for a hidden primary taxonomy field. 1
int primary term id 1
array The mapped taxonomies. 1
array The mapped taxonomy. 1
array Array of $option_name => $data pairs. 1
array List of option names, or empty array if unknown option group. 1
string The filtered sanitized option value. 1
mixed The filtered default value. 1
Yoast_Network_Settings_API The singleton instance. 1
string The URL of the asset file. 1
string The flattened version number. 1
WPSEO_Admin_Asset_Location The location to use in the asset manager. 1
bool True when the script is enqueued. 1
array The scripts that need to be registered. 1
array Styles that need to be registered. 1
bool True when sending data has been successful. 1
WP_Error|null The response error. 1
mixed The response body. 1
bool True when response is valid. 1
WP_User The user to show this notification for. 1
int The user id 1
string|null Nonce for this Notification. 1
float Returns the priority between 0 and 1. 1
string User Meta Option key that registers dismissal. 1
bool True if persistent, False if fire and forget. 1
bool True if a user needs to see this notification, false if not. 1
string The rendered notification. 1
string The wrapped message. 1
false|string 1
float|int The latest released major WordPress version. 0 when the stable-check API doesn't respond. 1
bool true if we should load the meta box classes, false otherwise. 1
$this 1
WPSEO_Option_Tab|null Get the active tab. 1
WPSEO_Option_Tab[] 1
array Array containing the column headings. 1
array Array containing the sortable columns. 1
array Array containing the columns to hide. 1
string The generated 1
array The SEO score filter. 1
array The Readability score filter. 1
array The keyword filter. 1
bool Whether the filter is considered valid. 1
array Array containing all the applicable filters. 1
array Array containing the meta query to use for filtering the posts overview. 1
array Array containing the query parameters regarding meta robots. 1
array Array containing the score filters that need to be applied to the meta query. 1
string|null The sanitized current post type or null when the variable is not set in $_GET. 1
string|null The sanitized seo filter or null when the variable is not set in $_GET. 1
string|null The sanitized readability filter or null when the variable is not set in $_GET. 1
string|null The sanitized seo keyword filter or null when the variable is not set in $_GET. 1
array Array containing the complete filter query. 1
array> The Readability Score filter. 1
array> The SEO score filter. 1
array> Array containin the no-index filter. 1
array> Array containing the no focus keyword filter. 1
array> Array containing the no readability filter. 1
array> Array containing the bad readability filter. 1
bool Whether or not it is indexable. 1
bool Whether or not the default indexing is being used for the post. 1
array Array containing the order filters. 1
string The HTML for the SEO score indicator. 1
bool Whether or not the meta box (and associated columns etc) should be hidden. 1
bool Whether or the current page can display the filter drop downs. 1
Yoast_Notification_Center 1
bool True if dismissed. 1
bool True if dismissed, false otherwise. 1
Yoast_Notification|null 1
int Number of notifications 1
int The user ID to use. 1
array The notifications, split on user ID. 1
array|Yoast_Notification[] Registered notifications. 1
Yoast_Notification[] The notifications for the user with the given ID. 1
string non-sanitized value of key if set, an empty string otherwise. 1
int 1, 0 or -1 for sorting offset. 1
bool True when notification is not persistent. 1
bool True if transaction was queued, false if it can be performed immediately. 1
bool True when notifications got removed. 1
bool True when there are stored notifications. 1
array|false Array with notifications or false when not set. 1
string The body of the response. 1
array Empty for an unknown file. See format above for known files. 1
bool True when the page request parameter equals the proxy page. 1
string The sanitized file request parameter or an empty string if it does not exist. 1
string The sanitized plugin_version request parameter or an empty string if it does not exist. 1
bool Whether or not it's an Yoast SEO option group. 1
string The modified or original admin title. 1
bool Whether or not the submitted input field contained an invalid value. 1
array An associative array of error descriptions. 1
string|null The error description. 1
string The aria-invalid HTML attribute or empty string. 1
string The aria-describedby HTML attribute or empty string. 1
string The error description HTML or empty string. 1
string The submitted invalid input field value. 1
string The error invalid value message or empty string. 1
int|string 1
string|bool Plugin name or false when no name is set. 1
array The editor specific replacement variables. 1
array The generic replacement variable names. 1
array Extracted names. 1
bool True if there are associated editor specific replace vars. 1
array The list of unique editor specific replacement variables. 1
bool Whether this is a settings updated settings notification. 1
bool Whether the settings have successfully been saved. 1
WP_REST_Response The response object. 1
string The header summing up the statistics results. 1
array The statistics for the current user. 1
array|mixed Returns the transient or an empty array if the transient doesn't exist. 1
array The statistics transient for the user. 1
array|bool The division of SEO scores, false if there are no posts. 1
array An array of SEO scores and associated data. 1
array The mapped rank. 1
string The label for the rank. 1
array Array containing the translatable labels. 1
bool Whether or not the count is zero. 1
string The link that shows an overview of posts with that rank. 1
int The total number of posts that match this filter. 1
array Array of views including the added view. 1
string|null The explanation or null. 1
string The url to activate this filter. 1
bool Whether the filter is active. 1
bool True when it is supported. 1
string|null The explanation. 1
string[] List of registered capabilities. 1
array Possibly modified array of the user's capabilities. 1
string[] Filtered primitive capabilities required of the user. 1
array Filtered list of capabilty groups. 1
array List of filtered groups. 1
string[] Registered capabilities. 1
WP_Role[] List of WP_Role objects. 1
array Filtered list of roles for the capability. 1
WPSEO_Capability_Manager Manager to use. 1
bool True if the user has the proper rights. 1
bool True if the user has the capability. 1
bool True if the capability is defined for the role. 1
array Capabilties that can be safely set. 1
WPSEO_Role_Manager 1
array Formatted capabilities. 1
array|bool|int> Default settings for the metabox. 1
string|null The current taxonomy or null when it is not set. 1
bool Whether the term is indexable. 1
string String decribing the current scope. 1
object|null Labels for the current taxonomy or null if the taxonomy is not set. 1
int|null the tag ID if it exists, null otherwise. 1
array The replacement variables. 1
array The recommended replacement variables. 1
array Array with shortcode tags. 1
array Converted subpages. 1
string The notification count in HTML format. 1
string Page identifier to use. 1
array Formatted submenu. 1
string Admin page identifier. 1
array Callback page handler. 1
string The title for the license page. 1
string SVG icon. 1
bool Whether the request comes from an IE 11 browser. 1
string[] List of classes that will be applied to the editbox container. 1
bool|void Boolean false if invalid save post request. 1
WP_Post|array 1
string[] Replace vars. 1
array Recommended replacement variables. 1
bool Whether or not the given page is the post overview page. 1
bool Whether or not the given page is the post edit page. 1
bool Whether or not the inclusive language analysis should be loaded. 1
string The CSS files WordPress wants to load and our CSS file. 1
array The new tinyMCE config with our added custom elements. 1
array The anonymized settings. 1
array Array with the value. 1
array|null The curl info. Or null when curl isn't available.. 1
array Returns the state of the php extensions. 1
array The formatted plugins. 1
array The formatted array. 1
string|null The name of the parent theme or null. 1
int The count for this post type. 1
bool True when tracking data should be sent. 1
bool True when seconds is bigger than threshold. 1
WPSEO_Collector The instance of the collector. 1
bool True when we can track, false when we can't. 1
bool Whether a notice should be shown or not. 1
bool True when notification is dismissed. 1
string|null The listener value or null if not set. 1
string Message about current status. 1
string Import action type. 1
WPSEO_Import_Status The current object. 1
string Returns a success message for the current action. 1
string Returns message with plugin name instead of replacement variables. 1
string The correct robot value. 1
array Array of post IDs from the DB. 1
string Query to get post ID's from the DB. 1
array|bool Array of data or false. 1
string The focus keyword. 1
string[] An array of all the unique custom fields/taxonomies/etc. used in the replace vars. 1
string[] All meta values that contain at least one AioSEO custom field replace var. 1
array|bool Array of Post IDs on success, false on failure. 1
string Plugin name. 1
bool Clone status. 1
bool Success status. 1
array Available importers. 1
array The robots values in Yoast format. 1
string HTML string for the warning. 1
bool True if set, false otherwise. 1
mixed Value for the key, or null if not set. 1
bool True if the feature is enabled, false otherwise. 1
string The file url. 1
bool True if it is hosted externally. 1
int The file size. 1
int|bool The file size or False if it could not be retrieved. 1
bool|array 1
bool Whether the post is viewable or not. 1
bool Whether the term is viewable or not. 1
string The taxonomy's singular label. 1
string The singular post type name. 1
bool Whether or not the post is visible. 1
string The full notification. 1
ORM Wrapper to use. 1
string Prepared full table name. 1
mixed|null The value of the property. 1
bool True when short table name should be used. 1
string|null The ID column name. 1
string The built foreign key name. 1
ORM Instance of the ORM wrapper. 1
$this|null Instance of the foreign model. 1
mixed The value of the property 1
array The data of this object. 1
bool True when value is set. 1
string The value of a property. 1
bool True when field is changed. 1
bool True when is new. 1
array The models data as array. 1
int The database ID of the models instance. 1
array Result of the static call. 1
bool Success. 1
bool|int Response of wpdb::query 1
bool|Model|ORM 1
bool|Model Instance of the model class. 1
array The query results. 1
float|int An integer representing the number of rows returned. 1
float|int The max value of the chosen column. 1
float|int The min value of the chosen column. 1
float|int The average value of the chosen column. 1
float|int The sum of the chosen column. 1
string The select query in SQL. 1
string The update query in SQL. 1
int The amount of null columns. 1
array|false The result rows. False if the query failed. 1
array Associative array of the raw data. 1
string The primary key ID of the row. 1
array The distinct set of columns that are dirty in at least one of the models. 1
bool True for successful insert, false for failed. 1
int|bool The number of rows changed if the query was succesful. False otherwise. 1
string The where part of the query. 1
string The update query. 1
string The delete query. 1
bool Whether the data has the key. 1
array|mixed|null The value. 1
array|mixed|null The value in the offset. 1
bool Whether the offset has the key. 1
mixed The value of the property. 1
bool True when property is set. 1
ContainerInterface|null The DI container. 1
array A mapping of surface name to the responsible class. 1
bool Whether or not to load in development mode. 1
bool Whether or not the query was performed succesfully. 1
array|false An associative array of the result. 1
array An array of associative arrays. 1
bool Whether or not the table was succesfully dropped. 1
Table 1
array|null 1
bool Whether or not the timestamps were removed. 1
bool Whether or not the index exists. 1
string The SQL type. 1
string The SQL statement for the column options. 1
string[] The version numbers that have been migrated. 1
bool Whether or not the version was succesfully set. 1
bool Whether or not the version was succesfully removed. 1
string The index name. 1
int The query type. 1
bool Whether or not it's a SQL function call. 1
string The SQL. 1
$this|null 1
bool|Table 1
object|null The service. 1
string|null The name of the container if the service was found. 1
string[]|false The registered migrations. False if no migrations were registered. 1
bool Whether all conditionals of the loadable are met. 1
object|null The class or, in production environments, null if it does not exist. 1
WP_Rewrite The WP_Query object. 1
PromiseInterface The promise interface. 1
Indexable_Presentation The indexable presentation. 1
bool True when WP_CRON is enabled. 1
bool `true` when the WooCommerce plugin is installed and activated. 1
bool `true` when the links on this website should be indexed. 1
bool `true` when the 'Redirect attachment URLs to the attachment itself' setting has been enabled. 1
bool `true` when on the frontend, or when on the post overview, 1
bool `true` when all database migrations have been run. 1
bool `true` when we aren't in a multisite setup. 1
bool `true` when the Jetpack plugin exists on this WordPress installation. 1
bool `true` when the headless REST endpoints have been enabled. 1
bool `true` when the Web Stories plugins is installed and active. 1
bool `true` when the current request is an XML-RPC request, `false` if not. 1
bool `true` when the Open Graph feature is enabled. 1
bool `true` when NOT on an admin page. 1
bool Whether we are on a theme or plugin upgrade page. 1
bool True when the wp_robots function exists. 1
bool True when the quick edit action is executed. 1
bool Whether Polylang is installed and active. 1
bool Whether the TranslatePress plugin is active. 1
bool True when the GET action is 'elementor'. 1
bool True when the POST action is 'wpseo_elementor_save'. 1
bool `true` when the Elementor plugin is installed and activated. 1
bool Whether or not the Yoast SEO Multilingual plugin is active. 1
string the title 1
string the description 1
string the canonical 1
string the id 1
string The site name. 1
string The alternate site name. 1
string The site name from the WordPress options. 1
string The site url. 1
int The site user id. 1
string|false Person or company. False if invalid value. 1
array|bool The site represents reference. False if none. 1
bool Whether or not open graph is enabled. 1
string The open graph publisher. 1
string The twitter card type. 1
string|array The schema page type. 1
string|array The schema article type. 1
bool Whether the current indexable has an image. 1
array 1
wpdb The wpdb global. 1
WPSEO_Replace_Vars The replace vars helper. 1
WPSEO_Admin_Asset_Manager The admin asset manager. 1
WPSEO_Addon_Manager The addon manager. 1
WPSEO_Shortlinker 1
WPSEO_Utils 1
false|string|WP_Error The permalink. 1
bool|null Whether or not the post type is public. Null if no override is set. 1
bool|null False when it has no parent. Null when it has a parent. 1
bool|null Whether the attachment has a public parent, can be true, false and null. Null when it is not an attachment. 1
bool|null True for noindex, false for index, null for default of parent/type. 1
array List of robots values. 1
int|null The number of pages or null if the post isn't paginated. 1
bool `true` if the post should be excluded from building, `false` if not. 1
string|null The input string or null. 1
array List of meta entries. 1
string|null The value of the meta field. 1
Author_Not_Built_Exception|null The exception if it should not be indexed, or `null` if it should. 1
bool|Indexable 1
bool|Indexable Instance of indexable. False when unable to build. 1
Indexable The home page indexable. 1
Indexable The date archive indexable. 1
Indexable The post type archive indexable. 1
Indexable The search result indexable. 1
Indexable|false The author indexable if it has been built, `false` if it could not be built. 1
bool Whether the indexable type is one that is not supposed to have object ID for. 1
Indexable|false The resulting Indexable. 1
bool True when indexable has a built hierarchy. 1
int The primary term ID. 0 if none exists. 1
int The deepest term ID. 1
WP_Term[] An array of all this term's parents. 1
string|int A unique ID for the indexable. 1
int The ID of the primary term. 1
string|null The meta value. 1
string[] An array of urls. 1
SEO_Links[] The link models. 1
SEO_Links The created link. 1
SEO_Links The enhanced link model. 1
string The link's permalink. 1
bool Whether or not the link should be filtered. 1
SEO_Links[] Links that are in $links_a, but not in $links_b. 1
int The number of internal links. 1
string The cleaned permalink. 1
bool Should the notification be shown. 1
bool Whether or not the migration should be run. 1
bool Whether or not the requested migration is at least the requested version. 1
bool|array False if there is no error, otherwise the error. 1
bool Whether or not the migration was succesfully locked. 1
bool|array The status of the migration, false if no status exists. 1
bool True if the status was succesfully updated, false otherwise. 1
bool Whether a group of badges is still eligible for a "new" badge. 1
bool Whether there are valid tokens. 1
OAuth_Token The stored tokens. 1
OAuth_Token The stored token. 1
bool The stored token. 1
OAuth_Token The refreshed tokens. 1
array[] The schema page type options. 1
array[] The schema article type options. 1
string The authentication URL. 1
array The list of all conflicting plugins. 1
array The authorization parameters 1
AccessToken|AccessTokenInterface The access token. 1
array The configurable options. 1
array The parsed response. 1
string The Indexable table name. 1
string[] The table names to use. 1
string Table name to use. 1
int[] An associated array of image IDs, keyed by their URLs. 1
int The ID that's extracted from the classes. 1
array> The pages. 1
array>> The script data. 1
bool If the inclusive language analysis should be loaded. 1
bool If cornerstone is enabled. 1
bool The SEMrush login status. 1
array Returns the name and if the addon is enabled. 1
bool Whether a multilingual plugin is currently active. 1
string|null The image URL for the social preview. 1
array> The post types for the given post IDs. 1
array The post IDs which use the passed keyphrase. 1
array> The parsed list. 1
Post_Site_Information 1
Term_Site_Information 1
bool If the feature is enabled. 1
string The feature identifier. 1
bool True if we have images, false if we don't. 1
number|null Returns the found image ID if it exists. Otherwise -1. 1
OAuth_Token The token object. 1
bool Whether or not the token has expired. 1
array The converted object. 1
int The most recent version number for the type, or 1 if the version doesn't exist. 1
User_Agent 1
bool|Indexable The indexable. If no indexable is found returns an empty indexable. Returns false if there is a database error. 1
Indexable[] The array with all the indexable instances of a certain object type. 1
Indexable[] The array with all the indexable instances of a certain object subtype. 1
Indexable[] An array of indexables. 1
Indexable[] The found indexables. 1
Indexable[] All ancestors of the given indexable. 1
Indexable[] array of indexables. 1
bool|Indexable The indexable. 1
int|bool The number of permalinks changed if the query was succesful. False otherwise. 1
int The total number of stored indexables. 1
Primary_Term|null Instance of a primary term. 1
SEO_Links|false The SEO Link, or false if none found. 1
array An array of associative arrays, each containing a post id and incoming property. 1
array An array of associative arrays, each containing a indexable id and incoming property. 1
bool Whether or not the insert was succesfull. 1
bool|int|mysqli_result|resource|null 1
int|bool The number of updated rows, false if query to get data fails. 1
bool Whether or not the indexables were successfully deleted. 1
bool Whether or not the ancestor was added successfully. 1
int[] The indexable id's of the ancestors in order of grandparent to child. 1
array Array with indexable id's for the children. 1
array List of indexable id's for the children. 1
Indexable_Extension|bool The extension. 1
int|null The post ID. 1
string The server request method, in upper case. 1
string|null The action or null if not found. 1
int|null The document ID or null if not found. 1
static Instance of the exception. 1
Term_Not_Built_Exception 1
Not_Built_Exception The exception. 1
Post_Type_Not_Built_Exception 1
string The db key of the Author_Metadesc custom meta. 1
string The db key of the Inclusive_Language_Analysis_Disable custom meta. 1
string The db key of the Noindex_Author custom meta. 1
string The db key of the Keyword_Analysis_Disable custom meta. 1
string The db key of the Author_Title custom meta. 1
string The db key of the Content_Analysis_Disable custom meta. 1
string The key of the Instagram contactmethod. 1
string The label of the Instagram field. 1
string The key of the X contactmethod. 1
string The label of the X field. 1
string The key of the Wikipedia contactmethod. 1
string The label of the Wikipedia field. 1
string The key of the MySpace contactmethod. 1
string The label of the MySpace field. 1
string The key of the Tumblr contactmethod. 1
string The label of the Tumblr field. 1
string The key of the SoundCloud contactmethod. 1
string The label of the SoundCloud field. 1
string The key of the Linkedin contactmethod. 1
string The label of the Linkedin field. 1
string The key of the YouTube contactmethod. 1
string The label of the YouTube field. 1
string The key of the Pinterest contactmethod. 1
string The label of the Pinterest field. 1
string The key of the Facebook contactmethod. 1
string The label of the Facebook field. 1
Closure[] An associative array of tasks to be added to the cleanup integration. 1
false|null False for when we are to filter out empty metadata, null for no filtering. 1
array The conditionals. 1
array The meta to be checked for emptiness. 1
array All the additional contactmethods. 1
array The additional contactmethods key/value pairs. 1
array The additional contactmethods keys. 1
array All the custom meta. 1
array All the custom meta, sorted by rendering priority. 1
array The custom meta that can't be empty. 1
int|false The number of rows that was deleted or false if the query failed. 1
int. 1
string The meta description tag. 1
string The filtered meta description. 1
string The filtered canonical. 1
string|array The raw value. 1
string The property key. 1
string The string with replacement variables replaced. 1
string The breadcrumbs HTML. 1
string The filtered output. 1
string The breadcrumb link. 1
string The id attribute. 1
string The class attribute. 1
string The wrapper element name. 1
string The separator. 1
string The element to use. 1
bool returns if the breadcrumb should be opened in another window. 1
string The rel next tag. 1
string The score icon. 1
string The URL list. 1
string The escaped value. 1
string Content to be placed in a robots.txt file. 1
string The meta author tag. 1
string The author's display name. 1
string The rel prev tag. 1
string The schema tag. 1
string The robots output tag. 1
string The filtered Twitter site. 1
string|bool Twitter ID or false if it failed to get a valid Twitter ID. 1
string The filtered Twitter description. 1
string The filtered card type. 1
string The filtered Twitter image. 1
string The filtered Twitter title. 1
string The styled Beta Badge. 1
string The styled Premium Badge. 1
string The styled Help link. 1
string The HTML string representation of the notification. 1
string The message to show in the notification. 1
string The time estimate as a HTML string. 1
string The sidebar HTML. 1
string The list item HTML. 1
string The styled New Badge. 1
bool True if still new. 1
string The error HTML. 1
string The styled Notice. 1
string The light switch's HTML. 1
string The second paragraph of the error message. 1
string The error message to show. 1
string The filtered article author's Facebook URL. 1
string The filtered type. 1
string The filtered article publisher's Facebook URL. 1
string The filtered url. 1
string The filtered description. 1
string The image tag. 1
array The raw value. 1
array The filtered image. 1
string The filtered site_name. 1
string The filtered title. 1
string The filtered locale. 1
string The Twitter tags for Slack. 1
array The enhanced data array 1
string The constructed version information. 1
array The conditionals that must be met to load this. 1
string The route prefix. 1
Content_Type|null The content type object. 1
bool The validated term ID. 1
SEO_Score_Groups_Interface The SEO score group that the SEO score belongs to. 1
array> 1
Endpoint_List The list with all endpoints. 1
array>> The scores. 1
array>> The current results. 1
array The current score links. 1
Taxonomy|null The taxonomy filter. 1
array>>>> The content types array. 1
Taxonomy|null The filtering taxonomy of the content type. 1
string The view link of the score. 1
bool True when the consent has been granted, false when it is not. 1
bool True when consent has been given, false when it is not. 1
array> The Site Kit API parameters. 1
bool Whether it's a comparison request. 1
bool Whether it's a daily request. 1
array> 1
array>> 1
array The score results for a content type. 1
array The select statement for the SEO scores query. 1
array The select statement for the readability scores query. 1
Data_Container The parsed Site Kit API response. 1
Data_Container Data about SEO scores of top pages. 1
bool|Indexable The indexable of the top page URL or false if there is none. 1
string|null The edit link for the top page. 1
Content_Types_List The content types in a list. 1
bool Whether the taxonomy in question is valid. 1
Taxonomy|null The hooked filtering taxonomy. 1
Taxonomy|null The taxonomy object for the category taxonomy. 1
string The REST API URL for the taxonomy. 1
array 1
array 1
string The the name of the readability score group. 1
null The minimum score of the readability score group. 1
null The maximum score of the readability score group. 1
string The the name of the SEO score group. 1
null The minimum score of the SEO score group. 1
null The maximum score of the SEO score group. 1
string The name of the current score. 1
string The amount of the current score. 1
string The ids of the current score. 1
array The links of the current score in the expected key value representation. 1
array>> The score list presented as the expected key value representation. 1
array>>|float|bool> Returns the name and if the feature is enabled. 1
string The subject. 1
string The filtering taxonomy. 1
string The filtered content type. 1
array The array of endpoints. 1
array The content types in the list. 1
array>>>> The content type list presented as the expected key value representation. 1
string The name of the content type. 1
string The label of the content type. 1
Taxonomy|null The taxonomy that filters the content type. 1
string The name of the taxonomy. 1
array> The taxonomy presented as the expected key value representation. 1
Data_Interface[] All the data points. 1
array The array of the data points. 1
Closure[] The cleanup tasks. 1
Closure[] The validated additional tasks. 1
int The limit for the amount of entities to be cleaned. 1
array The conditionals based on which this class should be loaded. 1
array The methods. 1
array|object|WP_Error|null The category we want to use for the post link. 1
int Primary category id. 1
string The filtered HTML output. 1
array The filtered presenters. 1
Abstract_Indexable_Presenter[] The presenters. 1
bool True when the title presenter should be removed, false otherwise. 1
array The preferences. 1
array The currently represented person's ID and name. 1
array The policy data. 1
array The policy data. 1
array The array of CTB settings. 1
array The default setting values. 1
array The settings defaults with local seo overides. 1
array The schema. 1
int The order. 1
string The route. 1
array The fallbacks. 1
string[] The (possibly adapted) list of enabled features. 1
array The excluded post types, including the specific post type. 1
array Array of pluralized durations. 1
string The formatted duration. 1
string The content with the duration text in the site language. 1
int The attachment ID. 0 if none was found. 1
array The images cache. 1
array The filtered categories. 1
array 1
bool returns if the block should be opened in another window. 1
array An array with the finished steps. 1
string The entity represented by the site. 1
string|false The company name. 1
string The website name. 1
string|false The website name. 1
string The company logo. 1
string The company logo id. 1
string|false The company logo URL. 1
string The person logo. 1
string|false The person logo URL. 1
string The person logo id. 1
string The site tagline. 1
string[] The social profiles. 1
bool True if tracking is enabled, false otherwise, null if in Free and conf. workout step not finished. 1
bool True if option change is allowed, false otherwise. 1
bool True if it's the main site or a single site, false if it's a subsite. 1
array The options for the company-or-person select. 1
array The extended array with columns. 1
array Modified Query pieces. 1
array The extended array with sortable columns. 1
void. 1
array The schedules containing the fifteen_minutes schedule. 1
bool Should cron indexation be performed. 1
bool Should background indexation be performed. 1
int The shutdown limit. 1
bool Returns true if the input array is a WordPress site status tests array. 1
string The data to pass as identifying data. 1
string The product info. 1
string The WordPress version string. 1
string The theme info as string. 1
string The indexables status in a string. 1
string The locale settings of the site and user. 1
array The sorted array of actions. 1
string The validation failure alert. 1
string The import failure alert. 1
string|WP_Error The source location or a WP_Error object if the required version is not installed. 1
string The updated comparison table. 1
bool Whether the required version is installed, or no version is required. 1
bool If the notification should be shown. 1
Indexing_Failed_Notification_Presenter|Indexing_Notification_Presenter 1
string The error to show if optimization failed. 1
bool If the site has a valid Premium subscription. 1
mixed|null Returns workouts option if found, null if not. 1
string The notification to update Premium. 1
bool Returns true when Premium is enabled and the version is below 17.7. 1
bool Returns true when Premium subscription has expired. 1
bool Returns true when Premium subscription is activated. 1
string Returns a string with the upsell/update copy for the card buttons. 1
string Returns a string with the upsell/update link for the card buttons. 1
array The excluded taxonomies, including specific taxonomies. 1
bool Whether or not premium is installed and not activated. 1
string The message to display. 1
bool True when user has right capabilities. 1
bool True if current page is the index.php. 1
bool True when the php version is support. 1
Indexable|false The indexable. False if none could be found. 1
array The IDs of all pages shown on the current page. 1
array The output of the activation. 1
array The installation success state and the output of the installation. 1
array List of owned addons with slug as key and name as value. 1
string[] The conditionals that should be met before this integration is loaded. 1
array The values, where the `metaDescriptionDate` is set to the empty string. 1
bool Whether the request is a REST request. 1
array Filtered presenters. 1
string The description sentence. 1
string|string[] Article type. 1
string The correct canonical. 1
Indexable[] The indexables to be shown in the breadcrumbs, with the shop page added. 1
int The Page ID of the shop. 1
string The title to use. 1
string The description to use. 1
string The rendered value. 1
string|null The link. 1
Indexable_Presentation The presentation, taken from the current page if the input was invalid. 1
string The unfiltered home URL. 1
string The original url. 1
array The passed array with the additional isWebStoriesIntegrationActive variable set to 1 if we are editing a web story. 1
bool Whether the metabox should be displayed. 1
bool Whether the highlighting functionality is available. 1
array Replace vars. 1
array Recommended replacement variables. 1
string The separator from Yoast SEO's settings. 1
string The canonical URL for the queried object. 1
bool Whether or not the RSS footer should included. 1
bool True when one of the fields has a value. 1
string The content to add. 1
string The link template. 1
string Filtered robots.txt output. 1
string The altered content. 1
false|string The buffered output. 1
string Content with shortcodes filtered out. 1
array The robots data. 1
array The robots key-value pairs. 1
array The formatted robots. 1
array The filtered robots. 1
array The sorted robots array. 1
array An array of oEmbed data with modified values where appropriate. 1
WP_Query 1
string|null The value of replytocom or null if it does not exist. 1
string The modified link. 1
bool True when redirect has been done. 1
bool True to remove, false not to remove. 1
bool Boolean indicating whether the noindex header was sent. 1
string The queried post type. 1
bool Whether or not to redirect an archive page. 1
string The attachment url. 1
int|false The ID of the primary term, or `false` if the post ID is invalid. 1
bool Whether the reset request ran. 1
array The retrieved taxonomies. 1
bool Whether the SEMrush tokens have been deleted or not. 1
bool Whether the Wincher tokens have been deleted or not. 1
bool Whether the WordProof tokens have been deleted or not. 1
bool Whether the option is set. 1
bool Whether the tokens have been deleted or not. 1
string The new HTML, with the auto-update toggle link replaced. 1
bool Whether auto updates for a plugin are enabled. 1
bool Whether search engines are discouraged from indexing the site. 1
Indexable[] The indexables. 1
bool True when the site is multisite and switched 1
bool Whether or not the option has been saved. 1
bool True if the children were reset. 1
array The list of additional child indexables for a given term. 1
array List with object ids for the term. 1
bool Whether the request ran. 1
bool Whether or not the ancestors are removed. 1
array Array with the relevant keys. 1
bool True when delete query was successful. 1
string The Open Graph description. 1
bool Whether the query contains multiple terms. 1
static A model presentation. 1
mixed The value if it could be generated. 1
bool Whether or not there is a generator for the requested property. 1
bool If this class is a prototype or not. 1
string The permalink. 1
array The base robots value. 1
array The filtered meta robots values. 1
string The open graph locale. 1
string The open graph site name. 1
string The Twitter card type. 1
string The Twitter site. 1
array The Schema object. 1
array The breadcrumbs. 1
int|null The estimated reading time. 1
array The list of promotions. 1
array The list of promotions. 1
array The list of promotions. 1
bool Whether the given time is within the interval. 1
Time_Interval 1
bool Whether the dismiss was successful or not. 1
bool Whether the reset was successful or not. 1
bool Whether the alert has been dismissed. 1
array|false An array with the keys of all Alerts that have been dismissed 1
bool Whether the alert is allowed. 1
string[]|false The dismissed alerts. False for an invalid $user_id. 1
array The old values. 1
Object The reponse object. 1
object The keyphrase chart data. 1
array The keyphrases. 1
array The filtered results. 1
bool Whether the limit is exceeded. 1
bool True when install is successful. 1
bool True when plugin is installed. 1
bool|WP_Error True when success, WP_Error when something went wrong. 1
bool True when activation is successful. 1
int The limited number of unindexed posts. 0 if the query fails. 1
int|false The total number of unindexed posts. False if the query fails. 1
array The indexable types to create. 1
int The total number of unindexed post type archives. 1
array The list of post types for which no indexable for its archive page has been made yet. 1
array The list of names of all post types that have archive pages. 1
array The list of names of post types with unindexed archive pages. 1
int The total number of unindexed links. 1
array Objects to be indexed, should be an array of objects with object_id, object_type and content. 1
object The presentations and status code 200. 1
object The head response. 1
bool True if the updated importer framework is enabled. 1
array The detected plugins. 1
string The plugin name. 1
string The type of data. 1
bool True if the action can import the given plugin's data of the given type. 1
string The plugin we import from. 1
string The data type we import from the plugin. 1
bool True if this action can handle the combination of Plugin and Type. 1
string The completed id. 1
int The stored state of completedness. 1
bool True by default unless a child class overrides it. 1
string The cursor id. 1
array The setting map of the robot setting for author archives. 1
bool The transformed redirect_attachment setting. 1
string The postmeta table name along with the db prefix. 1
array The setting map of the robot setting for post category taxonomies. 1
array An array of validated data or false if aioseo data did not pass validation. 1
bool Whether the AIOSEO table exists and has the structure we expect. 1
bool Whether the AIOSEO settings from the options table exist and have the structure we expect. 1
bool Whether the AIOSEO robots settings from the options table exist and have the structure we expect. 1
bool Whether the post AIOSEO robots settings from the options table exist and have the structure we expect. 1
bool Whether the AIOSEO robots settings for search appearance settings from the options table exist and have the structure we expect. 1
string The source option_name. 1
int The limited number of unindexed posts. 1
int The number of unindexed posts. 1
array|false An array of the AIOSEO settings that were imported or false if aioseo data was not found. 1
bool Whether the settings are set. 1
array The (maybe chunked) unimported AiOSEO settings to import. 1
array The (chunk of, if limit is applied)) unimported AIOSEO settings. 1
bool The transformed boolean meta data. 1
bool The noindex setting. 1
array The setting map of the robot setting for one subset of post types/taxonomies/archives or an empty array. 1
Indexable The created indexables. 1
string|bool|null The transformed data to be imported. 1
string|null The plucked keyphrase. 1
array The enhanced mapping. 1
bool|null The url of the social image we're importing, null if there's none. 1
string The transformed company logo url. 1
string The transformed person logo url. 1
string The transformed site represents setting. 1
string The transformed separator. 1
WP_REST_Response|WP_Error The response, or an error. 1
bool Whether the user has the required capabilities. 1
string The ID. 1
int The priority. 1
bool Whether this introduction should show. 1
array The list of introductions. 1
Introduction_Interface[] 1
array The introductions' metadata. 1
bool Whether the user has seen the introduction. 1
bool Whether the current page is applicable. 1
bool Whether the current page is one of our installation pages. 1
string The page variable. 1
bool Whether the version is between a min and max. 1
array The introductions. 1
bool True on successful update, false on failure or if the value passed to the function is the same as 1
bool Whether the introduction is seen. 1
bool False on failure. Not having to update is a success. 1
bool The current value. 1
array Returns in an array format. 1
Meta The meta values. 1
Meta[]|false The meta values. False if none could be found. 1
Meta The meta value 1
mixed The instance of the class. 1
object The HTML and JSON presentation of the head metadata. 1
mixed The value, as presented by the appropriate presenter. 1
bool Whether or not the requested property exists. 1
Abstract_Indexable_Presenter[] 1
object|null 1
array> An array of associative arrays that each have a 'text' and a 'url'. 1
bool Whether or not a blog crumb should be added. 1
string|false The parent if it exists, false otherwise. 1
string[] The breadcrumbs. 1
array> The images. 1
array The graph. 1
array The graph pieces to generate. 1
array The generated schema graph. 1
array The graph with the schema blocks graph pieces added. 1
array The schema graph. 1
array The schema graph with empty breadcrumbs taken out. 1
array The WebPage graph piece that has been adapted for password-protected posts. 1
Abstract_Schema_Piece[] A filtered array of graph pieces. 1
array The filtered graph piece. 1
array An array of the piece's types. 1
string The OG locale. 1
array> WebPage schema data. 1
array> The WebPage schema. 1
array> 1
array> The WebPage data with the potential action added. 1
string Search URL. 1
array Website data blob. 1
bool|array Person data on success, false on failure. 1
string[] A list of SameAs URLs. 1
array An array of Schema Person data. 1
bool True when the site is represented by the same person as this indexable. 1
array The Person schema data. 1
bool|array Array on success, false on failure. 1
array A breadcrumb listItem. 1
array The last of the breadcrumbs. 1
bool `true` if the breadcrumb is broken. 1
bool If the breadcrumb should not be hidden. 1
bool If the breadcrumb has a not empty text. 1
array Image schema. 1
bool|array Person data on success, false on failure. 1
array The Person schema. 1
mixed Article data. 1
array The Article data. 1
array The Article data with the potential action added. 1
int The number of words in the content. 1
false|array Image Schema. 1
array The Organization schema. 1
array An array of social profiles. 1
bool Whether or not the code is valid. 1
bool Whether or not the keyphrase is valid. 1
bool Whether or not the country code is valid. 1
bool Whether or not the current user is allowed to use SEMrush. 1
bool Whether the code is valid. 1
bool Whether the website_id is valid. 1
bool Whether the current user is allowed to use Wincher. 1
WP_REST_Response a list of features supported by this yoast seo installation. 1
bool Whether or not the url is valid. 1
bool Whether or not the current user is allowed to index. 1
WP_REST_Response|WP_Error The response, or an error when running the indexing action failed. 1
string|array|null The output value. String if HTML was requested, array otherwise. 1
WP_REST_Response the state of the configuration. 1
WP_REST_Response|false Response or false on non-existent route. 1
Importing_Action_Interface|false The importer, or false if no importer was found. 1
string|false The endpoint for the given action or false on failure of finding the one. 1
bool Whether or not the current user is allowed to import. 1
string Formatted date string. 1
int The current time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT). 1
bool True when datetime is valid. 1
bool True if metabox is enabled. 1
array Array with all the public post_types. 1
array The excluded post types. 1
bool If the post type is exclude. 1
bool True when the post type has an archive page. 1
array The post types that should be indexed. 1
array All post types which are indexable and have archive pages. 1
array The filtered post types that are included to be indexed. 1
bool if the archive is indexable. 1
array List of indexable post type objects. 1
bool True if WordPress is currently running on production, false for all other environments. 1
string The current WordPress environment. 1
bool Whether or not the attachment is valid. 1
bool True when valid. 1
bool Whether or not the attachment is a valid image type. 1
int|bool ID when found, false when not. 1
string The caption when found, empty string when no caption is found. 1
array The metadata, empty array when no metadata is found. 1
string The url when found, empty string otherwise. 1
bool|string The attachment url or false when no variations found. 1
array|bool Array with image details when the image is found, boolean when it's not found. 1
bool Whether or not the plugin is network-active. 1
bool True when url is relative. 1
string The path of the URL. Returns an empty string if URL parsing fails. 1
string The host of the URL. Returns an empty string if URL parsing fails. 1
string The extension. 1
string The absolute url. 1
string The link type. 1
array The parsed components of the URL. 1
string The AIOSEO table name along with the db prefix. 1
bool True if the table is found. 1
array The option where the global settings exist. 1
mixed|bool Value for the $meta if one is given, might be the default. 1
mixed|null Returns value if found, $default_value if not. 1
mixed|null Returns value if found. 1
mixed The default value. 1
string The title separator. 1
string The option title. 1
array The title defaults. 1
bool Whether the URL is valid. 1
bool Whether the twitter id is valid. 1
mixed Will be an array if $single is false. Will be value of meta data field if $single is true. 1
int The number of posts the user has written in this post type. 1
string The author's field from the current author's DB object. 1
string The author's archive url. 1
int The current user's ID, or 0 if no user is logged in. 1
int|bool Meta ID if the key didn't exist, true on successful update, 1
string|false The page type. False if it could not be determined. 1
bool Whether indexing the specific indexable is appropriate at this time. 1
bool Whether the indexables should be indexed. 1
bool Whether or not the dynamic permalinks should be used. 1
bool Whether the indexable has default values. 1
array The social profile fields. 1
array The organization profile fields. 1
array The person's social profiles. 1
array The social profiles for the organization. 1
string|array The sanitized social field. 1
array An array with the setting that the non-valid url is about to update. 1
array An array with the settings that the non-valid urls are about to update, suffixed with a dash-separated index of the positions of those settings, eg. other_social_urls-2. 1
array An array with the setting that the non-valid twitter value is about to update. 1
bool Whether adjacent rel links are disabled or not. 1
int The number of archive pages. 1
int The current archive page. 1
int The current post page. 1
int The current page number. 1
string The key of the query loop. 1
string The page number from the query loop. 1
bool Whether the table exists. 1
array The post types that are shown on an author's archive. 1
bool|null Whether the author has at least one public post. 1
bool `true` if author archives are disabled, `false` if not. 1
bool Whether the author has at least one post with the is public null. 1
bool True for hierarchical taxonomy. 1
array The flattened array. 1
array The registered disallow directives per user agent. 1
array The registered allow directives per user agent. 1
array The registered sitemap rules. 1
array The registered user agents. 1
bool True when there was a switch between the multisites. 1
string The processed string. 1
string String without shortcodes. 1
bool Whether the Indexable is indexable. 1
array The altered robots string. 1
string Page type. 1
bool Whether the currently opened page is a simple page. 1
int The id of the currently opened page. 1
int The id of the currently opened author archive. 1
int The id of the front page. 0 if the front page is not a static page. 1
int The id of the currently opened term archive. 1
string The post type of the main query. 1
bool Whether or not the current page is the homepage that displays posts. 1
bool Whether or not the current page is a static frontpage. 1
bool Whether or not the current page is a static posts page. 1
bool Whether or not it's a non-frontpage, statically set posts page. 1
bool Whether nor not the current page is a post type archive. 1
bool Whether nor not the current page is a term archive. 1
bool Whether nor not the current page is an attachment page. 1
bool Whether nor not the current page is an author archive. 1
bool Whether nor not the current page is an date archive. 1
bool Whether nor not the current page is a search result. 1
bool Whether nor not the current page is a 404 page. 1
bool Whether or not the current page is the post format archive. 1
bool Whether or not the current page is an archive page for multiple terms. 1
bool Whether the current page is paged. 1
bool Whether or not the current page is the front page. 1
string The current page. 1
bool True when current page is a yoast seo plugin page. 1
string The current Yoast SEO page. 1
bool current global post is set as privacy page 1
int The amoumt of queried terms. 1
bool True when is premium. 1
string|null The Premium version or null when premium version is not defined. 1
string[] All dependency urls of the given handle. 1
string[] All dependencies of the given handle. 1
string|false The URL of the asset or false if the asset does not exist. 1
bool True if the current URL is a valid URL. 1
array The list of the allowed extra vars. 1
array is_allowed and allowed_query. 1
bool is query with page param. 1
string The type of URL. 1
bool Whether the integration is active. 1
bool The Wincher login status. 1
bool Is WooCommerce active. 1
int The ID of the set page. 1
string|null The permalink. 1
bool Returns true if cURL is installed. 1
string|null Returns a string containing the cURL version, or null if cURL is not installed. 1
bool True when taxonomy is set to index. 1
string[]|WP_Taxonomy[] Array with all the public taxonomies. 1
string Term description (without tags). 1
array|bool Array of all the meta data for the term. 1
string The slug for the taxonomy. Returns the taxonomy's name if no slug could be found. 1
string[]|WP_Taxonomy[] Array with all the custom taxonomies. 1
array The excluded taxonomies. 1
bool If the taxonomy is excluded. 1
array The indexable taxonomies. 1
array List of indexable indexables objects. 1
bool Whether an indexing reason has been set in the options. 1
string The indexing reason, defaults to the empty string if no reason has been set. 1
int|bool The start time when the indexing process has started but not completed, false otherwise. 1
bool Whether the site still has to be indexed for the first time. 1
bool Whether the indexing of the indexables has completed. 1
int The amount of unindexed posts expressed in percentage. 1
bool Whether the SEO optimization button should show. 1
int The total number of unindexed objects that can be indexed in the background. 1
array The parsed url. 1
bool Whether the current user can do the first-time configuration. 1
bool Whether the current page is a Yoast SEO admin page 1
bool Whether the first-time configuration has been finished. 1
bool Whether the site representation name and logo have been set. 1
string Content without shortcode tags. 1
string Post excerpt (without tags). 1
string|false Post type on success, false on failure. 1
string The post title with fallback to `No title`. 1
WP_Post|null The post. 1
bool True if the post can be indexed. 1
array The excluded post statuses. 1
array The public post statuses. 1
array 1
string The PHP version. 1
string The wp_version. 1
array The shortlink data. 1
string The software name. 1
int The number of days the plugin is active. 1
bool Whether word form recognition is active for the used language. 1
bool Whether the language has function word support. 1
bool Whether the language has inclusive language support. 1
string The language to use to select a researcher. 1
string The site language code without region. 1
int The stored cursor value. 1
bool True if the user has at least one of the proper rights. 1
bool True when function parse_blocks exists. 1
string The sanitized string. 1
string The sanitized URL. 1
string Image size string. 1
string The image url. Empty string if the attachment is not valid. 1
bool True if it has Article schema, false if not. 1
bool True if author is supported for the passed object sub type. 1
array an empty ImageObject 1
string The user's schema ID. 1
array The array with replaced vars. 1
Closure A function that returns the given value. 1
array The Schema piece data with added language property 1
bool Whether or not the URL is a valid image. 1
string|null The image size when overriden by filter or null when not. 1
array|false The image data when found, `false` when not. 1
Report_Builder The new Report_Builder instance. 1
array The report in WordPress' site status report format. 1
string[] The badge. 1
string The badge label. 1
string The color for the badge's outline. 1
string A string containing the set actions and Yoast's signature. 1
string Yoast's signature as an HTML string. 1
string The identifier that WordPress requires. 1
string A human-readable label for the health check. 1
Report_Builder 1
bool True if the text link counter feature is enabled. 1
WPSEO_MyYoast_Api_Request 1
bool True if permalinks are set to contain the post name. 1
bool True if comments are displayed on a single page. 1
string The actions as an HTML string. 1
Indexable 1
array A list of all active conflicting plugins. 1
array The array of activated conflicting plugins. 1
false|array The names of all active plugins. 1
array The remaining active plugins. 1
bool The transformed robot setting. 1
string The default source of social images. 1
string The global default social image. 1
string The social default. 1
string The url of the first image in content. 1
string The url of the first attached image. 1
string The Yoast replacevar. 1
bool Whether global robot settings enable or not the specific setting. 1
bool The robot setting. 1
array The list of missing indexables. 1
string Returns the indexable type. 1
array The updated headers. 1
string|false The path to redirct to. False if no redirect should be done. 1
string Returns the breadcrumbs as a string. 1
array The collected links. 1
string|void 1
string The content title. 1
Indexable_Presentation The current page presentation. 1
string The partner. 1
bool True or false. 1
array The updated excludelist. 1
array A new array with meta fields. 1
string The script's tag. 1
bool True when the current request is a REST request. 1
bool Returns if the options are deleted 1
bool|string Returns if the integration should be disabled. 1
bool Returns if the integration toggle is set to true if conditionals are met. 1
bool Returns if WordProof should be active for this page. 1
string The formatted and translated date. 2
int|bool 2
string Score markup, or empty string if none available. 2
array The query vars. 2
array The category rewrite rules. 2
string The home url. 2
string[] The array of enabled features. 2
array The shortlink's query params. 2
bool|null True = stop saving, null = continue saving. 2
string All 'normal' values returned from get_post_meta() are strings. 2
bool Whether the value was changed. 2
bool Whether the delete was successful or not. 2
string The prefixed taxonomy. 2
int The found attachment ID, or 0 if none was found. 2
array|false Returns an array with image data on success, false on failure. 2
int|bool The attachment id, or false or 0 if no ID is available. 2
array Array with all the accessible post_types. 2
bool True when post type is set to index. 2
array The installed plugins. 2
int|null 2
array List of replace vars. 2
array Array where the first item is the hook name, the second is the hook callback, 2
string|bool 2
array The lookup table. 2
WPSEO_Sitemap_Image_Parser 2
array The selected attachments. 2
array The found attachments. 2
array Array of dates. 2
string The file path with normalized slashes. 2
array The translated strings. 2
bool Whether or not this is the dashboard screen. 2
array The recommended replacement variables. 2
array Contactmethods with added contactmethods. 2
string The current post type. 2
bool Whether the meta box (and associated columns etc) should be hidden. 2
Yoast_Plugin_Conflict 2
false|int 2
int The post ID. 2
string The field id. 2
array { 2
WP_Error|array The response or WP_Error on failure. 2
Meta The meta object. 2
string The HTML for the readability score indicator. 2
bool True if restored, false otherwise. 2
array|Yoast_Notification[] Sorted Notifications 2
string The modified query. 2
string The query value this filter uses. 2
string The label for this filter. 2
array The post types to which this filter should be added. 2
array The filtered post types. 2
array List of capabilities. 2
array The users that have the capability. 2
array The names of the roles that have the capability. 2
bool True if the user has at least one capability. 2
string[] List or registered roles. 2
WPSEO_File_Size_Exception Instance of the exception. 2
array|bool|int> 2
WPSEO_Metabox_Section[] 2
WPSEO_Metabox_Section_Additional[] 2
string The product title. 2
bool Whether the current post type has taxonomies. 2
string String describing the current scope. 2
string[] The hidden replace vars. 2
bool Whether the tab has any sections 2
Yoast_Notification The notification. 2
self Main instance. 2
Yoast_Feature_Toggle Feature toggle instance based on $toggle_data. 2
int An integer less than, equal to, or greater than zero indicating respectively 2
string The table name. 2
static Current object. 2
bool|int Response of wpdb::query. 2
bool|Model 2
array|mixed|null 2
string The insert query. 2
WP_Query The WP_Query object. 2
Meta_Tags_Context The meta tags context. 2
bool `true` when on the admin dashboard, update or Yoast SEO pages. 2
array The conditionals that must be met to load this. 2
string The company name. 2
int|bool The company logo id. 2
array>|bool 2
string|null The main image URL. 2
int|null The main image ID. 2
bool|Indexable The extended indexable. False when unable to build. 2
int|null Score to use. 2
array Lookup table for the indexable fields. 2
bool|null 2
SEO_Links[] The created SEO links. 2
bool Whether or not the current user is allowed to dismiss alerts. 2
array The response. 2
OAuth_Token The requested tokens. 2
int[] An associated array of image IDs, keyed by their URL. 2
array The keyphrase and the associated posts that use it. 2
Analysis_Features_List The analysis list. 2
array The specific seo data. 2
array The list presented as a key value representation. 2
bool Whether or not the update was succeful. 2
int|bool The number of deleted rows, false if the query fails. 2
int|bool The associative array with shape [ old_id => [ old_id, new_author ] ] or false if query to get 2
WP_Post|null 2
Forbidden_Property_Mutation_Exception The exception. 2
Post_Not_Built_Exception 2
string The output. 2
string The filtered adjacent link. 2
string The tag. 2
string The styled Alert. 2
string The debug close marker. 2
WP_REST_Response The success or failure response. 2
bool True when user has the 'wpseo_manage_options' capability. 2
Taxonomy|null The taxonomy object. 2
bool True when the configuration is dismissed, false when it is not. 2
Data_Container The Site Kit API response. 2
array> 2
array The SEO score results for a content type. 2
array The readability score results for a content type. 2
array The array of conditionals. 2
Closure[] Associative array of indexable cleanup functions. 2
string The correct link. 2
array The replacement variables. 2
string[] The conditionals based on which this loadable should be active. 2
int|null The person id, null if empty. 2
array the filtered submenu pages. 2
bool Whether the "First-time SEO Configuration" admin notice should be displayed. 2
int The new batch limit. 2
string[] Array containing WordPress site status tests with Yoast's health checks. 2
string The active plugins. 2
string[] The allowed dismissable alerts. 2
bool True if it's 404. 2
bool Whether the permalinks should be reset. 2
array 2
string The Open Graph URL. 2
string The open graph image ID. 2
string The open graph image URL. 2
string The open graph url. 2
string The open graph article publisher. 2
string The open graph article author. 2
string The open graph article published time. 2
string The open graph article modified time. 2
string The Twitter title. 2
string The Twitter image. 2
string The Twitter creator. 2
bool Whether the promotion is effective. 2
object The result object. 2
array Objects to be indexed. 2
array The reindexed objects. 2
string The transformed meta data. 2
string The transformed URL. 2
Indexable[]|false An array of created indexables or false if aioseo data was not found. 2
int 1 if it hasn't been completed in the past, 0 if it has. 2
array The needed data array that contains all the needed columns. 2
bool|null The value of Yoast's noindex setting for the post. 2
bool True when user has 'edit_posts' permission. 2
int The number of cleaned up records. 2
array The crumb. 2
Images The image container. 2
bool|int User ID or false upon return. 2
array Our Schema graph. 2
array Schema.org Question piece. 2
WP_REST_Response the configuration of the workouts. 2
bool True on success, false on failure. 2
bool True if default value. 2
string[] An array of field names which failed to be saved in the db. 2
bool Whether the author has at least one public post. 2
string The permalink of the currently opened date archive. 2
bool True when the page is a shop page. 2
string The sanitized HTML. 2
array An imageObject with width and height set if available. 2
string[] The array containing a WordPress site status report. 2
bool The boolean indicating if the health check was succesful. 2
bool True if the given version is older than the current latest version. 2
array The detected importers that have data to work with. 2
string The url of the featured image. 2
array Returns both values in an array format. 2
int Returns the amount of missing indexables. 2
static The instance. 2
bool Whether or not the WordProof Timestamp plugin is active. 2
array The updated integration toggles array. 2
string The modified content. 3
bool|Indexable The indexable, false if none could be found. 3
bool True if requirements are met, false otherwise. 3
bool True if capabilities are sufficient, false otherwise. 3
self 3
WPSEO_Rank[] 3
string Home URL with optional path, appropriately slashed if not. 3
bool Whether or not the metabox should be displayed. 3
array The post types. 3
string|null The image URL. 3
array Cleaned option. 3
bool Whether the update was successful. 3
bool|string 3
Yoast_Notification 3
string The message. 3
bool Whether or not data can be retrieved. 3
bool Whether the social templates should be used. 3
bool Whether the given meta value key is disabled. 3
array List of registered submenu pages. 3
string Capability to check against. 3
array Array containing all the replacement variables. 3
string The version. 3
WPSEO_Import_Status Import status object. 3
bool True on success. 3
array|bool False when not found, array with data when found. 3
bool If this analysis is enabled by the user. 3
bool If this analysis is enabled globally. 3
bool If the plugin is activated. 3
string The description template. 3
string The social title template. 3
string The title template. 3
array The images. 3
SEO_Links[] The SEO Links. 3
Author_Not_Built_Exception The exception. 3
array The raw value. 3
string The notification in an HTML string representation. 3
Data_Container The parsed response. 3
array 3
int The minimum score of the readability score group. 3
int The maximum score of the readability score group. 3
string The name of the readability score group. 3
int The minimum score of the SEO score group. 3
int The maximum score of the SEO score group. 3
string The name of the SEO score group. 3
array The script data. 3
array The settings. 3
array The taxonomies. 3
string The rendered breadcrumbs. 3
string The content with images optimized. 3
string The block output. 3
Yoast_Notification The notification to show. 3
array Array containing all the replacement variables. 3
array The graph piece. 3
string[] The conditionals. 3
string The Twitter description. 3
array The open graph images. 3
string The rel prev value. 3
string The rel prev next. 3
string The open graph title. 3
string The open graph description. 3
string The paginated URL. 3
int The total number of unimported objects. 3
string The query to use for importing or counting the number of items to import. 3
array The Person schema. 3
array Article data. 3
Score_Icon_Presenter The Score_Icon_Presenter. 3
array The blocks in a block-type => WP_Block_Parser_Block[] format. 3
string The actions as a string. 3
string The description as a string. 3
string The formatted date. 4
string The final URL. 4
array Validated clean value for the option to be saved to the database. 4
bool Whether or not this analysis is enabled. 4
bool Whether or not this analysis is enabled by the user. 4
bool Whether or not this analysis is enabled globally. 4
bool Boolean indicating whether there is something to import. 4
bool Import status. 4
array List of sorted Yoast_Feature_Toggle instances. 4
string The name of the feature flag. 4
string the name of the feature flag. 4
object An object with last_modified and published_at timestamps. 4
Indexable The indexable. 4
bool|Indexable Instance of indexable. 4
bool Whether or not the delete was succesfull. 4
WP_REST_Response|WP_Error The success or failure response. 4
Data_Container 4
bool False when the update failed, true when the update succeeded. 4
int The position of the readability score group. 4
int The position of the SEO score group. 4
array The pages. 4
string[] The presenters. 4
array|string[] The conditionals. 4
array The filtered submenu pages. 4
Indexable[] The created indexables. 4
mixed The helper class. 4
bool Whether the helper exists. 4
string[] The crumb. 4
string|null The head. 4
string The image url or an empty string when not found. 4
array Schema ImageObject array. 4
string The human-readable label. 4
string[] The WordPress-friendly health check result. 4
string The URL of the asset. 5
ORM Instance of the ORM. 5
bool Whether the conditional is met. 5
Indexable The extended indexable. 5
bool If this analysis is enabled. 5
int|bool The number of rows that was deleted or false if the query failed. 5
bool|int The number of deleted rows, false if the query fails. 5
string The webmaster tool site verification value. 5
string The name of the readability score group that is used when filtering on the posts page. 5
string The name of the SEO score group that is used when filtering on the posts page. 5
array The names of the post types. 5
array The endpoints. 5
string The meta description. 5
array The source. 5
int|false The limited number of unindexed posts. False if the query fails. 5
object 6
mixed The parsed API response. 6
string The legacy key. 6
bool If the integration is activated. 6
array 6
string The social description template. 6
float|int 6
int The priority which the custom meta's form field should be rendered with. 6
string The id of the custom meta's form field. 6
string The meta value. 6
bool Whether the respective global setting is enabled. 6
bool Whether the custom meta is allowed to be empty. 6
string The raw value. 6
array The conditionals. 6
string The Open Graph type. 6
array The collection data. 7
string The name. 7
bool Import success status. 7
array The array of conditionals. 7
object Object with head and status properties. 7
WP_REST_Response 7
string The proper URL. 7
Report_Builder This builder. 7
string The page type. 8
string The canonical. 8
array The robots value. 8
int The total number of unindexed objects. 8
string[] The message as a WordPress site status report. 8
string The translation. 8
string[] 9
bool Cleanup status. 9
array Returns the legacy key and if the feature is enabled. 9
string The title. 9
array Returns the name and if the feature is enabled. 10
Seo_Plugin_Data_Interface The specific seo data. 10
string The prepared query string. 10
int The limit. 11
Meta|false The meta values. False if none could be found. 11
mixed 13
array The conditionals. 13
int 15
array 17
object The response object. 18
string The table name to use. 22
WP_REST_Response The response. 26
bool Whether or not the conditional is met. 27
string|null 47
ORM 77
bool 148
array 151
string 217
void 1183
@see http://www.php-fig.org/psr/psr-1/ 1
wpseo_register_var_replacement() for a usage example. 1
members_register_cap_group() 1
URE_Capabilities_Groups_Manager::get_groups_tree() 1
URE_Capabilities_Groups_Manager::get_cap_groups() 1
https://yoast.com/help/list-available-snippet-variables-yoast-seo/ 4
@since 8.3 1
7.7 1
5.9.0 1
1.5.3 1
1.7.0 1
8.4 1
1.2.8 1
13.3 1
1.8.0 Moved from stand-alone function to this class. 1
2.3.0 1
3.7 Introduced the $minimum_version parameter. 1
3.2 Changed from function wpseo_invalidate_sitemap_cache() to method in this class. 1
3.2 Changed from function wpseo_invalidate_sitemap_cache_on_save_post() to method in this class. 1
3.2 Moved from WPSEO_Utils to this class. 1
1.4.23 1
1.4.16 1
1.4.13 1
10.2 1
11.5 1
3.4 1
12.8 1
2.1 Introduced the `$attr` parameter. 1
3.6 2
2.0.0 2
3.3.0 2
5.3 2
17.8.0 2
5.1.0 2
7.0 2
12.0 3
3.0.0 3
3.1 3
1.5.4 4
1.5.0 5
12.1 11
1.8.0 16
2.0 18
3.2 25
@throws WPSEO_MyYoast_Bad_Request_Exception When request is invalid. 1
WPSEO_MyYoast_Invalid_JSON_Exception When decoded string is not a JSON object. 1
RuntimeException Throws an exception if the $wp_rewrite global is not set. 1
OutOfRangeException When there is less than 15 characters of space for a key that is originally longer. 1
InvalidArgumentException When the input is not an integer. 1
Exception If no migration name is provided. 1
ReflectionException When the class to generate the unit test for cannot be found. 1
RuntimeException When the required command line argument is missing. 1
ReflectionException If the class for which to generate a unit test does not exist. 1
RuntimeException If there is already a unit test. 1
ReflectionException If the reflection class couldn't be found. 1
Exception If compiling the container fails. 1
InvalidArgumentException If invalid arguments are supplied. 1
InvalidArgumentException If invalid arguments were supplied. 1
InvalidArgumentException Throws when no name or src has been provided. 1
Exception When `wp_remote_get` returned an error. 1
Exception When the response code is not 200. 1
InvalidArgumentException Thrown when not all required arguments are present. 1
InvalidArgumentException Thrown when a required argument is missing. 1
WPSEO_File_Size_Exception The file is hosted externally. 1
WPSEO_File_Size_Exception Retrieval of file size went wrong for unknown reasons. 1
Exception When ID of current model has a null value. 1
Exception When ID of current model has a null value. 1
Exception When ID has a null value. 1
Exception When the ID is a null value. 1
InvalidArgumentException Invalid instances to be inserted. 1
Exception If loading fails and YOAST_ENVIRONMENT is development. 1
Exception When the property doesn't exist. 1
Exception If something goes wrong generating the DI container. 1
Exception If a transaction was already started. 1
Exception If no transaction was strated. 1
Exception If no transaction was started. 1
Exception If invalid arguments provided. 1
Exception If invalid arguments are passed. 1
Exception If the table definition has not been intialized. 1
ServiceCircularReferenceException When a circular reference is detected. 1
ServiceNotFoundException When the service is not defined. 1
Throwable If the class does not exist in development environments. 1
Exception If the request fails. 1
Post_Not_Found_Exception When the post could not be found. 1
Post_Not_Built_Exception When the post should not be indexed. 1
Post_Type_Not_Built_Exception Throws exception if the post type is excluded. 1
Author_Not_Built_Exception When author is not built. 1
Invalid_Term_Exception When the term is invalid. 1
Term_Not_Built_Exception When the term is not viewable. 1
Term_Not_Found_Exception When the term is not found. 1
Empty_Property_Exception Throws when one of the required properties is empty. 1
Failed_Storage_Exception Exception thrown if storing of the token fails. 1
Failed_Storage_Exception Exception thrown if clearing of the token fails. 1
Exception Throws exception if an invalid value is passed to random_bytes. 1
InvalidArgumentException Throws exception if an invalid PCKE method is passed in the options. 1
Exception When something goes wrong with generating the PKCE code. 1
UnexpectedValueException Exception thrown if the provider response contains errors. 1
IdentityProviderException Exception thrown if there is no proper identity provider. 1
Repository_Not_Found_Exception When the given widget name is not implemented yet. 1
Exception If the ROUTE_PREFIX constant is not set in the child class. 1
Exception When the content type is invalid. 1
Exception When the taxonomy is invalid. 1
Exception When the term id is invalidated. 1
Exception When getting the organic sessions' data fails. 1
Exception When getting score results from the infrastructure fails. 1
Exception When getting the top pages' data fails. 1
Failed_Request_Exception When the request responds with an error from Site Kit. 1
Invalid_Request_Exception When the request is invalid due to unexpected parameters. 1
Failed_Request_Exception When the request responds with an error from Site Kit. 1
Exception If attempting to create a model presentation from another model presentation. 1
Exception If there is no generator for the property. 1
Addon_Already_Installed_Exception When the addon is already installed. 1
Addon_Installation_Error_Exception When the installation encounters an error. 1
User_Cannot_Install_Plugins_Exception When the user does not have the permissions to install plugins. 1
Addon_Activation_Error_Exception Exception when the activation encounters an error. 1
User_Cannot_Activate_Plugins_Exception Exception when the user is not allowed to activate. 1
Exception If the PLUGIN constant is not set in the child class. 1
Aioseo_Validation_Exception If the validation fails. 1
Exception If the SOURCE_OPTION_NAME constant is not set in the child class. 1
ExitException When the input args are invalid. 1
Exception If the migration fails and YOAST_ENVIRONMENT is not production. 1
Exception If the migration failed. Caught by the run_migrations function. 1
RuntimeException If reflection fails. 2
InvalidArgumentException Instance to be inserted is not a new one. 2
Exception If invalid arguments are supplied. 2
Exception If an invalid user ID is supplied to the wistia repository. 2
Exception If the TYPE constant is not set in the child class. 2
Exception If an invalid user ID is supplied. 2
Exception When a migration errored. 2
OutOfBoundsException When an invalid page is requested. 3
Unexpected_Response_Exception When the request responds with an unexpected format. 3
Invalid_User_Id_Exception If an invalid user ID is supplied. 3
Exception Primary key ID contains null value(s). 4
Exception Primary key ID missing from row or is null. 4
Empty_Property_Exception Exception thrown if a token property is empty. 4
Exception If the route prefix is not overwritten this throws. 4
Score_Results_Not_Found_Exception When the query of getting score results fails. 4
Forbidden_Property_Mutation_Exception Set is never meant to be called. 6
Forbidden_Property_Mutation_Exception Unset is never meant to be called. 6
IdentityProviderException Exception thrown if there's something wrong with the identifying data. 6
Empty_Token_Exception Exception thrown if the token is empty. 7
Authentication_Failed_Exception Exception thrown if authentication has failed. 9
@todo [JRF => testers] Double check that validation will not cause errors when called 1
This class could use a general description with some explanation on sitemaps. OR. 1
[JRF => Yoast] Verify that this logic for the prioritisation is correct. 1
Merge/DRY this with the logic virtually the same in WPSEO_Metabox::column_sort_orderby(). 1
Check: shouldn't this use $this->args as well ? 1
[JRF/whomever] Figure out a way to show settings error during/after the upgrade - maybe 1
[JRF] - shouldn't this be a straight array merge ? at the end of the day, the validation 1
[JRF => whomever] Create css/metabox-mp6.css file and add it to the below allowed colors array when done. 1
Should this function also allow for relative urls ? 1
Data format is not self-documenting. Needs explanation inline. R. 2
[JRF => testers] Check if the extra actions below would run into problems if an option 3
@type string $alt Image's alt text. 1
string $path Path of image. 1
int $width Width of image. 1
int $height Height of image. 1
string $type Image's MIME type. 1
string $size Image's size. 1
string $url Image's URL. 1
int $filesize The file size in bytes, if already set. 1
int $min_width Minimum width of image. 1
int $max_width Maximum width of image. 1
int $min_height Minimum height of image. 1
int $max_height Maximum height of image. 1
callable $sanitize_callback A callback function that sanitizes the network option's value. 1
mixed $default Default value when calling `get_network_option()`. 1
string $asset_file The asset file to load. 1
int $ext_length The length of the extension, including suffix, of the filename. 1
string $suffix Optional. The suffix of the asset name. 1
array $additional_deps Optional. The additional dependencies assets may have. 1
string $base_dir Optional. The base directory of the asset. 1
string[] $header_scripts Optional. The script names that should be in the header. 1
string $name Required. Feature toggle identifier. 1
string $setting Required. Name of the setting the feature toggle is associated with. 1
string $disabled Whether the feature is premium or not. 1
string $label Feature toggle label. 1
string $read_more_url URL to learn more about the feature. Default empty string. 1
string $premium_upsell_url URL to buy premium. Default empty string. 1
string $read_more_label Label for the learn more link. Default empty string. 1
string $extra Additional help content for the feature. Default empty string. 1
int $order Value to specify the feature toggle order. A lower value indicates 1
bool $disabled Disable the integration toggle. Default false. 1
string $new Whether the feature is new or not. 1
bool $in_beta Whether the feature is in beta or not. 1
array $supported_languages The languages that this feature supports. 1
string $premium_version The Premium version in which this feature was added. 1
string $title The title field id. 2
string $description The description field id. 2
string $page_type_recommended The page type for the context of the recommended replace vars. 2
string $page_type_specific The page type for the context of the editor specific replace vars. 2
bool $paper_style Optional. Whether the editor has paper style. 2
string $label_title Optional. The label to use for the title field. 2
string $label_description Optional. The label to use for the description field. 2
string $description_placeholder Optional. The placeholder text to use for the description field. 2
bool $has_new_badge Optional. Whether to show the "New" badge. 2
bool $has_premium_badge Optional. Whether to show the "Premium" badge. 2
string $name The name of the asset. 2
string $src The src of the asset. 2
string[] $deps The dependenies of the asset. 2
bool $in_footer Whether or not the asset should be in the footer. 2
string $0 Parent menu page slug. 2
string $1 Page title, currently unused. 2
string $2 Title to display in the menu. 2
string $3 Required capability to access the page. 2
string $4 Page slug. 2
callable $5 Callback to run when the page is rendered. 2
array $6 Optional. List of callbacks to run when the page is loaded. 2
@uses WPSEO_Option::import() 1
clean_option() method from concrete class if it exists. 1
WPSEO_Option::get_original_option() 2
@var bool|Indexable 1
WP_Rewrite 1
array Array format: (string) option_name => (string) name of concrete class for the option. 1
WPSEO_Options 1
array|null 1
WPSEO_Option 1
WPSEO_Sitemap_Provider[] 1
WPSEO_Sitemaps_Renderer 1
WPSEO_Sitemaps_Router 1
WPSEO_Sitemaps_Cache 1
ReflectionParameter 1
ReflectionParameterType 1
ReflectionMethod 1
WPSEO_Option|null 1
string|array 1
WPSEO_Admin_Asset 1
WPSEO_Collection[] 1
array> 1
WPSEO_Plugin_Availability 1
Yoast_Network_Settings_API 1
WP_Error|null 1
WPSEO_Gutenberg_Compatibility 1
Yoast_Notification[][] 1
Yoast_Plugin_Conflict 1
array The editor specific replacement variables. 1
WPSEO_Statistics_Service 1
WPSEO_File_Size_Service 1
WPSEO_Capability_Manager 1
WP_Term|stdClass 1
WPSEO_Metabox_Formatter_Interface 1
array { 1
Yoast_Form Yoast 1
WPSEO_Menu 1
WPSEO_Metabox_Editor 1
WPSEO_Metabox_Collapsible[] 1
array All of the option_names which need to be 1
array The option_names for the options we want to track. 1
WPSEO_Plugin_Importer 1
ORM 1
mixed[] 1
ContainerInterface|null 1
Column[] 1
ContainerInterface[] 1
Presentation_Memoizer 1
Blocks_Helper 1
Indexable_Presentation[] 1
Front_End_Conditional 1
User_Can_Manage_Wpseo_Options_Conditional 1
Post_Conditional 1
WP_Block_Parser_Block[] 1
Indexable_Post_Type_Archive_Builder 1
Indexable_Post_Builder 1
Indexable_System_Page_Builder 1
Indexable_Home_Page_Builder 1
Indexable_Author_Builder 1
Indexable_Date_Archive_Builder 1
Indexable_Term_Builder 1
Image_Content_Extractor 1
Wincher_PKCE_Provider|GenericProvider 1
OAuth_Token|null 1
WP_Remote_Handler 1
Dashboard_Configuration 1
WooCommerce_Conditional $woocommerce_conditional 1
Polylang_Conditional $polylang_conditional 1
WPML_Conditional $wpml_conditional 1
TranslatePress_Conditional $translate_press_conditional 1
Product_Helper $product_helper 1
Wistia_Embed_Permission_Repository $wistia_embed_permission_repository 1
Short_Link_Helper $shortlink_helper 1
Meta_Surface $meta 1
WP_Taxonomy|false 1
WP_Term|string|false 1
string $permalink 1
Meta_Helper $meta_helper 1
Date_Helper $date_helper 1
Integration_Data_Provider_Interface[] $plugin_integrations 1
Analysis_Features_List 1
Analysis_Feature_Interface[] 1
Term_Site_Information $term_site_information 1
Post_Site_Information $post_site_information 1
Abstract_Term_Seo_Data_Provider $seo_data_providers 1
WP_Term $term 1
Abstract_Post_Seo_Data_Provider $seo_data_providers 1
WP_Post $post 1
array 1
string $title_template_no_fallback 1
string $title_template 1
array $keyword_usage_per_type 1
array $keyword_usage_count 1
string $description_template 1
string $description_date 1
string $social_description_template 1
string $social_first_content_image 1
string $social_title_template 1
string $social_image_template 1
array All paths affected by this directive. 1
Indexable_Extension[] 1
Cleanup_Service $cleanup_service The cleanup service. 1
Cleanup_Repository $custom_meta_collector The custom meta repository. 1
array $additional_contactmethods 1
array $custom_meta 1
Badge_Group_Names 1
WP_Post The metabox post. 1
string|bool 1
Organic_Sessions_Repository $organic_sessions_repository 1
Top_Query_Repository $top_query_repository 1
Top_Page_Repository $top_page_repository 1
Abstract_Score_Results_Repository 1
Site_Kit_Analytics_4_Adapter $site_kit_analytics_4_adapter 1
SEO_Score_Groups_Interface[] 1
Indexable_Helper $indexable_helper 1
Endpoints_Repository 1
User_Helper $user_helper 1
Content_Types_Repository $content_types_repository 1
Nonce_Repository 1
Enabled_Analysis_Features_Repository 1
array 1
Current_Scores_Repository 1
Score_Results_Collector_Interface 1
Score_Groups_Interface[] 1
Score_Group_Link_Collector 1
Top_Page_Indexable_Collector $top_page_indexable_collector 1
Filter_Pairs_Interface[] 1
Filter_Pairs_Repository 1
array> $dimensions 1
array> $dimension_filters 1
array> $metrics 1
array>> $order_by 1
SEO_Score_Results_Collector $seo_score_results_collector 1
Readability_Score_Results_Collector $readability_score_results_collector 1
string[] $dimensions 1
SEO_Score_Groups_Repository $seo_score_groups_repository 1
Indexable_Repository $indexable_repository 1
Taxonomy_Validator 1
Traffic_Data $traffic_data 1
string $date 1
int|null $total_users 1
int|null $sessions 1
Traffic_Data $previous_traffic_data 1
Traffic_Data $current_traffic_data 1
Current_Score[] 1
Current_Scores_List 1
float 1
int $clicks 1
int $impressions 1
float $clicks 1
float $position 1
SEO_Score_Groups_Interface 1
string $edit_link 1
Search_Ranking_Data $search_ranking_data 1
array $endpoints 1
array 1
Taxonomy 1
array $data_container 1
string $start_date 1
string $compare_start_date 1
string $end_date 1
int $limit 1
string $compare_end_date 1
Schema_Types 1
Article_Helper 1
Breadcrumbs_Presenter 1
Feature_Flag_Conditional[] 1
First_Time_Configuration_Notice_Helper 1
Jetpack_Conditional 1
Site_Kit_Consent_Management_Endpoint 1
Elementor_Activated_Conditional 1
Yoast_Admin_And_Dashboard_Conditional 1
Get_Request_Conditional 1
Indexation_Action_Interface[] 1
WP_CRON_Enabled_Conditional 1
Health_Check[] 1
string|null 1
Addon_Install_Action 1
Addon_Activate_Action 1
Wincher_Enabled_Conditional 1
WPML_WPSEO_Conditional 1
Request_Post 1
Promotion_Manager 1
WP_Post|null 1
Robots_Txt_Presenter 1
Meta|false 1
Search_Engines_Discouraged_Presenter 1
Logger 1
Attachment_Cleanup_Helper 1
Indexable_Post_Watcher 1
Woocommerce_Beta_Editor_Presenter 1
WooCommerce_Conditional 1
Values_Helper 1
Breadcrumbs_Generator 1
Schema_Generator 1
Open_Graph_Locale_Generator 1
Twitter_Image_Generator 1
Open_Graph_Image_Generator 1
array 1
Time_Interval 1
Conflicting_Plugins_Service 1
Import_Cursor_Helper 1
Sanitization_Helper 1
Aioseo_Robots_Transformer_Service 1
Aioseo_Posts_Importing_Action 1
Import_Helper 1
Indexable_To_Postmeta_Helper 1
Aioseo_Social_Images_Provider_Service 1
Introductions_Seen_Repository 1
Introduction_Interface[] 1
Introduction_Item[] 1
Cleanup_Integration 1
WP_Rewrite_Wrapper 1
Schema_Helpers_Surface 1
Open_Graph_Helpers_Surface 1
Twitter_Helpers_Surface 1
array Key is the property name. 1
Replace_Vars_Helper 1
Alert_Dismissal_Action 1
SEMrush_Options_Action 1
SEMrush_Login_Action 1
SEMrush_Phrases_Action 1
Wincher_Login_Action 1
Integrations_Action 1
Indexing_Complete_Action 1
First_Time_Configuration_Action 1
Importing_Action_Interface[] 1
Wpdb_Helper 1
WP_Rewrite_Wrapper WP_Rewrite wrapper. 1
WP_Query_Wrapper WP_Query wrapper. 1
User_Agent_List 1
Main_Image_Helper 1
HTML_Helper 1
Default_Tagline_Reports 1
Default_Tagline_Runner 1
Postname_Permalink_Runner 1
Postname_Permalink_Reports 1
Runner_Interface 1
Report_Builder_Factory 1
Links_Table_Runner 1
Links_Table_Reports 1
Page_Comments_Reports 1
Page_Comments_Runner 1
Indexable_Builder_Versions The current versions of all indexable builders. 1
array|Importing_Action_Interface[] 1
Options_Helper The options helper. 1
array 1
array 1
array 1
Crawl_Cleanup_Helper 1
Loader 1
WPSEO_Breadcrumbs 1
WPSEO_Frontend 1
WP_Customize_Manager 1
WPSEO_Sitemap_Image_Parser 2
Yoast_Form 2
WPSEO_Admin_Asset_Location 2
WPSEO_Statistics 2
Admin_Columns_Cache_Integration 2
Meta_Tags_Context[] 2
array 2
WP_Term 2
LoggerInterface 2
ID_Helper 2
Indexable_Presentation 2
Indexable_Version_Manager 2
Primary_Term_Builder 2
array 2
Primary_Term_Helper 2
SEO_Links_Repository 2
Alert_Dismissal_Action $alert_dismissal_action 2
Promotion_Manager $promotion_manager 2
Wincher_Helper 2
Directive 2
Indexable[] 2
Additional_Contactmethods_Collector $additional_contactmethods_collector The additional contactmethods collector. 2
Custom_Meta_Collector $custom_meta_collector The custom meta collector. 2
Robots_Txt_Helper 2
Site_Kit_Consent_Repository_Interface 2
Permanently_Dismissed_Site_Kit_Configuration_Repository_Interface 2
Taxonomies_Repository 2
Content_Types_Collector 2
Site_Kit 2
Site_Kit_Search_Console_Adapter $site_kit_search_console_adapter 2
Taxonomies_Collector 2
Module 2
Indexable_Cleanup_Repository 2
Social_Profiles_Helper 2
Importing_Route 2
Environment_Helper 2
Wincher_Account_Action 2
Wincher_Keyphrases_Action 2
SEMrush_Client 2
Require_File_Helper 2
Aioseo_Replacevar_Service 2
Aioseo_Robots_Provider_Service 2
Introductions_Collector 2
Wistia_Embed_Permission_Repository 2
Indexable_Post_Indexation_Action 2
Indexable_Post_Type_Archive_Indexation_Action 2
Term_Link_Indexing_Action 2
Indexing_Prepare_Action 2
Indexable_Term_Indexation_Action 2
Indexable_General_Indexation_Action 2
Indexable_Head_Action 2
String_Helper 2
Indexation_Action_Interface[]|Limited_Indexing_Action_Interface[] 2
Base_Image_Helper 2
self|null 3
WPSEO_Import_Status 3
Permalink_Helper 3
Site_Helper 3
Indexable 3
Open_Graph_Image_Helper 3
Twitter_Image_Helper 3
Content_Type_Visibility_Dismiss_Notifications 3
Post_Link_Indexing_Action 3
Indexable_Indexing_Complete_Action 3
Importable_Detector_Service 3
Front_End_Integration 3
Capability_Helper 3
Meta_Surface 3
Robots_Helper 3
Aioseo_Helper 3
Wordproof_Helper 3
WPSEO_Shortlinker 4
Score_Icon_Helper 4
stdClass 4
WP_Post 4
WPSEO_Metabox_Analysis_Inclusive_Language 4
string[] The option_names for the options we want to track. 4
Adapter 4
Wincher_Client 4
Meta_Helper 4
Author_Archive_Helper 4
Indexable_Hierarchy_Builder 4
Indexable_Link_Builder 4
Indexable_Hierarchy_Repository 4
Primary_Term_Repository 4
Notification_Helper 4
Language_Helper 4
Options_Helper $options_helper 4
Woocommerce_Helper 4
Date_Helper 4
WP_Query_Wrapper 4
mixed 5
Meta_Tags_Context 5
Migration_Status 5
WPSEO_Metabox_Analysis_SEO 6
WPSEO_Metabox_Analysis_Readability 6
Pagination_Helper 6
array 7
Redirect_Helper 7
Helpers_Surface 8
Meta_Tags_Context_Memoizer 8
Indexable_Builder 9
ContainerInterface 10
WPSEO_Replace_Vars 10
User_Helper 10
Taxonomy_Helper 11
wpdb 11
Indexing_Helper 11
Post_Helper 12
WPSEO_Addon_Manager 12
Yoast_Notification_Center 13
Image_Helper 13
Url_Helper 13
Short_Link_Helper 13
Current_Page_Helper 16
Product_Helper 19
Post_Type_Helper 22
string[] 26
WPSEO_Admin_Asset_Manager 30
Indexable_Helper 30
Indexable_Repository 34
int 35
bool 68
Options_Helper 93
array 178
string 530
@when after_wp_load 2