Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Helpers;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Actions\Indexing\Indexable_Post_Indexation_Action;

[4] Fix | Delete

use Yoast\WP\SEO\Actions\Indexing\Indexable_Post_Type_Archive_Indexation_Action;

[5] Fix | Delete

use Yoast\WP\SEO\Actions\Indexing\Indexable_Term_Indexation_Action;

[6] Fix | Delete

use Yoast\WP\SEO\Config\Indexing_Reasons;

[7] Fix | Delete

use Yoast\WP\SEO\Models\Indexable;

[8] Fix | Delete

use Yoast\WP\SEO\Repositories\Indexable_Repository;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* A helper object for indexables.

[12] Fix | Delete

[13] Fix | Delete

class Indexable_Helper {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Represents the indexable repository.

[17] Fix | Delete

[18] Fix | Delete

* @var Indexable_Repository

[19] Fix | Delete

[20] Fix | Delete

protected $repository;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Represents the options helper.

[24] Fix | Delete

[25] Fix | Delete

* @var Options_Helper

[26] Fix | Delete

[27] Fix | Delete

protected $options_helper;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Represents the environment helper.

[31] Fix | Delete

[32] Fix | Delete

* @var Environment_Helper

[33] Fix | Delete

[34] Fix | Delete

protected $environment_helper;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Represents the indexing helper.

[38] Fix | Delete

[39] Fix | Delete

* @var Indexing_Helper

[40] Fix | Delete

[41] Fix | Delete

protected $indexing_helper;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Default values of certain columns.

[45] Fix | Delete

[46] Fix | Delete

* @var array

[47] Fix | Delete

[48] Fix | Delete

protected $default_values = [

[49] Fix | Delete

'title' => [

[50] Fix | Delete

'default_value' => null,

[51] Fix | Delete

[52] Fix | Delete

'description' => [

[53] Fix | Delete

'default_value' => null,

[54] Fix | Delete

[55] Fix | Delete

'open_graph_title' => [

[56] Fix | Delete

'default_value' => null,

[57] Fix | Delete

[58] Fix | Delete

'open_graph_description' => [

[59] Fix | Delete

'default_value' => null,

[60] Fix | Delete

[61] Fix | Delete

'twitter_title' => [

[62] Fix | Delete

'default_value' => null,

[63] Fix | Delete

[64] Fix | Delete

'twitter_description' => [

[65] Fix | Delete

'default_value' => null,

[66] Fix | Delete

[67] Fix | Delete

'canonical' => [

[68] Fix | Delete

'default_value' => null,

[69] Fix | Delete

[70] Fix | Delete

'primary_focus_keyword' => [

[71] Fix | Delete

'default_value' => null,

[72] Fix | Delete

[73] Fix | Delete

'is_robots_noindex' => [

[74] Fix | Delete

'default_value' => null,

[75] Fix | Delete

[76] Fix | Delete

'is_robots_nofollow' => [

[77] Fix | Delete

'default_value' => false,

[78] Fix | Delete

[79] Fix | Delete

'is_robots_noarchive' => [

[80] Fix | Delete

'default_value' => null,

[81] Fix | Delete

[82] Fix | Delete

'is_robots_noimageindex' => [

[83] Fix | Delete

'default_value' => null,

[84] Fix | Delete

[85] Fix | Delete

'is_robots_nosnippet' => [

[86] Fix | Delete

'default_value' => null,

[87] Fix | Delete

[88] Fix | Delete

];

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Indexable_Helper constructor.

[92] Fix | Delete

[93] Fix | Delete

* @param Options_Helper $options_helper The options helper.

[94] Fix | Delete

* @param Environment_Helper $environment_helper The environment helper.

[95] Fix | Delete

* @param Indexing_Helper $indexing_helper The indexing helper.

[96] Fix | Delete

[97] Fix | Delete

public function __construct( Options_Helper $options_helper, Environment_Helper $environment_helper, Indexing_Helper $indexing_helper ) {

[98] Fix | Delete

$this->options_helper = $options_helper;

[99] Fix | Delete

$this->environment_helper = $environment_helper;

[100] Fix | Delete

$this->indexing_helper = $indexing_helper;

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Sets the indexable repository. Done to avoid circular dependencies.

[105] Fix | Delete

[106] Fix | Delete

* @required

[107] Fix | Delete

[108] Fix | Delete

* @param Indexable_Repository $repository The indexable repository.

[109] Fix | Delete

[110] Fix | Delete

* @return void

[111] Fix | Delete

[112] Fix | Delete

public function set_indexable_repository( Indexable_Repository $repository ) {

[113] Fix | Delete

$this->repository = $repository;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Returns the page type of an indexable.

[118] Fix | Delete

[119] Fix | Delete

* @param Indexable $indexable The indexable.

[120] Fix | Delete

[121] Fix | Delete

* @return string|false The page type. False if it could not be determined.

[122] Fix | Delete

[123] Fix | Delete

public function get_page_type_for_indexable( $indexable ) {

[124] Fix | Delete

switch ( $indexable->object_type ) {

[125] Fix | Delete

case 'post':

[126] Fix | Delete

$front_page_id = (int) \get_option( 'page_on_front' );

[127] Fix | Delete

if ( $indexable->object_id === $front_page_id ) {

[128] Fix | Delete

return 'Static_Home_Page';

[129] Fix | Delete

}

[130] Fix | Delete

$posts_page_id = (int) \get_option( 'page_for_posts' );

[131] Fix | Delete

if ( $indexable->object_id === $posts_page_id ) {

[132] Fix | Delete

return 'Static_Posts_Page';

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

return 'Post_Type';

[136] Fix | Delete

case 'term':

[137] Fix | Delete

return 'Term_Archive';

[138] Fix | Delete

case 'user':

[139] Fix | Delete

return 'Author_Archive';

[140] Fix | Delete

case 'home-page':

[141] Fix | Delete

return 'Home_Page';

[142] Fix | Delete

case 'post-type-archive':

[143] Fix | Delete

return 'Post_Type_Archive';

[144] Fix | Delete

case 'date-archive':

[145] Fix | Delete

return 'Date_Archive';

[146] Fix | Delete

case 'system-page':

[147] Fix | Delete

if ( $indexable->object_sub_type === 'search-result' ) {

[148] Fix | Delete

return 'Search_Result_Page';

[149] Fix | Delete

}

[150] Fix | Delete

if ( $indexable->object_sub_type === '404' ) {

[151] Fix | Delete

return 'Error_Page';

[152] Fix | Delete

}

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

return false;

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Resets the permalinks of the indexables.

[160] Fix | Delete

[161] Fix | Delete

* @param string|null $type The type of the indexable.

[162] Fix | Delete

* @param string|null $subtype The subtype. Can be null.

[163] Fix | Delete

* @param string $reason The reason that the permalink has been changed.

[164] Fix | Delete

[165] Fix | Delete

* @return void

[166] Fix | Delete

[167] Fix | Delete

public function reset_permalink_indexables( $type = null, $subtype = null, $reason = Indexing_Reasons::REASON_PERMALINK_SETTINGS ) {

[168] Fix | Delete

$result = $this->repository->reset_permalink( $type, $subtype );

[169] Fix | Delete

[170] Fix | Delete

$this->indexing_helper->set_reason( $reason );

[171] Fix | Delete

[172] Fix | Delete

if ( $result !== false && $result > 0 ) {

[173] Fix | Delete

\delete_transient( Indexable_Post_Indexation_Action::UNINDEXED_COUNT_TRANSIENT );

[174] Fix | Delete

\delete_transient( Indexable_Post_Type_Archive_Indexation_Action::UNINDEXED_COUNT_TRANSIENT );

[175] Fix | Delete

\delete_transient( Indexable_Term_Indexation_Action::UNINDEXED_COUNT_TRANSIENT );

[176] Fix | Delete

}

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

/**

[180] Fix | Delete

* Determines whether indexing the specific indexable is appropriate at this time.

[181] Fix | Delete

[182] Fix | Delete

* @param Indexable $indexable The indexable.

[183] Fix | Delete

[184] Fix | Delete

* @return bool Whether indexing the specific indexable is appropriate at this time.

[185] Fix | Delete

[186] Fix | Delete

public function should_index_indexable( $indexable ) {

[187] Fix | Delete

$intend_to_save = $this->should_index_indexables();

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Filter: 'wpseo_should_save_indexable' - Allow developers to enable / disable

[191] Fix | Delete

* saving the indexable when the indexable is updated. Warning: overriding

[192] Fix | Delete

* the intended action may cause problems when moving from a staging to a

[193] Fix | Delete

* production environment because indexable permalinks may get set incorrectly.

[194] Fix | Delete

[195] Fix | Delete

* @param bool $intend_to_save True if YoastSEO intends to save the indexable.

[196] Fix | Delete

* @param Indexable $indexable The indexable to be saved.

[197] Fix | Delete

[198] Fix | Delete

return \apply_filters( 'wpseo_should_save_indexable', $intend_to_save, $indexable );

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Determines whether indexing indexables is appropriate at this time.

[203] Fix | Delete

[204] Fix | Delete

* @return bool Whether the indexables should be indexed.

[205] Fix | Delete

[206] Fix | Delete

public function should_index_indexables() {

[207] Fix | Delete

// Currently, the only reason to index is when we're on a production website.

[208] Fix | Delete

$should_index = $this->environment_helper->is_production_mode();

[209] Fix | Delete

[210] Fix | Delete

/**

[211] Fix | Delete

* Filter: 'Yoast\WP\SEO\should_index_indexables' - Allow developers to enable / disable

[212] Fix | Delete

* creating indexables. Warning: overriding

[213] Fix | Delete

* the intended action may cause problems when moving from a staging to a

[214] Fix | Delete

* production environment because indexable permalinks may get set incorrectly.

[215] Fix | Delete

[216] Fix | Delete

* @since 18.2

[217] Fix | Delete

[218] Fix | Delete

* @param bool $should_index Whether the site's indexables should be created.

[219] Fix | Delete

[220] Fix | Delete

return (bool) \apply_filters( 'Yoast\WP\SEO\should_index_indexables', $should_index );

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

/**

[224] Fix | Delete

* Returns whether or not dynamic permalinks should be used.

[225] Fix | Delete

[226] Fix | Delete

* @return bool Whether or not the dynamic permalinks should be used.

[227] Fix | Delete

[228] Fix | Delete

public function dynamic_permalinks_enabled() {

[229] Fix | Delete

/**

[230] Fix | Delete

* Filters the value of the `dynamic_permalinks` option.

[231] Fix | Delete

[232] Fix | Delete

* @param bool $value The value of the `dynamic_permalinks` option.

[233] Fix | Delete

[234] Fix | Delete

return (bool) \apply_filters( 'wpseo_dynamic_permalinks_enabled', $this->options_helper->get( 'dynamic_permalinks', false ) );

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

/**

[238] Fix | Delete

* Sets a boolean to indicate that the indexing of the indexables has completed.

[239] Fix | Delete

[240] Fix | Delete

* @return void

[241] Fix | Delete

[242] Fix | Delete

public function finish_indexing() {

[243] Fix | Delete

$this->options_helper->set( 'indexables_indexing_completed', true );

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Checks whether the indexable has default values in given fields.

[248] Fix | Delete

[249] Fix | Delete

* @param Indexable $indexable The Yoast indexable that we're checking.

[250] Fix | Delete

* @param array $fields The Yoast indexable fields that we're checking against.

[251] Fix | Delete

[252] Fix | Delete

* @return bool Whether the indexable has default values.

[253] Fix | Delete

[254] Fix | Delete

public function check_if_default_indexable( $indexable, $fields ) {

[255] Fix | Delete

foreach ( $fields as $field ) {

[256] Fix | Delete

$is_default = $this->check_if_default_field( $indexable, $field );

[257] Fix | Delete

if ( ! $is_default ) {

[258] Fix | Delete

break;

[259] Fix | Delete

}

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

return $is_default;

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

/**

[266] Fix | Delete

* Checks if an indexable field contains the default value.

[267] Fix | Delete

[268] Fix | Delete

* @param Indexable $indexable The Yoast indexable that we're checking.

[269] Fix | Delete

* @param string $field The field that we're checking.

[270] Fix | Delete

[271] Fix | Delete

* @return bool True if default value.

[272] Fix | Delete

[273] Fix | Delete

public function check_if_default_field( $indexable, $field ) {

[274] Fix | Delete

$defaults = $this->default_values;

[275] Fix | Delete

if ( ! isset( $defaults[ $field ] ) ) {

[276] Fix | Delete

return false;

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

if ( $indexable->$field === $defaults[ $field ]['default_value'] ) {

[280] Fix | Delete

return true;

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

return false;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Saves and returns an indexable (on production environments only).

[288] Fix | Delete

[289] Fix | Delete

* Moved from Yoast\WP\SEO\Builders\Indexable_Builder.

[290] Fix | Delete

[291] Fix | Delete

* @param Indexable $indexable The indexable.

[292] Fix | Delete

* @param Indexable|null $indexable_before The indexable before possible changes.

[293] Fix | Delete

[294] Fix | Delete

* @return bool True if default value.

[295] Fix | Delete

[296] Fix | Delete

public function save_indexable( $indexable, $indexable_before = null ) {

[297] Fix | Delete

if ( ! $this->should_index_indexable( $indexable ) ) {

[298] Fix | Delete

return $indexable;

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

// Save the indexable before running the WordPress hook.

[302] Fix | Delete

$indexable->save();

[303] Fix | Delete

[304] Fix | Delete

if ( $indexable_before ) {

[305] Fix | Delete

/**

[306] Fix | Delete

* Action: 'wpseo_save_indexable' - Allow developers to perform an action

[307] Fix | Delete

* when the indexable is updated.

[308] Fix | Delete

[309] Fix | Delete

* @param Indexable $indexable The saved indexable.

[310] Fix | Delete

* @param Indexable $indexable_before The indexable before saving.

[311] Fix | Delete

[312] Fix | Delete

\do_action( 'wpseo_save_indexable', $indexable, $indexable_before );

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

return $indexable;

[316] Fix | Delete

}

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete