if ( ! defined( 'WPSEO_VERSION' ) ) {
header( 'Status: 403 Forbidden' );
header( 'HTTP/1.1 403 Forbidden' );
* Convenience function to JSON encode and echo results and then die.
* @param array $results Results array for encoding.
function wpseo_ajax_json_echo_die( $results ) {
// phpcs:ignore WordPress.Security.EscapeOutput -- Reason: WPSEO_Utils::format_json_encode is safe.
echo WPSEO_Utils::format_json_encode( $results );
* Function used from AJAX calls, takes it variables from $_POST, dies on exit.
function wpseo_set_option() {
if ( ! current_user_can( 'manage_options' ) ) {
check_ajax_referer( 'wpseo-setoption' );
$option = sanitize_text_field( filter_input( INPUT_POST, 'option' ) );
if ( $option !== 'page_comments' ) {
update_option( $option, 0 );
add_action( 'wp_ajax_wpseo_set_option', 'wpseo_set_option' );
* Since 3.2 Notifications are dismissed in the Notification Center.
add_action( 'wp_ajax_yoast_dismiss_notification', [ 'Yoast_Notification_Center', 'ajax_dismiss_notification' ] );
* Function used to remove the admin notices for several purposes, dies on exit.
function wpseo_set_ignore() {
if ( ! current_user_can( 'manage_options' ) ) {
check_ajax_referer( 'wpseo-ignore' );
$ignore_key = sanitize_text_field( filter_input( INPUT_POST, 'option' ) );
WPSEO_Options::set( 'ignore_' . $ignore_key, true );
add_action( 'wp_ajax_wpseo_set_ignore', 'wpseo_set_ignore' );
* Save an individual SEO title from the Bulk Editor.
function wpseo_save_title() {
wpseo_save_what( 'title' );
add_action( 'wp_ajax_wpseo_save_title', 'wpseo_save_title' );
* Save an individual meta description from the Bulk Editor.
function wpseo_save_description() {
wpseo_save_what( 'metadesc' );
add_action( 'wp_ajax_wpseo_save_metadesc', 'wpseo_save_description' );
* Save titles & descriptions.
* @param string $what Type of item to save (title, description).
function wpseo_save_what( $what ) {
check_ajax_referer( 'wpseo-bulk-editor' );
$new = filter_input( INPUT_POST, 'new_value' );
$post_id = intval( filter_input( INPUT_POST, 'wpseo_post_id' ) );
$original = filter_input( INPUT_POST, 'existing_value' );
$results = wpseo_upsert_new( $what, $post_id, $new, $original );
wpseo_ajax_json_echo_die( $results );
* Helper function to update a post's meta data, returning relevant information
* about the information updated and the results or the meta update.
* @param int $post_id Post ID.
* @param string $new_meta_value New meta value to record.
* @param string $orig_meta_value Original meta value.
* @param string $meta_key Meta key string.
* @param string $return_key Return key string to use in results.
function wpseo_upsert_meta( $post_id, $new_meta_value, $orig_meta_value, $meta_key, $return_key ) {
$post_id = intval( $post_id );
$sanitized_new_meta_value = wp_strip_all_tags( $new_meta_value );
$orig_meta_value = wp_strip_all_tags( $orig_meta_value );
"new_{$return_key}" => $sanitized_new_meta_value,
"original_{$return_key}" => $orig_meta_value,
$the_post = get_post( $post_id );
if ( empty( $the_post ) ) {
$upsert_results['status'] = 'failure';
$upsert_results['results'] = __( 'Post doesn\'t exist.', 'wordpress-seo' );
$post_type_object = get_post_type_object( $the_post->post_type );
if ( ! $post_type_object ) {
$upsert_results['status'] = 'failure';
$upsert_results['results'] = sprintf(
/* translators: %s expands to post type. */
__( 'Post has an invalid Content Type: %s.', 'wordpress-seo' ),
if ( ! current_user_can( $post_type_object->cap->edit_posts ) ) {
$upsert_results['status'] = 'failure';
$upsert_results['results'] = sprintf(
/* translators: %s expands to post type name. */
__( 'You can\'t edit %s.', 'wordpress-seo' ),
if ( ! current_user_can( $post_type_object->cap->edit_others_posts ) && (int) $the_post->post_author !== get_current_user_id() ) {
$upsert_results['status'] = 'failure';
$upsert_results['results'] = sprintf(
/* translators: %s expands to the name of a post type (plural). */
__( 'You can\'t edit %s that aren\'t yours.', 'wordpress-seo' ),
if ( $sanitized_new_meta_value === $orig_meta_value && $sanitized_new_meta_value !== $new_meta_value ) {
$upsert_results['status'] = 'failure';
$upsert_results['results'] = __( 'You have used HTML in your value which is not allowed.', 'wordpress-seo' );
$res = update_post_meta( $post_id, $meta_key, $sanitized_new_meta_value );
$upsert_results['status'] = ( $res !== false ) ? 'success' : 'failure';
$upsert_results['results'] = $res;
* Save all titles sent from the Bulk Editor.
function wpseo_save_all_titles() {
wpseo_save_all( 'title' );
add_action( 'wp_ajax_wpseo_save_all_titles', 'wpseo_save_all_titles' );
* Save all description sent from the Bulk Editor.
function wpseo_save_all_descriptions() {
wpseo_save_all( 'metadesc' );
add_action( 'wp_ajax_wpseo_save_all_descriptions', 'wpseo_save_all_descriptions' );
* Utility function to save values.
* @param string $what Type of item so save.
function wpseo_save_all( $what ) {
check_ajax_referer( 'wpseo-bulk-editor' );
if ( ! isset( $_POST['items'], $_POST['existingItems'] ) ) {
wpseo_ajax_json_echo_die( $results );
$new_values = array_map( [ 'WPSEO_Utils', 'sanitize_text_field' ], wp_unslash( (array) $_POST['items'] ) );
$original_values = array_map( [ 'WPSEO_Utils', 'sanitize_text_field' ], wp_unslash( (array) $_POST['existingItems'] ) );
foreach ( $new_values as $post_id => $new_value ) {
$original_value = $original_values[ $post_id ];
$results[] = wpseo_upsert_new( $what, $post_id, $new_value, $original_value );
wpseo_ajax_json_echo_die( $results );
* @param string $what Item type (such as title).
* @param int $post_id Post ID.
* @param string $new New value to record.
* @param string $original Original value.
function wpseo_upsert_new( $what, $post_id, $new, $original ) {
$meta_key = WPSEO_Meta::$meta_prefix . $what;
return wpseo_upsert_meta( $post_id, $new, $original, $meta_key, $what );
* Retrieves the keyword for the keyword doubles.
function ajax_get_keyword_usage() {
$post_id = filter_input( INPUT_POST, 'post_id' );
$keyword = filter_input( INPUT_POST, 'keyword' );
if ( ! current_user_can( 'edit_post', $post_id ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput -- Reason: WPSEO_Utils::format_json_encode is safe.
WPSEO_Utils::format_json_encode( WPSEO_Meta::keyword_usage( $keyword, $post_id ) )
add_action( 'wp_ajax_get_focus_keyword_usage', 'ajax_get_keyword_usage' );
* Retrieves the keyword for the keyword doubles of the termpages.
function ajax_get_term_keyword_usage() {
$post_id = filter_input( INPUT_POST, 'post_id' );
$keyword = filter_input( INPUT_POST, 'keyword' );
$taxonomy_name = filter_input( INPUT_POST, 'taxonomy' );
$taxonomy = get_taxonomy( $taxonomy_name );
if ( ! current_user_can( $taxonomy->cap->edit_terms ) ) {
$usage = WPSEO_Taxonomy_Meta::get_keyword_usage( $keyword, $post_id, $taxonomy_name );
// Normalize the result so it it the same as the post keyword usage AJAX request.
$usage = $usage[ $keyword ];
// phpcs:ignore WordPress.Security.EscapeOutput -- Reason: WPSEO_Utils::format_json_encode is safe.
WPSEO_Utils::format_json_encode( $usage )
add_action( 'wp_ajax_get_term_keyword_usage', 'ajax_get_term_keyword_usage' );
* Registers hooks for all AJAX integrations.
function wpseo_register_ajax_integrations() {
$integrations = [ new Yoast_Network_Admin() ];
foreach ( $integrations as $integration ) {
$integration->register_ajax_hooks();
wpseo_register_ajax_integrations();
new WPSEO_Shortcode_Filter();
new WPSEO_Taxonomy_Columns();
/* ********************* DEPRECATED FUNCTIONS ********************* */
* Hides the default tagline notice for a specific user.
function wpseo_dismiss_tagline_notice() {
if ( ! current_user_can( 'manage_options' ) ) {
_deprecated_function( __FUNCTION__, 'WPSEO 13.2', 'This method is deprecated.' );
wpseo_ajax_json_echo_die( '' );