woocommerce / code-reference

WooCommerce Code Reference Generator

WooCommerce Monorepo

Welcome to the WooCommerce Monorepo on GitHub. Here you can find all of the plugins, packages, and tools used in the development of the core WooCommerce plugin as well as WooCommerce extensions. You can browse the source, look at open issues, contribute code, and keep tracking of ongoing development.

We recommend all developers to follow the WooCommerce development blog to stay up to date about everything happening in the project. You can also follow @DevelopWC on Twitter for the latest development updates.

Getting Started

To get up and running within the WooCommerce Monorepo, you will need to make sure that you have installed all of the prerequisites.

Prerequisites

• NVM: While you can always install Node through other means, we recommend using NVM to ensure you're aligned with the version used by our development teams. Our repository contains an .nvmrc file which helps ensure you are using the correct version of Node.
• PNPM: Our repository utilizes PNPM to manage project dependencies and run various scripts involved in building and testing projects.
• PHP 7.4+: WooCommerce Core currently features a minimum PHP version of 7.4. It is also needed to run Composer and various project build scripts. See troubleshooting for troubleshooting problems installing PHP.
• Composer: We use Composer to manage all of the dependencies for PHP packages and plugins.

Once you've installed all of the prerequisites, you can run the following commands to get everything working.

# Ensure that you're using the correct version of Node
nvm use
# Install the PHP and Composer dependencies for all of the plugins, packages, and tools
pnpm install
# Build all of the plugins, packages, and tools in the monorepo
pnpm build

At this point you are now ready to begin developing and testing. All of the build outputs are cached running pnpm build again will only build the plugins, packages, and tools that have changed since the last time you ran the command.

Check out our development guide if you would like a more comprehensive look at working in our repository.

Repository Structure

• Plugins: Our repository contains plugins that relate to or otherwise aid in the development of WooCommerce.
  • WooCommerce Core: The core WooCommerce plugin is available in the plugins directory.
• Packages: Contained within the packages directory are all of the PHP and JavaScript provided for the community. Some of these are internal dependencies and are marked with an internal- prefix.
• Tools: We also have a growing number of tools within our repository. Many of these are intended to be utilities and scripts for use in the monorepo, but, this directory may also contain external tools.

Reporting Security Issues

To disclose a security issue to our team, please submit a report via HackerOne here.

Support

This repository is not suitable for support. Please don't use our issue tracker for support requests, but for core WooCommerce issues only. Support can take place through the appropriate channels:

• If you have a problem, you may want to start with the self help guide.
• The WooCommerce.com premium support portal for customers who have purchased themes or extensions.
• Our community forum on wp.org which is available for all WooCommerce users.
• The Official WooCommerce Facebook Group.
• For customizations, you may want to check our list of WooExperts or Codeable.

NOTE: Unfortunately, we are unable to honor support requests in issues on this repository; as a result, any requests submitted in this manner will be closed.

Community

For peer to peer support, real-time announcements, and office hours, please join our slack community!

Contributing to WooCommerce

As an open source project, we rely on community contributions to continue to improve WooCommerce. To contribute, please follow the pre-requisites above and visit our Contributing to Woo doc for more links and contribution guidelines.

code-reference's Issues

Add "Direct known implementers" and "Indirect known implementers"

Like in our old framework:

Cannot use 'Object' as class name as it is reserved

@claudiosanches I have tested this repo with PHP 7.2 and received the following error:

Fatal error: Cannot use 'Object' as class name as it is reserved in /var/www/html/apigen/vendor/latte/latte/src/Latte/Object.php on line 14 ErrorException: Cannot use 'Object' as class name as it is reserved in /var/www/html/apigen/vendor/latte/latte/src/Latte/Object.php:14

[Idea] GitHub action to deploy API docs

Just like action-build, it would be better to deploy API code reference during the release process via GitHub action.

Parser for WordPress hooks

@claudiosanches For hooks, isn't there an easy process to generate by parsing like previously done in ApiGen context. If some hooks get added then it has to be manually inserted currently right?

Hooks generator does not get all the PHP files to scan

Context

At Ventures team we would like to generate a hooks document for our internal use and we found there is an awesome script in this repo that just do the things we want. Here's our PR woocommerce/google-listings-and-ads#1573, it basically copy most of the code from the script and then modify a bit to suit what we need.

The Problem

We found the script does not capture all the PHP files in the directory, the TLDR reason is the script cannot work in the case where there are more than two levels of paths. Please see the detailed explanation in our PR's comment: woocommerce/google-listings-and-ads#1573 (comment).

It also relates to #15.

Our solution may not fulfil the needs in this repo, also if there's any better ways to generate hooks documents (like using PHPDoc?) in your mind, we're happy to hear and learn about.

null and false don't show correctly in property signatures

---

Here's an example:
https://woocommerce.github.io/code-reference/classes/WC-Data.html#property_meta_data

I did a bit of digging, and here are some lines you can see in the HTML files:

It seems like something is interpreting "false" as "\false" and is interpreting "null" as "\null".
https://www.php.net/manual/en/regexp.reference.escape.php

Add a hook generator

Currently we are using an old script that doesn't capture all files from our source code.
You can find the current script in https://github.com/woocommerce/code-reference/blob/trunk/generate-hook-docs.php

We could take this opportunity to create a documentation for hooks generating several pages for individual files and types like actions and filters.

WooCommerce Code Reference

I noticed changes in the documentation. This is horrible compared to before. Woocommerce had the best documentation for an open source project. Now everything is an unproductive mess.