Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Formatter

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* This class provides data for the term metabox by return its values for localization.

[8] Fix | Delete

[9] Fix | Delete

class WPSEO_Term_Metabox_Formatter implements WPSEO_Metabox_Formatter_Interface {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* The term the metabox formatter is for.

[13] Fix | Delete

[14] Fix | Delete

* @var WP_Term|stdClass

[15] Fix | Delete

[16] Fix | Delete

private $term;

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* The term's taxonomy.

[20] Fix | Delete

[21] Fix | Delete

* @var stdClass

[22] Fix | Delete

[23] Fix | Delete

private $taxonomy;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Whether we must return social templates values.

[27] Fix | Delete

[28] Fix | Delete

* @var bool

[29] Fix | Delete

[30] Fix | Delete

private $use_social_templates = false;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Array with the WPSEO_Titles options.

[34] Fix | Delete

[35] Fix | Delete

* @var array

[36] Fix | Delete

[37] Fix | Delete

protected $options;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* WPSEO_Taxonomy_Scraper constructor.

[41] Fix | Delete

[42] Fix | Delete

* @param stdClass $taxonomy Taxonomy.

[43] Fix | Delete

* @param WP_Term|stdClass $term Term.

[44] Fix | Delete

[45] Fix | Delete

public function __construct( $taxonomy, $term ) {

[46] Fix | Delete

$this->taxonomy = $taxonomy;

[47] Fix | Delete

$this->term = $term;

[48] Fix | Delete

[49] Fix | Delete

$this->use_social_templates = $this->use_social_templates();

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Determines whether the social templates should be used.

[54] Fix | Delete

[55] Fix | Delete

* @return bool Whether the social templates should be used.

[56] Fix | Delete

[57] Fix | Delete

public function use_social_templates() {

[58] Fix | Delete

return WPSEO_Options::get( 'opengraph', false ) === true;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Returns the translated values.

[63] Fix | Delete

[64] Fix | Delete

* @return array

[65] Fix | Delete

[66] Fix | Delete

public function get_values() {

[67] Fix | Delete

$values = [];

[68] Fix | Delete

[69] Fix | Delete

// Todo: a column needs to be added on the termpages to add a filter for the keyword, so this can be used in the focus keyphrase doubles.

[70] Fix | Delete

if ( is_object( $this->term ) && property_exists( $this->term, 'taxonomy' ) ) {

[71] Fix | Delete

$values = [

[72] Fix | Delete

'search_url' => $this->search_url(),

[73] Fix | Delete

'post_edit_url' => $this->edit_url(),

[74] Fix | Delete

'base_url' => $this->base_url_for_js(),

[75] Fix | Delete

'taxonomy' => $this->term->taxonomy,

[76] Fix | Delete

'keyword_usage' => $this->get_focus_keyword_usage(),

[77] Fix | Delete

'title_template' => $this->get_title_template(),

[78] Fix | Delete

'title_template_no_fallback' => $this->get_title_template( false ),

[79] Fix | Delete

'metadesc_template' => $this->get_metadesc_template(),

[80] Fix | Delete

'first_content_image' => $this->get_image_url(),

[81] Fix | Delete

'semrushIntegrationActive' => 0,

[82] Fix | Delete

'social_title_template' => $this->get_social_title_template(),

[83] Fix | Delete

'social_description_template' => $this->get_social_description_template(),

[84] Fix | Delete

'social_image_template' => $this->get_social_image_template(),

[85] Fix | Delete

'wincherIntegrationActive' => 0,

[86] Fix | Delete

'isInsightsEnabled' => $this->is_insights_enabled(),

[87] Fix | Delete

];

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

return $values;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Gets the image URL for the term's social preview.

[95] Fix | Delete

[96] Fix | Delete

* @return string|null The image URL for the social preview.

[97] Fix | Delete

[98] Fix | Delete

protected function get_image_url() {

[99] Fix | Delete

return WPSEO_Image_Utils::get_first_content_image_for_term( $this->term->term_id );

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Returns the url to search for keyword for the taxonomy.

[104] Fix | Delete

[105] Fix | Delete

* @return string

[106] Fix | Delete

[107] Fix | Delete

private function search_url() {

[108] Fix | Delete

return admin_url( 'edit-tags.php?taxonomy=' . $this->term->taxonomy . '&seo_kw_filter={keyword}' );

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Returns the url to edit the taxonomy.

[113] Fix | Delete

[114] Fix | Delete

* @return string

[115] Fix | Delete

[116] Fix | Delete

private function edit_url() {

[117] Fix | Delete

return admin_url( 'term.php?action=edit&taxonomy=' . $this->term->taxonomy . '&tag_ID={id}' );

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Returns a base URL for use in the JS, takes permalink structure into account.

[122] Fix | Delete

[123] Fix | Delete

* @return string

[124] Fix | Delete

[125] Fix | Delete

private function base_url_for_js() {

[126] Fix | Delete

[127] Fix | Delete

$base_url = home_url( '/', null );

[128] Fix | Delete

if ( ! WPSEO_Options::get( 'stripcategorybase', false ) ) {

[129] Fix | Delete

if ( $this->taxonomy->rewrite ) {

[130] Fix | Delete

$base_url = trailingslashit( $base_url . $this->taxonomy->rewrite['slug'] );

[131] Fix | Delete

}

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

return $base_url;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

/**

[138] Fix | Delete

* Counting the number of given keyword used for other term than given term_id.

[139] Fix | Delete

[140] Fix | Delete

* @return array

[141] Fix | Delete

[142] Fix | Delete

private function get_focus_keyword_usage() {

[143] Fix | Delete

$focuskw = WPSEO_Taxonomy_Meta::get_term_meta( $this->term, $this->term->taxonomy, 'focuskw' );

[144] Fix | Delete

[145] Fix | Delete

return WPSEO_Taxonomy_Meta::get_keyword_usage( $focuskw, $this->term->term_id, $this->term->taxonomy );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Retrieves the title template.

[150] Fix | Delete

[151] Fix | Delete

* @param bool $fallback Whether to return the hardcoded fallback if the template value is empty.

[152] Fix | Delete

[153] Fix | Delete

* @return string The title template.

[154] Fix | Delete

[155] Fix | Delete

private function get_title_template( $fallback = true ) {

[156] Fix | Delete

$title = $this->get_template( 'title' );

[157] Fix | Delete

[158] Fix | Delete

if ( $title === '' && $fallback === true ) {

[159] Fix | Delete

/* translators: %s expands to the variable used for term title. */

[160] Fix | Delete

$archives = sprintf( __( '%s Archives', 'wordpress-seo' ), '%%term_title%%' );

[161] Fix | Delete

return $archives . ' %%page%% %%sep%% %%sitename%%';

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

return $title;

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* Retrieves the metadesc template.

[169] Fix | Delete

[170] Fix | Delete

* @return string The metadesc template.

[171] Fix | Delete

[172] Fix | Delete

private function get_metadesc_template() {

[173] Fix | Delete

return $this->get_template( 'metadesc' );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Retrieves the social title template.

[178] Fix | Delete

[179] Fix | Delete

* @return string The social title template.

[180] Fix | Delete

[181] Fix | Delete

private function get_social_title_template() {

[182] Fix | Delete

if ( $this->use_social_templates ) {

[183] Fix | Delete

return $this->get_social_template( 'title' );

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

return '';

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Retrieves the social description template.

[191] Fix | Delete

[192] Fix | Delete

* @return string The social description template.

[193] Fix | Delete

[194] Fix | Delete

private function get_social_description_template() {

[195] Fix | Delete

if ( $this->use_social_templates ) {

[196] Fix | Delete

return $this->get_social_template( 'description' );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

return '';

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Retrieves the social image template.

[204] Fix | Delete

[205] Fix | Delete

* @return string The social description template.

[206] Fix | Delete

[207] Fix | Delete

private function get_social_image_template() {

[208] Fix | Delete

if ( $this->use_social_templates ) {

[209] Fix | Delete

return $this->get_social_template( 'image-url' );

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

return '';

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* Retrieves a template.

[217] Fix | Delete

[218] Fix | Delete

* @param string $template_option_name The name of the option in which the template you want to get is saved.

[219] Fix | Delete

[220] Fix | Delete

* @return string

[221] Fix | Delete

[222] Fix | Delete

private function get_template( $template_option_name ) {

[223] Fix | Delete

$needed_option = $template_option_name . '-tax-' . $this->term->taxonomy;

[224] Fix | Delete

return WPSEO_Options::get( $needed_option, '' );

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

/**

[228] Fix | Delete

* Retrieves a social template.

[229] Fix | Delete

[230] Fix | Delete

* @param string $template_option_name The name of the option in which the template you want to get is saved.

[231] Fix | Delete

[232] Fix | Delete

* @return string

[233] Fix | Delete

[234] Fix | Delete

private function get_social_template( $template_option_name ) {

[235] Fix | Delete

/**

[236] Fix | Delete

* Filters the social template value for a given taxonomy.

[237] Fix | Delete

[238] Fix | Delete

* @param string $template The social template value, defaults to empty string.

[239] Fix | Delete

* @param string $template_option_name The subname of the option in which the template you want to get is saved.

[240] Fix | Delete

* @param string $taxonomy The name of the taxonomy.

[241] Fix | Delete

[242] Fix | Delete

return apply_filters( 'wpseo_social_template_taxonomy', '', $template_option_name, $this->term->taxonomy );

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Determines whether the insights feature is enabled for this taxonomy.

[247] Fix | Delete

[248] Fix | Delete

* @return bool

[249] Fix | Delete

[250] Fix | Delete

protected function is_insights_enabled() {

[251] Fix | Delete

return WPSEO_Options::get( 'enable_metabox_insights', false );

[252] Fix | Delete

}

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete