iotcat
/
Ushio-cn-old
mirror of https://github.com/IoTcat/Ushio-cn-old.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
175 Commits
7 Branches
0 Tags
240 MiB
Tag: Branch: Tree: 5f9d94edf4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5f9d94edf4'
${ noResults }
Ushio-cn-old/yimian/www/blog-wp/wp-content/plugins/wordpress-seo/admin/metabox/class-metabox.php

1130 lines
38 KiB
Raw Blame History

<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Admin
*/
/**
* This class generates the metabox on the edit post / page as well as contains all page analysis functionality.
*/
class WPSEO_Metabox extends WPSEO_Meta {
/**
* An instance of the Social Admin class.
*
* @var WPSEO_Social_Admin
*/
protected $social_admin;
/**
* An instance of the Metabox Analysis SEO class.
*
* @var WPSEO_Metabox_Analysis_SEO
*/
protected $analysis_seo;
/**
* An instance of the Metabox Analysis Readability class.
*
* @var WPSEO_Metabox_Analysis_Readability
*/
protected $analysis_readability;
/**
* The metabox editor object.
*
* @var WPSEO_Metabox_Editor
*/
protected $editor;
/**
* Class constructor.
*/
public function __construct() {
if ( $this->is_internet_explorer() ) {
add_action( 'add_meta_boxes', array( $this, 'internet_explorer_metabox' ) );
return;
}
add_action( 'add_meta_boxes', array( $this, 'add_meta_box' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue' ) );
add_action( 'wp_insert_post', array( $this, 'save_postdata' ) );
add_action( 'edit_attachment', array( $this, 'save_postdata' ) );
add_action( 'add_attachment', array( $this, 'save_postdata' ) );
add_action( 'admin_init', array( $this, 'translate_meta_boxes' ) );
// Check if one of the social settings is checked in the options, if so, initialize the social_admin object.
if ( WPSEO_Options::get( 'opengraph', false ) || WPSEO_Options::get( 'twitter', false ) ) {
$this->social_admin = new WPSEO_Social_Admin();
}
$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();
}
/**
* Checks whether the request comes from an IE 11 browser.
*
* @return bool Whether the request comes from an IE 11 browser.
*/
public static function is_internet_explorer() {
$user_agent = $_SERVER['HTTP_USER_AGENT'];
if ( ! stripos( $user_agent, 'Trident/7.0' ) ) {
return false;
}
return true;
}
/**
* Adds an alternative metabox for internet explorer users.
*/
public function internet_explorer_metabox() {
$post_types = WPSEO_Post_Type::get_accessible_post_types();
$post_types = array_filter( $post_types, array( $this, 'display_metabox' ) );
if ( ! is_array( $post_types ) || $post_types === array() ) {
return;
}
$product_title = $this->get_product_title();
foreach ( $post_types as $post_type ) {
add_filter( "postbox_classes_{$post_type}_wpseo_meta", array( $this, 'wpseo_metabox_class' ) );
add_meta_box(
'wpseo_meta',
$product_title,
array( $this, 'render_internet_explorer_notice' ),
$post_type,
'normal',
apply_filters( 'wpseo_metabox_prio', 'high' ),
array( '__block_editor_compatible_meta_box' => true )
);
}
}
/**
* Renders the content for the internet explorer metabox.
*/
public function render_internet_explorer_notice() {
echo '<div class="yoast-alert-box yoast-alert-box__warning">';
echo '<span class="icon">';
echo '<svg xmlns="http://www.w3.org/2000/svg" fill="#674E00" height="14px" width="14px" viewBox="0 0 576 512" role="img" aria-hidden="true" focusable="false"><path d="M569.517 440.013C587.975 472.007 564.806 512 527.94 512H48.054c-36.937 0-59.999-40.055-41.577-71.987L246.423 23.985c18.467-32.009 64.72-31.951 83.154 0l239.94 416.028zM288 354c-25.405 0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346l7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373 0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884 0-12.356 5.78-11.981 12.654z"/></svg>';
echo '</span>';
echo '<div style="float: left">';
printf(
esc_html__( 'The browser you are currently using is unfortunately rather dated. Since we strive to give you the best experience possible, we no longer support this browser. Instead, please use %1$sFirefox%4$s, %2$sChrome%4$s or %3$sMicrosoft Edge%4$s.', 'wordpress-seo' ),
'<a href="https://www.mozilla.org/firefox/new/">',
'<a href="https://www.google.com/intl/nl/chrome/">',
'<a href="https://www.microsoft.com/windows/microsoft-edge">',
'</a>'
);
echo '</div></div>';
}
/**
* Translates 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() {
WPSEO_Meta::$meta_fields['general']['title']['title'] = __( 'SEO title', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['general']['metadesc']['title'] = __( 'Meta description', 'wordpress-seo' );
/* translators: %s expands to the post type name. */
WPSEO_Meta::$meta_fields['advanced']['meta-robots-noindex']['title'] = __( 'Allow search engines to show this %s in search results?', 'wordpress-seo' );
if ( '0' === (string) get_option( 'blog_public' ) ) {
WPSEO_Meta::$meta_fields['advanced']['meta-robots-noindex']['description'] = '<span class="error-message">' . __( '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' ) . '</span>';
}
/* translators: %1$s expands to Yes or No, %2$s expands to the post type name.*/
WPSEO_Meta::$meta_fields['advanced']['meta-robots-noindex']['options']['0'] = __( 'Default for %2$s, currently: %1$s', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-noindex']['options']['2'] = __( 'Yes', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-noindex']['options']['1'] = __( 'No', 'wordpress-seo' );
/* translators: %1$s expands to the post type name.*/
WPSEO_Meta::$meta_fields['advanced']['meta-robots-nofollow']['title'] = __( 'Should search engines follow links on this %1$s?', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-nofollow']['options']['0'] = __( 'Yes', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-nofollow']['options']['1'] = __( 'No', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-adv']['title'] = __( 'Meta robots advanced', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-adv']['description'] = __( 'If you want to apply advanced <code>meta</code> robots settings for this page, please define them in the following field.', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-adv']['options']['noimageindex'] = __( 'No Image Index', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-adv']['options']['noarchive'] = __( 'No Archive', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['meta-robots-adv']['options']['nosnippet'] = __( 'No Snippet', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['bctitle']['title'] = __( 'Breadcrumbs Title', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['bctitle']['description'] = __( 'Title to use for this page in breadcrumb paths', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['canonical']['title'] = __( 'Canonical URL', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['canonical']['description'] = sprintf(
/* translators: 1: link open tag; 2: link close tag. */
__( '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' ),
'<a href="https://googlewebmastercentral.blogspot.com/2009/12/handling-legitimate-cross-domain.html" target="_blank" rel="noopener">',
WPSEO_Admin_Utils::get_new_tab_message() . '</a>'
);
WPSEO_Meta::$meta_fields['advanced']['redirect']['title'] = __( '301 Redirect', 'wordpress-seo' );
WPSEO_Meta::$meta_fields['advanced']['redirect']['description'] = __( 'The URL that this page should redirect to.', 'wordpress-seo' );
do_action( 'wpseo_tab_translate' );
}
/**
* Determines whether the metabox should be shown for the passed identifier.
*
* By default the check is done for post types, but can also be used for taxonomies.
*
* @param string|null $identifier The identifier to check.
* @param string $type The type of object to check. Defaults to post_type.
*
* @return bool Whether or not the metabox should be displayed.
*/
public function display_metabox( $identifier = null, $type = 'post_type' ) {
return WPSEO_Utils::is_metabox_active( $identifier, $type );
}
/**
* Adds the Yoast SEO meta box to the edit boxes in the edit post, page,
* attachment, and custom post types pages.
*
* @return void
*/
public function add_meta_box() {
$post_types = WPSEO_Post_Type::get_accessible_post_types();
$post_types = array_filter( $post_types, array( $this, 'display_metabox' ) );
if ( ! is_array( $post_types ) || $post_types === array() ) {
return;
}
$product_title = $this->get_product_title();
foreach ( $post_types as $post_type ) {
add_filter( "postbox_classes_{$post_type}_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' ),
array( '__block_editor_compatible_meta_box' => true )
);
}
}
/**
* Adds CSS classes to the meta box.
*
* @param array $classes An array of postbox CSS classes.
*
* @return array List of classes that will be applied to the editbox container.
*/
public function wpseo_metabox_class( $classes ) {
$classes[] = 'yoast wpseo-metabox';
return $classes;
}
/**
* Passes 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, array(), $permalink )
);
$values = $post_formatter->get_values();
/** This filter is documented in admin/filters/class-cornerstone-filter.php. */
$post_types = apply_filters( 'wpseo_cornerstone_post_types', WPSEO_Post_Type::get_accessible_post_types() );
if ( $values['cornerstoneActive'] && ! in_array( $post->post_type, $post_types, true ) ) {
$values['cornerstoneActive'] = false;
}
return $values;
}
/**
* Passes 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(),
'recommended_replace_vars' => $this->get_recommended_replace_vars(),
'scope' => $this->determine_scope(),
'has_taxonomies' => $this->current_post_type_has_taxonomies(),
);
}
/**
* Determines whether or not the current post type has registered taxonomies.
*
* @return bool Whether the current post type has taxonomies.
*/
private function current_post_type_has_taxonomies() {
$post_taxonomies = get_object_taxonomies( get_post_type() );
return ! empty( $post_taxonomies );
}
/**
* 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 describing the current scope.
*/
private function determine_scope() {
$post_type = get_post_type( $this->get_metabox_post() );
if ( $post_type === 'page' ) {
return 'page';
}
return 'post';
}
/**
* Passes some variables to js for the edit / post page overview, 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(),
);
}
/**
* Outputs the meta box.
*/
public function meta_box() {
$content_sections = $this->get_content_sections();
echo '<div class="wpseo-metabox-content">';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Reason: $this->get_product_title is considered safe.
printf( '<div class="wpseo-metabox-menu"><ul role="tablist" class="yoast-aria-tabs" aria-label="%s">', $this->get_product_title() );
foreach ( $content_sections as $content_section ) {
if ( $content_section->name === 'premium' ) {
continue;
}
$content_section->display_link();
}
echo '</ul></div>';
foreach ( $content_sections as $content_section ) {
$content_section->display_content();
}
echo '</div>';
}
/**
* Returns the relevant metabox sections for the current view.
*
* @return WPSEO_Metabox_Section[]
*/
private function get_content_sections() {
$content_sections = array();
$content_sections[] = $this->get_seo_meta_section();
if ( $this->analysis_readability->is_enabled() ) {
$content_sections[] = $this->get_readability_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();
}
$content_sections = array_merge( $content_sections, $this->get_additional_meta_sections() );
return $content_sections;
}
/**
* Returns the metabox section for the seo analysis.
*
* @return WPSEO_Metabox_Section
*/
private function get_seo_meta_section() {
wp_nonce_field( 'yoast_free_metabox', 'yoast_free_metabox_nonce' );
$content = $this->get_tab_content( 'general' );
$label = __( 'SEO', 'wordpress-seo' );
if ( $this->analysis_seo->is_enabled() ) {
$label = '<span class="wpseo-score-icon-container" id="wpseo-seo-score-icon"></span>' . $label;
}
$html_after = '';
if ( WPSEO_Capability_Utils::current_user_can( 'wpseo_edit_advanced_metadata' ) || WPSEO_Options::get( 'disableadvanced_meta' ) === false ) {
$advanced_collapsible = new WPSEO_Paper_Presenter(
__( 'Advanced', 'wordpress-seo' ),
null,
array(
'collapsible' => true,
'class' => 'metabox wpseo-form wpseo-collapsible-container',
'content' => $this->get_tab_content( 'advanced' ),
'paper_id' => 'collapsible-advanced-settings',
)
);
$html_after = '<div class="wpseo_content_wrapper">' . $advanced_collapsible->get_output() . '</div>';
}
/**
* Filter: 'wpseo_content_meta_section_content' - Allow filtering the metabox content before outputting.
*
* @api string $post_content The metabox content string.
*/
$content = apply_filters( 'wpseo_content_meta_section_content', $content );
return new WPSEO_Metabox_Section_React(
'content',
$label,
$content,
array(
'html_after' => $html_after,
)
);
}
/**
* Returns the metabox section for the readability analysis.
*
* @return WPSEO_Metabox_Section
*/
private function get_readability_meta_section() {
return new WPSEO_Metabox_Section_Readability();
}
/**
* Returns the metabox sections that have been added by other plugins.
*
* @return WPSEO_Metabox_Section_Additional[]
*/
protected function get_additional_meta_sections() {
$sections = array();
/**
* Private filter: 'yoast_free_additional_metabox_sections'.
*
* Meant for internal use only. Allows adding additional tabs to the Yoast SEO metabox.
*
* @since 11.9
*
* @param array[] $sections {
* An array of arrays with tab specifications.
*
* @type array $section {
* A tab specification.
*
* @type string $name The name of the tab. Used in the HTML IDs, href and aria properties.
* @type string $link_content The content of the tab link.
* @type string $content The content of the tab.
* @type array $options {
* Optional. Extra options.
*
* @type string $link_class Optional. The class for the tab link.
* @type string $link_aria_label Optional. The aria label of the tab link.
* }
* }
* }
*/
$requested_sections = apply_filters( 'yoast_free_additional_metabox_sections', array() );
foreach ( $requested_sections as $section ) {
if ( is_array( $section ) && array_key_exists( 'name', $section ) && array_key_exists( 'link_content', $section ) && array_key_exists( 'content', $section ) ) {
$options = array_key_exists( 'options', $section ) ? $section['options'] : array();
$sections[] = new WPSEO_Metabox_Section_Additional(
$section['name'],
$section['link_content'],
$section['content'],
$options
);
}
}
return $sections;
}
/**
* Retrieves the contents for the metabox tab.
*
* @param string $tab_name Tab for which to retrieve the field definitions.
*
* @return string
*/
private function get_tab_content( $tab_name ) {
$content = '';
foreach ( WPSEO_Meta::get_meta_field_defs( $tab_name ) as $key => $meta_field ) {
$content .= $this->do_meta_box( $meta_field, $key );
}
return $content;
}
/**
* Adds a line in the meta box.
*
* @todo [JRF] Check if $class is added appropriately everywhere.
*
* @param array $meta_field_def Contains the vars based on which output is generated.
* @param string $key Internal key (without prefix).
*
* @return string
*/
public function do_meta_box( $meta_field_def, $key = '' ) {
$content = '';
$esc_form_key = esc_attr( WPSEO_Meta::$form_prefix . $key );
$meta_value = WPSEO_Meta::get_value( $key, $this->get_metabox_post()->ID );
$class = '';
if ( isset( $meta_field_def['class'] ) && $meta_field_def['class'] !== '' ) {
$class = ' ' . $meta_field_def['class'];
}
$placeholder = '';
if ( isset( $meta_field_def['placeholder'] ) && $meta_field_def['placeholder'] !== '' ) {
$placeholder = $meta_field_def['placeholder'];
}
$aria_describedby = '';
$description = '';
if ( isset( $meta_field_def['description'] ) ) {
$aria_describedby = ' aria-describedby="' . $esc_form_key . '-desc"';
$description = '<p id="' . $esc_form_key . '-desc" class="yoast-metabox__description">' . $meta_field_def['description'] . '</p>';
}
switch ( $meta_field_def['type'] ) {
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 .= '<input type="text"' . $placeholder . ' id="' . $esc_form_key . '" ' . $ac . 'name="' . $esc_form_key . '" value="' . esc_attr( $meta_value ) . '" class="large-text' . $class . '"' . $aria_describedby . '/>';
break;
case 'textarea':
$rows = 3;
if ( isset( $meta_field_def['rows'] ) && $meta_field_def['rows'] > 0 ) {
$rows = $meta_field_def['rows'];
}
$content .= '<textarea class="large-text' . $class . '" rows="' . esc_attr( $rows ) . '" id="' . $esc_form_key . '" name="' . $esc_form_key . '"' . $aria_describedby . '>' . esc_textarea( $meta_value ) . '</textarea>';
break;
case 'hidden':
$content .= '<input type="hidden" id="' . $esc_form_key . '" name="' . $esc_form_key . '" value="' . esc_attr( $meta_value ) . '"/>' . "\n";
break;
case 'select':
if ( isset( $meta_field_def['options'] ) && is_array( $meta_field_def['options'] ) && $meta_field_def['options'] !== array() ) {
$content .= '<select name="' . $esc_form_key . '" id="' . $esc_form_key . '" class="yoast' . $class . '">';
foreach ( $meta_field_def['options'] as $val => $option ) {
$selected = selected( $meta_value, $val, false );
$content .= '<option ' . $selected . ' value="' . esc_attr( $val ) . '">' . esc_html( $option ) . '</option>';
}
unset( $val, $option, $selected );
$content .= '</select>';
}
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 .= '<select multiple="multiple" size="' . esc_attr( $options_count ) . '" name="' . $esc_form_key . '[]" id="' . $esc_form_key . '" class="yoast' . $class . '"' . $aria_describedby . '>';
foreach ( $meta_field_def['options'] as $val => $option ) {
$selected = '';
if ( in_array( $val, $selected_arr, true ) ) {
$selected = ' selected="selected"';
}
$content .= '<option ' . $selected . ' value="' . esc_attr( $val ) . '">' . esc_html( $option ) . '</option>';
}
$content .= '</select>';
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 .= '<input type="checkbox" id="' . $esc_form_key . '" name="' . $esc_form_key . '" ' . $checked . ' value="on" class="yoast' . $class . '"' . $aria_describedby . '/> <label for="' . $esc_form_key . '">' . $expl . '</label>';
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 .= '<input type="radio" ' . $checked . ' id="' . $esc_form_key . '_' . esc_attr( $val ) . '" name="' . $esc_form_key . '" value="' . esc_attr( $val ) . '"/> <label for="' . $esc_form_key . '_' . esc_attr( $val ) . '">' . esc_html( $option ) . '</label> ';
}
unset( $val, $option, $checked );
}
break;
case 'upload':
$content .= '<input' .
' id="' . $esc_form_key . '"' .
' type="text"' .
' size="36"' .
' class="' . $class . '"' .
' name="' . $esc_form_key . '"' .
' value="' . esc_attr( $meta_value ) . '"' . $aria_describedby .
' readonly="readonly"' .
' /> ';
$content .= '<input' .
' id="' . esc_attr( $esc_form_key ) . '_button"' .
' class="wpseo_image_upload_button button"' .
' data-target="' . esc_attr( $esc_form_key ) . '"' .
' data-target-id="' . esc_attr( $esc_form_key ) . '-id"' .
' type="button"' .
' value="' . esc_attr__( 'Upload Image', 'wordpress-seo' ) . '"' .
' /> ';
$content .= '<input' .
' class="wpseo_image_remove_button button"' .
' type="button"' .
' value="' . esc_attr__( 'Clear Image', 'wordpress-seo' ) . '"' .
' />';
break;
}
$html = '';
if ( $content === '' ) {
$content = apply_filters( 'wpseo_do_meta_box_field_' . $key, $content, $meta_value, $esc_form_key, $meta_field_def, $key );
}
if ( $content !== '' ) {
$title = esc_html( $meta_field_def['title'] );
// By default, use the field title as a label element.
$label = '<label for="' . $esc_form_key . '">' . $title . '</label>';
// 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 '<fieldset><legend>' . $title . '</legend>' . $help_button . $help_panel . $content . $description . '</fieldset>';
}
// If it's a single checkbox, ignore the title.
if ( 'checkbox' === $meta_field_def['type'] ) {
$label = '';
}
// Other meta box content or form fields.
if ( $meta_field_def['type'] === 'hidden' ) {
$html = $content;
}
else {
$html = $label . $description . $help_button . $help_panel . $content;
}
}
return $html;
}
/**
* Saves 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 ( ! isset( $_POST['yoast_free_metabox_nonce'] ) || ! wp_verify_nonce( $_POST['yoast_free_metabox_nonce'], 'yoast_free_metabox' ) ) {
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.
*/
if ( ! isset( $_POST['ID'] ) || $post_id !== (int) $_POST['ID'] ) {
return false;
}
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, WPSEO_Meta::get_meta_field_defs( 'general', $post->post_type ), WPSEO_Meta::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 ) ) {
WPSEO_Meta::delete( $key, $post_id );
continue;
}
$data = null;
$field_name = WPSEO_Meta::$form_prefix . $key;
if ( 'checkbox' === $meta_box['type'] ) {
$data = isset( $_POST[ $field_name ] ) ? 'on' : 'off';
}
else {
if ( isset( $_POST[ $field_name ] ) ) {
$data = wp_unslash( $_POST[ $field_name ] );
// For multi-select.
if ( is_array( $data ) ) {
$data = array_map( array( 'WPSEO_Utils', 'sanitize_text_field' ), $data );
}
if ( is_string( $data ) ) {
$data = WPSEO_Utils::sanitize_text_field( $data );
}
}
// Reset options when no entry is present with multiselect - only applies to `meta-robots-adv` currently.
if ( ! isset( $_POST[ $field_name ] ) && ( $meta_box['type'] === 'multiselect' ) ) {
$data = array();
}
}
if ( $data !== null ) {
WPSEO_Meta::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 );
if ( self::is_post_overview( $pagenow ) ) {
$asset_manager->enqueue_style( 'edit-page' );
$asset_manager->enqueue_script( 'edit-page-script' );
return;
}
/* Filter 'wpseo_always_register_metaboxes_on_admin' documented in wpseo-main.php */
if ( ( $is_editor === false && apply_filters( 'wpseo_always_register_metaboxes_on_admin', false ) === false ) || $this->display_metabox() === false ) {
return;
}
$post_id = get_queried_object_id();
if ( empty( $post_id ) && isset( $_GET['post'] ) ) {
$post_id = sanitize_text_field( $_GET['post'] );
}
if ( $post_id !== 0 ) {
// Enqueue files needed for upload functionality.
wp_enqueue_media( array( 'post' => $post_id ) );
}
$asset_manager->enqueue_style( 'metabox-css' );
$asset_manager->enqueue_style( 'scoring' );
$asset_manager->enqueue_style( 'select2' );
$asset_manager->enqueue_script( 'metabox' );
$asset_manager->enqueue_script( 'admin-media' );
$asset_manager->enqueue_script( 'post-scraper' );
$asset_manager->enqueue_script( 'replacevar-plugin' );
$asset_manager->enqueue_script( 'shortcode-plugin' );
$asset_manager->enqueue_script( 'admin-script' );
$asset_manager->enqueue_style( 'admin-css' );
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() );
$yoast_components_l10n = new WPSEO_Admin_Asset_Yoast_Components_L10n();
$yoast_components_l10n->localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'post-scraper' );
$analysis_worker_location = new WPSEO_Admin_Asset_Analysis_Worker_Location( $asset_manager->flatten_version( WPSEO_VERSION ) );
$used_keywords_assessment_location = new WPSEO_Admin_Asset_Analysis_Worker_Location( $asset_manager->flatten_version( WPSEO_VERSION ), 'used-keywords-assessment' );
$localization_data = array(
'url' => $analysis_worker_location->get_url( $analysis_worker_location->get_asset(), WPSEO_Admin_Asset::TYPE_JS ),
'keywords_assessment_url' => $used_keywords_assessment_location->get_url( $used_keywords_assessment_location->get_asset(), WPSEO_Admin_Asset::TYPE_JS ),
'log_level' => WPSEO_Utils::get_analysis_worker_log_level(),
// We need to make the feature flags separately available inside of the analysis web worker.
'enabled_features' => WPSEO_Utils::retrieve_enabled_features(),
);
wp_localize_script(
WPSEO_Admin_Asset_Manager::PREFIX . 'post-scraper',
'wpseoAnalysisWorkerL10n',
$localization_data
);
/**
* Removes the emoji script as it is incompatible with both React and any
* contenteditable fields.
*/
remove_action( 'admin_print_scripts', 'print_emoji_detection_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_Utils::get_admin_l10n() );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'metabox', 'wpseoSelect2Locale', WPSEO_Language_Utils::get_language( WPSEO_Language_Utils::get_user_locale() ) );
wp_localize_script( WPSEO_Admin_Asset_Manager::PREFIX . 'metabox', 'wpseoFeaturesL10n', WPSEO_Utils::retrieve_enabled_features() );
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 );
}
}
/**
* Passes 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 ) {
$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',
'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 ) );
}
/**
* Prepares the recommended replace vars for localization.
*
* @return array Recommended replacement variables.
*/
private function get_recommended_replace_vars() {
$recommended_replace_vars = new WPSEO_Admin_Recommended_Replace_Vars();
$post = $this->get_metabox_post();
// What is recommended depends on the current context.
$post_type = $recommended_replace_vars->determine_for_post( $post );
return $recommended_replace_vars->get_recommended_replacevars_for( $post_type );
}
/**
* 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;
}
/**
* Checks if the page is the post overview page.
*
* @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;
}
/**
* Checks if the page is the post edit 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;
}
/**
* Retrieves the product title.
*
* @return string The product title.
*/
protected function get_product_title() {
$product_title = 'Yoast SEO';
if ( WPSEO_Utils::is_yoast_seo_premium() ) {
$product_title .= ' Premium';
}
return $product_title;
}
/* ********************* DEPRECATED METHODS ********************* */
/**
* Outputs the page analysis score in the Publish Box.
*
* @deprecated 9.6
* @codeCoverageIgnore
*
* @return void
*/
public function publish_box() {
_deprecated_function( __METHOD__, 'WPSEO 9.6' );
}
/**
* Sets up all the functionality related to the prominence of the page analysis functionality.
*
* @deprecated 9.6
* @codeCoverageIgnore
*
* @return void
*/
public function setup_page_analysis() {
_deprecated_function( __METHOD__, 'WPSEO 9.6' );
}
/**
* Outputs a tab in the Yoast SEO Metabox.
*
* @deprecated 12.2
* @codeCoverageIgnore
*
* @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 ) {
_deprecated_function( __METHOD__, '12.2' );
?>
<div id="<?php echo esc_attr( 'wpseo_' . $id ); ?>" class="wpseotab wpseo-form <?php echo esc_attr( $id ); ?>">
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Reason: deprecated function.
echo $content;
?>
</div>
<?php
}
}