<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WPSEO\Admin

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Adds the UI to change the primary term for a post.

[8] Fix | Delete

*/

[9] Fix | Delete

class WPSEO_Primary_Term_Admin implements WPSEO_WordPress_Integration {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Constructor.

[13] Fix | Delete

*

[14] Fix | Delete

* @return void

[15] Fix | Delete

*/

[16] Fix | Delete

public function register_hooks() {

[17] Fix | Delete

add_filter( 'wpseo_content_meta_section_content', [ $this, 'add_input_fields' ] );

[18] Fix | Delete

[19] Fix | Delete

add_action( 'admin_footer', [ $this, 'wp_footer' ], 10 );

[20] Fix | Delete

[21] Fix | Delete

add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );

[22] Fix | Delete

}

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Gets the current post ID.

[26] Fix | Delete

*

[27] Fix | Delete

* @return int The post ID.

[28] Fix | Delete

*/

[29] Fix | Delete

protected function get_current_id() {

[30] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Reason: We are not processing form information, We are casting to an integer.

[31] Fix | Delete

$post_id = isset( $_GET['post'] ) && is_string( $_GET['post'] ) ? (int) wp_unslash( $_GET['post'] ) : 0;

[32] Fix | Delete

[33] Fix | Delete

if ( $post_id === 0 && isset( $GLOBALS['post_ID'] ) ) {

[34] Fix | Delete

$post_id = (int) $GLOBALS['post_ID'];

[35] Fix | Delete

}

[36] Fix | Delete

[37] Fix | Delete

return $post_id;

[38] Fix | Delete

}

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Adds hidden fields for primary taxonomies.

[42] Fix | Delete

*

[43] Fix | Delete

* @param string $content The metabox content.

[44] Fix | Delete

*

[45] Fix | Delete

* @return string The HTML content.

[46] Fix | Delete

*/

[47] Fix | Delete

public function add_input_fields( $content ) {

[48] Fix | Delete

$taxonomies = $this->get_primary_term_taxonomies();

[49] Fix | Delete

[50] Fix | Delete

foreach ( $taxonomies as $taxonomy ) {

[51] Fix | Delete

$content .= $this->primary_term_field( $taxonomy->name );

[52] Fix | Delete

$content .= wp_nonce_field( 'save-primary-term', WPSEO_Meta::$form_prefix . 'primary_' . $taxonomy->name . '_nonce', false, false );

[53] Fix | Delete

}

[54] Fix | Delete

return $content;

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Generates the HTML for a hidden field for a primary taxonomy.

[59] Fix | Delete

*

[60] Fix | Delete

* @param string $taxonomy_name The taxonomy's slug.

[61] Fix | Delete

*

[62] Fix | Delete

* @return string The HTML for a hidden primary taxonomy field.

[63] Fix | Delete

*/

[64] Fix | Delete

protected function primary_term_field( $taxonomy_name ) {

[65] Fix | Delete

return sprintf(

[66] Fix | Delete

'<input class="yoast-wpseo-primary-term" type="hidden" id="%1$s" name="%2$s" value="%3$s" />',

[67] Fix | Delete

esc_attr( $this->generate_field_id( $taxonomy_name ) ),

[68] Fix | Delete

esc_attr( $this->generate_field_name( $taxonomy_name ) ),

[69] Fix | Delete

esc_attr( $this->get_primary_term( $taxonomy_name ) )

[70] Fix | Delete

);

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Generates an id for a primary taxonomy's hidden field.

[75] Fix | Delete

*

[76] Fix | Delete

* @param string $taxonomy_name The taxonomy's slug.

[77] Fix | Delete

*

[78] Fix | Delete

* @return string The field id.

[79] Fix | Delete

*/

[80] Fix | Delete

protected function generate_field_id( $taxonomy_name ) {

[81] Fix | Delete

return 'yoast-wpseo-primary-' . $taxonomy_name;

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Generates a name for a primary taxonomy's hidden field.

[86] Fix | Delete

*

[87] Fix | Delete

* @param string $taxonomy_name The taxonomy's slug.

[88] Fix | Delete

*

[89] Fix | Delete

* @return string The field id.

[90] Fix | Delete

*/

[91] Fix | Delete

protected function generate_field_name( $taxonomy_name ) {

[92] Fix | Delete

return WPSEO_Meta::$form_prefix . 'primary_' . $taxonomy_name . '_term';

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Adds primary term templates.

[97] Fix | Delete

*

[98] Fix | Delete

* @return void

[99] Fix | Delete

*/

[100] Fix | Delete

public function wp_footer() {

[101] Fix | Delete

$taxonomies = $this->get_primary_term_taxonomies();

[102] Fix | Delete

[103] Fix | Delete

if ( ! empty( $taxonomies ) ) {

[104] Fix | Delete

$this->include_js_templates();

[105] Fix | Delete

}

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Enqueues all the assets needed for the primary term interface.

[110] Fix | Delete

*

[111] Fix | Delete

* @return void

[112] Fix | Delete

*/

[113] Fix | Delete

public function enqueue_assets() {

[114] Fix | Delete

global $pagenow;

[115] Fix | Delete

[116] Fix | Delete

if ( ! WPSEO_Metabox::is_post_edit( $pagenow ) ) {

[117] Fix | Delete

return;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

$taxonomies = $this->get_primary_term_taxonomies();

[121] Fix | Delete

[122] Fix | Delete

// Only enqueue if there are taxonomies that need a primary term.

[123] Fix | Delete

if ( empty( $taxonomies ) ) {

[124] Fix | Delete

return;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

$asset_manager = new WPSEO_Admin_Asset_Manager();

[128] Fix | Delete

$asset_manager->enqueue_style( 'primary-category' );

[129] Fix | Delete

[130] Fix | Delete

$mapped_taxonomies = $this->get_mapped_taxonomies_for_js( $taxonomies );

[131] Fix | Delete

[132] Fix | Delete

$data = [

[133] Fix | Delete

'taxonomies' => $mapped_taxonomies,

[134] Fix | Delete

];

[135] Fix | Delete

[136] Fix | Delete

$asset_manager->localize_script( 'post-edit', 'wpseoPrimaryCategoryL10n', $data );

[137] Fix | Delete

$asset_manager->localize_script( 'post-edit-classic', 'wpseoPrimaryCategoryL10n', $data );

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Gets the id of the primary term.

[142] Fix | Delete

*

[143] Fix | Delete

* @param string $taxonomy_name Taxonomy name for the term.

[144] Fix | Delete

*

[145] Fix | Delete

* @return int primary term id

[146] Fix | Delete

*/

[147] Fix | Delete

protected function get_primary_term( $taxonomy_name ) {

[148] Fix | Delete

$primary_term = new WPSEO_Primary_Term( $taxonomy_name, $this->get_current_id() );

[149] Fix | Delete

[150] Fix | Delete

return $primary_term->get_primary_term();

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Returns all the taxonomies for which the primary term selection is enabled.

[155] Fix | Delete

*

[156] Fix | Delete

* @param int|null $post_id Default current post ID.

[157] Fix | Delete

* @return array

[158] Fix | Delete

*/

[159] Fix | Delete

protected function get_primary_term_taxonomies( $post_id = null ) {

[160] Fix | Delete

if ( $post_id === null ) {

[161] Fix | Delete

$post_id = $this->get_current_id();

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

$taxonomies = wp_cache_get( 'primary_term_taxonomies_' . $post_id, 'wpseo' );

[165] Fix | Delete

if ( $taxonomies !== false ) {

[166] Fix | Delete

return $taxonomies;

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

$taxonomies = $this->generate_primary_term_taxonomies( $post_id );

[170] Fix | Delete

[171] Fix | Delete

wp_cache_set( 'primary_term_taxonomies_' . $post_id, $taxonomies, 'wpseo' );

[172] Fix | Delete

[173] Fix | Delete

return $taxonomies;

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Includes templates file.

[178] Fix | Delete

*

[179] Fix | Delete

* @return void

[180] Fix | Delete

*/

[181] Fix | Delete

protected function include_js_templates() {

[182] Fix | Delete

include_once WPSEO_PATH . 'admin/views/js-templates-primary-term.php';

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* Generates the primary term taxonomies.

[187] Fix | Delete

*

[188] Fix | Delete

* @param int $post_id ID of the post.

[189] Fix | Delete

*

[190] Fix | Delete

* @return array

[191] Fix | Delete

*/

[192] Fix | Delete

protected function generate_primary_term_taxonomies( $post_id ) {

[193] Fix | Delete

$post_type = get_post_type( $post_id );

[194] Fix | Delete

$all_taxonomies = get_object_taxonomies( $post_type, 'objects' );

[195] Fix | Delete

$all_taxonomies = array_filter( $all_taxonomies, [ $this, 'filter_hierarchical_taxonomies' ] );

[196] Fix | Delete

[197] Fix | Delete

/**

[198] Fix | Delete

* Filters which taxonomies for which the user can choose the primary term.

[199] Fix | Delete

*

[200] Fix | Delete

* @param array $taxonomies An array of taxonomy objects that are primary_term enabled.

[201] Fix | Delete

* @param string $post_type The post type for which to filter the taxonomies.

[202] Fix | Delete

* @param array $all_taxonomies All taxonomies for this post types, even ones that don't have primary term

[203] Fix | Delete

* enabled.

[204] Fix | Delete

*/

[205] Fix | Delete

$taxonomies = (array) apply_filters( 'wpseo_primary_term_taxonomies', $all_taxonomies, $post_type, $all_taxonomies );

[206] Fix | Delete

[207] Fix | Delete

return $taxonomies;

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

/**

[211] Fix | Delete

* Creates a map of taxonomies for localization.

[212] Fix | Delete

*

[213] Fix | Delete

* @param array $taxonomies The taxononmies that should be mapped.

[214] Fix | Delete

*

[215] Fix | Delete

* @return array The mapped taxonomies.

[216] Fix | Delete

*/

[217] Fix | Delete

protected function get_mapped_taxonomies_for_js( $taxonomies ) {

[218] Fix | Delete

return array_map( [ $this, 'map_taxonomies_for_js' ], $taxonomies );

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Returns an array suitable for use in the javascript.

[223] Fix | Delete

*

[224] Fix | Delete

* @param stdClass $taxonomy The taxonomy to map.

[225] Fix | Delete

*

[226] Fix | Delete

* @return array The mapped taxonomy.

[227] Fix | Delete

*/

[228] Fix | Delete

private function map_taxonomies_for_js( $taxonomy ) {

[229] Fix | Delete

$primary_term = $this->get_primary_term( $taxonomy->name );

[230] Fix | Delete

[231] Fix | Delete

if ( empty( $primary_term ) ) {

[232] Fix | Delete

$primary_term = '';

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

$terms = get_terms(

[236] Fix | Delete

[

[237] Fix | Delete

'taxonomy' => $taxonomy->name,

[238] Fix | Delete

'update_term_meta_cache' => false,

[239] Fix | Delete

'fields' => 'id=>name',

[240] Fix | Delete

]

[241] Fix | Delete

);

[242] Fix | Delete

[243] Fix | Delete

$mapped_terms_for_js = [];

[244] Fix | Delete

foreach ( $terms as $id => $name ) {

[245] Fix | Delete

$mapped_terms_for_js[] = [

[246] Fix | Delete

'id' => $id,

[247] Fix | Delete

'name' => $name,

[248] Fix | Delete

];

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

return [

[252] Fix | Delete

'title' => $taxonomy->labels->singular_name,

[253] Fix | Delete

'name' => $taxonomy->name,

[254] Fix | Delete

'primary' => $primary_term,

[255] Fix | Delete

'singularLabel' => $taxonomy->labels->singular_name,

[256] Fix | Delete

'fieldId' => $this->generate_field_id( $taxonomy->name ),

[257] Fix | Delete

'restBase' => ( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name,

[258] Fix | Delete

'terms' => $mapped_terms_for_js,

[259] Fix | Delete

];

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Returns whether or not a taxonomy is hierarchical.

[264] Fix | Delete

*

[265] Fix | Delete

* @param stdClass $taxonomy Taxonomy object.

[266] Fix | Delete

*

[267] Fix | Delete

* @return bool

[268] Fix | Delete

*/

[269] Fix | Delete

private function filter_hierarchical_taxonomies( $taxonomy ) {

[270] Fix | Delete

return (bool) $taxonomy->hierarchical;

[271] Fix | Delete

}

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete