Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

class ET_Theme_Builder_Request {

[2] Fix | Delete

/**

[3] Fix | Delete

* Type constants.

[4] Fix | Delete

[5] Fix | Delete

const TYPE_FRONT_PAGE = 'front_page';

[6] Fix | Delete

const TYPE_404 = '404';

[7] Fix | Delete

const TYPE_SEARCH = 'search';

[8] Fix | Delete

const TYPE_SINGULAR = 'singular';

[9] Fix | Delete

const TYPE_POST_TYPE_ARCHIVE = 'archive';

[10] Fix | Delete

const TYPE_TERM = 'term';

[11] Fix | Delete

const TYPE_AUTHOR = 'author';

[12] Fix | Delete

const TYPE_DATE = 'date';

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Requested object type.

[16] Fix | Delete

[17] Fix | Delete

* @var string

[18] Fix | Delete

[19] Fix | Delete

protected $type = '';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Requested object subtype.

[23] Fix | Delete

[24] Fix | Delete

* @var string

[25] Fix | Delete

[26] Fix | Delete

protected $subtype = '';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Requested object id.

[30] Fix | Delete

[31] Fix | Delete

* @var integer

[32] Fix | Delete

[33] Fix | Delete

protected $id = 0;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Create a request object based on the current request.

[37] Fix | Delete

[38] Fix | Delete

* @since 4.0

[39] Fix | Delete

[40] Fix | Delete

* @return ET_Theme_Builder_Request|null

[41] Fix | Delete

[42] Fix | Delete

public static function from_current() {

[43] Fix | Delete

$is_extra_layout_home = 'layout' === get_option( 'show_on_front' ) && is_home();

[44] Fix | Delete

[45] Fix | Delete

if ( $is_extra_layout_home || is_front_page() ) {

[46] Fix | Delete

return new self( self::TYPE_FRONT_PAGE, '', get_queried_object_id() );

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

if ( is_404() ) {

[50] Fix | Delete

return new self( self::TYPE_404, '', 0 );

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

if ( is_search() ) {

[54] Fix | Delete

return new self( self::TYPE_SEARCH, '', 0 );

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

$id = get_queried_object_id();

[58] Fix | Delete

$object = get_queried_object();

[59] Fix | Delete

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

[60] Fix | Delete

$is_blog_page = 0 !== $page_for_posts && is_page( $page_for_posts );

[61] Fix | Delete

[62] Fix | Delete

if ( is_singular() ) {

[63] Fix | Delete

return new self( self::TYPE_SINGULAR, get_post_type( $id ), $id );

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

if ( $is_blog_page || is_home() ) {

[67] Fix | Delete

return new self( self::TYPE_POST_TYPE_ARCHIVE, 'post', $id );

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

if ( is_category() || is_tag() || is_tax() ) {

[71] Fix | Delete

return new self( self::TYPE_TERM, $object->taxonomy, $id );

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

if ( is_post_type_archive() ) {

[75] Fix | Delete

return new self( self::TYPE_POST_TYPE_ARCHIVE, $object->name, $id );

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

if ( is_author() ) {

[79] Fix | Delete

return new self( self::TYPE_AUTHOR, '', $id );

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

if ( is_date() ) {

[83] Fix | Delete

return new self( self::TYPE_DATE, '', 0 );

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

return null;

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Create a request object based on a post id.

[91] Fix | Delete

[92] Fix | Delete

* @since 4.0

[93] Fix | Delete

[94] Fix | Delete

* @param integer $post_id

[95] Fix | Delete

[96] Fix | Delete

* @return ET_Theme_Builder_Request

[97] Fix | Delete

[98] Fix | Delete

public static function from_post( $post_id ) {

[99] Fix | Delete

if ( (int) get_option( 'page_on_front' ) === $post_id ) {

[100] Fix | Delete

return new self( self::TYPE_FRONT_PAGE, '', $post_id );

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

if ( (int) get_option( 'page_for_posts' ) === $post_id ) {

[104] Fix | Delete

return new self( self::TYPE_POST_TYPE_ARCHIVE, 'post', $post_id );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

return new self( self::TYPE_SINGULAR, get_post_type( $post_id ), $post_id );

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Constructor.

[112] Fix | Delete

[113] Fix | Delete

* @since 4.0

[114] Fix | Delete

[115] Fix | Delete

* @param string $type

[116] Fix | Delete

* @param string $subtype

[117] Fix | Delete

* @param integer $id

[118] Fix | Delete

[119] Fix | Delete

public function __construct( $type, $subtype, $id ) {

[120] Fix | Delete

$this->type = $type;

[121] Fix | Delete

$this->subtype = $subtype;

[122] Fix | Delete

$this->id = $id;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Get the requested object type.

[127] Fix | Delete

[128] Fix | Delete

* @since 4.0

[129] Fix | Delete

[130] Fix | Delete

* @return string

[131] Fix | Delete

[132] Fix | Delete

public function get_type() {

[133] Fix | Delete

return $this->type;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

/**

[137] Fix | Delete

* Get the requested object subtype.

[138] Fix | Delete

[139] Fix | Delete

* @since 4.0

[140] Fix | Delete

[141] Fix | Delete

* @return string

[142] Fix | Delete

[143] Fix | Delete

public function get_subtype() {

[144] Fix | Delete

return $this->subtype;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Get the requested object id.

[149] Fix | Delete

[150] Fix | Delete

* @since 4.0

[151] Fix | Delete

[152] Fix | Delete

* @return string

[153] Fix | Delete

[154] Fix | Delete

public function get_id() {

[155] Fix | Delete

return $this->id;

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

/**

[159] Fix | Delete

* Get the top ancestor of a setting based on its id. Takes the setting itself

[160] Fix | Delete

* if it has no ancestors.

[161] Fix | Delete

* Returns an empty array if the setting is not found.

[162] Fix | Delete

[163] Fix | Delete

* @since 4.0

[164] Fix | Delete

[165] Fix | Delete

* @param array $flat_settings

[166] Fix | Delete

* @param string $setting_id

[167] Fix | Delete

[168] Fix | Delete

* @return array

[169] Fix | Delete

[170] Fix | Delete

protected function _get_template_setting_ancestor( $flat_settings, $setting_id ) {

[171] Fix | Delete

$id = $setting_id;

[172] Fix | Delete

[173] Fix | Delete

if ( ! isset( $flat_settings[ $id ] ) ) {

[174] Fix | Delete

// If the setting is not found, check if a valid parent exists.

[175] Fix | Delete

$parent_id = explode( ET_THEME_BUILDER_SETTING_SEPARATOR, $id );

[176] Fix | Delete

array_pop( $parent_id );

[177] Fix | Delete

$parent_id[] = '';

[178] Fix | Delete

$parent_id = implode( ET_THEME_BUILDER_SETTING_SEPARATOR, $parent_id );

[179] Fix | Delete

$id = $parent_id;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

if ( ! isset( $flat_settings[ $id ] ) ) {

[183] Fix | Delete

// The setting is still not found - bail.

[184] Fix | Delete

return array();

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

return $flat_settings[ $id ];

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

/**

[191] Fix | Delete

* Get $a or $b depending on which template setting has a higher priority.

[192] Fix | Delete

* Handles cases such as category settings with equal priority but in a ancestor-child relationship.

[193] Fix | Delete

* Returns an empty string if neither setting is found.

[194] Fix | Delete

[195] Fix | Delete

* @since 4.0

[196] Fix | Delete

[197] Fix | Delete

* @param array $flat_settings

[198] Fix | Delete

* @param string $a

[199] Fix | Delete

* @param string $b

[200] Fix | Delete

[201] Fix | Delete

* @return string

[202] Fix | Delete

[203] Fix | Delete

protected function _get_higher_priority_template_setting( $flat_settings, $a, $b ) {

[204] Fix | Delete

$map = array_flip( array_keys( $flat_settings ) );

[205] Fix | Delete

$a_ancestor = $this->_get_template_setting_ancestor( $flat_settings, $a );

[206] Fix | Delete

$b_ancestor = $this->_get_template_setting_ancestor( $flat_settings, $b );

[207] Fix | Delete

$a_found = ! empty( $a_ancestor );

[208] Fix | Delete

$b_found = ! empty( $b_ancestor );

[209] Fix | Delete

[210] Fix | Delete

if ( ! $a_found || ! $b_found ) {

[211] Fix | Delete

if ( $a_found ) {

[212] Fix | Delete

return $a;

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

if ( $b_found ) {

[216] Fix | Delete

return $b;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

return '';

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

if ( $a_ancestor['priority'] !== $b_ancestor['priority'] ) {

[223] Fix | Delete

// Priorities are not equal - use a simple comparison.

[224] Fix | Delete

return $a_ancestor['priority'] >= $b_ancestor['priority'] ? $a : $b;

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

if ( $a_ancestor['id'] !== $b_ancestor['id'] ) {

[228] Fix | Delete

// Equal priorities, but the ancestors are not the same - use the order in $flat_settings

[229] Fix | Delete

// so we have a deterministic result even if $a and $b are swapped.

[230] Fix | Delete

return $map[ $a_ancestor['id'] ] <= $map[ $b_ancestor['id'] ] ? $a : $b;

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

// Equal priorities, same ancestor.

[234] Fix | Delete

$ancestor = $a_ancestor;

[235] Fix | Delete

$a_pieces = explode( ET_THEME_BUILDER_SETTING_SEPARATOR, $a );

[236] Fix | Delete

$b_pieces = explode( ET_THEME_BUILDER_SETTING_SEPARATOR, $b );

[237] Fix | Delete

$separator = preg_quote( ET_THEME_BUILDER_SETTING_SEPARATOR, '/' );

[238] Fix | Delete

[239] Fix | Delete

// Hierarchical post types are a special case by spec since we have to take hierarchy into account.

[240] Fix | Delete

// Test if the ancestor matches "singular:post_type:<post_type>:children:id:".

[241] Fix | Delete

$id_pieces = array( 'singular', 'post_type', '[^' . $separator . ']+', 'children', 'id', '' );

[242] Fix | Delete

$term_regex = '/^' . implode( $separator, $id_pieces ) . '$/';

[243] Fix | Delete

[244] Fix | Delete

if ( preg_match( $term_regex, $ancestor['id'] ) && is_post_type_hierarchical( $a_pieces[2] ) ) {

[245] Fix | Delete

$a_post_id = (int) $a_pieces[5];

[246] Fix | Delete

$b_post_id = (int) $b_pieces[5];

[247] Fix | Delete

[248] Fix | Delete

$a_post_ancestors = get_post_ancestors( $a_post_id );

[249] Fix | Delete

$b_post_ancestors = get_post_ancestors( $b_post_id );

[250] Fix | Delete

[251] Fix | Delete

if ( in_array( $a_post_id, $b_post_ancestors, true ) ) {

[252] Fix | Delete

// $b is a child of $a so it should take priority.

[253] Fix | Delete

return $b;

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

if ( in_array( $b_post_id, $a_post_ancestors, true ) ) {

[257] Fix | Delete

// $a is a child of $b so it should take priority.

[258] Fix | Delete

return $a;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

// neither $a nor $b is an ancestor to the other - continue the comparisons.

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

// Term archive listings are a special case by spec since we have to take hierarchy into account.

[265] Fix | Delete

// Test if the ancestor matches "archive:taxonomy:<taxonomy>:term:id:".

[266] Fix | Delete

$id_pieces = array( 'archive', 'taxonomy', '[^' . $separator . ']+', 'term', 'id', '' );

[267] Fix | Delete

$term_regex = '/^' . implode( $separator, $id_pieces ) . '$/';

[268] Fix | Delete

[269] Fix | Delete

if ( preg_match( $term_regex, $ancestor['id'] ) && is_taxonomy_hierarchical( $a_pieces[2] ) ) {

[270] Fix | Delete

$a_term_id = $a_pieces[5];

[271] Fix | Delete

$b_term_id = $b_pieces[5];

[272] Fix | Delete

[273] Fix | Delete

if ( term_is_ancestor_of( $a_term_id, $b_term_id, $a_pieces[2] ) ) {

[274] Fix | Delete

// $b is a child of $a so it should take priority.

[275] Fix | Delete

return $b;

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

if ( term_is_ancestor_of( $b_term_id, $a_term_id, $a_pieces[2] ) ) {

[279] Fix | Delete

// $a is a child of $b so it should take priority.

[280] Fix | Delete

return $a;

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

// neither $a nor $b is an ancestor to the other - continue the comparisons.

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

// Find the first difference in the settings and compare it.

[287] Fix | Delete

// The difference should be representing an id or a slug.

[288] Fix | Delete

foreach ( $a_pieces as $index => $a_piece ) {

[289] Fix | Delete

$b_piece = $b_pieces[ $index ];

[290] Fix | Delete

[291] Fix | Delete

if ( $b_piece === $a_piece ) {

[292] Fix | Delete

continue;

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

if ( is_numeric( $a_piece ) ) {

[296] Fix | Delete

$prioritized = (float) $a_piece <= (float) $b_piece ? $a : $b;

[297] Fix | Delete

} else {

[298] Fix | Delete

$prioritized = strcmp( $a, $b ) <= 0 ? $a : $b;

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

/**

[302] Fix | Delete

* Filters the higher prioritized setting in a given pair that

[303] Fix | Delete

* has equal built-in priority.

[304] Fix | Delete

[305] Fix | Delete

* @since 4.2

[306] Fix | Delete

[307] Fix | Delete

* @param string $prioritized_setting

[308] Fix | Delete

* @param string $setting_a

[309] Fix | Delete

* @param string $setting_b

[310] Fix | Delete

* @param ET_Theme_Builder_Request $request

[311] Fix | Delete

[312] Fix | Delete

return apply_filters( 'et_theme_builder_prioritized_template_setting', $prioritized, $a, $b, $this );

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

// We should only reach this point if $a and $b are equal so it doesn't

[316] Fix | Delete

// matter which we return.

[317] Fix | Delete

return $a;

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

/**

[321] Fix | Delete

* Check if this request fulfills a template setting.

[322] Fix | Delete

[323] Fix | Delete

* @since 4.0

[324] Fix | Delete

[325] Fix | Delete

* @param array $flat_settings

[326] Fix | Delete

* @param string $setting_id

[327] Fix | Delete

[328] Fix | Delete

* @return boolean

[329] Fix | Delete

[330] Fix | Delete

protected function _fulfills_template_setting( $flat_settings, $setting_id ) {

[331] Fix | Delete

$ancestor = $this->_get_template_setting_ancestor( $flat_settings, $setting_id );

[332] Fix | Delete

$fulfilled = false;

[333] Fix | Delete

[334] Fix | Delete

if ( ! empty( $ancestor ) && isset( $ancestor['validate'] ) && is_callable( $ancestor['validate'] ) ) {

[335] Fix | Delete

// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found

[336] Fix | Delete

$fulfilled = call_user_func(

[337] Fix | Delete

$ancestor['validate'],

[338] Fix | Delete

$this->get_type(),

[339] Fix | Delete

$this->get_subtype(),

[340] Fix | Delete

$this->get_id(),

[341] Fix | Delete

explode( ET_THEME_BUILDER_SETTING_SEPARATOR, $setting_id )

[342] Fix | Delete

);

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete

return $fulfilled;

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

/**

[349] Fix | Delete

* Reduce callback for self::get_template() to get the highest priority template from all applicable ones.

[350] Fix | Delete

[351] Fix | Delete

* @since 4.0

[352] Fix | Delete

[353] Fix | Delete

* @param array $carry

[354] Fix | Delete

* @param array $applicable_template

[355] Fix | Delete

[356] Fix | Delete

* @return array

[357] Fix | Delete

[358] Fix | Delete

public function reduce_get_template( $carry, $applicable_template ) {

[359] Fix | Delete

global $__et_theme_builder_request_flat_settings;

[360] Fix | Delete

[361] Fix | Delete

if ( empty( $carry ) ) {

[362] Fix | Delete

return $applicable_template;

[363] Fix | Delete

}

[364] Fix | Delete

[365] Fix | Delete

$higher = $this->_get_higher_priority_template_setting(

[366] Fix | Delete

$__et_theme_builder_request_flat_settings,

[367] Fix | Delete

$carry['top_setting_id'],

[368] Fix | Delete

$applicable_template['top_setting_id']

[369] Fix | Delete

);

[370] Fix | Delete

[371] Fix | Delete

return $carry['top_setting_id'] !== $higher ? $applicable_template : $carry;

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Get the highest-priority template that should be applied for this request, if any.

[376] Fix | Delete

[377] Fix | Delete

* @since 4.0

[378] Fix | Delete

[379] Fix | Delete

* @param array $templates

[380] Fix | Delete

* @param array $flat_settings

[381] Fix | Delete

[382] Fix | Delete

* @return array

[383] Fix | Delete

[384] Fix | Delete

public function get_template( $templates, $flat_settings ) {

[385] Fix | Delete

// Use a global variable to pass data to the reduce callback as we support PHP 5.2.

[386] Fix | Delete

global $__et_theme_builder_request_flat_settings;

[387] Fix | Delete

[388] Fix | Delete

$applicable_templates = array();

[389] Fix | Delete

[390] Fix | Delete

foreach ( $templates as $template ) {

[391] Fix | Delete

if ( ! $template['enabled'] ) {

[392] Fix | Delete

continue;

[393] Fix | Delete

}

[394] Fix | Delete

[395] Fix | Delete

foreach ( $template['exclude_from'] as $setting_id ) {

[396] Fix | Delete

if ( $this->_fulfills_template_setting( $flat_settings, $setting_id ) ) {

[397] Fix | Delete

// The setting is explicitly excluded - bail from testing the template any further.

[398] Fix | Delete

continue 2;

[399] Fix | Delete

}

[400] Fix | Delete

}

[401] Fix | Delete

[402] Fix | Delete

$highest_priority = '';

[403] Fix | Delete

[404] Fix | Delete

foreach ( $template['use_on'] as $setting_id ) {

[405] Fix | Delete

if ( $this->_fulfills_template_setting( $flat_settings, $setting_id ) ) {

[406] Fix | Delete

$highest_priority = $this->_get_higher_priority_template_setting( $flat_settings, $highest_priority, $setting_id );

[407] Fix | Delete

}

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

if ( '' !== $highest_priority ) {

[411] Fix | Delete

$applicable_templates[] = array(

[412] Fix | Delete

'template' => $template,

[413] Fix | Delete

'top_setting_id' => $highest_priority,

[414] Fix | Delete

);

[415] Fix | Delete

}

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

$__et_theme_builder_request_flat_settings = $flat_settings;

[419] Fix | Delete

$applicable_template = array_reduce( $applicable_templates, array( $this, 'reduce_get_template' ), array() );

[420] Fix | Delete

$__et_theme_builder_request_flat_settings = array();

[421] Fix | Delete

[422] Fix | Delete

if ( ! empty( $applicable_template ) ) {

[423] Fix | Delete

// Found the highest priority applicable template - return it.

[424] Fix | Delete

return $applicable_template['template'];

[425] Fix | Delete

}

[426] Fix | Delete

[427] Fix | Delete

$default_templates = et_()->array_pick( $templates, array( 'default' => true ) );

[428] Fix | Delete

[429] Fix | Delete

if ( ! empty( $default_templates ) ) {

[430] Fix | Delete

$default_template = $default_templates[0];

[431] Fix | Delete

[432] Fix | Delete

if ( $default_template['enabled'] ) {

[433] Fix | Delete

// Return the first default template. We don't expect there to be multiple ones but

[434] Fix | Delete

// it is technically possible with direct database edits, for example.

[435] Fix | Delete

return $default_template;

[436] Fix | Delete

}

[437] Fix | Delete

}

[438] Fix | Delete

[439] Fix | Delete

// No templates found at all - probably never used the Theme Builder.

[440] Fix | Delete

return array();

[441] Fix | Delete

}

[442] Fix | Delete

}

[443] Fix | Delete

[444] Fix | Delete