Skip to content

Fire actions before and after Optimization Detective processes a document #1919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
westonruter merged 16 commits into from
Mar 15, 2025
Merged

Fire actions before and after Optimization Detective processes a document #1919

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
abdefc0
Move OD initialization to wp action instead of output buffer callback
westonruter Mar 12, 2025
64d63da
Add od_start_template_optimization action
westonruter Mar 12, 2025
3b0f696
Initiaize OD objects at template_include filter
westonruter Mar 12, 2025
f7da494
Introduce OD_Template_Optimization_Context
westonruter Mar 12, 2025
51feaad
Add link collection to context
westonruter Mar 12, 2025
0ad7f79
Reuse template optimization context in od_optimize_template_output_bu…
westonruter Mar 12, 2025
8bcfc13
Finalize the tag registry after the od_register_tag_visitors action h…
westonruter Mar 13, 2025
a57391d
Add TODO in Image_Prioritizer_Background_Image_Styled_Tag_Visitor
westonruter Mar 13, 2025
6abee9c
Go back to initializing in footer but add action before/after optimiz…
westonruter Mar 13, 2025
09d7af7
Rename variable make it distinct from other context
westonruter Mar 13, 2025
0d8cb65
Use phpdoc to declare that the post ID is a positive-int|null
westonruter Mar 13, 2025
38a4c6b
Add tests and fix bug with adding links at finish action
westonruter Mar 14, 2025
5d12ef7
Add docs for requirement for valid HTML passed into methods
westonruter Mar 14, 2025
5da134c
Merge branch 'trunk' into update/od-initialization-timing
westonruter Mar 14, 2025
53a91a2
Remove append_head_html() and append_body_html() methods from OD_Temp…
westonruter Mar 14, 2025
a01d760
Merge branch 'trunk' into update/od-initialization-timing
westonruter Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add docs for requirement for valid HTML passed into methods
  • Loading branch information
@westonruter
westonruter committed Mar 14, 2025
commit 5d12ef7dd06b2c486b97d409f80d7adb74913ae1
24 changes: 14 additions & 10 deletions plugins/optimization-detective/class-od-html-tag-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,29 +702,33 @@ public function is_admin_bar(): bool {
}

/**
* Append HTML to the HEAD.
* Appends raw HTML to the HEAD.
*
* The provided HTML must be valid! No validation is performed.
* The provided HTML must be valid for insertion in the HEAD. No validation is currently performed. However, in the
* future the HTML Processor may be used to ensure the validity of the provided HTML. At that time, when invalid
* HTML is provided, this method may emit a `_doing_it_wrong()` warning.
*
* @since 0.4.0
*
* @param string $html HTML to inject.
* @param string $raw_html Raw HTML to inject.
*/
public function append_head_html( string $html ): void {
$this->buffered_text_replacements[ self::END_OF_HEAD_BOOKMARK ][] = $html;
public function append_head_html( string $raw_html ): void {
$this->buffered_text_replacements[ self::END_OF_HEAD_BOOKMARK ][] = $raw_html;
}

/**
* Append HTML to the BODY.
* Appends raw HTML to the BODY.
*
* The provided HTML must be valid! No validation is performed.
* The provided HTML must be valid for insertion in the BODY. No validation is currently performed. However, in the
* future the HTML Processor may be used to ensure the validity of the provided HTML. At that time, when invalid
* HTML is provided, this method may emit a `_doing_it_wrong()` warning.
*
* @since 0.4.0
*
* @param string $html HTML to inject.
* @param string $raw_html Raw HTML to inject.
*/
public function append_body_html( string $html ): void {
$this->buffered_text_replacements[ self::END_OF_BODY_BOOKMARK ][] = $html;
public function append_body_html( string $raw_html ): void {
$this->buffered_text_replacements[ self::END_OF_BODY_BOOKMARK ][] = $raw_html;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion plugins/optimization-detective/class-od-tag-visitor-context.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public function track_tag(): void {
* @throws Error When property is unknown.
*/
public function __get( string $name ) {
// Note that there is intentionally not a case for 'visited_tag_state'.
// Note: There is intentionally not a 'visited_tag_state' case to expose $this->visited_tag_state.
switch ( $name ) {
case 'processor':
return $this->processor;
Expand Down
28 changes: 17 additions & 11 deletions plugins/optimization-detective/class-od-template-optimization-context.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,29 +101,35 @@ public function __construct( OD_HTML_Tag_Processor $processor, OD_URL_Metric_Gro
}

/**
* Append HTML to the HEAD.
* Appends raw HTML to the HEAD.
*
* The provided HTML must be valid! No validation is performed.
* The provided HTML must be valid for insertion in the HEAD. No validation is currently performed. However, in the
* future the HTML Processor may be used to ensure the validity of the provided HTML. At that time, when invalid
* HTML is provided, this method may emit a `_doing_it_wrong()` warning.
*
* @since n.e.x.t
* @see OD_HTML_Tag_Processor::append_head_html()
*
* @param non-empty-string $html HTML to inject.
* @param string $raw_html Raw HTML to inject.
*/
public function append_head_html( string $html ): void {
$this->processor->append_head_html( $html );
public function append_head_html( string $raw_html ): void {
$this->processor->append_head_html( $raw_html );
}

/**
* Append HTML to the BODY.
* Appends raw HTML to the BODY.
*
* The provided HTML must be valid! No validation is performed.
* The provided HTML must be valid for insertion in the BODY. No validation is currently performed. However, in the
* future the HTML Processor may be used to ensure the validity of the provided HTML. At that time, when invalid
* HTML is provided, this method may emit a `_doing_it_wrong()` warning.
*
* @since n.e.x.t
* @see OD_HTML_Tag_Processor::append_body_html()
*
* @param non-empty-string $html HTML to inject.
* @param string $raw_html HTML to inject.
*/
public function append_body_html( string $html ): void {
$this->processor->append_body_html( $html );
public function append_body_html( string $raw_html ): void {
$this->processor->append_body_html( $raw_html );
}

/**
Expand All @@ -137,7 +143,7 @@ public function append_body_html( string $html ): void {
* @throws Error When property is unknown.
*/
public function __get( string $name ) {
// Note: The $processor is intentionally not exposed.
// Note: There is intentionally not a 'processor' case to expose $this->processor.
switch ( $name ) {
case 'url_metrics_id':
return $this->url_metrics_id;
Expand Down