| Property | Type | Description | |
|---|---|---|---|
| $analysis_readability | WPSEO_Metabox_Analysis_Readability | ||
| $analysis_seo | WPSEO_Metabox_Analysis_SEO | ||
| $social_admin | WPSEO_Social_Admin |
| Method | Description | |
|---|---|---|
| __construct ( ) | Class constructor | |
| aasort ( array &$array, string $key ) | ||
| add_custom_box ( ) | Adds the Yoast SEO box | |
| add_meta_box ( ) | Adds the Yoast SEO meta box to the edit boxes in the edit post, page, attachment, and custom post types pages. | |
| calculate_results ( object $post ) : array | WP_Error | ||
| check_double_focus_keyword ( array $job, array &$results ) | ||
| column_content ( string $column_name, integer $post_id ) | ||
| column_heading ( array $columns ) : array | ||
| column_hidden ( array | false $result, string $option, WP_User $user ) : array | false | ||
| column_sort ( array $columns ) : array | ||
| column_sort_orderby ( array $vars ) : array | ||
| do_meta_box ( array $meta_field_def, string $key = '' ) : string | Adds a line in the meta box | |
| do_tab ( string $id, string $heading, string $content ) | Output a tab in the Yoast SEO Metabox | |
| enqueue ( ) | Enqueues all the needed JS and CSS. | |
| get_anchor_count ( object &$xpath ) : array | ||
| get_anchor_texts ( object &$xpath ) : array | ||
| get_body ( object $post ) : string | ||
| get_first_paragraph ( string $body ) : string | ||
| get_headings ( string $postcontent ) : array | ||
| get_images_alt_text ( integer $post_id, string $body, array $imgs ) : array | ||
| get_meta_boxes ( string $post_type = 'post' ) : array | Retrieve the meta boxes for the given post type. | |
| get_metadesc_template ( object $post ) : string | ||
| get_post_date ( WP_Post $post ) : string | ||
| get_sample_permalink ( WP_Post $post ) : array | ||
| get_title_template ( object $post ) : string | ||
| is_meta_value_disabled ( string $key ) : boolean | Determines if the given meta value key is disabled | |
| is_metabox_hidden ( string $post_type = null ) : boolean | Test whether the metabox should be hidden either by choice of the admin or because the post type is not a public post type | |
| is_post_edit ( string $page ) : boolean | ||
| is_post_overview ( string $page ) : boolean | ||
| linkdex_output ( object $post ) : string | ||
| localize_media_script ( ) : array | Pass some variables to js for upload module. | |
| localize_post_scraper_script ( ) : array | Pass variables to js for use with the post-scraper | |
| localize_replace_vars_script ( ) | Pass some variables to js for replacing variables. | |
| localize_script ( ) : array | ||
| localize_shortcode_plugin_script ( ) : array | Pass some variables to js for the edit / post page overview, snippet preview, etc. | |
| meta_box ( ) | Output the meta box | |
| page_title ( integer $post_id ) : string | ||
| posts_filter_dropdown ( ) | ||
| publish_box ( ) | Outputs the page analysis score in the Publish Box. | |
| save_postdata ( integer $post_id ) : boolean | void | Save the WP SEO metadata for posts. | |
| save_score_result ( array &$results, integer $scoreValue, string $scoreMessage, string $scoreLabel, string $rawScore = null ) | ||
| score_anchor_texts ( array $job, array &$results, array $anchor_texts, array $count ) | ||
| score_body ( array $job, array &$results, string $body, string $firstp ) | ||
| score_description ( array $job, array &$results, string $description, integer $maxlength = 155 ) | ||
| score_headings ( array $job, array &$results, array $headings ) | ||
| score_images_alt_text ( array $job, array &$results, array $imgs ) | ||
| score_keyword ( string $keyword, array &$results ) | ||
| score_title ( array $job, array &$results ) | ||
| score_url ( array $job, array &$results ) | ||
| script ( ) | Pass some variables to js | |
| seo_score_posts_where ( string $where ) : string | ||
| setup_page_analysis ( ) | Sets up all the functionality related to the prominence of the page analysis functionality. | |
| snippet ( ) : string | ||
| strip_separators_and_fold ( string $inputString, boolean $removeOptionalCharacters ) : string | ||
| strtolower_utf8 ( string $string ) : string | ||
| template_generic_tab ( ) | Generic tab. | |
| template_keyword_tab ( ) | Keyword tab for enabling analysis of multiple keywords. | |
| traffic_light_svg ( ) | Return the SVG for the traffic light in the metabox. | |
| translate_meta_boxes ( ) | Translate text strings for use in the meta box | |
| wpseo_metabox_class ( array $classes ) : array | Adds CSS classes to the meta box. |
| Method | Description | |
|---|---|---|
| get_metabox_post ( ) | Returns post in metabox context |
| Method | Description | |
|---|---|---|
| create_content_box ( string $content, string $hidden_help_name, string $help_button, string $help_panel ) : string | Creates a sections specific row. | |
| determine_scope ( ) : string | Determines the scope based on the post type. | |
| get_addons_meta_section ( ) : WPSEO_Metabox_Section | Returns a metabox section dedicated to hosting metabox tabs that have been added by other plugins through the wpseo_tab_header and wpseo_tab_content actions. | |
| get_advanced_meta_section ( ) : WPSEO_Metabox_Section | Returns the metabox section for the advanced settings. | |
| get_buy_premium_link ( ) : string | Returns a link to activate the Buy Premium tab. | |
| get_buy_premium_section ( ) : WPSEO_Metabox_Section | Returns the metabox section for the Premium section. | |
| get_content_meta_section ( ) : WPSEO_Metabox_Section | Returns the metabox section for the content analysis. | |
| get_content_sections ( ) : WPSEO_Metabox_Section[] | Returns the relevant metabox sections for the current view. | |
| get_custom_fields_replace_vars ( WP_Post $post ) : array | Gets the custom replace variables for custom fields. | |
| get_custom_replace_vars ( WP_Post $post ) : array | Gets the custom replace variables for custom taxonomies and fields. | |
| get_custom_taxonomies_replace_vars ( WP_Post $post ) : array | Gets the custom replace variables for custom taxonomies. | |
| get_replace_vars ( ) : array | Prepares the replace vars for localization. | |
| get_tab_content ( string $tab_name ) : string | Gets the table contents for the metabox tab. | |
| get_valid_shortcode_tags ( ) : array | Returns an array with shortcode tags for all registered shortcodes. |
| public add_meta_box ( ) |
| public calculate_results ( object $post ) : array | WP_Error | ||
| $post | object | Post to calculate the results for. |
| return | array | WP_Error | |
| public check_double_focus_keyword ( array $job, array &$results ) | ||
| $job | array | Job data array. |
| $results | array | Results set by reference. |
| public column_content ( string $column_name, integer $post_id ) | ||
| $column_name | string | Column to display the content for. |
| $post_id | integer | Post to display the column content for. |
| public column_heading ( array $columns ) : array | ||
| $columns | array | Already existing columns. |
| return | array | |
| public column_sort ( array $columns ) : array | ||
| $columns | array | appended with their orderby variable. |
| return | array | |
| public column_sort_orderby ( array $vars ) : array | ||
| $vars | array | Query variables. |
| return | array | |
| public get_anchor_count ( object &$xpath ) : array | ||
| $xpath | object | An XPATH object of the current document. |
| return | array | |
| public get_anchor_texts ( object &$xpath ) : array | ||
| $xpath | object | An XPATH object of the current document. |
| return | array | |
| public get_first_paragraph ( string $body ) : string | ||
| $body | string | The post content to retrieve the first paragraph from. |
| return | string | |
| public get_headings ( string $postcontent ) : array | ||
| $postcontent | string | Post content to find headings in. |
| return | array | Array of heading texts. |
| public get_meta_boxes ( string $post_type = 'post' ) : array | ||
| $post_type | string | The post type for which to get the meta fields. |
| return | array | |
| public static get_metadesc_template ( object $post ) : string | ||
| $post | object | metabox post. |
| return | string | |
| public get_post_date ( WP_Post $post ) : string | ||
| $post | WP_Post | The post for which to retrieve the post date. |
| return | string | |
| public get_sample_permalink ( WP_Post $post ) : array | ||
| $post | WP_Post | Post object instance. |
| return | array | |
| public static get_title_template ( object $post ) : string | ||
| $post | object | metabox post. |
| return | string | |
| public is_meta_value_disabled ( string $key ) : boolean | ||
| $key | string | The key of the meta value. |
| return | boolean | Whether the given meta value key is disabled. |
| public static is_post_edit ( string $page ) : boolean | ||
| $page | string | The page to check for the post edit page. |
| return | boolean | Whether or not the given page is the post edit page. |
| public static is_post_overview ( string $page ) : boolean | ||
| $page | string | The page to check for the post overview page. |
| return | boolean | Whether or not the given page is the post overview page. |
| public linkdex_output ( object $post ) : string | ||
| $post | object | Post to output the page analysis results for. |
| return | string | |
| public localize_media_script ( ) : array | ||
| return | array | |
| public localize_post_scraper_script ( ) : array | ||
| return | array | |
| public localize_replace_vars_script ( ) |
| public localize_shortcode_plugin_script ( ) : array | ||
| return | array | |
| public page_title ( integer $post_id ) : string | ||
| $post_id | integer | Post to retrieve the title for. |
| return | string | |
| public publish_box ( ) |
| public save_score_result ( array &$results, integer $scoreValue, string $scoreMessage, string $scoreLabel, string $rawScore = null ) | ||
| $results | array | The results array used to store results. |
| $scoreValue | integer | The score value. |
| $scoreMessage | string | The score message. |
| $scoreLabel | string | The label of the score to use in the results array. |
| $rawScore | string | The raw score, to be used by other filters. |
| public score_anchor_texts ( array $job, array &$results, array $anchor_texts, array $count ) | ||
| $job | array | The job array holding both the keyword versions. |
| $results | array | The results array. |
| $anchor_texts | array | The array holding all anchors in the document. |
| $count | array | The number of anchors in the document, grouped by type. |
| public score_keyword ( string $keyword, array &$results ) | ||
| $keyword | string | The keyword to check for stopwords. |
| $results | array | The results array. |
| public score_title ( array $job, array &$results ) | ||
| $job | array | The job array holding both the keyword versions. |
| $results | array | The results array. |
| public seo_score_posts_where ( string $where ) : string | ||
| $where | string | Where clause. |
| return | string | |
| public setup_page_analysis ( ) |
| public strtolower_utf8 ( string $string ) : string | ||
| $string | string | Deprecated. |
| return | string | |
| public template_keyword_tab ( ) |
| public traffic_light_svg ( ) |
| public static translate_meta_boxes ( ) |
| public wpseo_metabox_class ( array $classes ) : array | ||
| $classes | array | An array of postbox CSS classes. |
| return | array | |
| protected WPSEO_Metabox_Analysis_Readability $analysis_readability | ||
| return | WPSEO_Metabox_Analysis_Readability | |
| protected WPSEO_Metabox_Analysis_SEO $analysis_seo | ||
| return | WPSEO_Metabox_Analysis_SEO | |