Using Git with WordPress: A Step-by-Step Guide

Sharing your creations is what makes art come to life, and the same holds true for WordPress developers. When you’ve built something new or exciting for the platform, it’s only natural to want to share it with the wider WordPress community. Maybe you’re even thinking about hosting your custom code for free. If you identify with it, using Git with WordPress might be your perfect fit.

Git and GitHub work together to provide a powerful solution for version control and management of your codebase. It allows you to host your work and invite other developers to review and modify your code. Plus, with GitHub pages, you can take advantage of free hosting if you’re deploying a static WordPress site. 

In this guide, we’ll show you how to use GitHub to manage your WordPress themes and plugins. You’ll also discover how to use a WordPress static site generator to deploy your projects to GitHub pages—without spending a dime. 

What is Git? 

Git, short for ‘global information tracker’, is a distributed version control system designed to help you keep track of changes in coding projects or files. These projects are stored in a ‘repository’ (repo for short), which is essentially a parent folder Git uses to organize all the files it’s managing. 

Git is a go-to tool for developers working on various software projects. One of its biggest advantages is that multiple people can create their own clones of the main repository, which contains the original code. They can then make edits or changes on their own local machine without directly altering the main repo. 

Once the changes are ready to go live, users upload them to a service like GitHub, which helps keep the team’s repositories organized and accessible. 

Git vs. GitHub 

A common question, especially for beginners, is: what’s the difference between Git and GitHub? 

Many new developers or site owners assume Git and GitHub are the same, but they’re actually different tools. Git is the version control system—it tracks changes in your code and organizes it into repositories. On the other hand, GitHub is a web hosting platform that stores Git repositories, making them easily accessible for teams. 

While you can use Git on its own, managing everything locally, GitHub requires Git to function. GitHub also stands out among other Git hosting platforms like Launchpad, Assembla and Bitbucket because of its additional features, which are particularly useful for companies and remote teams. Its user-friendly interface and collaboration tools make working on shared projects much simpler. 

Plus, with GitHub, everything is safely stored in the cloud, so even if your local machine gets damaged or lost, your code is still secure. 

Prerequisites for using Git with WordPress 

Before you start integrating Git with your WordPress projects, it’s essential to ensure you have the necessary tools and foundational knowledge. Here’s what you’ll need: 

Basic command-line knowledge 

Familiarity with command-line interfaces (CLI) like Terminal on macOS/Linux or Command Prompt/PowerShell on Windows is crucial. You’ll use CLI commands to interact with Git. You must also know how to navigate directories (cd), list files (ls or dir) and execute basic commands. 

Git installed on your local machine 

Check if Git is installed by running the git --version in your command line. If it’s not available, you can download it from the official Git website. If it has not already been installed, follow your operating system’s installation instructions. 

Local WordPress installation 

Create a local server environment with MAMP, XAMPP, WampServer or Local WP. Then, install WordPress locally to have a safe testing ground for your development work. 

GitHub account 

Sign up for a free account on GitHub and understand how to create GitHub repositories, commit changes and navigate the GitHub interface. 

Text Editor or IDE 

You can use a text editor like Visual Studio Code, Sublime Text or an Integrated Development Environment (IDE) like PhpStorm for coding. 

Basic understanding of WordPress file structure 

You must know where themes (wp-content/themes/) and plugins (wp-content/plugins/) are located within the WordPress directory. The basic understanding of core WordPress files’ role will further help avoid unintended modifications. 

While programming skills are not mandatory for version control, familiarity with PHP and WordPress development practices will help you make meaningful contributions to your projects. 

Benefits of using Git and GitHub with WordPress 

If you’re working on WordPress development, you’ve likely faced the frustration of managing different versions of your theme or plugin. Perhaps you’ve made updates and want to keep track of changes, or maybe you’ve collaborated with others and need a streamlined way to manage contributions. This is where Git and GitHub become useful: 

Version control: Git allows you to track changes to your files, keep a history of modifications, easily roll back to previous versions and collaborate without chaos. 

Backup security: GitHub safely backs up your code in multiple locations, so you don’t have to worry about losing important data. 

