<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WPSEO\Internals

[4] Fix | Delete

* @since 1.5.4

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

// Avoid direct calls to this file.

[8] Fix | Delete

if ( ! defined( 'WPSEO_VERSION' ) ) {

[9] Fix | Delete

header( 'Status: 403 Forbidden' );

[10] Fix | Delete

header( 'HTTP/1.1 403 Forbidden' );

[11] Fix | Delete

exit();

[12] Fix | Delete

}

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Class: WPSEO_Replace_Vars.

[16] Fix | Delete

*

[17] Fix | Delete

* This class implements the replacing of `%%variable_placeholders%%` with their real value based on the current

[18] Fix | Delete

* requested page/post/cpt/etc in text strings.

[19] Fix | Delete

*/

[20] Fix | Delete

class WPSEO_Replace_Vars {

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Default post/page/cpt information.

[24] Fix | Delete

*

[25] Fix | Delete

* @var array

[26] Fix | Delete

*/

[27] Fix | Delete

protected $defaults = [

[28] Fix | Delete

'ID' => '',

[29] Fix | Delete

'name' => '',

[30] Fix | Delete

'post_author' => '',

[31] Fix | Delete

'post_content' => '',

[32] Fix | Delete

'post_date' => '',

[33] Fix | Delete

'post_excerpt' => '',

[34] Fix | Delete

'post_modified' => '',

[35] Fix | Delete

'post_title' => '',

[36] Fix | Delete

'taxonomy' => '',

[37] Fix | Delete

'term_id' => '',

[38] Fix | Delete

'term404' => '',

[39] Fix | Delete

];

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Current post/page/cpt information.

[43] Fix | Delete

*

[44] Fix | Delete

* @var stdClass

[45] Fix | Delete

*/

[46] Fix | Delete

protected $args;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Help texts for use in WPSEO -> Search appearance tabs.

[50] Fix | Delete

*

[51] Fix | Delete

* @var array

[52] Fix | Delete

*/

[53] Fix | Delete

protected static $help_texts = [];

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Register of additional variable replacements registered by other plugins/themes.

[57] Fix | Delete

*

[58] Fix | Delete

* @var array

[59] Fix | Delete

*/

[60] Fix | Delete

protected static $external_replacements = [];

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Setup the help texts and external replacements as statics so they will be available to all instances.

[64] Fix | Delete

*

[65] Fix | Delete

* @return void

[66] Fix | Delete

*/

[67] Fix | Delete

public static function setup_statics_once() {

[68] Fix | Delete

if ( self::$help_texts === [] ) {

[69] Fix | Delete

self::set_basic_help_texts();

[70] Fix | Delete

self::set_advanced_help_texts();

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

if ( self::$external_replacements === [] ) {

[74] Fix | Delete

/**

[75] Fix | Delete

* Action: 'wpseo_register_extra_replacements' - Allows for registration of additional

[76] Fix | Delete

* variables to replace.

[77] Fix | Delete

*/

[78] Fix | Delete

do_action( 'wpseo_register_extra_replacements' );

[79] Fix | Delete

}

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Register new replacement %%variables%%.

[84] Fix | Delete

* For use by other plugins/themes to register extra variables.

[85] Fix | Delete

*

[86] Fix | Delete

* @see wpseo_register_var_replacement() for a usage example.

[87] Fix | Delete

*

[88] Fix | Delete

* @param string $var_to_replace The name of the variable to replace, i.e. '%%var%%'.

[89] Fix | Delete

* Note: the surrounding %% are optional.

[90] Fix | Delete

* @param mixed $replace_function Function or method to call to retrieve the replacement value for the variable.

[91] Fix | Delete

* Uses the same format as add_filter/add_action function parameter and

[92] Fix | Delete

* should *return* the replacement value. DON'T echo it.

[93] Fix | Delete

* @param string $type Type of variable: 'basic' or 'advanced', defaults to 'advanced'.

[94] Fix | Delete

* @param string $help_text Help text to be added to the help tab for this variable.

[95] Fix | Delete

*

[96] Fix | Delete

* @return bool Whether the replacement function was succesfully registered.

[97] Fix | Delete

*/

[98] Fix | Delete

public static function register_replacement( $var_to_replace, $replace_function, $type = 'advanced', $help_text = '' ) {

[99] Fix | Delete

$success = false;

[100] Fix | Delete

[101] Fix | Delete

if ( is_string( $var_to_replace ) && $var_to_replace !== '' ) {

[102] Fix | Delete

$var_to_replace = self::remove_var_delimiter( $var_to_replace );

[103] Fix | Delete

[104] Fix | Delete

if ( preg_match( '`^[A-Z0-9_-]+$`i', $var_to_replace ) === false ) {

[105] Fix | Delete

trigger_error( esc_html__( 'A replacement variable can only contain alphanumeric characters, an underscore or a dash. Try renaming your variable.', 'wordpress-seo' ), E_USER_WARNING );

[106] Fix | Delete

}

[107] Fix | Delete

elseif ( strpos( $var_to_replace, 'cf_' ) === 0 || strpos( $var_to_replace, 'ct_' ) === 0 ) {

[108] Fix | Delete

trigger_error( esc_html__( 'A replacement variable can not start with "%%cf_" or "%%ct_" as these are reserved for the WPSEO standard variable variables for custom fields and custom taxonomies. Try making your variable name unique.', 'wordpress-seo' ), E_USER_WARNING );

[109] Fix | Delete

}

[110] Fix | Delete

elseif ( ! method_exists( self::class, 'retrieve_' . $var_to_replace ) ) {

[111] Fix | Delete

if ( $var_to_replace !== '' && ! isset( self::$external_replacements[ $var_to_replace ] ) ) {

[112] Fix | Delete

self::$external_replacements[ $var_to_replace ] = $replace_function;

[113] Fix | Delete

$replacement_variable = new WPSEO_Replacement_Variable( $var_to_replace, $var_to_replace, $help_text );

[114] Fix | Delete

self::register_help_text( $type, $replacement_variable );

[115] Fix | Delete

$success = true;

[116] Fix | Delete

}

[117] Fix | Delete

else {

[118] Fix | Delete

trigger_error( esc_html__( 'A replacement variable with the same name has already been registered. Try making your variable name unique.', 'wordpress-seo' ), E_USER_WARNING );

[119] Fix | Delete

}

[120] Fix | Delete

}

[121] Fix | Delete

else {

[122] Fix | Delete

trigger_error( esc_html__( 'You cannot overrule a WPSEO standard variable replacement by registering a variable with the same name. Use the "wpseo_replacements" filter instead to adjust the replacement value.', 'wordpress-seo' ), E_USER_WARNING );

[123] Fix | Delete

}

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

return $success;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Replace `%%variable_placeholders%%` with their real value based on the current requested page/post/cpt/etc.

[131] Fix | Delete

*

[132] Fix | Delete

* @param string $text The string to replace the variables in.

[133] Fix | Delete

* @param array $args The object some of the replacement values might come from,

[134] Fix | Delete

* could be a post, taxonomy or term.

[135] Fix | Delete

* @param array $omit Variables that should not be replaced by this function.

[136] Fix | Delete

*

[137] Fix | Delete

* @return string

[138] Fix | Delete

*/

[139] Fix | Delete

public function replace( $text, $args, $omit = [] ) {

[140] Fix | Delete

[141] Fix | Delete

$text = wp_strip_all_tags( $text );

[142] Fix | Delete

[143] Fix | Delete

// Let's see if we can bail super early.

[144] Fix | Delete

if ( strpos( $text, '%%' ) === false ) {

[145] Fix | Delete

return YoastSEO()->helpers->string->standardize_whitespace( $text );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

$args = (array) $args;

[149] Fix | Delete

if ( isset( $args['post_content'] ) && ! empty( $args['post_content'] ) ) {

[150] Fix | Delete

$args['post_content'] = YoastSEO()->helpers->string->strip_shortcode( $args['post_content'] );

[151] Fix | Delete

}

[152] Fix | Delete

if ( isset( $args['post_excerpt'] ) && ! empty( $args['post_excerpt'] ) ) {

[153] Fix | Delete

$args['post_excerpt'] = YoastSEO()->helpers->string->strip_shortcode( $args['post_excerpt'] );

[154] Fix | Delete

}

[155] Fix | Delete

$this->args = (object) wp_parse_args( $args, $this->defaults );

[156] Fix | Delete

[157] Fix | Delete

// Clean $omit array.

[158] Fix | Delete

if ( is_array( $omit ) && $omit !== [] ) {

[159] Fix | Delete

$omit = array_map( [ self::class, 'remove_var_delimiter' ], $omit );

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

$replacements = [];

[163] Fix | Delete

if ( preg_match_all( '`%%([^%]+(%%single)?)%%?`iu', $text, $matches ) ) {

[164] Fix | Delete

$replacements = $this->set_up_replacements( $matches, $omit );

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* Filter: 'wpseo_replacements' - Allow customization of the replacements before they are applied.

[169] Fix | Delete

*

[170] Fix | Delete

* @param array $replacements The replacements.

[171] Fix | Delete

* @param array $args The object some of the replacement values might come from,

[172] Fix | Delete

* could be a post, taxonomy or term.

[173] Fix | Delete

*/

[174] Fix | Delete

$replacements = apply_filters( 'wpseo_replacements', $replacements, $this->args );

[175] Fix | Delete

[176] Fix | Delete

// Do the actual replacements.

[177] Fix | Delete

if ( is_array( $replacements ) && $replacements !== [] ) {

[178] Fix | Delete

$text = str_replace(

[179] Fix | Delete

array_keys( $replacements ),

[180] Fix | Delete

// Make sure to exclude replacement values that are arrays e.g. coming from a custom field serialized value.

[181] Fix | Delete

array_filter( array_values( $replacements ), 'is_scalar' ),

[182] Fix | Delete

$text

[183] Fix | Delete

);

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Filter: 'wpseo_replacements_final' - Allow overruling of whether or not to remove placeholders

[188] Fix | Delete

* which didn't yield a replacement.

[189] Fix | Delete

*

[190] Fix | Delete

* @example <code>add_filter( 'wpseo_replacements_final', '__return_false' );</code>

[191] Fix | Delete

*

[192] Fix | Delete

* @param bool $final

[193] Fix | Delete

*/

[194] Fix | Delete

if ( apply_filters( 'wpseo_replacements_final', true ) === true && ( isset( $matches[1] ) && is_array( $matches[1] ) ) ) {

[195] Fix | Delete

// Remove non-replaced variables.

[196] Fix | Delete

$remove = array_diff( $matches[1], $omit ); // Make sure the $omit variables do not get removed.

[197] Fix | Delete

$remove = array_map( [ self::class, 'add_var_delimiter' ], $remove );

[198] Fix | Delete

$text = str_replace( $remove, '', $text );

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

// Undouble separators which have nothing between them, i.e. where a non-replaced variable was removed.

[202] Fix | Delete

if ( isset( $replacements['%%sep%%'] ) && ( is_string( $replacements['%%sep%%'] ) && $replacements['%%sep%%'] !== '' ) ) {

[203] Fix | Delete

$q_sep = preg_quote( $replacements['%%sep%%'], '`' );

[204] Fix | Delete

$text = preg_replace( '`' . $q_sep . '(?:\s*' . $q_sep . ')*`u', $replacements['%%sep%%'], $text );

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

// Remove superfluous whitespace.

[208] Fix | Delete

$text = YoastSEO()->helpers->string->standardize_whitespace( $text );

[209] Fix | Delete

[210] Fix | Delete

return $text;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Register a new replacement variable if it has not been registered already.

[215] Fix | Delete

*

[216] Fix | Delete

* @param string $var_to_replace The name of the variable to replace, i.e. '%%var%%'.

[217] Fix | Delete

* Note: the surrounding %% are optional.

[218] Fix | Delete

* @param mixed $replace_function Function or method to call to retrieve the replacement value for the variable.

[219] Fix | Delete

* Uses the same format as add_filter/add_action function parameter and

[220] Fix | Delete

* should *return* the replacement value. DON'T echo it.

[221] Fix | Delete

* @param string $type Type of variable: 'basic' or 'advanced', defaults to 'advanced'.

[222] Fix | Delete

* @param string $help_text Help text to be added to the help tab for this variable.

[223] Fix | Delete

*

[224] Fix | Delete

* @return bool `true` if the replace var has been registered, `false` if not.

[225] Fix | Delete

*/

[226] Fix | Delete

public function safe_register_replacement( $var_to_replace, $replace_function, $type = 'advanced', $help_text = '' ) {

[227] Fix | Delete

if ( ! $this->has_been_registered( $var_to_replace ) ) {

[228] Fix | Delete

return self::register_replacement( $var_to_replace, $replace_function, $type, $help_text );

[229] Fix | Delete

}

[230] Fix | Delete

return false;

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Checks whether the given replacement variable has already been registered or not.

[235] Fix | Delete

*

[236] Fix | Delete

* @param string $replacement_variable The replacement variable to check, including the variable delimiter (e.g. `%%var%%`).

[237] Fix | Delete

*

[238] Fix | Delete

* @return bool `true` if the replacement variable has already been registered.

[239] Fix | Delete

*/

[240] Fix | Delete

public function has_been_registered( $replacement_variable ) {

[241] Fix | Delete

$replacement_variable = self::remove_var_delimiter( $replacement_variable );

[242] Fix | Delete

[243] Fix | Delete

return isset( self::$external_replacements[ $replacement_variable ] );

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Returns the list of hidden replace vars.

[248] Fix | Delete

*

[249] Fix | Delete

* E.g. the replace vars that should work, but are not advertised.

[250] Fix | Delete

*

[251] Fix | Delete

* @return string[] The list of hidden replace vars.

[252] Fix | Delete

*/

[253] Fix | Delete

public function get_hidden_replace_vars() {

[254] Fix | Delete

return [

[255] Fix | Delete

'currentdate',

[256] Fix | Delete

'currentyear',

[257] Fix | Delete

'currentmonth',

[258] Fix | Delete

'currentday',

[259] Fix | Delete

'post_year',

[260] Fix | Delete

'post_month',

[261] Fix | Delete

'post_day',

[262] Fix | Delete

'author_first_name',

[263] Fix | Delete

'author_last_name',

[264] Fix | Delete

'permalink',

[265] Fix | Delete

'post_content',

[266] Fix | Delete

'category_title',

[267] Fix | Delete

];

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Retrieve the replacements for the variables found.

[272] Fix | Delete

*

[273] Fix | Delete

* @param array $matches Variables found in the original string - regex result.

[274] Fix | Delete

* @param array $omit Variables that should not be replaced by this function.

[275] Fix | Delete

*

[276] Fix | Delete

* @return array Retrieved replacements - this might be a smaller array as some variables

[277] Fix | Delete

* may not yield a replacement in certain contexts.

[278] Fix | Delete

*/

[279] Fix | Delete

private function set_up_replacements( $matches, $omit ) {

[280] Fix | Delete

[281] Fix | Delete

$replacements = [];

[282] Fix | Delete

[283] Fix | Delete

// @todo Figure out a way to deal with external functions starting with cf_/ct_.

[284] Fix | Delete

foreach ( $matches[1] as $k => $var ) {

[285] Fix | Delete

[286] Fix | Delete

// Don't set up replacements which should be omitted.

[287] Fix | Delete

if ( in_array( $var, $omit, true ) ) {

[288] Fix | Delete

continue;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

// Deal with variable variable names first.

[292] Fix | Delete

if ( strpos( $var, 'cf_' ) === 0 ) {

[293] Fix | Delete

$replacement = $this->retrieve_cf_custom_field_name( $var );

[294] Fix | Delete

}

[295] Fix | Delete

elseif ( strpos( $var, 'ct_desc_' ) === 0 ) {

[296] Fix | Delete

$replacement = $this->retrieve_ct_desc_custom_tax_name( $var );

[297] Fix | Delete

}

[298] Fix | Delete

elseif ( strpos( $var, 'ct_' ) === 0 ) {

[299] Fix | Delete

$single = ( isset( $matches[2][ $k ] ) && $matches[2][ $k ] !== '' );

[300] Fix | Delete

$replacement = $this->retrieve_ct_custom_tax_name( $var, $single );

[301] Fix | Delete

}

[302] Fix | Delete

// Deal with non-variable variable names.

[303] Fix | Delete

elseif ( method_exists( $this, 'retrieve_' . $var ) ) {

[304] Fix | Delete

$method_name = 'retrieve_' . $var;

[305] Fix | Delete

$replacement = $this->$method_name();

[306] Fix | Delete

}

[307] Fix | Delete

// Deal with externally defined variable names.

[308] Fix | Delete

elseif ( isset( self::$external_replacements[ $var ] ) && ! is_null( self::$external_replacements[ $var ] ) ) {

[309] Fix | Delete

$replacement = call_user_func( self::$external_replacements[ $var ], $var, $this->args );

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

// Replacement retrievals can return null if no replacement can be determined, root those outs.

[313] Fix | Delete

if ( isset( $replacement ) ) {

[314] Fix | Delete

$var = self::add_var_delimiter( $var );

[315] Fix | Delete

$replacements[ $var ] = $replacement;

[316] Fix | Delete

}

[317] Fix | Delete

unset( $replacement, $single, $method_name );

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

return $replacements;

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

/* *********************** BASIC VARIABLES ************************** */

[324] Fix | Delete

[325] Fix | Delete

/**

[326] Fix | Delete

* Retrieve the post/cpt categories (comma separated) for use as replacement string.

[327] Fix | Delete

*

[328] Fix | Delete

* @return string|null

[329] Fix | Delete

*/

[330] Fix | Delete

private function retrieve_category() {

[331] Fix | Delete

$replacement = null;

[332] Fix | Delete

[333] Fix | Delete

if ( ! empty( $this->args->ID ) ) {

[334] Fix | Delete

$cat = $this->get_terms( $this->args->ID, 'category' );

[335] Fix | Delete

if ( $cat !== '' ) {

[336] Fix | Delete

return $cat;

[337] Fix | Delete

}

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

if ( isset( $this->args->cat_name ) && ! empty( $this->args->cat_name ) ) {

[341] Fix | Delete

$replacement = $this->args->cat_name;

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

return $replacement;

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

/**

[348] Fix | Delete

* Retrieve the category description for use as replacement string.

[349] Fix | Delete

*

[350] Fix | Delete

* @return string|null

[351] Fix | Delete

*/

[352] Fix | Delete

private function retrieve_category_description() {

[353] Fix | Delete

return $this->retrieve_term_description();

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

/**

[357] Fix | Delete

* Retrieve the date of the post/page/cpt for use as replacement string.

[358] Fix | Delete

*

[359] Fix | Delete

* @return string|null

[360] Fix | Delete

*/

[361] Fix | Delete

private function retrieve_date() {

[362] Fix | Delete

$replacement = null;

[363] Fix | Delete

[364] Fix | Delete

if ( $this->args->post_date !== '' ) {

[365] Fix | Delete

// Returns a string.

[366] Fix | Delete

$replacement = YoastSEO()->helpers->date->format_translated( $this->args->post_date, get_option( 'date_format' ) );

[367] Fix | Delete

}

[368] Fix | Delete

elseif ( get_query_var( 'day' ) && get_query_var( 'day' ) !== '' ) {

[369] Fix | Delete

// Returns a string.

[370] Fix | Delete

$replacement = get_the_date();

[371] Fix | Delete

}

[372] Fix | Delete

elseif ( single_month_title( ' ', false ) && single_month_title( ' ', false ) !== '' ) {

[373] Fix | Delete

// Returns a string.

[374] Fix | Delete

$replacement = single_month_title( ' ', false );

[375] Fix | Delete

}

[376] Fix | Delete

elseif ( get_query_var( 'year' ) !== '' ) {

[377] Fix | Delete

// Returns an integer, let's cast to string.

[378] Fix | Delete

$replacement = (string) get_query_var( 'year' );

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

return $replacement;

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

/**

[385] Fix | Delete

* Retrieve the post/page/cpt excerpt for use as replacement string.

[386] Fix | Delete

* The excerpt will be auto-generated if it does not exist.

[387] Fix | Delete

*

[388] Fix | Delete

* @return string|null

[389] Fix | Delete

*/

[390] Fix | Delete

private function retrieve_excerpt() {

[391] Fix | Delete

$replacement = null;

[392] Fix | Delete

$locale = get_locale();

[393] Fix | Delete

[394] Fix | Delete

// Japanese doesn't have a jp_JP variant in WP.

[395] Fix | Delete

$limit = ( $locale === 'ja' ) ? 80 : 156;

[396] Fix | Delete

[397] Fix | Delete

// The check `post_password_required` is because excerpt must be hidden for a post with a password.

[398] Fix | Delete

if ( ! empty( $this->args->ID ) && ! post_password_required( $this->args->ID ) ) {

[399] Fix | Delete

if ( $this->args->post_excerpt !== '' ) {

[400] Fix | Delete

$replacement = wp_strip_all_tags( $this->args->post_excerpt );

[401] Fix | Delete

}

[402] Fix | Delete

elseif ( $this->args->post_content !== '' ) {

[403] Fix | Delete

$content = strip_shortcodes( $this->args->post_content );

[404] Fix | Delete

$content = wp_strip_all_tags( $content );

[405] Fix | Delete

[406] Fix | Delete

if ( mb_strlen( $content ) <= $limit ) {

[407] Fix | Delete

return $content;

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

$replacement = wp_html_excerpt( $content, $limit );

[411] Fix | Delete

[412] Fix | Delete

// Check if the description has space and trim the auto-generated string to a word boundary.

[413] Fix | Delete

if ( strrpos( $replacement, ' ' ) ) {

[414] Fix | Delete

$replacement = substr( $replacement, 0, strrpos( $replacement, ' ' ) );

[415] Fix | Delete

}

[416] Fix | Delete

}

[417] Fix | Delete

}

[418] Fix | Delete

[419] Fix | Delete

return $replacement;

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

/**

[423] Fix | Delete

* Retrieve the post/page/cpt excerpt for use as replacement string (without auto-generation).

[424] Fix | Delete

*

[425] Fix | Delete

* @return string|null

[426] Fix | Delete

*/

[427] Fix | Delete

private function retrieve_excerpt_only() {

[428] Fix | Delete

$replacement = null;

[429] Fix | Delete

[430] Fix | Delete

// The check `post_password_required` is because excerpt must be hidden for a post with a password.

[431] Fix | Delete

if ( ! empty( $this->args->ID ) && $this->args->post_excerpt !== '' && ! post_password_required( $this->args->ID ) ) {

[432] Fix | Delete

$replacement = wp_strip_all_tags( $this->args->post_excerpt );

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

return $replacement;

[436] Fix | Delete

}

[437] Fix | Delete

[438] Fix | Delete

/**

[439] Fix | Delete

* Retrieve the title of the parent page of the current page/cpt for use as replacement string.

[440] Fix | Delete

* Only applicable for hierarchical post types.

[441] Fix | Delete

*

[442] Fix | Delete

* @todo Check: shouldn't this use $this->args as well ?

[443] Fix | Delete

*

[444] Fix | Delete

* @return string|null

[445] Fix | Delete

*/

[446] Fix | Delete

private function retrieve_parent_title() {

[447] Fix | Delete

$replacement = null;

[448] Fix | Delete

[449] Fix | Delete

if ( ! empty( $this->args->ID ) ) {

[450] Fix | Delete

$parent_id = wp_get_post_parent_id( $this->args->ID );

[451] Fix | Delete

if ( $parent_id ) {

[452] Fix | Delete

$replacement = get_the_title( $parent_id );

[453] Fix | Delete

}

[454] Fix | Delete

}

[455] Fix | Delete

[456] Fix | Delete

return $replacement;

[457] Fix | Delete

}

[458] Fix | Delete

[459] Fix | Delete

/**

[460] Fix | Delete

* Retrieve the current search phrase for use as replacement string.

[461] Fix | Delete

*

[462] Fix | Delete

* @return string|null

[463] Fix | Delete

*/

[464] Fix | Delete

private function retrieve_searchphrase() {

[465] Fix | Delete

$replacement = null;

[466] Fix | Delete

[467] Fix | Delete

$search = get_query_var( 's' );

[468] Fix | Delete

if ( $search !== '' ) {

[469] Fix | Delete

$replacement = esc_html( $search );

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

return $replacement;

[473] Fix | Delete

}

[474] Fix | Delete

[475] Fix | Delete

/**

[476] Fix | Delete

* Retrieve the separator for use as replacement string.

[477] Fix | Delete

*

[478] Fix | Delete

* @return string Retrieves the title separator.

[479] Fix | Delete

*/

[480] Fix | Delete

private function retrieve_sep() {

[481] Fix | Delete

return YoastSEO()->helpers->options->get_title_separator();

[482] Fix | Delete

}

[483] Fix | Delete

[484] Fix | Delete

/**

[485] Fix | Delete

* Retrieve the site's tag line / description for use as replacement string.

[486] Fix | Delete

*

[487] Fix | Delete

* The `$replacement` variable is static because it doesn't change depending

[488] Fix | Delete

* on the context. See https://github.com/Yoast/wordpress-seo/pull/1172#issuecomment-46019482.

[489] Fix | Delete

*

[490] Fix | Delete

* @return string|null

[491] Fix | Delete

*/

[492] Fix | Delete

private function retrieve_sitedesc() {

[493] Fix | Delete

static $replacement;

[494] Fix | Delete

[495] Fix | Delete

if ( ! isset( $replacement ) ) {

[496] Fix | Delete

$description = wp_strip_all_tags( get_bloginfo( 'description' ) );

[497] Fix | Delete

if ( $description !== '' ) {

[498] Fix | Delete

$replacement = $description;

[499] Fix | Delete