thefrosty / wp-utilities

A library containing my standard development resources for bootsrapping WordPress plugins.

Frosty's WordPress Utilities

A library containing my standard development resources to build high quality WordPress plugins.

Requirements

PHP >= 8.1
WordPress >= 6.1

PHP version	WP Utilities
< 7.1	1.3.x
>= 7.1 && < 7.3	1.9.x
7.3	2.0.0
>= 7.4	2.1.0
>= 8.0	3.0
>= 8.1	3.3

The required WordPress version will always be the most recent point release of the previous major release branch.

For both PHP and WordPress requirements, although this library may work with a version below the required versions, they will not be supported and any compatibility is entirely coincidental.

Installation

To install this library, use Composer:

composer require thefrosty/wp-utilities:^3.3

Then follow examples in the Plugin README

wp-utilities's Issues

Psr/Container: Psr11\ServiceLocator version 2 error

Fatal error: Declaration of Pimple\Psr11\ServiceLocator::has($id) must be compatible with Psr\Container\ContainerInterface::has(string $id): bool in /srv/users/serverpilot/apps/frosty-web-designs/public/wp-content/plugins/satispress/vendor/pimple/pimple/src/Pimple/Psr11/ServiceLocator.php on line 71

PHP8 Fatal error: Declaration must be compatible

PHP Fatal error:  Declaration of Pimple\Psr11\ServiceLocator::get(string $id) 
must be compatible with Psr\Container\ContainerInterface::get($id) in 
/.../plugins/wp-debug-log-widget/vendor/pimple/pimple/src/Pimple/Psr11/ServiceLocator.php on line 59

PHP Fatal error:  Declaration of TheFrosty\WpUtilities\Plugin\Container::get(string $id) 
must be compatible with Psr\Container\ContainerInterface::get($id) in 
/.../plugins/wp-login-locker/vendor/thefrosty/wp-utilities/src/Plugin/Container.php on line 23

Enhancement: Get Unit Test Coverage to ~90%

PHP 8.2: Errors in PHPStan Runner

