add_filter( 'wpseo_replacements_final', '__return_false' );
*
* @api bool $final
*/
if ( apply_filters( 'wpseo_replacements_final', true ) === true && ( isset( $matches[1] ) && is_array( $matches[1] ) ) ) {
// Remove non-replaced variables.
$remove = array_diff( $matches[1], $omit ); // Make sure the $omit variables do not get removed.
$remove = array_map( array( __CLASS__, 'add_var_delimiter' ), $remove );
$string = str_replace( $remove, '', $string );
}
// Undouble separators which have nothing between them, i.e. where a non-replaced variable was removed.
if ( isset( $replacements['%%sep%%'] ) && ( is_string( $replacements['%%sep%%'] ) && $replacements['%%sep%%'] !== '' ) ) {
$q_sep = preg_quote( $replacements['%%sep%%'], '`' );
$string = preg_replace( '`' . $q_sep . '(?:\s*' . $q_sep . ')*`u', $replacements['%%sep%%'], $string );
}
// Remove superfluous whitespace.
$string = WPSEO_Utils::standardize_whitespace( $string );
return $string;
}
/**
* Retrieve the replacements for the variables found.
*
* @param array $matches Variables found in the original string - regex result.
* @param array $omit Variables that should not be replaced by this function.
*
* @return array Retrieved replacements - this might be a smaller array as some variables
* may not yield a replacement in certain contexts.
*/
private function set_up_replacements( $matches, $omit ) {
$replacements = array();
// @todo -> Figure out a way to deal with external functions starting with cf_/ct_.
foreach ( $matches[1] as $k => $var ) {
// Don't set up replacements which should be omitted.
if ( in_array( $var, $omit, true ) ) {
continue;
}
// Deal with variable variable names first.
if ( strpos( $var, 'cf_' ) === 0 ) {
$replacement = $this->retrieve_cf_custom_field_name( $var );
}
elseif ( strpos( $var, 'ct_desc_' ) === 0 ) {
$replacement = $this->retrieve_ct_desc_custom_tax_name( $var );
}
elseif ( strpos( $var, 'ct_' ) === 0 ) {
$single = ( isset( $matches[2][ $k ] ) && $matches[2][ $k ] !== '' ) ? true : false;
$replacement = $this->retrieve_ct_custom_tax_name( $var, $single );
} // Deal with non-variable variable names.
elseif ( method_exists( $this, 'retrieve_' . $var ) ) {
$method_name = 'retrieve_' . $var;
$replacement = $this->$method_name();
} // Deal with externally defined variable names.
elseif ( isset( self::$external_replacements[ $var ] ) && ! is_null( self::$external_replacements[ $var ] ) ) {
$replacement = call_user_func( self::$external_replacements[ $var ], $var, $this->args );
}
// Replacement retrievals can return null if no replacement can be determined, root those outs.
if ( isset( $replacement ) ) {
$var = self::add_var_delimiter( $var );
$replacements[ $var ] = $replacement;
}
unset( $replacement, $single, $method_name );
}
return $replacements;
}
/* *********************** BASIC VARIABLES ************************** */
/**
* Retrieve the post/cpt categories (comma separated) for use as replacement string.
*
* @return string|null
*/
private function retrieve_category() {
$replacement = null;
if ( ! empty( $this->args->ID ) ) {
$cat = $this->get_terms( $this->args->ID, 'category' );
if ( $cat !== '' ) {
$replacement = $cat;
}
}
if ( ( ! isset( $replacement ) || $replacement === '' ) && ( isset( $this->args->cat_name ) && ! empty( $this->args->cat_name ) ) ) {
$replacement = $this->args->cat_name;
}
return $replacement;
}
/**
* Retrieve the category description for use as replacement string.
*
* @return string|null
*/
private function retrieve_category_description() {
return $this->retrieve_term_description();
}
/**
* Retrieve the date of the post/page/cpt for use as replacement string.
*
* @return string|null
*/
private function retrieve_date() {
$replacement = null;
if ( $this->args->post_date !== '' ) {
$replacement = mysql2date( get_option( 'date_format' ), $this->args->post_date, true );
}
else {
if ( get_query_var( 'day' ) && get_query_var( 'day' ) !== '' ) {
$replacement = get_the_date();
}
else {
if ( single_month_title( ' ', false ) && single_month_title( ' ', false ) !== '' ) {
$replacement = single_month_title( ' ', false );
}
elseif ( get_query_var( 'year' ) !== '' ) {
$replacement = get_query_var( 'year' );
}
}
}
return $replacement;
}
/**
* Retrieve the post/page/cpt excerpt for use as replacement string.
* The excerpt will be auto-generated if it does not exist.
*
* @return string|null
*/
private function retrieve_excerpt() {
$replacement = null;
// The check `post_password_required` is because excerpt must be hidden for a post with a password.
if ( ! empty( $this->args->ID ) && ! post_password_required( $this->args->ID ) ) {
if ( $this->args->post_excerpt !== '' ) {
$replacement = wp_strip_all_tags( $this->args->post_excerpt );
}
elseif ( $this->args->post_content !== '' ) {
$replacement = wp_html_excerpt( strip_shortcodes( $this->args->post_content ), 156 );
// Trim the auto-generated string to a word boundary.
$replacement = substr( $replacement, 0, strrpos( $replacement, ' ' ) );
}
}
return $replacement;
}
/**
* Retrieve the post/page/cpt excerpt for use as replacement string (without auto-generation).
*
* @return string|null
*/
private function retrieve_excerpt_only() {
$replacement = null;
// The check `post_password_required` is because excerpt must be hidden for a post with a password.
if ( ! empty( $this->args->ID ) && $this->args->post_excerpt !== '' && ! post_password_required( $this->args->ID ) ) {
$replacement = wp_strip_all_tags( $this->args->post_excerpt );
}
return $replacement;
}
/**
* Retrieve the title of the parent page of the current page/cpt for use as replacement string.
* Only applicable for hierarchical post types.
*
* @todo Check: shouldn't this use $this->args as well ?
*
* @return string|null
*/
private function retrieve_parent_title() {
$replacement = null;
if ( ! isset( $replacement ) && ( ( is_singular() || is_admin() ) && isset( $GLOBALS['post'] ) ) ) {
if ( isset( $GLOBALS['post']->post_parent ) && 0 !== $GLOBALS['post']->post_parent ) {
$replacement = get_the_title( $GLOBALS['post']->post_parent );
}
}
return $replacement;
}
/**
* Retrieve the current search phrase for use as replacement string.
*
* @return string|null
*/
private function retrieve_searchphrase() {
$replacement = null;
if ( ! isset( $replacement ) ) {
$search = get_query_var( 's' );
if ( $search !== '' ) {
$replacement = esc_html( $search );
}
}
return $replacement;
}
/**
* Retrieve the separator for use as replacement string.
*
* @return string
*/
private function retrieve_sep() {
return WPSEO_Utils::get_title_separator();
}
/**
* Retrieve the site's tag line / description for use as replacement string.
*
* @return string|null
*/
private function retrieve_sitedesc() {
static $replacement;
if ( ! isset( $replacement ) ) {
$description = wp_strip_all_tags( get_bloginfo( 'description' ) );
if ( $description !== '' ) {
$replacement = $description;
}
}
return $replacement;
}
/**
* Retrieve the site's name for use as replacement string.
*
* @return string|null
*/
private function retrieve_sitename() {
static $replacement;
if ( ! isset( $replacement ) ) {
$sitename = WPSEO_Utils::get_site_name();
if ( $sitename !== '' ) {
$replacement = $sitename;
}
}
return $replacement;
}
/**
* Retrieve the current tag/tags for use as replacement string.
*
* @return string|null
*/
private function retrieve_tag() {
$replacement = null;
if ( isset( $this->args->ID ) ) {
$tags = $this->get_terms( $this->args->ID, 'post_tag' );
if ( $tags !== '' ) {
$replacement = $tags;
}
}
return $replacement;
}
/**
* Retrieve the tag description for use as replacement string.
*
* @return string|null
*/
private function retrieve_tag_description() {
return $this->retrieve_term_description();
}
/**
* Retrieve the term description for use as replacement string.
*
* @return string|null
*/
private function retrieve_term_description() {
$replacement = null;
if ( isset( $this->args->term_id ) && ! empty( $this->args->taxonomy ) ) {
$term_desc = get_term_field( 'description', $this->args->term_id, $this->args->taxonomy );
if ( $term_desc !== '' ) {
$replacement = wp_strip_all_tags( $term_desc );
}
}
return $replacement;
}
/**
* Retrieve the term name for use as replacement string.
*
* @return string|null
*/
private function retrieve_term_title() {
$replacement = null;
if ( ! empty( $this->args->taxonomy ) && ! empty( $this->args->name ) ) {
$replacement = $this->args->name;
}
return $replacement;
}
/**
* Retrieve the title of the post/page/cpt for use as replacement string.
*
* @return string|null
*/
private function retrieve_title() {
$replacement = null;
if ( is_string( $this->args->post_title ) && $this->args->post_title !== '' ) {
$replacement = stripslashes( $this->args->post_title );
}
return $replacement;
}
/**
* Retrieve primary category for use as replacement string.
*
* @return bool|int|null
*/
private function retrieve_primary_category() {
$primary_category = null;
if ( ! empty( $this->args->ID ) ) {
$wpseo_primary_category = new WPSEO_Primary_Term( 'category', $this->args->ID );
$term_id = $wpseo_primary_category->get_primary_term();
$term = get_term( $term_id );
if ( ! is_wp_error( $term ) && ! empty( $term ) ) {
$primary_category = $term->name;
}
}
return $primary_category;
}
/**
* Retrieve the string generated by get_the_archive_title().
*
* @return string|null
*/
private function retrieve_archive_title() {
return get_the_archive_title();
}
/* *********************** ADVANCED VARIABLES ************************** */
/**
* Determine the page numbering of the current post/page/cpt.
*
* @param string $request Either 'nr'|'max' - whether to return the page number or the max number of pages.
*
* @return int|null
*/
private function determine_pagenumbering( $request = 'nr' ) {
global $wp_query, $post;
$max_num_pages = null;
$page_number = null;
$max_num_pages = 1;
if ( ! is_singular() ) {
$page_number = get_query_var( 'paged' );
if ( $page_number === 0 || $page_number === '' ) {
$page_number = 1;
}
if ( ! empty( $wp_query->max_num_pages ) ) {
$max_num_pages = $wp_query->max_num_pages;
}
}
else {
$page_number = get_query_var( 'page' );
if ( $page_number === 0 || $page_number === '' ) {
$page_number = 1;
}
if ( isset( $post->post_content ) ) {
$max_num_pages = ( substr_count( $post->post_content, '' ) + 1 );
}
}
$return = null;
switch ( $request ) {
case 'nr':
$return = $page_number;
break;
case 'max':
$return = $max_num_pages;
break;
}
return $return;
}
/**
* Determine the post type names for the current post/page/cpt.
*
* @param string $request Either 'single'|'plural' - whether to return the single or plural form.
*
* @return string|null
*/
private function determine_pt_names( $request = 'single' ) {
global $wp_query;
$pt_single = null;
$pt_plural = null;
$post_type = '';
if ( isset( $wp_query->query_vars['post_type'] ) && ( ( is_string( $wp_query->query_vars['post_type'] ) && $wp_query->query_vars['post_type'] !== '' ) || ( is_array( $wp_query->query_vars['post_type'] ) && $wp_query->query_vars['post_type'] !== array() ) ) ) {
$post_type = $wp_query->query_vars['post_type'];
}
elseif ( isset( $this->args->post_type ) && ( is_string( $this->args->post_type ) && $this->args->post_type !== '' ) ) {
$post_type = $this->args->post_type;
}
else {
// Make it work in preview mode.
$post = $wp_query->get_queried_object();
if ( $post instanceof WP_Post ) {
$post_type = $post->post_type;
}
}
if ( is_array( $post_type ) ) {
$post_type = reset( $post_type );
}
if ( $post_type !== '' ) {
$pt = get_post_type_object( $post_type );
$pt_single = $pt->name;
$pt_plural = $pt->name;
if ( isset( $pt->labels->singular_name ) ) {
$pt_single = $pt->labels->singular_name;
}
if ( isset( $pt->labels->name ) ) {
$pt_plural = $pt->labels->name;
}
}
$return = null;
switch ( $request ) {
case 'single':
$return = $pt_single;
break;
case 'plural':
$return = $pt_plural;
break;
}
return $return;
}
/**
* Retrieve the attachment caption for use as replacement string.
*
* @return string|null
*/
private function retrieve_caption() {
return $this->retrieve_excerpt_only();
}
/**
* Retrieve a post/page/cpt's custom field value for use as replacement string.
*
* @param string $var The complete variable to replace which includes the name of
* the custom field which value is to be retrieved.
*
* @return string|null
*/
private function retrieve_cf_custom_field_name( $var ) {
global $post;
$replacement = null;
if ( is_string( $var ) && $var !== '' ) {
$field = substr( $var, 3 );
if ( ( is_singular() || is_admin() ) && ( is_object( $post ) && isset( $post->ID ) ) ) {
$name = get_post_meta( $post->ID, $field, true );
if ( $name !== '' ) {
$replacement = $name;
}
}
}
return $replacement;
}
/**
* Retrieve a post/page/cpt's custom taxonomies for use as replacement string.
*
* @param string $var The complete variable to replace which includes the name of
* the custom taxonomy which value(s) is to be retrieved.
* @param bool $single Whether to retrieve only the first or all values for the taxonomy.
*
* @return string|null
*/
private function retrieve_ct_custom_tax_name( $var, $single = false ) {
$replacement = null;
if ( ( is_string( $var ) && $var !== '' ) && ! empty( $this->args->ID ) ) {
$tax = substr( $var, 3 );
$name = $this->get_terms( $this->args->ID, $tax, $single );
if ( $name !== '' ) {
$replacement = $name;
}
}
return $replacement;
}
/**
* Retrieve a post/page/cpt's custom taxonomies description for use as replacement string.
*
* @param string $var The complete variable to replace which includes the name of
* the custom taxonomy which description is to be retrieved.
*
* @return string|null
*/
private function retrieve_ct_desc_custom_tax_name( $var ) {
global $post;
$replacement = null;
if ( is_string( $var ) && $var !== '' ) {
$tax = substr( $var, 8 );
if ( is_object( $post ) && isset( $post->ID ) ) {
$terms = get_the_terms( $post->ID, $tax );
if ( is_array( $terms ) && $terms !== array() ) {
$term = current( $terms );
$term_desc = get_term_field( 'description', $term->term_id, $tax );
if ( $term_desc !== '' ) {
$replacement = wp_strip_all_tags( $term_desc );
}
}
}
}
return $replacement;
}
/**
* Retrieve the current date for use as replacement string.
*
* @return string The formatted current date.
*/
private function retrieve_currentdate() {
static $replacement;
if ( ! isset( $replacement ) ) {
$replacement = date_i18n( get_option( 'date_format' ) );
}
return $replacement;
}
/**
* Retrieve the current day for use as replacement string.
*
* @return string The current day.
*/
private function retrieve_currentday() {
static $replacement;
if ( ! isset( $replacement ) ) {
$replacement = date_i18n( 'j' );
}
return $replacement;
}
/**
* Retrieve the current month for use as replacement string.
*
* @return string The current month.
*/
private function retrieve_currentmonth() {
static $replacement;
if ( ! isset( $replacement ) ) {
$replacement = date_i18n( 'F' );
}
return $replacement;
}
/**
* Retrieve the current time for use as replacement string.
*
* @return string The formatted current time.
*/
private function retrieve_currenttime() {
static $replacement;
if ( ! isset( $replacement ) ) {
$replacement = date_i18n( get_option( 'time_format' ) );
}
return $replacement;
}
/**
* Retrieve the current year for use as replacement string.
*
* @return string The current year.
*/
private function retrieve_currentyear() {
static $replacement;
if ( ! isset( $replacement ) ) {
$replacement = date_i18n( 'Y' );
}
return $replacement;
}
/**
* Retrieve the post/page/cpt's focus keyword for use as replacement string.
*
* @return string|null
*/
private function retrieve_focuskw() {
$replacement = null;
if ( ! empty( $this->args->ID ) ) {
$focus_kw = WPSEO_Meta::get_value( 'focuskw', $this->args->ID );
if ( $focus_kw !== '' ) {
$replacement = $focus_kw;
}
}
return $replacement;
}
/**
* Retrieve the post/page/cpt ID for use as replacement string.
*
* @return string|null
*/
private function retrieve_id() {
$replacement = null;
if ( ! empty( $this->args->ID ) ) {
$replacement = $this->args->ID;
}
return $replacement;
}
/**
* Retrieve the post/page/cpt modified time for use as replacement string.
*
* @return string|null
*/
private function retrieve_modified() {
$replacement = null;
if ( ! empty( $this->args->post_modified ) ) {
$replacement = mysql2date( get_option( 'date_format' ), $this->args->post_modified, true );
}
return $replacement;
}
/**
* Retrieve the post/page/cpt author's "nice name" for use as replacement string.
*
* @return string|null
*/
private function retrieve_name() {
$replacement = null;
$user_id = $this->retrieve_userid();
$name = get_the_author_meta( 'display_name', $user_id );
if ( $name !== '' ) {
$replacement = $name;
}
return $replacement;
}
/**
* Retrieve the post/page/cpt author's users description for use as a replacement string.
*
* @return null|string
*/
private function retrieve_user_description() {
$replacement = null;
$user_id = $this->retrieve_userid();
$description = get_the_author_meta( 'description', $user_id );
if ( $description !== '' ) {
$replacement = $description;
}
return $replacement;
}
/**
* Retrieve the current page number with context (i.e. 'page 2 of 4') for use as replacement string.
*
* @return string
*/
private function retrieve_page() {
$replacement = null;
$max = $this->determine_pagenumbering( 'max' );
$nr = $this->determine_pagenumbering( 'nr' );
$sep = $this->retrieve_sep();
if ( $max > 1 && $nr > 1 ) {
/* translators: 1: current page number, 2: total number of pages. */
$replacement = sprintf( $sep . ' ' . __( 'Page %1$d of %2$d', 'wordpress-seo' ), $nr, $max );
}
return $replacement;
}
/**
* Retrieve the current page number for use as replacement string.
*
* @return string|null
*/
private function retrieve_pagenumber() {
$replacement = null;
$nr = $this->determine_pagenumbering( 'nr' );
if ( isset( $nr ) && $nr > 0 ) {
$replacement = (string) $nr;
}
return $replacement;
}
/**
* Retrieve the current page total for use as replacement string.
*
* @return string|null
*/
private function retrieve_pagetotal() {
$replacement = null;
$max = $this->determine_pagenumbering( 'max' );
if ( isset( $max ) && $max > 0 ) {
$replacement = (string) $max;
}
return $replacement;
}
/**
* Retrieve the post type plural label for use as replacement string.
*
* @return string|null
*/
private function retrieve_pt_plural() {
$replacement = null;
$name = $this->determine_pt_names( 'plural' );
if ( isset( $name ) && $name !== '' ) {
$replacement = $name;
}
return $replacement;
}
/**
* Retrieve the post type single label for use as replacement string.
*
* @return string|null
*/
private function retrieve_pt_single() {
$replacement = null;
$name = $this->determine_pt_names( 'single' );
if ( isset( $name ) && $name !== '' ) {
$replacement = $name;
}
return $replacement;
}
/**
* Retrieve the slug which caused the 404 for use as replacement string.
*
* @return string|null
*/
private function retrieve_term404() {
$replacement = null;
if ( $this->args->term404 !== '' ) {
$replacement = sanitize_text_field( str_replace( '-', ' ', $this->args->term404 ) );
}
else {
$error_request = get_query_var( 'pagename' );
if ( $error_request !== '' ) {
$replacement = sanitize_text_field( str_replace( '-', ' ', $error_request ) );
}
else {
$error_request = get_query_var( 'name' );
if ( $error_request !== '' ) {
$replacement = sanitize_text_field( str_replace( '-', ' ', $error_request ) );
}
}
}
return $replacement;
}
/**
* Retrieve the post/page/cpt author's user id for use as replacement string.
*
* @return string
*/
private function retrieve_userid() {
$replacement = ! empty( $this->args->post_author ) ? $this->args->post_author : get_query_var( 'author' );
return $replacement;
}
/* *********************** HELP TEXT RELATED ************************** */
/**
* Create a variable help text table.
*
* @param string $type Either 'basic' or 'advanced'.
*
* @return string Help text table.
*/
private static function create_variable_help_table( $type ) {
if ( ! in_array( $type, array( 'basic', 'advanced' ), true ) ) {
return '';
}
$table = '
| ' . esc_html__( 'Label', 'wordpress-seo' ) . ' | ' . esc_html__( 'Variable', 'wordpress-seo' ) . ' | ' . esc_html__( 'Description', 'wordpress-seo' ) . ' |
|---|---|---|
| ' . esc_html( $replacement_variable->get_label() ) . ' | %%' . esc_html( $replacement_variable->get_variable() ) . '%% | ' . esc_html( $replacement_variable->get_description() ) . ' |
wp_title()'
'wp_title()'
) ),
);
foreach ( $replacement_variables as $replacement_variable ) {
self::register_help_text( 'basic', $replacement_variable );
}
}
/**
* Set/translate the help texts for the WPSEO standard advanced variables.
*/
private static function set_advanced_help_texts() {
$replacement_variables = array(
new WPSEO_Replacement_Variable( 'pt_single', __( 'Post type (singular)', 'wordpress-seo' ), __( 'Replaced with the content type single label', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'pt_plural', __( 'Post type (plural)', 'wordpress-seo' ), __( 'Replaced with the content type plural label', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'modified', __( 'Modified', 'wordpress-seo' ), __( 'Replaced with the post/page modified time', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'id', __( 'ID', 'wordpress-seo' ), __( 'Replaced with the post/page ID', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'name', __( 'Name', 'wordpress-seo' ), __( 'Replaced with the post/page author\'s \'nicename\'', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'user_description', __( 'User description', 'wordpress-seo' ), __( 'Replaced with the post/page author\'s \'Biographical Info\'', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'page', __( 'Page number', 'wordpress-seo' ), __( 'Replaced with the current page number with context (i.e. page 2 of 4)', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'pagetotal', __( 'Pagetotal', 'wordpress-seo' ), __( 'Replaced with the current page total', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'pagenumber', __( 'Pagenumber', 'wordpress-seo' ), __( 'Replaced with the current page number', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'caption', __( 'Caption', 'wordpress-seo' ), __( 'Attachment caption', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'focuskw', __( 'Focus keyword', 'wordpress-seo' ), __( 'Replaced with the posts focus keyphrase', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'term404', __( 'Term404', 'wordpress-seo' ), __( 'Replaced with the slug which caused the 404', 'wordpress-seo' ) ),
new WPSEO_Replacement_Variable( 'cf_