Skip to content
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.

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

Fix infinite loop when calling wp_get_upload_dir in a function that's used to filter font_dir #6200

Closed

Conversation

matiasbenedetto
Copy link

@matiasbenedetto matiasbenedetto commented Feb 28, 2024

ℹ️ Porting WordPress/gutenberg#58839 already merged in from Gutenberg repo.

What?

Fix infinite loop when calling wp_get_upload_dir in a function that's used to filter font_dir.
An alternative approach to: #6198

Why?

This avoids an infinite loop that can occur if wp_upload_dir() is called inside a 'font_dir' callback.

Testing instructions

  1. Use wp_get_upload_dir() inside a function used to filter upload_dir as in the following example:
 function alter_wp_fonts_dir( $defaults ) {
	$wp_upload_dir = wp_get_upload_dir();
	$uploads_basedir = $wp_upload_dir['basedir'];
	$uploads_baseurl = $wp_upload_dir['baseurl'];

	$fonts_dir = $uploads_basedir . '/fonts';
	// Generate the URL for the fonts directory from the font dir.
	$fonts_url = str_replace( $uploads_basedir, $uploads_baseurl, $fonts_dir );

	$defaults['path'] = $fonts_dir;
	$defaults['url']  = $fonts_url;

	return $defaults;
}
add_filter( 'font_dir', 'alter_wp_fonts_dir' );
  1. Upload fonts using the font library
  2. Check that the fonts were successfully uploaded to the path set by the filter.
    (wp-content/uploads/fonts in the example provided).

Trac ticket: https://core.trac.wordpress.org/ticket/60652

Copy link

github-actions bot commented Feb 28, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props mmaattiiaass, ironprogrammer.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@ironprogrammer
Copy link

Test Report

Environment

  • System: MacBook Pro Apple M1 Pro, macOS 14.3.1
  • Browser: Safari 17.3.1
  • Server: nginx/1.25.4, PHP 8.2.16, MySQL 8.0.27
  • WordPress: 6.5-beta3-57723-src
  • Theme: twentytwentyfour v1.0
  • Active Plugins:
    • font-dir-mover (mu-plugin with sample font_dir filter code)

Actual Results

  • ✅ Fonts saved successfully to relocated font storage directory, wp-content/uploads/fonts (+directory creation was successful).

Supplemental Artifacts

Figure 1: Before patch.
font face not installed

Figure 2: After patch.
font face installed successfully

Figure 3: Source URL after patch.
font saved to wp-content/uploads/fonts

Copy link

@ironprogrammer ironprogrammer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, @matiasbenedetto! Just a nit on comment spacing here.

Co-authored-by: Brian Alexander <824344+ironprogrammer@users.noreply.github.com>
@youknowriad
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants