You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
454 lines
10 KiB
PHTML
454 lines
10 KiB
PHTML
7 months ago
|
<?php
|
||
|
|
/**
|
||
|
|
* Basic variable replacer.
|
||
|
|
*
|
||
|
|
* @since 1.0.33
|
||
|
|
* @package RankMath
|
||
|
|
* @subpackage RankMath\Replace_Variables
|
||
|
|
* @author Rank Math <support@rankmath.com>
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace RankMath\Replace_Variables;
|
||
|
|
|
||
|
|
use RankMath\Helper;
|
||
|
|
use RankMath\Helpers\Str;
|
||
|
|
|
||
|
|
defined( 'ABSPATH' ) || exit;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Basic_Variables class.
|
||
|
|
*/
|
||
|
|
class Basic_Variables extends Cache {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Hold counter variable data.
|
||
|
|
*
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
protected $counters = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Is on post edit screen.
|
||
|
|
*
|
||
|
|
* @var bool
|
||
|
|
*/
|
||
|
|
public $is_post_edit = false;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Is on term edit screen.
|
||
|
|
*
|
||
|
|
* @var bool
|
||
|
|
*/
|
||
|
|
public $is_term_edit = false;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Is on user edit screen.
|
||
|
|
*
|
||
|
|
* @var bool
|
||
|
|
*/
|
||
|
|
protected $is_user_edit = false;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Setup basic variables.
|
||
|
|
*/
|
||
|
|
public function setup_basic_variables() {
|
||
|
|
$this->register_replacement(
|
||
|
|
'sep',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Separator Character', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Separator character, as set in the Title Settings', 'rank-math' ),
|
||
|
|
'variable' => 'sep',
|
||
|
|
'example' => $this->get_sep(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_sep' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'search_query',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Search Query', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Search query (only available on search results page)', 'rank-math' ),
|
||
|
|
'variable' => 'search_query',
|
||
|
|
'example' => esc_html__( 'example search', 'rank-math' ),
|
||
|
|
],
|
||
|
|
[ $this, 'get_search_query' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'count',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Counter', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Starts at 1 and increments by 1.', 'rank-math' ),
|
||
|
|
'variable' => 'count(varname)',
|
||
|
|
'example' => '2',
|
||
|
|
'nocache' => true,
|
||
|
|
],
|
||
|
|
[ $this, 'get_count' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'filename',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'File Name', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'File Name of the attachment', 'rank-math' ),
|
||
|
|
'variable' => 'filename',
|
||
|
|
'example' => 'Sunrise at Maldives',
|
||
|
|
'nocache' => true,
|
||
|
|
],
|
||
|
|
[ $this, 'get_filename' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->setup_site_variables();
|
||
|
|
$this->setup_date_variables();
|
||
|
|
$this->setup_time_variables();
|
||
|
|
$this->setup_organization_variables();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Setup site info variables.
|
||
|
|
*/
|
||
|
|
private function setup_site_variables() {
|
||
|
|
$this->register_replacement(
|
||
|
|
'sitename',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Site Title', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Title of the site', 'rank-math' ),
|
||
|
|
'variable' => 'sitename',
|
||
|
|
'example' => $this->get_sitename(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_sitename' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'sitedesc',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Site Description', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Description of the site', 'rank-math' ),
|
||
|
|
'variable' => 'sitedesc',
|
||
|
|
'example' => $this->get_sitedesc(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_sitedesc' ]
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Setup date variables.
|
||
|
|
*/
|
||
|
|
private function setup_date_variables() {
|
||
|
|
$this->register_replacement(
|
||
|
|
'currentdate',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Current Date', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Current server date', 'rank-math' ),
|
||
|
|
'variable' => 'currentdate',
|
||
|
|
'example' => $this->get_current_date(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_current_date' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'currentday',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Current Day', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Current server day', 'rank-math' ),
|
||
|
|
'variable' => 'currentday',
|
||
|
|
'example' => $this->get_current_day(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_current_day' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'currentmonth',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Current Month', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Current server month', 'rank-math' ),
|
||
|
|
'variable' => 'currentmonth',
|
||
|
|
'example' => $this->get_current_month(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_current_month' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'currentyear',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Current Year', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Current server year', 'rank-math' ),
|
||
|
|
'variable' => 'currentyear',
|
||
|
|
'example' => $this->get_current_year(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_current_year' ]
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Setup time variables.
|
||
|
|
*/
|
||
|
|
private function setup_time_variables() {
|
||
|
|
$this->register_replacement(
|
||
|
|
'currenttime',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Current Time', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Current server time', 'rank-math' ),
|
||
|
|
'variable' => 'currenttime',
|
||
|
|
'example' => $this->get_current_time(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_current_time' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'currenttime_args',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Current Time (advanced)', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Current server time with custom formatting pattern.', 'rank-math' ),
|
||
|
|
'variable' => 'currenttime(F jS, Y)',
|
||
|
|
'example' => $this->get_current_time( 'F jS, Y' ),
|
||
|
|
],
|
||
|
|
[ $this, 'get_current_time' ]
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Setup site info variables.
|
||
|
|
*/
|
||
|
|
private function setup_organization_variables() {
|
||
|
|
$this->register_replacement(
|
||
|
|
'org_name',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Organization Name', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'The Organization Name added in Local SEO Settings.', 'rank-math' ),
|
||
|
|
'variable' => 'org_name',
|
||
|
|
'example' => $this->get_sitename(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_org_name' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'org_logo',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Organization Logo', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Organization Logo added in Local SEO Settings.', 'rank-math' ),
|
||
|
|
'variable' => 'org_logo',
|
||
|
|
'example' => $this->get_org_logo(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_org_logo' ]
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->register_replacement(
|
||
|
|
'org_url',
|
||
|
|
[
|
||
|
|
'name' => esc_html__( 'Organization URL', 'rank-math' ),
|
||
|
|
'description' => esc_html__( 'Organization URL added in Local SEO Settings.', 'rank-math' ),
|
||
|
|
'variable' => 'org_url',
|
||
|
|
'example' => $this->get_org_url(),
|
||
|
|
],
|
||
|
|
[ $this, 'get_org_url' ]
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the separator to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_sep() {
|
||
|
|
$sep = $this->do_filter( 'settings/title_separator', Helper::get_settings( 'titles.title_separator' ) );
|
||
|
|
|
||
|
|
return htmlentities( $sep, ENT_COMPAT, 'UTF-8', false );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the site name to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function get_sitename() {
|
||
|
|
if ( $this->in_cache( 'sitename' ) ) {
|
||
|
|
return $this->get_cache( 'sitename' );
|
||
|
|
}
|
||
|
|
|
||
|
|
$sitename = wp_strip_all_tags( get_bloginfo( 'name' ), true );
|
||
|
|
if ( '' !== $sitename ) {
|
||
|
|
$this->set_cache( 'sitename', $sitename );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $sitename;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the site tag line to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function get_sitedesc() {
|
||
|
|
if ( $this->in_cache( 'sitedesc' ) ) {
|
||
|
|
return $this->get_cache( 'sitedesc' );
|
||
|
|
}
|
||
|
|
|
||
|
|
$sitedesc = wp_strip_all_tags( get_bloginfo( 'description' ) );
|
||
|
|
if ( '' !== $sitedesc ) {
|
||
|
|
$this->set_cache( 'sitedesc', $sitedesc );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $sitedesc;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current search query to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function get_search_query() {
|
||
|
|
if ( $this->in_cache( 'search_query' ) ) {
|
||
|
|
return $this->get_cache( 'search_query' );
|
||
|
|
}
|
||
|
|
|
||
|
|
$search = get_search_query();
|
||
|
|
if ( '' !== $search ) {
|
||
|
|
$this->set_cache( 'search_query', $search );
|
||
|
|
}
|
||
|
|
|
||
|
|
return $search;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the counter for the given variable.
|
||
|
|
*
|
||
|
|
* @param string $name The name of field.
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function get_count( $name ) {
|
||
|
|
if ( ! is_string( $name ) ) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( ! isset( $this->counters[ $name ] ) ) {
|
||
|
|
$this->counters[ $name ] = 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
return ++$this->counters[ $name ];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the filename of the attachment to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string|null
|
||
|
|
*/
|
||
|
|
public function get_filename() {
|
||
|
|
if ( empty( $this->args->filename ) ) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
$name = \pathinfo( $this->args->filename );
|
||
|
|
|
||
|
|
// Remove size if embedded.
|
||
|
|
$name = explode( '-', $name['filename'] );
|
||
|
|
if ( Str::contains( 'x', end( $name ) ) ) {
|
||
|
|
array_pop( $name );
|
||
|
|
}
|
||
|
|
|
||
|
|
// Format filename.
|
||
|
|
$name = join( ' ', $name );
|
||
|
|
$name = trim( str_replace( '_', ' ', $name ) );
|
||
|
|
|
||
|
|
return '' !== $name ? $name : null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current time to use as a replacement.
|
||
|
|
*
|
||
|
|
* @param string $format (Optional) PHP date format.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_current_time( $format = '' ) {
|
||
|
|
$format = $format ? $format : get_option( 'time_format' );
|
||
|
|
return $this->date_i18n( $format );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current date to use as a replacement.
|
||
|
|
*
|
||
|
|
* @param string $format (Optional) PHP date format.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_current_date( $format = '' ) {
|
||
|
|
$format = $format ? $format : get_option( 'date_format' );
|
||
|
|
return $this->date_i18n( $format );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current day to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_current_day() {
|
||
|
|
return $this->date_i18n( 'j' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current month to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_current_month() {
|
||
|
|
return $this->date_i18n( 'F' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current year to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_current_year() {
|
||
|
|
return $this->date_i18n( 'Y' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the Organization Name to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_org_name() {
|
||
|
|
return Helper::get_settings( 'titles.knowledgegraph_name', get_bloginfo( 'name' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the Organization Logo to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_org_logo() {
|
||
|
|
return Helper::get_settings( 'titles.knowledgegraph_logo', '' );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the Organization URL to use as a replacement.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function get_org_url() {
|
||
|
|
return Helper::get_settings( 'titles.url', home_url() );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return localized date.
|
||
|
|
*
|
||
|
|
* @param string $format (Optional) PHP date format.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
private function date_i18n( $format = '' ) {
|
||
|
|
$key = 'date_i18n_' . sanitize_key( $format );
|
||
|
|
if ( $this->in_cache( $key ) ) {
|
||
|
|
return $this->get_cache( $key );
|
||
|
|
}
|
||
|
|
|
||
|
|
$date = date_i18n( $format );
|
||
|
|
$this->set_cache( $key, $date );
|
||
|
|
|
||
|
|
return $date;
|
||
|
|
}
|
||
|
|
}
|