brian/wp-plugin-boilerplate
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

just updating some docblocks

Browse Source
This commit is contained in:
Brian
2023-07-28 11:43:53 -06:00
parent f9125ca8cf
commit 3d58f71135
3 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
includes/class-nmspcli.php
View File

@ -13,6 +13,7 @@ class NmspCli {
/** /**
* Class constructor. Can add commands here. * Class constructor. Can add commands here.
* *
* @package PluginNamespace\NmspCli
* @since 1.0.0 * @since 1.0.0
* *
* @return void * @return void
@ -31,6 +32,7 @@ class NmspCli {
/** /**
* A sample method where something is done by being invoked from WP CLI. * A sample method where something is done by being invoked from WP CLI.
* *
* @package PluginNamespace\NmspCli
* @since 1.0.0 * @since 1.0.0
* *
* @return void * @return void

10
includes/front/class-rewrites.php
View File

@ -11,6 +11,7 @@ class Rewrites {
/** /**
* Class constructor. * Class constructor.
* *
* @package PluginNamespace\Front\Rewrites
* @since 1.0.0 * @since 1.0.0
* *
* @return void * @return void
@ -25,6 +26,7 @@ class Rewrites {
/** /**
* Generate new rewrite rules and flush the cached values. * Generate new rewrite rules and flush the cached values.
* *
* @package PluginNamespace\Front\Rewrites
* @since 1.0.0 * @since 1.0.0
* *
* @return void * @return void
@ -50,9 +52,10 @@ class Rewrites {
* Build the array of post IDs that have a slug for the URL * Build the array of post IDs that have a slug for the URL
* along with what custom query variable to use. * along with what custom query variable to use.
* *
* @package PluginNamespace\Front\Rewrites
* @since 1.0.0 * @since 1.0.0
* *
* @return array * @return array<int, array<string, string>>
*/ */
public function build_rewrite_urls(): array { public function build_rewrite_urls(): array {
$pages = array(); $pages = array();
@ -82,11 +85,12 @@ class Rewrites {
* Append custom query variables to the list WordPress maintinas * Append custom query variables to the list WordPress maintinas
* with each request. * with each request.
* *
* @package PluginNamespace\Front\Rewrites
* @since 1.0.0 * @since 1.0.0
* *
* @param array $variable * @param array<int, string> $vars
* *
* @return array * @return array<int, string>
*/ */
public function custom_query_vars( array $vars ): array { public function custom_query_vars( array $vars ): array {
$vars[] = 'foo'; $vars[] = 'foo';

6
nmsp-plugin-name.php
View File

@ -6,13 +6,13 @@ use eftec\bladeone\BladeOne;
/** /**
* Boilerplate Plugin v2 * Boilerplate Plugin v2
* *
* @package BoilerplatePluginv2 * @package BoilerplatePlugin
* @author Plugin Author * @author Plugin Author
* @copyright GPLv3 * @copyright GPLv3
* @license https://www.gnu.org/licenses/gpl-3.0.en.html * @license https://www.gnu.org/licenses/gpl-3.0.en.html
* *
* @wordpress-plugin * @wordpress-plugin
* Plugin Name: Boilerplate Plugin v2 * Plugin Name: Boilerplate Plugin
* Description: Your plugin description. * Description: Your plugin description.
* License: GPLv3 * License: GPLv3
* License URI: https://www.gnu.org/licenses/gpl-3.0.en.html * License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
@ -20,7 +20,7 @@ use eftec\bladeone\BladeOne;
* Update URI: https://example.com/my-plugin/ * Update URI: https://example.com/my-plugin/
* Version: 1.0.0 * Version: 1.0.0
* Requires at least: 5.2 * Requires at least: 5.2
* Requires PHP: 8.0.2 * Requires PHP: 8.1
* Author: Plugin Author * Author: Plugin Author
* Author URI: https://plugin-author.com * Author URI: https://plugin-author.com
* Text Domain: nmsp-plugin-name-text-domain * Text Domain: nmsp-plugin-name-text-domain