Effortless sharing: Sharing your code with others becomes easy, whether you’re working on open-source projects or collaborating with a private team. 

Smooth team collaboration: GitHub streamlines working with others, allowing for seamless contributions from multiple developers on the same project. 

Build connections: Collaborating on GitHub opens doors to building relationships with other developers and expanding your professional network. 

Enhance your profile: GitHub isn’t just a storage solution—it’s also a great way to showcase your work and build a professional profile that others can view. 

Professional development workflow: Using Git and GitHub makes managing WordPress development workflow both easier and more professional. 

How to use Git and GitHub for WordPress development 

Git and GitHub are invaluable tools for WordPress theme and plugin development. Whether you’re working on creating a new theme or customizing an existing one, GitHub offers an ideal platform for managing your project’s codebase. 

For example, when you’re developing a custom theme for your site, you can fetch the theme repository from GitHub, make your changes and test it on a local server. Once you’re happy with the updates, you push the updated repository to GitHub and then apply those changes to the live WordPress website. 

The same workflow applies to plugin development. If you’re a WordPress developer building plugin, GitHub helps you manage the codebase efficiently. This is especially useful for open-source projects, where other developers can contribute by fixing bugs or enhancing features. You can download the plugin files from GitHub, improve and share your work with the community. 

Aside from managing development, GitHub can also be used to download and install WordPress plugins and themes on your live website. However, it’s worth noting that while GitHub does allow for file storage and downloading, it’s not intended to serve as file storage like Dropbox or Google Drive. 

Setting up a local WordPress environment for Git 

Before diving into Git and GitHub, it’s the best practice to create a local WordPress environment. This is where you can safely work on your project, make changes, test your new code and develop plugins or themes without affecting your live website. If something goes wrong, you can easily debug and correct the code in your local environment before deploying it live. 

To set up a local environment, you’ll need software that lets you host a WordPress site directly on your computer, instead of a live or staging server. Tools like Local WP (formerly known as Local by Flywheel), MAMP, XAMPP and WampServer are all excellent choices for creating local environments. They’re free, user-friendly and simple to set up. 

Installing Git locally and creating a Git Repository 

Once your local WordPress environment is all set up, the next step is to install Git on your computer. However, before diving into the installation, it’s a good idea to check if Git has already been installed. If you’re using a macOS or Linux device, chances are you will find Git pre-installed. 

To check, open the Terminal (on Mac or Linux) and type the command: 

git --version 

On Windows, you can check by opening the Command Prompt and entering the same command: 

git --version 

If Git is already installed, you’ll see its version number displayed. If not, you’ll see nothing or get an error message saying the command is unknown. In that case, you’ll need to install Git manually. 

To install Git, take the following actions: 

• Go to the Git website. 
• Navigate to the Downloads area.

• Choose the relevant download link based on your operating system (Mac, Windows, or Linux/Unix). 

• Launch the installation wizard after downloading. 
• To finish the installation, click Next and adhere to the on-screen directions. 
• To ensure that Git has been installed correctly, restart your terminal or command prompt after installation and type the following command: 

git --version 

Now that Git is up and running, it’s time to create a local Git repository. This repository will allow you to commit changes to your WordPress files before pushing them to GitHub. 

Here’s how you can create a local repository: 

• Navigate to your local WordPress site files on your computer. 
• Go to the wp-content folder and find the plugin or theme folder you’re working on. 

• Right-click anywhere inside that WordPress folder and select Open Git Bash Here (or open Git manually if you’re on Mac/Linux). 
• In the terminal, type the following command to initialize a new Git repository: 

git init 

• Next, to stage all the files for your first commit, run this command: 

git add . 

• Now, it’s time to commit your changes. You can add a commit message to explain what changes you’ve made: 

git commit -m "your message here" 

Be sure to replace “your message here” with a relevant note about the updates you’ve made. Hit Enter to complete the commit. 

After this, a hidden .git folder will appear in your local WordPress theme files or plugin files, indicating that your repository is set up and ready for version control. 

Creating a GitHub Repository and committing changes 

The next step is to create a repository on GitHub to house your project after setting up Git locally. Here is how to take these actions: 