See https://github.com/thefrosty/wp-utilities/actions/runs/4950330475/jobs/8853791217?pr=115

  Line   PostTypes/AbstractPostType.php                                        
 ------ ---------------------------------------------------------------------- 
  62     Method                                                                
         TheFrosty\WpUtilities\PostTypes\AbstractPostType::registerPostType()  
         has invalid return type PostTypes\PostType.                           
  62     Method                                                                
         TheFrosty\WpUtilities\PostTypes\AbstractPostType::registerPostType()  
         has invalid return type PostTypes\PostType.                           
  64     Instantiated class PostTypes\PostType not found.                      
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols   
  65     Call to method register() on an unknown class PostTypes\PostType.     
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols   
 ------ ---------------------------------------------------------------------- 

 ------ ------------------------------------------------------------------------ 
  Line   Taxonomies/AbstractTaxonomy.php                                         
 ------ ------------------------------------------------------------------------ 
  45     PHPDoc tag @throws with type                                            
         TheFrosty\WpUtilities\Exceptions\Exception is not subtype of            
         Throwable                                                               
  48     Instantiated class TheFrosty\WpUtilities\Exceptions\Exception not       
         found.                                                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
  48     Throwing object of an unknown class                                     
         TheFrosty\WpUtilities\Exceptions\Exception.                             
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
  52     Instantiated class TheFrosty\WpUtilities\Exceptions\Exception not       
         found.                                                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
  52     Throwing object of an unknown class                                     
         TheFrosty\WpUtilities\Exceptions\Exception.                             
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
  73     Method                                                                  
         TheFrosty\WpUtilities\Taxonomies\AbstractTaxonomy::registerTaxonomy()   
         has invalid return type PostTypes\Taxonomy.                             
  73     Method                                                                  
         TheFrosty\WpUtilities\Taxonomies\AbstractTaxonomy::registerTaxonomy()   
         has invalid return type PostTypes\Taxonomy.                             
  75     Instantiated class PostTypes\Taxonomy not found.                        
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
  77     Call to method register() on an unknown class PostTypes\Taxonomy.       
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
  140    Parameter $taxonomy of method                                           
         TheFrosty\WpUtilities\Taxonomies\AbstractTaxonomy::registerPostTypes()  
         has invalid type PostTypes\Taxonomy.                                    
  140    Parameter $taxonomy of method                                           
         TheFrosty\WpUtilities\Taxonomies\AbstractTaxonomy::registerPostTypes()  
         has invalid type PostTypes\Taxonomy.                                    
  147    Call to method posttype() on an unknown class PostTypes\Taxonomy.       
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols     
 ------ ------------------------------------------------------------------------ 

 ------ ------------------------------------------------------------------------------ 
  Line   Utils/AbstractSingleton.php                                                   
 ------ ------------------------------------------------------------------------------ 
  24     Unsafe usage of new static().                                                 
         💡 See:                                                                       
            https://phpstan.org/blog/solving-phpstan-error-unsafe-usage-of-new-static  
 ------ ------------------------------------------------------------------------------ 

 ------ ----------------------------------------------------------------------- 
  Line   Utils/View.php                                                         
 ------ ----------------------------------------------------------------------- 
  77     Parameter #1 $args of method TheFrosty\WpUtilities\Utils\View::load()  
         expects array<string, array>, array<int, array|string> given.          
  137    Offset 0 does not exist on array<string, array>.                       
  137    Offset 1 does not exist on array<string, array>.                       
  202    PHPDoc tag @return with type mixed is not subtype of native type       
         void.                                                                  
 ------ ----------------------------------------------------------------------- 

 ------ -------------------------------------------------------------------- 
  Line   WpAdmin/DisablePluginUpdateCheck.php                                
 ------ -------------------------------------------------------------------- 
  49     Result of && is always false.                                       
         💡 Because the type is coming from a PHPDoc, you can turn off this  
            check by setting treatPhpDocTypesAsCertain: false in your        
            phpstan.neon.dist.                                               
  52     Strict comparison using === between true and false will always      
         evaluate to false.                                                  
         💡 Because the type is coming from a PHPDoc, you can turn off this  
            check by setting treatPhpDocTypesAsCertain: false in your        
            phpstan.neon.dist.                                               
 ------ -------------------------------------------------------------------- 

 -- -------------------------------------------------------------------------- 
     Error                                                                     
 -- -------------------------------------------------------------------------- 
     Ignored error pattern #^Function apply_filters(_ref_array)? invoked with  
     [34567] parameters, 2 required\.$# was not matched in reported errors.    
 -- -------------------------------------------------------------------------- 

Error:  [ERROR] Found 54 errors          

Can't add object with properties

In AbstractPlugin::addOnHook the first parameter is a string (the fully qualified class name) so that the class isn't instantiated earlier than the hook it's needed to be loaded on, but that doesn't allow any properties to be passed to the class if it has dependencies.

Look into an alternative like changing it to an array where the key is the class and the value is an array of properties to inject or possibly a model using the BaseModel class.

Running code quality tools on the whole project shows errors

vendor/bin/phpcs --standard=phpcs-ruleset.xml src/
vendor/bin/phpmd src/ text phpmd-ruleset.xml --exclude tests,vendor --suffixes php

Please consider running CI on every file: composer run-script ci

Enhancement: Plugin Update Check for new DocBlock header: `Update URI`

See introduction of new code in WordPress 5.8: https://make.wordpress.org/core/2021/06/29/introducing-update-uri-plugin-header-in-wordpress-5-8/

This project needs a name

Please give it a name.

Maybe something not beginning with "WordPress". Maybe ending in "for WordPress"

e.g. Frosty Utils for WordPress

Support for adding on condition

Just like addOnHook, maybe add an addOnCondition that a callback can be passed in to add conditional instantiations based on things like class_exits or the like.

Error message: Uncaught Error: Call to protected method

wp-utilities/views/dashboard-widget/rest.php

Line 15 in 57f3c52

$wpRemote->deleteCache($wpRemote->getQueryCacheKey() ?? '');

Opened in https://wordpress.org/support/topic/fatal-error-v4-0-8/#post-16592722

Drop Support for PHP 8.0