wp scaffold
Генерує код для типів записів, таксономій, плагінів, дочірніх тем тощо.
Список команд | Опис |
---|---|
wp scaffold post-type | Генерує PHP код для реєстрації типу запису користувача. |
wp scaffold taxonomy | Генерує PHP код для реєстрації таксономії користувача. |
wp scaffold block | Генерує PHP, JS та CSS код для реєстрації блоку Гутенберга, для плагіна чи теми. |
wp scaffold _s | Створює початковий код теми на основі теми _s. |
wp scaffold child-theme | Створює дочірню тему з урахуванням існуючої теми. |
wp scaffold plugin | Генерує стартовий код для плагіна. |
wp scaffold plugin-tests | Створює файли, необхідні для виконання тестів PHPUnit у плагіні. |
wp scaffold theme-tests | Створює файли, необхідні для виконання тестів PHPUnit у тему. |
Приклади
# Generate a new plugin with unit tests $ wp scaffold plugin sample-plugin Success: Created plugin files. Success: Created test files. # Generate theme based on _s $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe" Success: Created theme 'Sample Theme'. # Generate code for post type registration in given theme $ wp scaffold post-type movie --label=Movie --theme=simple-life Success: Created /var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php
Вихідний код команд
wp scaffold post-type
Генерує PHP код для реєстрації типу запису користувача.
Використання
wp scaffold post-type {slug} [--label={label}] [--textdomain={textdomain}] [--dashicon={dashicon}] [--theme] [--plugin={plugin}] [ --raw] [--force]
Можна вказати Глобальні параметри та такі:
- {slug}
- Внутрішнє ім’я по типу типу.
- [–label={label}]
- Text використовується для передачі оновлень messages.
- [–textdomain={textdomain}]
- Textdomain to use for labels.
- [–dashicon={dashicon}]
- Dashicon to use в menu.
- [–theme]
-
Створюйте файл в активній тематиці директора, додайте повідомлення до STDOUT. Specify theme with
–theme=<theme> щоб мати файл placed in theme. - [–plugin={plugin}]
- Створюйте файл у гігієнічному модулі директорії, досліджуючий подання до STDOUT.
- [–raw]
-
Just generate
register_post_type() call and nothing else. - [–force]
- Перевірте файли, що існують.
Приклади
# Generate a 'movie' post type for the 'simple-life' theme $ wp scaffold post-type movie --label=Movie --theme=simple-life Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'.
wp scaffold taxonomy
Генерує PHP код для реєстрації таксономії користувача.
Використання
wp scaffold taxonomy {slug} [--post_types={post-types}] [--label={label}] [--textdomain={textdomain}] [--theme] [--plugin={plugin}] [ --raw] [--force]
Можна вказати Глобальні параметри та такі:
- {slug}
- Внутрішня назва taxonomy.
- [–post_types={post-types}]
- Post types до registra для використання з taxonomy.
- [–label={label}]
- Text використовується для передачі оновлень messages.
- [–textdomain={textdomain}]
- Textdomain to use for labels.
- [–theme]
-
Створюйте файл в активній тематиці директора, додайте повідомлення до STDOUT. Specify theme with
–theme=<theme> щоб мати файл placed in theme. - [–plugin={plugin}]
- Створюйте файл у гігієнічному модулі директорії, досліджуючий подання до STDOUT.
- [–raw]
-
Just generate the
register_taxonomy() call and nothing else. - [–force]
- Перевірте файли, що існують.
Приклади
# Generate PHP code для registering a custom taxonomy and save in a file $ wp scaffold taxonomy venue --post_types=event,presentation > taxonomy.php
wp scaffold block
Генерує PHP, JS та CSS код для реєстрації блоку Гутенберга, для плагіна чи теми.
Блоки є важливим елементом в Gutenberg editor. Вони є пріоритетним способом в яких plugins і теми можуть тримати свої власні функціональності і розширити можливості з editorом.
Visit the Gutenberg handbook до більше, ніж Block API.
Якщо ви збираєтеся блокувати ви повинні використовувати їх тема або plugin option. Latter is recommended.
Використання
wp scaffold block {slug} [--title={title}] [--dashicon={dashicon}] [--category={category}] [--theme] [--plugin={plugin}] [-- force]
Можна вказати Глобальні параметри та такі:
- {slug}
- Внутрішня назва блоку.
- [–title={title}]
- Display title for your block.
- [–dashicon={dashicon}]
- dashicon to make it easier to identify your block.
- [–category={category}]
- Category name to help users browse and discover your block.
Типово: widgets
Можливо:- common
- embed
- formatting
- layout
- widgets
- [–theme]
-
Створити файли в активному тематиці. Specify theme with
–theme=<theme> щоб мати файл placed in theme. - [–plugin={plugin}]
- Створюйте файли в гігієнічному plugin’s directory.
- [–force]
- Перевірте файли, що існують.
Приклади
# Generate a 'movie' block for the 'movies' plugin $ wp scaffold block movie --title="Movie block" --plugin=movies Success: Created block 'Movie block'.
# Generate a 'movie' block for the 'simple-life' theme $ wp scaffold block movie --title="Movie block" --theme=simple-life Success: Created block 'Movie block'.
# Create a new plugin and add two blocks # Create plugin called books $ wp scaffold plugin books # Add a block called book to plugin books $ wp scaffold block book --title="Book" --plugin=books # Add a second block to plugin called books. $ wp scaffold block books --title="Book List" --plugin=books
wp scaffold _s
Створює початковий код теми на основі теми _s.
Щоб дізнатися більше про тему, відвідайте офіційний сайт Underscores .
Аліас:
wp scaffold underscores
Використання
wp scaffold _s {slug} [--activate] [--enable-network] [--theme_name={title}] [--author={full-name}] [--author_uri={uri}] [-- sassify] [--woocommerce] [--force]
Можна вказати Глобальні параметри та такі:
- {slug}
- Служок для нового теми, використовуваний для fixing функцій.
- [–activate]
- Activate the newly downloaded theme.
- [–enable-network]
- Enable the newly downloaded theme for the entire network.
- [–theme_name={title}]
- What to put в ‘Theme Name:’ header in ‘style.css’.
- [–author={full-name}]
- What to put in the ‘Author:’ header in ‘style.css’.
- [–author_uri={uri}]
- What to put в ‘Author URI:’ header in ‘style.css’.
- [–sassify]
- Включають у себемети як SASS.
- [–woocommerce]
- Include WooCommerce boilerplate files.
- [–force]
- Перевірте файли, що існують.
Приклади
# Generate a theme with name "Sample Theme" and author "John Doe" $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe" Success: Created theme 'Sample Theme'.
wp scaffold child-theme
Створює дочірню тему з урахуванням існуючої теми.
Створюйте хлопець тема folder with functions.php and style.css files.
Використання
wp scaffold child-theme {slug} --parent_theme={slug} [--theme_name={title}] [--author={full-name}] [--author_uri={uri}] [--theme_uri={ uri}] [--activate] [--enable-network] [--force]
Можна вказати Глобальні параметри та такі:
- {slug}
- Slug for the new child theme.
- –parent_theme={slug}
- What to put in the ‘Template:’ header in ‘style.css’.
- [–theme_name={title}]
- What to put в ‘Theme Name:’ header in ‘style.css’.
- [–author={full-name}]
- What to put in the ‘Author:’ header in ‘style.css’.
- [–author_uri={uri}]
- What to put в ‘Author URI:’ header in ‘style.css’.
- [–theme_uri={uri}]
- What to put в ‘Theme URI:’ header in ‘style.css’.
- [–activate]
- Activate the newly created child theme.
- [–enable-network]
- Enable the newly created child theme for the entire network.
- [–force]
- Перевірте файли, що існують.
Приклади
# Generate a 'sample-theme' child theme based on TwentySixteen $ wp scaffold child-theme sample-theme --parent_theme=twentysixteen Success: Created '/var/www/example.com/public_html/wp-content/themes/sample-theme'.
wp scaffold plugin
Генерує стартовий код для плагіна.
The following files are always generated:
- plugin-slug.php is the main PHP plugin file.
- readme.txt is the readme file for the plugin.
- package.json потребує NPM holds різні metadata relevant to the project. Packages: grunt , grunt-wp-i18n та grunt-wp-readme-to-markdown .
- Gruntfile.js є JS файлом, що містить Grunt tasks. Tasks: i18n містить addtextdomain and makepot , readme containing wp_readme_to_markdown .
- .editorconfig is the configuration file для Editor.
- .gitignore tells which files (or patterns) git should ignore.
- .distignore tells which files and folders should be ignored in distribution.
Наступні файли є також включені до незмінного –skip -tests is used:
- phpunit.xml.dist is configuration file for PHPUnit.
- .travis.yml є налаштування файлу для Travis CI. Use –ci=<provider> to select a different service.
- bin/install-wp-tests.sh configures the WordPress test suite and a test database.
- tests/bootstrap.php is the file that makes the current plugin active when running the test suite.
- tests/test-sample.php is a sample file containing test cases.
- .phpcs.xml.dist is a collection of PHP_CodeSniffer rules.
Використання
wp scaffold plugin {slug} [--dir={dirname}] [--plugin_name={title}] [--plugin_description={description}] [--plugin_author={author}] [--plugin_author_uri={url} ] [--plugin_uri={url}] [--skip-tests] [--ci={provider}] [--activate] [--activate-network] [--force]
Можна вказати Глобальні параметри та такі:
- {slug}
- Внутрішня назва plugin.
- [–dir={dirname}]
- Натисніть на новий plugin в деякій arbitrary directory path. Plugin directory will be path plus supplied slug.
- [–plugin_name={title}]
- What to put в ‘Plugin Name:’ header.
- [–plugin_description={description}]
- What to put в ‘Description:’ header.
- [–plugin_author={author}]
- What to put in the ‘Author:’ header.
- [–plugin_author_uri={url}]
- What to put in the ‘Author URI:’ header.
- [–plugin_uri={url}]
- What to put в ‘Plugin URI:’ header.
- [–skip-tests]
- Don’t generate files for unit testing.
- [–ci={provider}]
- Choose a configuration file для continuous integration provider.
Типово: travis
Можливо:- travis
- circle
- gitlab
- [–activate]
- Activate the newly generated plugin.
- [–activate-network]
- Network activate the newly generated plugin.
- [–force]
- Перевірте файли, що існують.
Приклади
$ wp scaffold plugin sample-plugin Success: Created plugin files. Success: Created test files.
wp scaffold plugin-tests
Створює файли, необхідні для виконання тестів PHPUnit у плагіні.
The following files are generated by default:
- phpunit.xml.dist is configuration file for PHPUnit.
- .travis.yml є налаштування файлу для Travis CI. Use –ci=<provider> to select a different service.
- bin/install-wp-tests.sh configures the WordPress test suite and a test database.
- tests/bootstrap.php is the file that makes the current plugin active when running the test suite.
- tests/test-sample.php is a sample file, що містить нові тести.
- .phpcs.xml.dist is a collection of PHP_CodeSniffer rules.
Learn more from the plugin unit tests documentation .
Довкілля
Tests /bootstrap.php file looks for WP_TESTS_DIR environment variable.
Використання
wp scaffold plugin-tests [{plugin}] [--dir={dirname}] [--ci={provider}] [--force]
Можна вказати Глобальні параметри та такі:
- [{plugin}]
- Назву файлу для створення test files for.
- [–dir={dirname}]
- Generate test files for non-standard plugin path. Якщо не plugin slug is specified, the directory name is used.
- [–ci={provider}]
- Choose a configuration file для continuous integration provider.
Типово: travis
Можливо:- travis
- circle
- gitlab
- bitbucket
- [–force]
- Перевірте файли, що існують.
Приклади
# Generate unit test files for plugin 'sample-plugin'. $ wp scaffold plugin-tests sample-plugin Success: Created test files.
wp scaffold theme-tests
Створює файли, необхідні для виконання тестів PHPUnit у тему.
The following files are generated by default:
- phpunit.xml.dist is configuration file for PHPUnit.
- .travis.yml є налаштування файлу для Travis CI. Use –ci=<provider> to select a different service.
- bin/install-wp-tests.sh configures the WordPress test suite and a test database.
- tests/bootstrap.php is the file that makes the current theme active when running the test suite.
- tests/test-sample.php is a sample file, що містить нові тести.
- .phpcs.xml.dist is a collection of PHP_CodeSniffer rules.
Learn more from the plugin unit tests documentation .
Довкілля
Tests /bootstrap.php file looks for WP_TESTS_DIR environment variable.
Використання
wp scaffold theme-tests [{theme}] [--dir={dirname}] [--ci={provider}] [--force]
Можна вказати Глобальні параметри та такі:
- [{theme}]
- Ім’я теми для створення test files for.
- [–dir={dirname}]
- Generate test files for non-standard theme path. Якщо ви не знайдете значення slug, в directory name is used.
- [–ci={provider}]
- Choose a configuration file для continuous integration provider.
Типово: travis
Можливо:- travis
- circle
- gitlab
- bitbucket
- [–force]
- Перевірте файли, що існують.
Приклади
# Generate unit test files for theme 'twentysixteenchild'. $ wp scaffold theme-tests twentysixteenchild Success: Created test files.