Yoast\WP\SEO\Integrations\Third_Party
Elementor{} Yoast 1.0
Integrates the Yoast SEO metabox in the Elementor editor.
Хуки из класса
Возвращает
Null. Ничего.
Использование
$Elementor = new Elementor(); // use class methods
Методы
- __construct(
- add_yoast_panel_tab()
- current_post_type_has_taxonomies()
- determine_scope()
- display_metabox( $identifier = null, $type = 'post_type' )
- enqueue()
- get_conditionals()
- get_custom_fields_replace_vars( $post )
- get_custom_replace_vars( $post )
- get_custom_taxonomies_replace_vars( $post )
- get_metabox_post()
- get_metabox_script_data()
- get_recommended_replace_vars()
- get_replace_vars()
- get_valid_shortcode_tags()
- init()
- is_meta_value_disabled( $key )
- register_document_controls( $document )
- register_hooks()
- render_hidden_fields()
- save_postdata()
Код Elementor{} Elementor{} Yoast 15.7
<?php
class Elementor implements Integration_Interface {
/**
* Represents the post.
*
* @var WP_Post|null
*/
protected $post;
/**
* Represents the admin asset manager.
*
* @var WPSEO_Admin_Asset_Manager
*/
protected $asset_manager;
/**
* Represents the options helper.
*
* @var \Yoast\WP\SEO\Helpers\Options_Helper
*/
protected $options;
/**
* Represents the capability helper.
*
* @var \Yoast\WP\SEO\Helpers\Capability_Helper
*/
protected $capability;
/**
* Holds whether the socials are enabled.
*
* @var bool
*/
protected $social_is_enabled;
/**
* Holds whether the advanced settings are enabled.
*
* @var bool
*/
protected $is_advanced_metadata_enabled;
/**
* Helper to determine whether or not the SEO analysis is enabled.
*
* @var WPSEO_Metabox_Analysis_SEO
*/
protected $seo_analysis;
/**
* Helper to determine whether or not the readability analysis is enabled.
*
* @var WPSEO_Metabox_Analysis_Readability
*/
protected $readability_analysis;
/**
* Represents the estimated_reading_time_conditional.
*
* @var Estimated_Reading_Time_Conditional
*/
protected $estimated_reading_time_conditional;
/**
* The identifier for the elementor tab.
*/
const YOAST_TAB = 'yoast-tab';
/**
* Returns the conditionals based in which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ Elementor_Edit_Conditional::class ];
}
/**
* Constructor.
*
* @param WPSEO_Admin_Asset_Manager $asset_manager The asset manager.
* @param Options_Helper $options The options helper.
* @param Capability_Helper $capability The capability helper.
* @param Estimated_Reading_Time_Conditional $estimated_reading_time_conditional The Estimated Reading Time conditional.
*/
public function __construct(
WPSEO_Admin_Asset_Manager $asset_manager,
Options_Helper $options,
Capability_Helper $capability,
Estimated_Reading_Time_Conditional $estimated_reading_time_conditional
) {
$this->asset_manager = $asset_manager;
$this->options = $options;
$this->capability = $capability;
$this->seo_analysis = new WPSEO_Metabox_Analysis_SEO();
$this->readability_analysis = new WPSEO_Metabox_Analysis_Readability();
$this->social_is_enabled = $this->options->get( 'opengraph', false ) || $this->options->get( 'twitter', false );
$this->is_advanced_metadata_enabled = $this->capability->current_user_can( 'wpseo_edit_advanced_metadata' ) || $this->options->get( 'disableadvanced_meta' ) === false;
$this->estimated_reading_time_conditional = $estimated_reading_time_conditional;
}
/**
* Initializes the integration.
*
* This is the place to register hooks and filters.
*
* @return void
*/
public function register_hooks() {
\add_action( 'wp_ajax_wpseo_elementor_save', [ $this, 'save_postdata' ] );
if ( ! $this->display_metabox( $this->get_metabox_post()->post_type ) ) {
return;
}
\add_action( 'elementor/editor/before_enqueue_scripts', [ $this, 'init' ] );
// We are too late for elementor/init. We should see if we can be on time, or else this workaround works (we do always get the "else" though).
if ( ! \did_action( 'elementor/init' ) ) {
\add_action( 'elementor/init', [ $this, 'add_yoast_panel_tab' ] );
}
else {
$this->add_yoast_panel_tab();
}
\add_action( 'elementor/documents/register_controls', [ $this, 'register_document_controls' ] );
}
/**
* Initializes the integration.
*
* @return void
*/
public function init() {
$this->asset_manager->register_assets();
$this->enqueue();
$this->render_hidden_fields();
}
/**
* Register a panel tab slug, in order to allow adding controls to this tab.
*/
public function add_yoast_panel_tab() {
Controls_Manager::add_tab( $this::YOAST_TAB, __( 'Yoast SEO', 'wordpress-seo' ) );
}
/**
* Register additional document controls.
*
* @param PageBase $document The PageBase document.
*/
public function register_document_controls( $document ) {
// PageBase is the base class for documents like `post` `page` and etc.
if ( ! $document instanceof PageBase || ! $document::get_property( 'has_elements' ) ) {
return;
}
// This is needed to get the tab to appear, but will be overwritten in the JavaScript.
$document->start_controls_section(
'yoast_temporary_section',
[
'label' => __( 'Yoast SEO', 'wordpress-seo' ),
'tab' => self::YOAST_TAB,
]
);
$document->end_controls_section();
}
// Below is mostly copied from `class-metabox.php`. That constructor has side-effects we do not need.
/**
* 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 );
}
/**
* Saves the WP SEO metadata for posts.
*
* {@internal $_POST parameters are validated via sanitize_post_meta().}}
*
* @return void Outputs JSON via wp_send_json then stops code execution.
*/
public function save_postdata() {
global $post;
$post_id = \filter_input( INPUT_POST, 'post_id', FILTER_SANITIZE_NUMBER_INT );
if ( ! \current_user_can( 'manage_options' ) ) {
\wp_send_json_error( 'Unauthorized', 401 );
}
\check_ajax_referer( 'wpseo_elementor_save', '_wpseo_elementor_nonce' );
// Bail if this is a multisite installation and the site has been switched.
if ( \is_multisite() && \ms_is_switched() ) {
\wp_send_json_error( 'Switched multisite', 409 );
}
\clean_post_cache( $post_id );
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- To setup the post we need to do this explicitly.
$post = \get_post( $post_id );
if ( ! \is_object( $post ) ) {
// Non-existent post.
\wp_send_json_error( 'Post not found', 400 );
}
\do_action( 'wpseo_save_compare_data', $post );
// Initialize meta, amongst other things it registers sanitization.
WPSEO_Meta::init();
$social_fields = [];
if ( $this->social_is_enabled ) {
$social_fields = WPSEO_Meta::get_meta_field_defs( 'social', $post->post_type );
}
// The below methods use the global post so make sure it is setup.
\setup_postdata( $post );
$meta_boxes = \apply_filters( 'wpseo_save_metaboxes', [] );
$meta_boxes = \array_merge(
$meta_boxes,
WPSEO_Meta::get_meta_field_defs( 'general', $post->post_type ),
WPSEO_Meta::get_meta_field_defs( 'advanced', $post->post_type ),
$social_fields,
WPSEO_Meta::get_meta_field_defs( 'schema', $post->post_type )
);
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 ( $meta_box['type'] === 'checkbox' ) {
$data = isset( $_POST[ $field_name ] ) ? 'on' : 'off';
}
else {
if ( isset( $_POST[ $field_name ] ) ) {
// phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: Sanitized through sanitize_post_meta.
$data = \wp_unslash( $_POST[ $field_name ] );
// For multi-select.
if ( \is_array( $data ) ) {
$data = \array_map( [ 'WPSEO_Utils', 'sanitize_text_field' ], $data );
}
if ( \is_string( $data ) ) {
$data = ( $key !== 'canonical' ) ? WPSEO_Utils::sanitize_text_field( $data ) : WPSEO_Utils::sanitize_url( $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 = [];
}
}
if ( $data !== null ) {
WPSEO_Meta::set_value( $key, $data, $post_id );
}
}
// Saving the WP post to save the slug.
$slug = \filter_input( INPUT_POST, WPSEO_Meta::$form_prefix . 'slug', FILTER_SANITIZE_STRING );
if ( $post->post_name !== $slug ) {
$post_array = $post->to_array();
$post_array['post_name'] = $slug;
$save_successful = \wp_insert_post( $post_array );
if ( \is_wp_error( $save_successful ) ) {
\wp_send_json_error( 'Slug not saved', 400 );
}
// Update the post object to ensure we have the actual slug.
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Updating the post is needed to get the current slug.
$post = \get_post( $post_id );
if ( ! \is_object( $post ) ) {
\wp_send_json_error( 'Updated slug not found', 400 );
}
}
\do_action( 'wpseo_saved_postdata' );
// Output the slug, because it is processed by WP and we need the actual slug again.
\wp_send_json_success( [ 'slug' => $post->post_name ] );
}
/**
* 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 ( $key === 'linkdex' && ! $this->seo_analysis->is_enabled() ) {
return true;
}
if ( $key === 'content_score' && ! $this->readability_analysis->is_enabled() ) {
return true;
}
return false;
}
/**
* Enqueues all the needed JS and CSS.
*
* @return void
*/
public function enqueue() {
$post_id = \get_queried_object_id();
if ( empty( $post_id ) ) {
$post_id = \sanitize_text_field( \filter_input( INPUT_GET, 'post' ) );
}
if ( $post_id !== 0 ) {
// Enqueue files needed for upload functionality.
\wp_enqueue_media( [ 'post' => $post_id ] );
}
$this->asset_manager->enqueue_style( 'admin-global' );
$this->asset_manager->enqueue_style( 'metabox-css' );
$this->asset_manager->enqueue_style( 'scoring' );
$this->asset_manager->enqueue_style( 'select2' );
$this->asset_manager->enqueue_style( 'monorepo' );
$this->asset_manager->enqueue_style( 'admin-css' );
$this->asset_manager->enqueue_style( 'elementor' );
$this->asset_manager->enqueue_script( 'elementor' );
$yoast_components_l10n = new WPSEO_Admin_Asset_Yoast_Components_L10n();
$yoast_components_l10n->localize_script( 'elementor' );
$this->asset_manager->localize_script( 'elementor', 'wpseoAdminL10n', WPSEO_Utils::get_admin_l10n() );
$this->asset_manager->localize_script( 'elementor', 'wpseoFeaturesL10n', WPSEO_Utils::retrieve_enabled_features() );
$analysis_worker_location = new WPSEO_Admin_Asset_Analysis_Worker_Location( $this->asset_manager->flatten_version( WPSEO_VERSION ) );
$used_keywords_assessment_location = new WPSEO_Admin_Asset_Analysis_Worker_Location( $this->asset_manager->flatten_version( WPSEO_VERSION ), 'used-keywords-assessment' );
$plugins_script_data = [
'replaceVars' => [
'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(),
],
'shortcodes' => [
'wpseo_filter_shortcodes_nonce' => \wp_create_nonce( 'wpseo-filter-shortcodes' ),
'wpseo_shortcode_tags' => $this->get_valid_shortcode_tags(),
],
];
$worker_script_data = [
'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(),
];
$script_data = [
'media' => [ 'choose_image' => __( 'Use Image', 'wordpress-seo' ) ],
'metabox' => $this->get_metabox_script_data(),
'userLanguageCode' => WPSEO_Language_Utils::get_language( \get_user_locale() ),
'isPost' => true,
'isBlockEditor' => WP_Screen::get()->is_block_editor(),
'isElementorEditor' => true,
'analysis' => [
'plugins' => $plugins_script_data,
'worker' => $worker_script_data,
'estimatedReadingTimeEnabled' => $this->estimated_reading_time_conditional->is_met(),
],
];
if ( \post_type_supports( $this->get_metabox_post()->post_type, 'thumbnail' ) ) {
$this->asset_manager->enqueue_style( 'featured-image' );
$script_data['featuredImage'] = [
'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' ),
];
}
$this->asset_manager->localize_script( 'elementor', 'wpseoScriptData', $script_data );
}
/**
* Renders the metabox hidden fields.
*
* @return void
*/
protected function render_hidden_fields() {
// Wrap in a form with an action and post_id for the submit.
printf(
'<form id="yoast-form" method="post" action="%1$s"><input type="hidden" name="action" value="wpseo_elementor_save" /><input type="hidden" id="post_ID" name="post_id" value="%2$s" />',
\esc_url( \admin_url( 'admin-ajax.php' ) ),
\esc_attr( $this->get_metabox_post()->ID )
);
\wp_nonce_field( 'wpseo_elementor_save', '_wpseo_elementor_nonce' );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Reason: Meta_Fields_Presenter->present is considered safe.
echo new Meta_Fields_Presenter( $this->get_metabox_post(), 'general' );
if ( $this->is_advanced_metadata_enabled ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Reason: Meta_Fields_Presenter->present is considered safe.
echo new Meta_Fields_Presenter( $this->get_metabox_post(), 'advanced' );
}
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Reason: Meta_Fields_Presenter->present is considered safe.
echo new Meta_Fields_Presenter( $this->get_metabox_post(), 'schema', $this->get_metabox_post()->post_type );
if ( $this->social_is_enabled ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Reason: Meta_Fields_Presenter->present is considered safe.
echo new Meta_Fields_Presenter( $this->get_metabox_post(), 'social' );
}
printf(
'<input type="hidden" id="%1$s" name="%1$s" value="%2$s" />',
\esc_attr( WPSEO_Meta::$form_prefix . 'slug' ),
\esc_attr( $this->get_metabox_post()->post_name )
);
echo '</form>';
}
/**
* Returns post in metabox context.
*
* @return WP_Post|null
*/
protected function get_metabox_post() {
if ( $this->post !== null ) {
return $this->post;
}
$post = \filter_input( INPUT_GET, 'post' );
if ( ! empty( $post ) ) {
$post_id = (int) WPSEO_Utils::validate_int( $post );
$this->post = \get_post( $post_id );
return $this->post;
}
if ( isset( $GLOBALS['post'] ) ) {
$this->post = $GLOBALS['post'];
return $this->post;
}
return null;
}
/**
* Passes variables to js for use with the post-scraper.
*
* @return array
*/
protected function get_metabox_script_data() {
$permalink = '';
if ( \is_object( $this->get_metabox_post() ) ) {
$permalink = \get_sample_permalink( $this->get_metabox_post()->ID );
$permalink = $permalink[0];
}
$post_formatter = new WPSEO_Metabox_Formatter(
new WPSEO_Post_Metabox_Formatter( $this->get_metabox_post(), [], $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', YoastSEO()->helpers->post_type->get_accessible_post_types() );
if ( $values['cornerstoneActive'] && ! \in_array( $this->get_metabox_post()->post_type, $post_types, true ) ) {
$values['cornerstoneActive'] = false;
}
return $values;
}
/**
* Prepares the replace vars for localization.
*
* @return array Replace vars.
*/
protected function get_replace_vars() {
$cached_replacement_vars = [];
$vars_to_cache = [
'date',
'id',
'sitename',
'sitedesc',
'sep',
'page',
'currentyear',
'tag',
'category',
'primary_category',
'pt_single',
'pt_plural',
'modified',
'name',
'user_description',
'pagetotal',
'pagenumber',
];
foreach ( $vars_to_cache as $var ) {
$cached_replacement_vars[ $var ] = \wpseo_replace_vars( '%%' . $var . '%%', $this->get_metabox_post() );
}
// Merge custom replace variables with the WordPress ones.
return \array_merge( $cached_replacement_vars, $this->get_custom_replace_vars( $this->get_metabox_post() ) );
}
/**
* Prepares the recommended replace vars for localization.
*
* @return array Recommended replacement variables.
*/
protected function get_recommended_replace_vars() {
$recommended_replace_vars = new WPSEO_Admin_Recommended_Replace_Vars();
// What is recommended depends on the current context.
$post_type = $recommended_replace_vars->determine_for_post( $this->get_metabox_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.
*/
protected function get_custom_replace_vars( $post ) {
return [
'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.
*/
protected function get_custom_taxonomies_replace_vars( $post ) {
$taxonomies = \get_object_taxonomies( $post, 'objects' );
$custom_replace_vars = [];
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 ] = [
'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.
*/
protected function get_custom_fields_replace_vars( $post ) {
$custom_replace_vars = [];
// 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 ) {
// Skip private custom fields.
if ( \substr( $custom_field_name, 0, 1 ) === '_' ) {
continue;
}
// Skip custom field values that are serialized.
if ( \is_serialized( $custom_field[0] ) ) {
continue;
}
$custom_replace_vars[ $custom_field_name ] = $custom_field[0];
}
return $custom_replace_vars;
}
/**
* 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.
*/
protected function determine_scope() {
if ( $this->get_metabox_post()->post_type === 'page' ) {
return 'page';
}
return 'post';
}
/**
* Determines whether or not the current post type has registered taxonomies.
*
* @return bool Whether the current post type has taxonomies.
*/
protected function current_post_type_has_taxonomies() {
$post_taxonomies = \get_object_taxonomies( $this->get_metabox_post()->post_type );
return ! empty( $post_taxonomies );
}
/**
* Returns an array with shortcode tags for all registered shortcodes.
*
* @return array
*/
protected function get_valid_shortcode_tags() {
$shortcode_tags = [];
foreach ( $GLOBALS['shortcode_tags'] as $tag => $description ) {
$shortcode_tags[] = $tag;
}
return $shortcode_tags;
}
}