• Visit the GitHub website and create a free account. After inputting your email address, click the GitHub Sign up button.

• On the next screen, you must fill in your details, such as your GitHub username, password and email preferences. GitHub will also ask you to solve a quick puzzle to verify your account, similar to reCAPTCHA. 
• Once your account is set up, you’ll be taken to the GitHub dashboard. Look for the ‘+’ icon at the top right, click on it and select New repository. 

Now that you’re creating a new repository, here’s what to do: 

• Enter a name for your new repository. You can also add an optional description. 
• Choose whether you want to make your repository public or keep it private. 
• Scroll down, and you’ll see more options, such as adding a README file (which is great for documentation) and selecting a license for your project. 
• Once you’ve filled in all the details, click the Create repository button. 

You’ll get a URL after the repository is created. This link will connect your local repository to the one you just created on GitHub. You can find the URL under the Quick Setup section. 

To link your local repository with the GitHub repository, open Git Bash and run the following command, replacing the URL with your GitHub repository link: 

git remote add origin URL 

After that, push your local files to GitHub by typing the following command: 

git push -u origin main 

If your GitHub account isn’t yet linked with Git, you’ll be prompted to sign in and authorize the connection. Once that’s done, your local files will be uploaded to GitHub, where they’re available for others to view and collaborate on. 

At this point, your repository on GitHub will display the files you’ve edited locally. Other developers can now fork, clone or contribute to your project. If someone updates the repository, you can fetch the latest changes to your local environment by running the following command in Git Bash (again, replacing the URL with the GitHub repository link): 

git fetch URL 

This ensures your local environment stays in sync with the latest updates from GitHub. Once you’re satisfied with your changes, you can push them to your live WordPress website. 

Deploying GitHub themes and plugins to a live WordPress site 

After completing the development of your WordPress plugin or theme, the final step is to deploy it on your live site. While you can use Git commands to push updates to WordPress, there’s an easier way to use the WP Pusher plugin, which simplifies this process. 

Here’s how you can deploy your project using WP Pusher: 

• Head over to the WP Pusher website and click the Download button. Save the plugin files to your computer. 

• Next, install and activate the WP Pusher plugin in WordPress.
• Once WP Pusher is activated, navigate to the GitHub tab in the WP Pusher settings from your WordPress dashboard. 
• A window requesting authorization to establish a connection to your GitHub account will show up. Click Authorize wppusher and log in to your GitHub account. 
• After logging in, GitHub will generate a token for WP Pusher. Copy this token. 
• In the WP Pusher settings, paste the token into the GitHub token field and click Save GitHub token. This creates a link between your GitHub account and WordPress website. 

Now that GitHub is connected, you can deploy your themes and plugins directly from your GitHub repository. 

Install plugins from GitHub: 

• To install a plugin, navigate to WP Pusher » Install Plugin in the WordPress admin panel. 
• Enter the plugin repository’s URL or click Pick from GitHub to select the plugin from your GitHub account. 
• After pasting the repository URL, you can specify additional options like the branch or subdirectory if needed. 
• Scroll down and click Install plugin to install it on your WordPress website. 

Activate the plugin: 

• After the plugin has been installed, select Plugins > Installed Plugins and click the newly added plugin by clicking Activate. 
• At this point, your live site can utilize the plugin since it is active. 

Install themes from GitHub: 

• If you’re deploying a theme instead, follow the same process under Install Theme in the WP Pusher menu. 
• Enter the theme’s repository URL, fill in any necessary details and click Install theme. 

With WP Pusher, managing and deploying custom themes and plugins from GitHub becomes seamless, allowing you to streamline the development process and ensure that your live WordPress site is always up to date with the latest changes. 

Installing WordPress plugins and themes from GitHub 

Beyond using Git and GitHub for development, you can also source plugins and themes that are no longer available in the WordPress.org repository. Many WordPress developers maintain their plugins and themes on GitHub, making it a valuable resource when you can’t find them in the official library. 

Here’s how you can install plugins and themes from GitHub: 

