options = WPSEO_Options::get_options( array( 'wpseo', 'wpseo_social' ) );
// Check if one of the social settings is checked in the options, if so, initialize the social_admin object.
if ( $this->options['opengraph'] === true || $this->options['twitter'] === true ) {
$this->social_admin = new WPSEO_Social_Admin( $this->options );
}
$this->editor = new WPSEO_Metabox_Editor();
$this->editor->register_hooks();
$this->analysis_seo = new WPSEO_Metabox_Analysis_SEO();
$this->analysis_readability = new WPSEO_Metabox_Analysis_Readability();
}
/**
* Translate text strings for use in the meta box.
*
* IMPORTANT: if you want to add a new string (option) somewhere, make sure you add that array key to
* the main meta box definition array in the class WPSEO_Meta() as well!!!!
*/
public static function translate_meta_boxes() {
self::$meta_fields['general']['snippetpreview']['title'] = __( 'Snippet editor', 'wordpress-seo' );
/* translators: 1: link open tag; 2: link close tag. */
self::$meta_fields['general']['snippetpreview']['help'] = sprintf( __( 'This is a rendering of what this post might look like in Google\'s search results. %1$sLearn more about the Snippet Preview%2$s.', 'wordpress-seo' ), '', ' ' );
self::$meta_fields['general']['snippetpreview']['help-button'] = __( 'Show information about the snippet editor', 'wordpress-seo' );
self::$meta_fields['general']['pageanalysis']['title'] = __( 'Analysis', 'wordpress-seo' );
/* translators: 1: link open tag; 2: link close tag. */
self::$meta_fields['general']['pageanalysis']['help'] = sprintf( __( 'This is the content analysis, a collection of content checks that analyze the content of your page. %1$sLearn more about the Content Analysis Tool%2$s.', 'wordpress-seo' ), '', ' ' );
self::$meta_fields['general']['pageanalysis']['help-button'] = __( 'Show information about the content analysis', 'wordpress-seo' );
self::$meta_fields['general']['focuskw_text_input']['title'] = __( 'Focus keyword', 'wordpress-seo' );
self::$meta_fields['general']['focuskw_text_input']['label'] = __( 'Enter a focus keyword', 'wordpress-seo' );
/* translators: 1: link open tag; 2: link close tag. */
self::$meta_fields['general']['focuskw_text_input']['help'] = sprintf( __( 'Pick the main keyword or keyphrase that this post/page is about. %1$sLearn more about the Focus Keyword%2$s.', 'wordpress-seo' ), '', ' ' );
self::$meta_fields['general']['focuskw_text_input']['help-button'] = __( 'Show information about the focus keyword', 'wordpress-seo' );
self::$meta_fields['general']['title']['title'] = __( 'SEO title', 'wordpress-seo' );
self::$meta_fields['general']['metadesc']['title'] = __( 'Meta description', 'wordpress-seo' );
self::$meta_fields['general']['metakeywords']['title'] = __( 'Meta keywords', 'wordpress-seo' );
self::$meta_fields['general']['metakeywords']['label'] = __( 'Enter the meta keywords', 'wordpress-seo' );
/* translators: 1: link open tag; 2: link close tag. */
self::$meta_fields['general']['metakeywords']['description'] = __( 'If you type something above it will override your %1$smeta keywords template%2$s.', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-noindex']['title'] = __( 'Meta robots index', 'wordpress-seo' );
if ( '0' === (string) get_option( 'blog_public' ) ) {
self::$meta_fields['advanced']['meta-robots-noindex']['description'] = '' . __( 'Warning: even though you can set the meta robots setting here, the entire site is set to noindex in the sitewide privacy settings, so these settings won\'t have an effect.', 'wordpress-seo' ) . '
';
}
/* translators: %s expands to the robots (no)index setting default as set in the site-wide settings.*/
self::$meta_fields['advanced']['meta-robots-noindex']['options']['0'] = __( 'Default for this post type, currently: %s', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-noindex']['options']['2'] = 'index';
self::$meta_fields['advanced']['meta-robots-noindex']['options']['1'] = 'noindex';
self::$meta_fields['advanced']['meta-robots-nofollow']['title'] = __( 'Meta robots follow', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-nofollow']['options']['0'] = 'follow';
self::$meta_fields['advanced']['meta-robots-nofollow']['options']['1'] = 'nofollow';
self::$meta_fields['advanced']['meta-robots-adv']['title'] = __( 'Meta robots advanced', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-adv']['description'] = __( 'Advanced meta robots settings for this page.', 'wordpress-seo' );
/* translators: %s expands to the advanced robots settings default as set in the site-wide settings.*/
self::$meta_fields['advanced']['meta-robots-adv']['options']['-'] = __( 'Site-wide default: %s', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-adv']['options']['none'] = __( 'None', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-adv']['options']['noimageindex'] = __( 'No Image Index', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-adv']['options']['noarchive'] = __( 'No Archive', 'wordpress-seo' );
self::$meta_fields['advanced']['meta-robots-adv']['options']['nosnippet'] = __( 'No Snippet', 'wordpress-seo' );
self::$meta_fields['advanced']['bctitle']['title'] = __( 'Breadcrumbs Title', 'wordpress-seo' );
self::$meta_fields['advanced']['bctitle']['description'] = __( 'Title to use for this page in breadcrumb paths', 'wordpress-seo' );
self::$meta_fields['advanced']['canonical']['title'] = __( 'Canonical URL', 'wordpress-seo' );
/* translators: 1: link open tag; 2: link close tag. */
self::$meta_fields['advanced']['canonical']['description'] = sprintf( __( 'The canonical URL that this page should point to, leave empty to default to permalink. %1$sCross domain canonical%2$s supported too.', 'wordpress-seo' ), '', ' ' );
self::$meta_fields['advanced']['redirect']['title'] = __( '301 Redirect', 'wordpress-seo' );
self::$meta_fields['advanced']['redirect']['description'] = __( 'The URL that this page should redirect to.', 'wordpress-seo' );
do_action( 'wpseo_tab_translate' );
}
/**
* Test whether the metabox should be hidden either by choice of the admin or because
* the post type is not a public post type.
*
* @since 1.5.0
*
* @param string $post_type Optional. The post type to test, defaults to the current post post_type.
*
* @return bool Whether or not the meta box (and associated columns etc) should be hidden.
*/
public function is_metabox_hidden( $post_type = null ) {
if ( ! isset( $post_type ) && ( isset( $GLOBALS['post'] ) && ( is_object( $GLOBALS['post'] ) && isset( $GLOBALS['post']->post_type ) ) ) ) {
$post_type = $GLOBALS['post']->post_type;
}
if ( isset( $post_type ) ) {
// Don't make static as post_types may still be added during the run.
$post_types = WPSEO_Post_Type::get_accessible_post_types();
$options = get_option( 'wpseo_titles' );
return ( ( isset( $options[ 'hideeditbox-' . $post_type ] ) && $options[ 'hideeditbox-' . $post_type ] === true ) || in_array( $post_type, $post_types, true ) === false );
}
return false;
}
/**
* Sets up all the functionality related to the prominence of the page analysis functionality.
*/
public function setup_page_analysis() {
if ( apply_filters( 'wpseo_use_page_analysis', true ) === true ) {
add_action( 'post_submitbox_start', array( $this, 'publish_box' ) );
}
}
/**
* Outputs the page analysis score in the Publish Box.
*/
public function publish_box() {
if ( $this->is_metabox_hidden() === true ) {
return;
}
$post = $this->get_metabox_post();
if ( self::get_value( 'meta-robots-noindex', $post->ID ) === '1' ) {
$score_label = 'noindex';
$title = __( 'Post is set to noindex.', 'wordpress-seo' );
$score_title = $title;
}
else {
$score = self::get_value( 'linkdex', $post->ID );
if ( $score === '' ) {
$score_label = 'na';
$title = __( 'No focus keyword set.', 'wordpress-seo' );
}
else {
$score_label = WPSEO_Utils::translate_score( $score );
}
$score_title = WPSEO_Utils::translate_score( $score, false );
if ( ! isset( $title ) ) {
$title = $score_title;
}
}
}
/**
* Adds the Yoast SEO meta box to the edit boxes in the edit post, page,
* attachment, and custom post types pages.
*/
public function add_meta_box() {
$post_types = WPSEO_Post_Type::get_accessible_post_types();
if ( is_array( $post_types ) && $post_types !== array() ) {
foreach ( $post_types as $post_type ) {
if ( $this->is_metabox_hidden( $post_type ) === false ) {
$product_title = 'Yoast SEO';
if ( file_exists( WPSEO_PATH . 'premium/' ) ) {
$product_title .= ' Premium';
}
if ( null !== get_current_screen() ) {
$screen_id = get_current_screen()->id;
add_filter( "postbox_classes_{$screen_id}_wpseo_meta", array( $this, 'wpseo_metabox_class' ) );
}
add_meta_box( 'wpseo_meta', $product_title, array(
$this,
'meta_box',
), $post_type, 'normal', apply_filters( 'wpseo_metabox_prio', 'high' ) );
}
}
}
}
/**
* Adds CSS classes to the meta box.
*
* @param array $classes An array of postbox CSS classes.
*
* @return array
*/
public function wpseo_metabox_class( $classes ) {
$classes[] = 'yoast wpseo-metabox';
return $classes;
}
/**
* Pass variables to js for use with the post-scraper.
*
* @return array
*/
public function localize_post_scraper_script() {
$post = $this->get_metabox_post();
$permalink = '';
if ( is_object( $post ) ) {
$permalink = get_sample_permalink( $post->ID );
$permalink = $permalink[0];
}
$post_formatter = new WPSEO_Metabox_Formatter(
new WPSEO_Post_Metabox_Formatter( $post, WPSEO_Options::get_option( 'wpseo_titles' ), $permalink )
);
return $post_formatter->get_values();
}
/**
* Pass some variables to js for replacing variables.
*/
public function localize_replace_vars_script() {
return array(
'no_parent_text' => __( '(no parent)', 'wordpress-seo' ),
'replace_vars' => $this->get_replace_vars(),
'scope' => $this->determine_scope(),
);
}
/**
* Determines the scope based on the post type.
* This can be used by the replacevar plugin to determine if a replacement needs to be executed.
*
* @return string String decribing the current scope.
*/
private function determine_scope() {
$post_type = get_post_type( $this->get_metabox_post() );
if ( $post_type === 'page' ) {
return 'page';
}
return 'post';
}
/**
* Pass some variables to js for the edit / post page overview, snippet preview, etc.
*
* @return array
*/
public function localize_shortcode_plugin_script() {
return array(
'wpseo_filter_shortcodes_nonce' => wp_create_nonce( 'wpseo-filter-shortcodes' ),
'wpseo_shortcode_tags' => $this->get_valid_shortcode_tags(),
);
}
/**
* Output a tab in the Yoast SEO Metabox.
*
* @param string $id CSS ID of the tab.
* @param string $heading Heading for the tab.
* @param string $content Content of the tab. This content should be escaped.
*/
public function do_tab( $id, $heading, $content ) {
?>
get_content_sections();
$helpcenter_tab = new WPSEO_Option_Tab( 'metabox', __( 'Meta box', 'wordpress-seo' ),
array( 'video_url' => WPSEO_Shortlinker::get( 'https://yoa.st/metabox-screencast' ) ) );
$help_center = new WPSEO_Help_Center( '', $helpcenter_tab, WPSEO_Utils::is_yoast_seo_premium() );
$help_center->localize_data();
$help_center->mount();
if ( ! defined( 'WPSEO_PREMIUM_FILE' ) ) {
echo $this->get_buy_premium_link();
}
echo '';
echo '';
foreach ( $content_sections as $content_section ) {
$content_section->display_content();
}
echo '
';
}
/**
* Returns the relevant metabox sections for the current view.
*
* @return WPSEO_Metabox_Section[]
*/
private function get_content_sections() {
$content_sections = array( $this->get_content_meta_section() );
// Check if social_admin is an instance of WPSEO_Social_Admin.
if ( $this->social_admin instanceof WPSEO_Social_Admin ) {
$content_sections[] = $this->social_admin->get_meta_section();
}
if ( WPSEO_Capability_Utils::current_user_can( 'wpseo_edit_advanced_metadata' ) || $this->options['disableadvanced_meta'] === false ) {
$content_sections[] = $this->get_advanced_meta_section();
}
if ( ! defined( 'WPSEO_PREMIUM_FILE' ) ) {
$content_sections[] = $this->get_buy_premium_section();
}
if ( has_action( 'wpseo_tab_header' ) || has_action( 'wpseo_tab_content' ) ) {
$content_sections[] = $this->get_addons_meta_section();
}
return $content_sections;
}
/**
* Returns the metabox section for the content analysis.
*
* @return WPSEO_Metabox_Section
*/
private function get_content_meta_section() {
$content = $this->get_tab_content( 'general' );
$tabs = array();
$tabs[] = new WPSEO_Metabox_Form_Tab(
'content',
$content,
'',
array(
'tab_class' => 'yoast-seo__remove-tab',
)
);
$tabs[] = new WPSEO_Metabox_Add_Keyword_Tab();
return new WPSEO_Metabox_Tab_Section(
'content',
'' . __( 'Content optimization', 'wordpress-seo' ) . ' ' . $this->traffic_light_svg() . ' ',
$tabs,
array(
'link_aria_label' => __( 'Content optimization', 'wordpress-seo' ),
'link_class' => 'yoast-tooltip yoast-tooltip-e',
)
);
}
/**
* Returns the metabox section for the advanced settings.
*
* @return WPSEO_Metabox_Section
*/
private function get_advanced_meta_section() {
$content = $this->get_tab_content( 'advanced' );
$tab = new WPSEO_Metabox_Form_Tab(
'advanced',
$content,
__( 'Advanced', 'wordpress-seo' ),
array(
'single' => true,
)
);
return new WPSEO_Metabox_Tab_Section(
'advanced',
'' . __( 'Advanced', 'wordpress-seo' ) . '
%s
%s - %s
%s - %s
%s - %s
%s - %s
%s
' . __( 'Add-ons', 'wordpress-seo' ) . ' ' . $meta_field_def['description'] . '
';
}
switch ( $meta_field_def['type'] ) {
case 'pageanalysis':
$content_analysis_active = $this->options['content_analysis_active'];
$keyword_analysis_active = $this->options['keyword_analysis_active'];
if ( $content_analysis_active === false && $keyword_analysis_active === false ) {
break;
}
$content .= '';
$content .= '
';
$content .= '' . __( 'Analysis', 'wordpress-seo' ) . ' ';
$content .= '
';
$content .= '
';
$content .= ' ';
$content .= '
';
break;
case 'focuskeyword':
if ( $placeholder !== '' ) {
$placeholder = ' placeholder="' . esc_attr( $placeholder ) . '"';
}
$content .= '';
$content .= '';
$content .= '
';
break;
case 'metakeywords':
$content .= '';
$content .= '';
$content .= '
';
break;
case 'text':
$ac = '';
if ( isset( $meta_field_def['autocomplete'] ) && $meta_field_def['autocomplete'] === false ) {
$ac = 'autocomplete="off" ';
}
if ( $placeholder !== '' ) {
$placeholder = ' placeholder="' . esc_attr( $placeholder ) . '"';
}
$content .= '';
foreach ( $meta_field_def['options'] as $val => $option ) {
$selected = selected( $meta_value, $val, false );
$content .= '' . esc_html( $option ) . ' ';
}
unset( $val, $option, $selected );
$content .= ' ';
}
break;
case 'multiselect':
if ( isset( $meta_field_def['options'] ) && is_array( $meta_field_def['options'] ) && $meta_field_def['options'] !== array() ) {
// Set $meta_value as $selected_arr.
$selected_arr = $meta_value;
// If the multiselect field is 'meta-robots-adv' we should explode on ,.
if ( 'meta-robots-adv' === $key ) {
$selected_arr = explode( ',', $meta_value );
}
if ( ! is_array( $selected_arr ) ) {
$selected_arr = (array) $selected_arr;
}
$options_count = count( $meta_field_def['options'] );
// This select now uses Select2.
$content .= '';
foreach ( $meta_field_def['options'] as $val => $option ) {
$selected = '';
if ( in_array( $val, $selected_arr ) ) {
$selected = ' selected="selected"';
}
$content .= '' . esc_html( $option ) . ' ';
}
$content .= ' ';
unset( $val, $option, $selected, $selected_arr, $options_count );
}
break;
case 'checkbox':
$checked = checked( $meta_value, 'on', false );
$expl = ( isset( $meta_field_def['expl'] ) ) ? esc_html( $meta_field_def['expl'] ) : '';
$content .= '' . $expl . ' ';
unset( $checked, $expl );
break;
case 'radio':
if ( isset( $meta_field_def['options'] ) && is_array( $meta_field_def['options'] ) && $meta_field_def['options'] !== array() ) {
foreach ( $meta_field_def['options'] as $val => $option ) {
$checked = checked( $meta_value, $val, false );
$content .= '' . esc_html( $option ) . ' ';
}
unset( $val, $option, $checked );
}
break;
case 'upload':
$content .= '' . $title . ' ';
// Set the inline help and help panel, if any.
$help_button = '';
$help_panel = '';
if ( isset( $meta_field_def['help'] ) && $meta_field_def['help'] !== '' ) {
$help = new WPSEO_Admin_Help_Panel( $key, $meta_field_def['help-button'], $meta_field_def['help'] );
$help_button = $help->get_button_html();
$help_panel = $help->get_panel_html();
}
// If it's a set of radio buttons, output proper fieldset and legend.
if ( 'radio' === $meta_field_def['type'] ) {
return '' . $title . ' ' . $help_button . $help_panel . $content . $description . '' . $help_button . $help_panel . '
';
return $html;
}
/**
* Save the WP SEO metadata for posts.
*
* {@internal $_POST parameters are validated via sanitize_post_meta().}}
*
* @param int $post_id Post ID.
*
* @return bool|void Boolean false if invalid save post request.
*/
public function save_postdata( $post_id ) {
// Bail if this is a multisite installation and the site has been switched.
if ( is_multisite() && ms_is_switched() ) {
return false;
}
if ( $post_id === null ) {
return false;
}
if ( wp_is_post_revision( $post_id ) ) {
$post_id = wp_is_post_revision( $post_id );
}
/**
* Determine we're not accidentally updating a different post.
* We can't use filter_input here as the ID isn't available at this point, other than in the $_POST data.
*/
// @codingStandardsIgnoreStart
if ( ! isset( $_POST['ID'] ) || $post_id !== (int) $_POST['ID'] ) {
return false;
}
// @codingStandardsIgnoreEnd
clean_post_cache( $post_id );
$post = get_post( $post_id );
if ( ! is_object( $post ) ) {
// Non-existent post.
return false;
}
do_action( 'wpseo_save_compare_data', $post );
$meta_boxes = apply_filters( 'wpseo_save_metaboxes', array() );
$meta_boxes = array_merge( $meta_boxes, $this->get_meta_field_defs( 'general', $post->post_type ), $this->get_meta_field_defs( 'advanced' ) );
foreach ( $meta_boxes as $key => $meta_box ) {
// If analysis is disabled remove that analysis score value from the DB.
if ( $this->is_meta_value_disabled( $key ) ) {
self::delete( $key, $post_id );
continue;
}
$data = null;
if ( 'checkbox' === $meta_box['type'] ) {
// @codingStandardsIgnoreLine
$data = isset( $_POST[ self::$form_prefix . $key ] ) ? 'on' : 'off';
}
else {
// @codingStandardsIgnoreLine
if ( isset( $_POST[ self::$form_prefix . $key ] ) ) {
// @codingStandardsIgnoreLine
$data = $_POST[ self::$form_prefix . $key ];
}
}
if ( isset( $data ) ) {
self::set_value( $key, $data, $post_id );
}
}
do_action( 'wpseo_saved_postdata' );
}
/**
* Determines if the given meta value key is disabled.
*
* @param string $key The key of the meta value.
* @return bool Whether the given meta value key is disabled.
*/
public function is_meta_value_disabled( $key ) {
if ( 'linkdex' === $key && ! $this->analysis_seo->is_enabled() ) {
return true;
}
if ( 'content_score' === $key && ! $this->analysis_readability->is_enabled() ) {
return true;
}
return false;
}
/**
* Enqueues all the needed JS and CSS.
*
* @todo [JRF => whomever] Create css/metabox-mp6.css file and add it to the below allowed colors array when done.
*/
public function enqueue() {
global $pagenow;
$asset_manager = new WPSEO_Admin_Asset_Manager();
$is_editor = self::is_post_overview( $pagenow ) || self::is_post_edit( $pagenow );
/* Filter 'wpseo_always_register_metaboxes_on_admin' documented in wpseo-main.php */
if ( ( ! $is_editor && apply_filters( 'wpseo_always_register_metaboxes_on_admin', false ) === false ) || $this->is_metabox_hidden() === true
) {
return;
}
if ( self::is_post_overview( $pagenow ) ) {
$asset_manager->enqueue_style( 'edit-page' );
$asset_manager->enqueue_script( 'edit-page-script' );
}
else {
if ( 0 !== get_queried_object_id() ) {
wp_enqueue_media( array( 'post' => get_queried_object_id() ) ); // Enqueue files needed for upload functionality.
}
$asset_manager->enqueue_style( 'metabox-css' );
$asset_manager->enqueue_style( 'scoring' );
$asset_manager->enqueue_style( 'snippet' );
$asset_manager->enqueue_style( 'select2' );
$asset_manager->enqueue_script( 'metabox' );
$asset_manager->enqueue_script( 'help-center' );
$asset_manager->enqueue_script( 'admin-media' );
$asset_manager->enqueue_script( 'post-scraper' );
$asset_manager->enqueue_script( 'replacevar-plugin' );
$asset_manager->enqueue_script( 'shortcode-plugin' );
wp_enqueue_script( 'jquery-ui-autocomplete' );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'admin-media', 'wpseoMediaL10n', $this->localize_media_script() );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'post-scraper', 'wpseoPostScraperL10n', $this->localize_post_scraper_script() );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'replacevar-plugin', 'wpseoReplaceVarsL10n', $this->localize_replace_vars_script() );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'shortcode-plugin', 'wpseoShortcodePluginL10n', $this->localize_shortcode_plugin_script() );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'metabox', 'wpseoAdminL10n', WPSEO_Help_Center::get_translated_texts() );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'metabox', 'wpseoSelect2Locale', WPSEO_Utils::get_language( WPSEO_Utils::get_user_locale() ) );
if ( post_type_supports( get_post_type(), 'thumbnail' ) ) {
$asset_manager->enqueue_style( 'featured-image' );
$asset_manager->enqueue_script( 'featured-image' );
$featured_image_l10 = array( 'featured_image_notice' => __( 'SEO issue: The featured image should be at least 200 by 200 pixels to be picked up by Facebook and other social media sites.', 'wordpress-seo' ) );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'metabox', 'wpseoFeaturedImageL10n', $featured_image_l10 );
}
}
}
/**
* Pass some variables to js for upload module.
*
* @return array
*/
public function localize_media_script() {
return array(
'choose_image' => __( 'Use Image', 'wordpress-seo' ),
);
}
/**
* Returns post in metabox context.
*
* @returns WP_Post|array
*/
protected function get_metabox_post() {
$post = filter_input( INPUT_GET, 'post' );
if ( ! empty( $post ) ) {
$post_id = (int) WPSEO_Utils::validate_int( $post );
return get_post( $post_id );
}
if ( isset( $GLOBALS['post'] ) ) {
return $GLOBALS['post'];
}
return array();
}
/**
* Returns an array with shortcode tags for all registered shortcodes.
*
* @return array
*/
private function get_valid_shortcode_tags() {
$shortcode_tags = array();
foreach ( $GLOBALS['shortcode_tags'] as $tag => $description ) {
array_push( $shortcode_tags, $tag );
}
return $shortcode_tags;
}
/**
* Prepares the replace vars for localization.
*
* @return array replace vars
*/
private function get_replace_vars() {
$post = $this->get_metabox_post();
$cached_replacement_vars = array();
$vars_to_cache = array(
'date',
'id',
'sitename',
'sitedesc',
'sep',
'page',
'currenttime',
'currentdate',
'currentday',
'currentmonth',
'currentyear',
);
foreach ( $vars_to_cache as $var ) {
$cached_replacement_vars[ $var ] = wpseo_replace_vars( '%%' . $var . '%%', $post );
}
// Merge custom replace variables with the WordPress ones.
return array_merge( $cached_replacement_vars, $this->get_custom_replace_vars( $post ) );
}
/**
* Gets the custom replace variables for custom taxonomies and fields.
*
* @param WP_Post $post The post to check for custom taxonomies and fields.
*
* @return array Array containing all the replacement variables.
*/
private function get_custom_replace_vars( $post ) {
return array(
'custom_fields' => $this->get_custom_fields_replace_vars( $post ),
'custom_taxonomies' => $this->get_custom_taxonomies_replace_vars( $post ),
);
}
/**
* Gets the custom replace variables for custom taxonomies.
*
* @param WP_Post $post The post to check for custom taxonomies.
*
* @return array Array containing all the replacement variables.
*/
private function get_custom_taxonomies_replace_vars( $post ) {
$taxonomies = get_object_taxonomies( $post, 'objects' );
$custom_replace_vars = array();
foreach ( $taxonomies as $taxonomy_name => $taxonomy ) {
if ( is_string( $taxonomy ) ) { // If attachment, see https://core.trac.wordpress.org/ticket/37368 .
$taxonomy_name = $taxonomy;
$taxonomy = get_taxonomy( $taxonomy_name );
}
if ( $taxonomy->_builtin && $taxonomy->public ) {
continue;
}
$custom_replace_vars[ $taxonomy_name ] = array(
'name' => $taxonomy->name,
'description' => $taxonomy->description,
);
}
return $custom_replace_vars;
}
/**
* Gets the custom replace variables for custom fields.
*
* @param WP_Post $post The post to check for custom fields.
*
* @return array Array containing all the replacement variables.
*/
private function get_custom_fields_replace_vars( $post ) {
$custom_replace_vars = array();
// If no post object is passed, return the empty custom_replace_vars array.
if ( ! is_object( $post ) ) {
return $custom_replace_vars;
}
$custom_fields = get_post_custom( $post->ID );
foreach ( $custom_fields as $custom_field_name => $custom_field ) {
if ( substr( $custom_field_name, 0, 1 ) === '_' ) {
continue;
}
$custom_replace_vars[ $custom_field_name ] = $custom_field[0];
}
return $custom_replace_vars;
}
/**
* Return the SVG for the traffic light in the metabox.
*/
public function traffic_light_svg() {
return <<
SVG;
}
/**
* Generic tab.
*/
public function template_generic_tab() {
// This template belongs to the post scraper so don't echo it if it isn't enqueued.
if ( ! wp_script_is( WPSEO_Admin_Asset_Manager::PREFIX . 'post-scraper' ) ) {
return;
}
echo '';
}
/**
* Keyword tab for enabling analysis of multiple keywords.
*/
public function template_keyword_tab() {
// This template belongs to the post scraper so don't echo it if it isn't enqueued.
if ( ! wp_script_is( WPSEO_Admin_Asset_Manager::PREFIX . 'post-scraper' ) ) {
return;
}
echo '';
}
/**
* @param string $page The page to check for the post overview page.
*
* @return bool Whether or not the given page is the post overview page.
*/
public static function is_post_overview( $page ) {
return 'edit.php' === $page;
}
/**
* @param string $page The page to check for the post edit page.
*
* @return bool Whether or not the given page is the post edit page.
*/
public static function is_post_edit( $page ) {
return 'post.php' === $page
|| 'post-new.php' === $page;
}
/********************** DEPRECATED METHODS **********************/
// @codeCoverageIgnoreStart
/**
* Adds the Yoast SEO box.
*
* @deprecated 1.4.24
* @deprecated use WPSEO_Metabox::add_meta_box()
* @see WPSEO_Meta::add_meta_box()
*/
public function add_custom_box() {
_deprecated_function( __METHOD__, 'WPSEO 1.4.24', 'WPSEO_Metabox::add_meta_box()' );
$this->add_meta_box();
}
/**
* Retrieve the meta boxes for the given post type.
*
* @deprecated 1.5.0
* @deprecated use WPSEO_Meta::get_meta_field_defs()
* @see WPSEO_Meta::get_meta_field_defs()
*
* @param string $post_type The post type for which to get the meta fields.
*
* @return array
*/
public function get_meta_boxes( $post_type = 'post' ) {
_deprecated_function( __METHOD__, 'WPSEO 1.5.0', 'WPSEO_Meta::get_meta_field_defs()' );
return $this->get_meta_field_defs( 'general', $post_type );
}
/**
* Pass some variables to js.
*
* @deprecated 1.5.0
* @deprecated use WPSEO_Meta::localize_script()
* @see WPSEO_Meta::localize_script()
*/
public function script() {
_deprecated_function( __METHOD__, 'WPSEO 1.5.0', 'WPSEO_Meta::localize_script()' );
return $this->localize_script();
}
/**
* @deprecated 3.0 Removed, use javascript functions instead.
*
* @param string $string Deprecated.
*
* @return string
*/
public function strtolower_utf8( $string ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', esc_html__( 'Use javascript instead.', 'wordpress-seo' ) );
return $string;
}
/**
* @deprecated 3.0 Removed.
*
* @return array
*/
public function localize_script() {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0 Removed, use javascript functions instead.
*
* @return string
*/
public function snippet() {
_deprecated_function( __METHOD__, 'WPSEO 3.0', esc_html__( 'Use javascript instead.', 'wordpress-seo' ) );
return '';
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::posts_filter_dropdown instead.
*/
public function posts_filter_dropdown() {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::posts_filter_dropdown' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
$meta_columns->posts_filter_dropdown();
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::column_heading instead.
*
* @param array $columns Already existing columns.
*
* @return array
*/
public function column_heading( $columns ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::column_heading' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
return $meta_columns->column_heading( $columns );
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::column_content instead.
*
* @param string $column_name Column to display the content for.
* @param int $post_id Post to display the column content for.
*/
public function column_content( $column_name, $post_id ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::column_content' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
$meta_columns->column_content( $column_name, $post_id );
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::column_sort instead.
*
* @param array $columns Columns appended with their orderby variable.
*
* @return array
*/
public function column_sort( $columns ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::column_sort' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
return $meta_columns->column_sort( $columns );
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::column_sort_orderby instead.
*
* @param array $vars Query variables.
*
* @return array
*/
public function column_sort_orderby( $vars ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::column_sort_orderby' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
return $meta_columns->column_sort_orderby( $vars );
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::column_hidden instead.
*
* @param array|false $result The hidden columns.
* @param string $option The option name used to set which columns should be hidden.
* @param WP_User $user The User.
*
* @return array|false $result
*/
public function column_hidden( $result, $option, $user ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::column_hidden' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
return $meta_columns->column_hidden( $result, $option, $user );
}
/**
* @deprecated 3.0 Use WPSEO_Meta_Columns::seo_score_posts_where instead.
*
* @param string $where Where clause.
*
* @return string
*/
public function seo_score_posts_where( $where ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0', 'WPSEO_Metabox_Columns::seo_score_posts_where' );
/** @var WPSEO_Meta_Columns $meta_columns */
$meta_columns = $GLOBALS['wpseo_meta_columns'];
return $meta_columns->seo_score_posts_where( $where );
}
/**
* @deprecated 3.0 Removed.
*
* @param int $post_id Post to retrieve the title for.
*
* @return string
*/
public function page_title( $post_id ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return '';
}
/**
* @deprecated 3.0
*
* @param array $array Array to sort, array is returned sorted.
* @param string $key Key to sort array by.
*/
public function aasort( &$array, $key ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param object $post Post to output the page analysis results for.
*
* @return string
*/
public function linkdex_output( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return '';
}
/**
* @deprecated 3.0
*
* @param object $post Post to calculate the results for.
*
* @return array|WP_Error
*/
public function calculate_results( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0
*
* @param WP_Post $post Post object instance.
*
* @return array
*/
public function get_sample_permalink( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0
*
* @param array $results The results array used to store results.
* @param int $score_value The score value.
* @param string $score_message The score message.
* @param string $score_label The label of the score to use in the results array.
* @param string $raw_score The raw score, to be used by other filters.
*/
public function save_score_result( &$results, $score_value, $score_message, $score_label, $raw_score = null ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param string $input_string String to clean up.
* @param bool $remove_optional_characters Whether or not to do a cleanup of optional chars too.
*
* @return string
*/
public function strip_separators_and_fold( $input_string, $remove_optional_characters ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return '';
}
/**
* @deprecated 3.0
*
* @param array $job Job data array.
* @param array $results Results set by reference.
*/
public function check_double_focus_keyword( $job, &$results ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param string $keyword The keyword to check for stopwords.
* @param array $results The results array.
*/
public function score_keyword( $keyword, &$results ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param array $job The job array holding both the keyword and the URLs.
* @param array $results The results array.
*/
public function score_url( $job, &$results ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param array $job The job array holding both the keyword versions.
* @param array $results The results array.
*/
public function score_title( $job, &$results ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param array $job The job array holding both the keyword versions.
* @param array $results The results array.
* @param array $anchor_texts The array holding all anchors in the document.
* @param array $count The number of anchors in the document, grouped by type.
*/
public function score_anchor_texts( $job, &$results, $anchor_texts, $count ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param object $xpath An XPATH object of the current document.
*
* @return array
*/
public function get_anchor_texts( &$xpath ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0
*
* @param object $xpath An XPATH object of the current document.
*
* @return array
*/
public function get_anchor_count( &$xpath ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0
*
* @param array $job The job array holding both the keyword versions.
* @param array $results The results array.
* @param array $imgs The array with images alt texts.
*/
public function score_images_alt_text( $job, &$results, $imgs ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param int $post_id The post to find images in.
* @param string $body The post content to find images in.
* @param array $imgs The array holding the image information.
*
* @return array The updated images array.
*/
public function get_images_alt_text( $post_id, $body, $imgs ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0
*
* @param array $job The array holding the keywords.
* @param array $results The results array.
* @param array $headings The headings found in the document.
*/
public function score_headings( $job, &$results, $headings ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param string $postcontent Post content to find headings in.
*
* @return array Array of heading texts.
*/
public function get_headings( $postcontent ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return array();
}
/**
* @deprecated 3.0
*
* @param array $job The array holding the keywords.
* @param array $results The results array.
* @param string $description The meta description.
* @param int $maxlength The maximum length of the meta description.
*/
public function score_description( $job, &$results, $description, $maxlength = 155 ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param array $job The array holding the keywords.
* @param array $results The results array.
* @param string $body The body.
* @param string $firstp The first paragraph.
*/
public function score_body( $job, &$results, $body, $firstp ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
}
/**
* @deprecated 3.0
*
* @param object $post The post object.
*
* @return string The post content.
*/
public function get_body( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return '';
}
/**
* @deprecated 3.0
*
* @param string $body The post content to retrieve the first paragraph from.
*
* @return string
*/
public function get_first_paragraph( $body ) {
_deprecated_function( __METHOD__, 'WPSEO 3.0' );
return '';
}
/**
* @deprecated 3.2
*
* Retrieves the title template.
*
* @param object $post Metabox post.
*
* @return string
*/
public static function get_title_template( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.2', 'WPSEO_Post_Scraper::get_title_template' );
return '';
}
/**
* @deprecated 3.2
*
* Retrieves the metadesc template.
*
* @param object $post Metabox post.
*
* @return string
*/
public static function get_metadesc_template( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.2', 'WPSEO_Post_Scraper::get_metadesc_template' );
return '';
}
/**
* @deprecated 3.2
* Retrieve a post date when post is published, or return current date when it's not.
*
* @param WP_Post $post The post for which to retrieve the post date.
*
* @return string
*/
public function get_post_date( $post ) {
_deprecated_function( __METHOD__, 'WPSEO 3.2', 'WPSEO_Post_Scraper::get_post_date' );
return '';
}
// @codeCoverageIgnoreEnd
}