• Open GitHub and search for the plugin or theme you want to install. 
• Once you find the repository, click the Code button and select Download ZIP. This will download a ZIP file containing the plugin or theme files to your computer. 
• To install the downloaded plugin or theme, go to your WordPress dashboard. For plugins, navigate to Plugins > Add New Plugin and click Upload Plugin.

• For themes, go to Appearance > Themes and click Add New, then Upload. Choose the ZIP file you downloaded and install it. 

• After installation, activate the plugin or theme from the respective sections in your WordPress dashboard. You can now use it on your site. 

Troubleshooting common Git issues in WordPress projects 

As a new developer working with WordPress, you might encounter a few common Git issues. Here’s a simple guide to help you troubleshoot and resolve these problems efficiently. 

Merge conflicts 

Issue: You encounter conflicts when merging branches. 

Solution: 

• Identify the conflicts: Git will point out which files are in conflict. 
• Manually edit the conflicting files: Look for the conflict markers (e.g., <<<<<<< HEAD and >>>>>>>) and resolve them. 
• Stage and commit the changes: Once resolved, use git add to stage the files, then commit the changes. 

Accidentally committed sensitive files 

Issue: Sensitive files (like passwords or API keys) were accidentally committed to your repository. 

Solution: 

• Remove the files: Use git rm –cached filename to remove the file from your Git history. 
• Update your .gitignore: Add the sensitive files to .gitignore so they don’t get committed again. 
• Remove them from your Git history: Use tools like BFG Repo-Cleaner to clean up past commits. 
• Update any exposed credentials: Make sure to change any sensitive information that was exposed. 

Synchronization issues 

Issue: You encounter errors when trying to pull or push changes. 

Solution: 

• Use git pull –rebase: This ensures that your changes are reapplied cleanly on top of the latest commits. 
• Avoid force-pushing: Only force-push when absolutely necessary, as it can overwrite others’ work. 
• Check remote URLs: Make sure your remote repository URL is correct. 

Detached HEAD state 

Issue: You’re working in a “detached HEAD” state, meaning you’re not on a branch. 

Solution: 

• Create a new branch: Run git checkout -b branch-name to create and switch to a new branch. 
• Switch to an existing branch: Use git checkout branch-name to get back to a branch you were previously working on. 

Files in .gitignore still tracked 

Issue: Git is still tracking the files you’ve added to .gitignore. 

Solution: 

• Untrack the files: Use git rm –cached filename to stop tracking the files. 
• Check your .gitignore syntax: Ensure there are no mistakes in how you’ve listed the files in .gitignore. 

Large Repository due to media files 

Issue: Your repository is getting too large because of media files. 

Solution: 

• Exclude media files: Add media files to .gitignore so they’re not committed. 
• Use Git LFS: For large files, use Git Large File Storage (Git LFS) to store them more efficiently. 

Line ending conflicts 

Issue: You’re facing issues due to different operating systems using different line endings (e.g., Windows vs. Mac/Linux). 

Solution 

• Configure Git: Run git config core.autocrlf true on Windows to handle line ending differences. 
• Standardize settings: Ensure your team uses consistent Git settings to avoid future line-ending conflicts. 

Important Git and GitHub terms you should know 

As you delve into using Git and GitHub for WordPress development, you’ll encounter several key terms. Here’s a quick glossary to help you navigate: 

Branches: Think of branches as separate paths within a repository. They allow you to make changes independently of the main codebase, so you can experiment without affecting the live version. 

Merge: Merging is the process of integrating changes from one branch into another. For example, you might merge a feature branch into the main branch to combine updates. 

Pull: Pulling involves fetching changes from a remote repository and incorporating them into your local copy. It ensures that your local files stay up to date with the latest changes. 

Pull requests (PR): One method to suggest modifications to a repository is through a pull request. Before the modifications are integrated into the main codebase, it enables others to examine and debate the changes. 

Fork: Forking creates a personal copy of another user’s repository. You can make changes to your fork without affecting the original project. 

Commit: A commit is a record of the modifications that have been made to the repository. Each commit has a unique ID and records who made the changes and when. 

Push: Pushing sends your local changes to a remote repository on GitHub, making them accessible to others. 

FAQs about using Git with WordPress